~drizzle-trunk/drizzle/development : contents of drizzled/index

~drizzle-trunk/drizzle/development : (revision 2415.1.4)

/* - mode: c; c-basic-offset: 2; indent-tabs-mode: nil; -*-
 *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
 *
 *  Copyright (C) 2008-2009 Sun Microsystems, Inc.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

/**
 * @file
 *
 * Defines the API for index hints
 */

#pragma once

namespace drizzled {

/*
  String names used to print a statement with index hints.
  Keep in sync with index_hint_type.
*/
extern const char* index_hint_type_name[];
typedef unsigned char index_clause_map;

enum index_hint_type
{
  INDEX_HINT_IGNORE,
  INDEX_HINT_USE,
  INDEX_HINT_FORCE
};

/*
  Bits in index_clause_map : one for each possible FOR clause in
  USE/FORCE/IGNORE INDEX index hint specification
*/
#define INDEX_HINT_MASK_JOIN  (1)
#define INDEX_HINT_MASK_GROUP (1 << 1)
#define INDEX_HINT_MASK_ORDER (1 << 2)

#define INDEX_HINT_MASK_ALL (INDEX_HINT_MASK_JOIN | INDEX_HINT_MASK_GROUP | INDEX_HINT_MASK_ORDER)

/* Single element of an USE/FORCE/IGNORE INDEX list specified as a SQL hint  */
class Index_hint : public memory::SqlAlloc
{
public:
  /* The type of the hint : USE/FORCE/IGNORE */
  index_hint_type type;
  /* Where the hit applies to. A bitmask of INDEX_HINT_MASK_<place> values */
  index_clause_map clause;
  /*
    The index name. Empty (str=NULL) name represents an empty list
    USE INDEX () clause
  */
  const char* key_name;

  Index_hint(index_hint_type type_arg, index_clause_map clause_arg, const char *str) :
    type(type_arg), clause(clause_arg), key_name(str)
  {
  }

  void print(String&) const;
};

} /* namespace drizzled */

934.2.2 by Jay Pipes Forgot to add the new files...	1	/* - mode: c; c-basic-offset: 2; indent-tabs-mode: nil; -*-
	2	* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
	3	*
1999.6.1 by kalebral at gmail update Copyright strings to a more common format to help with creating the master debian copyright file	4	* Copyright (C) 2008-2009 Sun Microsystems, Inc.
934.2.2 by Jay Pipes Forgot to add the new files...	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, write to the Free Software
	18	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	19	*/
	20
	21	/**
	22	* @file
	23	*
	24	* Defines the API for index hints
	25	*/
	26
2234 by Brian Aker Mass removal of ifdef/endif in favor of pragma once.	27	#pragma once
934.2.2 by Jay Pipes Forgot to add the new files...	28
2385.3.19 by Olaf van der Spek Refactor	29	namespace drizzled {
1280.1.10 by Monty Taylor Put everything in drizzled into drizzled namespace.	30
934.2.2 by Jay Pipes Forgot to add the new files...	31	/*
	32	String names used to print a statement with index hints.
	33	Keep in sync with index_hint_type.
	34	*/
2385.3.20 by Olaf van der Spek Refactor	35	extern const char* index_hint_type_name[];
934.2.2 by Jay Pipes Forgot to add the new files...	36	typedef unsigned char index_clause_map;
	37
	38	enum index_hint_type
	39	{
	40	INDEX_HINT_IGNORE,
	41	INDEX_HINT_USE,
	42	INDEX_HINT_FORCE
	43	};
	44
	45	/*
	46	Bits in index_clause_map : one for each possible FOR clause in
	47	USE/FORCE/IGNORE INDEX index hint specification
	48	*/
	49	#define INDEX_HINT_MASK_JOIN (1)
	50	#define INDEX_HINT_MASK_GROUP (1 << 1)
	51	#define INDEX_HINT_MASK_ORDER (1 << 2)
	52
2385.3.20 by Olaf van der Spek Refactor	53	#define INDEX_HINT_MASK_ALL (INDEX_HINT_MASK_JOIN \| INDEX_HINT_MASK_GROUP \| INDEX_HINT_MASK_ORDER)
934.2.2 by Jay Pipes Forgot to add the new files...	54
934.2.2 by Jay Pipes Forgot to add the new files...	55	/* Single element of an USE/FORCE/IGNORE INDEX list specified as a SQL hint */
1280.1.10 by Monty Taylor Put everything in drizzled into drizzled namespace.	56	class Index_hint : public memory::SqlAlloc
934.2.2 by Jay Pipes Forgot to add the new files...	57	{
	58	public:
	59	/* The type of the hint : USE/FORCE/IGNORE */
2385.3.19 by Olaf van der Spek Refactor	60	index_hint_type type;
934.2.2 by Jay Pipes Forgot to add the new files...	61	/* Where the hit applies to. A bitmask of INDEX_HINT_MASK_<place> values */
	62	index_clause_map clause;
	63	/*
	64	The index name. Empty (str=NULL) name represents an empty list
	65	USE INDEX () clause
	66	*/
2385.3.20 by Olaf van der Spek Refactor	67	const char* key_name;
934.2.2 by Jay Pipes Forgot to add the new files...	68
2385.3.21 by Olaf van der Spek Refactor	69	Index_hint(index_hint_type type_arg, index_clause_map clause_arg, const char *str) :
2385.3.21 by Olaf van der Spek Refactor	70	type(type_arg), clause(clause_arg), key_name(str)
934.2.2 by Jay Pipes Forgot to add the new files...	71	{
	72	}
	73
2385.3.21 by Olaf van der Spek Refactor	74	void print(String&) const;
934.2.2 by Jay Pipes Forgot to add the new files...	75	};
934.2.2 by Jay Pipes Forgot to add the new files...	76
1280.1.10 by Monty Taylor Put everything in drizzled into drizzled namespace.	77	} /* namespace drizzled */