updateIndex

The updateIndex element allows an existing index to be modified.

Example:

<updateIndex name="my_existing_index" table="case">
   <columns>newIndexedColumn, newIndexedRelation</columns>
   <description>This is the new description of my custom index.</description>
</updateIndex>

Required Attributes:

Attribute Name

Description

name

Specifies the name of the index.

table

Specifies the name of the table on which this index exists.


Optional Child Elements:

Element Name

Description

columns

A comma separated list of columns that make up the index. This can include fields and relations.

description

Description of the index and its purpose.

isUnique

Specifies if the index is a unique index or not.

See Also

schemaScript

addColumn

addExclusiveRelationSet

addIndex

addJoin

addRelation

addSqlView

addSqlViewColumn

addTable

addView

addViewColumn

updateColumn

updateJoin

updateRelation

updateTable

updateSchema

updateSqlView

updateSqlViewColumn

updateView

updateViewColumn

Next

updateJoin

updateIndex