v5:dictionary:metaindexes
Differences
This shows you the differences between two versions of the page.
Next revision | Previous revisionLast revisionBoth sides next revision | ||
dictionary:metaindexes [2015/08/12 02:05] – created mnewnham | v5:dictionary:metaindexes [2016/03/17 00:24] – mnewnham | ||
---|---|---|---|
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, | ||
) | ) | ||
</ | </ | ||
===== Description ===== | ===== Description ===== | ||
- | The function '' | + | The function '' |
+ | 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 | ||
+ | */ | ||
+ | | ||
+ | ) | ||
</ | </ | ||
+ | ------- | ||
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 ==== |
v5/dictionary/metaindexes.txt · Last modified: 2016/11/02 13:14 by dregad