Key Class Reference

#include <sql_class.h>

Inheritance diagram for Key:

[legend]Collaboration diagram for Key:

[legend]List of all members.

Public Types
enum	Keytype { PRIMARY, UNIQUE, MULTIPLE, FULLTEXT, SPATIAL, FOREIGN_KEY }
Public Member Functions
	Key (enum Keytype type_par, const char *name_arg, enum ha_key_alg alg_par, bool generated_arg, List< key_part_spec > &cols)
	~Key ()
Public Attributes
List< key_part_spec >	columns
const char *	name
bool	generated
Friends
bool	foreign_key_prefix (Key *a, Key *b)

---

Member Enumeration Documentation

enum Key::Keytype

Enumeration values: PRIMARY  UNIQUE  MULTIPLE  FULLTEXT  SPATIAL  FOREIGN_KEY  { PRIMARY, UNIQUE, MULTIPLE, FULLTEXT, SPATIAL, FOREIGN_KEY};

---

Constructor & Destructor Documentation

Key::Key (  enum Keytype  type_par, const char *  name_arg, enum ha_key_alg  alg_par, bool  generated_arg, List< key_part_spec > &  cols )  [inline]

:type(type_par), algorithm(alg_par), columns(cols), name(name_arg), generated(generated_arg) {}

Key::~Key (   )  [inline]

{}

---

Friends And Related Function Documentation

bool foreign_key_prefix (  Key *  a, Key *  b )  [friend]

{ /* Ensure that 'a' is the generated key */ if (a->generated) { if (b->generated && a->columns.elements > b->columns.elements) swap_variables(Key*, a, b); // Put shorter key in 'a' } else { if (!b->generated) return TRUE; // No foreign key swap_variables(Key*, a, b); // Put generated key in 'a' } /* Test if 'a' is a prefix of 'b' */ if (a->columns.elements > b->columns.elements) return TRUE; // Can't be prefix List_iterator<key_part_spec> col_it1(a->columns); List_iterator<key_part_spec> col_it2(b->columns); const key_part_spec *col1, *col2; #ifdef ENABLE_WHEN_INNODB_CAN_HANDLE_SWAPED_FOREIGN_KEY_COLUMNS while ((col1= col_it1++)) { bool found= 0; col_it2.rewind(); while ((col2= col_it2++)) { if (*col1 == *col2) { found= TRUE; break; } } if (!found) return TRUE; // Error } return FALSE; // Is prefix #else while ((col1= col_it1++)) { col2= col_it2++; if (!(*col1 == *col2)) return TRUE; } return FALSE; // Is prefix #endif }

---

Member Data Documentation

List<key_part_spec> Key::columns

bool Key::generated

const char* Key::name

---

The documentation for this class was generated from the following file:

• /root/mysql-5.0.2-alpha/sql/sql_class.h

---