TTCatalogIndex Reference

Each TTCatalogTable object contains an array of TTCatalogColumn objects and an array of TTCatalogIndex objects.

Public Members

None

Public Methods

This section summarizes then describes the TTCatalogIndex public methods.

Public Methods Summary

Method	Description
`getCollation()`	Returns the collation of the specified column in the index.
`getColumnName()`	Returns the name of the specified column in the index.
`getIndexName()`	Returns the name of the index.
`getIndexOwner()`	Returns the owner of the index.
`getNumColumns()`	Returns the number of columns in the index.
`getTableName()`	Returns the name of the table for which the index was created.
`getType()`	Returns the type of the index.
`isUnique()`	Indicates whether the index is a unique index.

getCollation()

char getCollation (int num)

Returns the collation of column number num in the index. Values returned are "A" for ascending order or "D" for descending order.

getColumnName()

const char* getColumnName(int num)

Returns the name of column number num in the index.

getIndexName()

const char* getIndexName()

Returns the name of the index.

getIndexOwner()

const char* getIndexOwner()

Returns the owner of the index.

getNumColumns()

int getNumColumns()

Returns the number of columns in the index.

getTableName()

const char* getTableName()

Returns the name of the table for which the index was created. This is the table represented by the TTCatalogTable object from which the index was retrieved through a TTCatalogTable::getIndex() call.

getType()

int getType()

Returns the type of the index. For TimesTen, the allowable values are PRIMARY_KEY, HASH_INDEX (the same as PRIMARY_KEY), and RANGE_INDEX.

isUnique()

bool isUnique()

Returns TRUE if the index is a unique index, or FALSE otherwise.