====== metaIndexes ======
~~NOTOC~~
== See Also ==
[[v5:dictionary:metaprimarykeys|metaPrimaryKeys()]]\\
== Syntax ==
mixed metaIndexes(
string $tableName,
optional bool $includePrimary=false,
optional string $owner=false,
)
===== Description =====
The function ''metaIndexes()'' returns a list of indexes associated with a specific table. If there are no indices defined for the requested table, the method returns false.
All drivers return the same array of data. There are no database-specific entries. The array of data is as followed:
----------------------------------------------
[index_name] => Array
(
[unique] => 0
[columns] => Array
(
[0] => Column 1
[1] => Column 2
[2] => etc........
)
/*
* After ADOdb Version 6.0
* the following column is also returned
*/
[primary] => 0
)
-------
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 =====
==== $includePrimary ====
If set, the index associated with the primary key is also returned
==== $owner ====
If specified, only returns indexes associated with a table owned by that name. Support for this function is limited, see the [[v5:database:feature_comparison]].
===== Usage =====
/*
* Database connection to DB2 database sample assumed
*/
$mi = $db->metaIndexes('ACT');
print_r($mi);
/*
* Returns
Array
(
[PK_ACT] => Array
(
[unique] => 0
[columns] => Array
(
[0] => ACTNO
)
)
[XACT2] => Array
(
[unique] => 0
[columns] => Array
(
[0] => ACTNO
[1] => ACTKWD
)
)
)
*/