ADOdb

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== addIndexObject ======
~~NOTOC~~
<WRAP right box>
**From Version 5.21.0-beta-2**
== See Also ==
[[v6:dictionary:structure:introduction|Structured Schema Management]]\\

== Syntax ==
  obj addIndexObject(
      string $indexName,
      optional string $platform=''
  )
  
</WRAP>
The method ''addIndexObject()'' is part of the **//Structured Schema Management//** suite, and adds an index to the current [[v6:dictionary:structure:metaobjectstructure|table]] object. The index object is a container for  [[v6:dictionary:structure:addindexitemobject|Index Item]] objects, which are the columns themselves.
--------------------------------
===== Parameters =====
==== $indexName ====
The name of the index to be created. The name must conform to any pre-defined rules for the database to be used

==== $platform ====
The platform parameter can be any parameter recognized by the [[v6:dictionary:structure:platform|Platform]] keyword.


===== Usage =====
In the following example, a table **//employees//** is to be created. The table has 2 columns, COL1 and COL2 and an index COL1-IDX will be created, holding COL1.

<code php>
$t = new metaObjectStructure($dict,'employees');

$t->addColumnObject('COL1','I');
$t->addColumnObject('COL2','C(60)');

$i = $t->addIndexObject('COL1-IDX');

$i->addIndexItemObject('COL1-IDX','COL1')

</code>