Differences

This shows you the differences between two versions of the page.

--- dictionary:metaindexes [2015/08/12 02:05] – created mnewnham
+++ v5:dictionary:metaindexes [2016/11/02 13:14] (current) – add link to comparison matrix dregad
@@ Line 3: / Line 3: @@
 <WRAP right box>
 == See Also ==
-[[reference:metaprimarykeys|metaPrimaryKeys()]]
+[[v5:dictionary:metaprimarykeys|metaPrimaryKeys()]]\\
 == Syntax ==
     mixed metaIndexes(
         string $tableName,
-        optional bool $primary=true,
+        optional bool $includePrimary=false,
         optional string $owner=false,
         )
 </WRAP>
 ===== Description =====
-The function ''metaIndexes()'' returns a list of indexes associated with a specific table. All drivers return the same array of data. There are no database-specific entries. The array of data is as followed:
+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:
+----------------------------------------------
 <code php>
 [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
+      */
+     [primary] => 0
+)
 </code>
+-------
 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 =====
-==== $primary ====
+==== $includePrimary ====
-If set, only returns the index associated with the primary key
+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 compatibility matrix.
+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 =====
 <code php>