v5:dictionary:metaindexes
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| dictionary:metaindexes [2015/09/11 02:43] – mnewnham | v5:dictionary:metaindexes [2016/11/02 13:14] (current) – add link to comparison matrix dregad | ||
|---|---|---|---|
| Line 3: | Line 3: | ||
| <WRAP right box> | <WRAP right box> | ||
| == See Also == | == See Also == | ||
| - | [[reference: | + | [[v5: |
| == Syntax == | == Syntax == | ||
| mixed metaIndexes( | mixed metaIndexes( | ||
| string $tableName, | string $tableName, | ||
| - | optional bool $primary=true, | + | optional bool $includePrimary=false, |
| optional string $owner=false, | optional string $owner=false, | ||
| ) | ) | ||
| Line 16: | Line 15: | ||
| All drivers return the same array of data. There are no database-specific entries. The array of data is as followed: | All drivers return the same array of data. There are no database-specific entries. The array of data is as followed: | ||
| + | ---------------------------------------------- | ||
| <code php> | <code php> | ||
| [index_name] => Array | [index_name] => Array | ||
| - | | + | ( |
| - | [unique] => 0 | + | [unique] => 0 |
| - | [columns] => Array | + | [columns] => Array |
| - | ( | + | ( |
| - | [0] => Column 1 | + | [0] => Column 1 |
| - | [1] => Column 2 | + | [1] => Column 2 |
| - | [2] => etc........ | + | [2] => etc........ |
| - | ) | + | |
| - | + | /* | |
| - | ) | + | * After ADOdb Version 6.0 |
| + | * the following column is also returned | ||
| + | */ | ||
| + | | ||
| + | ) | ||
| </ | </ | ||
| ------- | ------- | ||
| - | <WRAP right info 300px> | + | |
| - | As of ADOdb version 6.0, the casing of the index and column names can be controlled by the [[dictionary: | + | |
| - | </ | + | |
| The casing of metaIndexes is returned in the native mode for the database, you should not assume the casing for the returned data. | The casing of metaIndexes is returned in the native mode for the database, you should not assume the casing for the returned data. | ||
| ===== Optional Parameters ===== | ===== Optional Parameters ===== | ||
| - | ==== $primary | + | ==== $includePrimary |
| - | If set, only returns | + | If set, the index associated with the primary key is also returned |
| ==== $owner ==== | ==== $owner ==== | ||
| - | If specified, only returns indexes associated with a table owned by that name. Support for this function is limited, see the compatibility matrix. | + | If specified, only returns indexes associated with a table owned by that name. Support for this function is limited, see the [[v5: |
| ===== Usage ===== | ===== Usage ===== | ||
| <code php> | <code php> | ||
v5/dictionary/metaindexes.1441932233.txt.gz · Last modified: (external edit)
