Abstract
This section provides a reference to the Index
class and its public members.
Parent class. NdbDictionary
Child classes. None
Description.
This class represents an index on an NDB
Cluster table column. It is a descendant of the
NdbDictionary class, via the
Object class. For information on these, see
Section 2.3.10, “The NdbDictionary Class”, and
Section 2.3.20, “The Object Class”.
Methods.
The following table lists the public methods of
Index and the purpose or use of each method:
| Method | Purpose / Use |
|---|---|
Index() |
Class constructor |
~Index() |
Destructor |
getName() |
Gets the name of the index |
getTable() |
Gets the name of the table being indexed |
getNoOfColumns() |
Gets the number of columns belonging to the index |
getColumn() |
Gets a column making up (part of) the index |
getType() |
Gets the index type |
getLogging() |
Checks whether the index is logged to disk |
getObjectStatus() |
Gets the index object status |
getObjectVersion() |
Gets the index object status |
getObjectId() |
Gets the index object ID |
setName() |
Sets the name of the index |
setTable() |
Sets the name of the table to be indexed |
addColumn() |
Adds a Column object to the index |
addColumnName() |
Adds a column by name to the index |
addColumnNames() |
Adds multiple columns by name to the index |
setType() |
Set the index type |
setLogging() |
Enable/disable logging of the index to disk |
For detailed descriptions, signatures, and examples of use for
each of these methods, see Section 2.3.5.2, “Index Methods”.
Types.
Index has one public type, the Type type. For a
discussion of Type, see
Section 2.3.5.1, “The Index::Type Type”.
Class diagram.
This diagram shows all the available methods and enumerated types
of the Index class:
