Class DB_dbindex

Description

Defines a database index.

Located in /pg-schema-defs.php (line 174)

SchemaObject
   |
   --dbindex
      |
      --DB_dbindex
Variable Summary
Method Summary
 DB_dbindex DB_dbindex (mixed &$schema, mixed $name, mixed $tablename, [mixed $flds = ""], [mixed $primary = false], [mixed $unique = false], [mixed $clustered = false], [mixed $access = ""])
 void create ()
 void drop ()
 void getschema ()
Variables
mixed $access_method = "" (line 178)

Access method, eg. btree, hash etc.

mixed $clustered = false (line 176)

True if index is clustered

mixed $fieldnums = array() (line 180)

Field numbers of fields in index

Inherited Variables

Inherited from dbindex

dbindex::$fieldnames
dbindex::$primary
dbindex::$tablename
dbindex::$unique

Inherited from SchemaObject

SchemaObject::$name
SchemaObject::$schema
Methods
Constructor DB_dbindex (line 182)
DB_dbindex DB_dbindex (mixed &$schema, mixed $name, mixed $tablename, [mixed $flds = ""], [mixed $primary = false], [mixed $unique = false], [mixed $clustered = false], [mixed $access = ""])
create (line 223)

Return SQL required to create this index.

void create ()

Redefinition of:
dbindex::create()
Return SQL required to create this index.
drop (line 245)
void drop ()

Redefinition of:
dbindex::drop()
getschema (line 195)

Obtain index schema information.

NB: For indexes this only retrieves the fields as numeric offsets in the list of fields on the table the index is for. The $fieldnames array of this index must be populated by the dbtable descendant.

void getschema ()

Redefinition of:
dbindex::getschema()
Acquires the schema from database metadata.

Inherited Methods

Inherited From dbindex

 dbindex::dbindex()
 dbindex::create()
 dbindex::drop()
 dbindex::dump()
 dbindex::getschema()
 dbindex::set()

Inherited From SchemaObject

 SchemaObject::SchemaObject()

Documentation generated by phpDocumentor 1.3.0RC3