Class dbindex

Description

Defines a database index.

Located in /schema-defs.php (line 178)

SchemaObject
   |
   --dbindex
Direct descendents
Class Description
 class DB_dbindex Defines a database index.
Variable Summary
 mixed $fieldnames
 mixed $primary
 mixed $tablename
 mixed $unique
Method Summary
 dbindex dbindex (mixed &$schema, mixed $name, [mixed $tablename = ""], [mixed $flds = ""], [mixed $primary = false], [mixed $unique = false])
 void create ()
 void drop ()
 void dump ()
 void getschema ()
 void set ([mixed $tablename = ""], [mixed $flds = ""], [mixed $primary = false], [mixed $unique = false])
Variables
mixed $fieldnames = array() (line 182)

Fieldnames in the index

mixed $primary = false (line 184)

True if index is for a primary key

mixed $tablename (line 180)

Name of table index is built on

mixed $unique = false (line 186)

True if index is unique

Inherited Variables

Inherited from SchemaObject

SchemaObject::$name
SchemaObject::$schema
Methods
Constructor dbindex (line 188)
dbindex dbindex (mixed &$schema, mixed $name, [mixed $tablename = ""], [mixed $flds = ""], [mixed $primary = false], [mixed $unique = false])
create (line 214)

Return SQL required to create this index.

void create ()

Redefined in descendants as:
drop (line 232)
void drop ()

Redefined in descendants as:
dump (line 208)

Dump ascii description of this index to stdout.

void dump ()
getschema (line 205)

Acquires the schema from database metadata.

NB: Override this function to get schema info per DB type.

void getschema ()

Redefined in descendants as:
set (line 194)

Set index variables.

void set ([mixed $tablename = ""], [mixed $flds = ""], [mixed $primary = false], [mixed $unique = false])

Inherited Methods

Inherited From SchemaObject

 SchemaObject::SchemaObject()

Documentation generated by phpDocumentor 1.3.0RC3