Abstract
This section describes the Dictionary class.
Parent class. NdbDictionary
Child classes. List
Description. This is used for defining and retrieving data object metadata. It also includes methods for creating and dropping database objects.
Methods. The following table lists the public methods of this class and the purpose or use of each method:
| Method | Purpose / Use |
|---|---|
Dictionary() |
Class constructor method |
~Dictionary() |
Destructor method |
getTable() |
Gets the table having the given name |
getIndex() |
Gets the index having the given name |
getEvent() |
Gets the event having the given name |
getTablespace() |
Gets the tablespace having the given name |
getLogfileGroup() |
Gets the logfile group having the given name |
getDatafile() |
Gets the datafile having the given name |
getUndofile() |
Gets the undofile having the given name |
getNdbError() |
Retrieves the latest error |
createTable() |
Creates a table |
createIndex() |
Creates an index |
createEvent() |
Creates an event |
createTablespace() |
Creates a tablespace |
createLogfileGroup() |
Creates a logfile group |
createDatafile() |
Creates a datafile |
createUndofile() |
Creates an undofile |
dropTable() |
Drops a table |
dropIndex() |
|
dropEvent() |
Drops an index |
dropTablespace() |
Drops a tablespace |
dropLogfileGroup() |
Drops a logfile group |
dropDatafile() |
Drops a datafile |
dropUndofile() |
Drops an undofile |
listObjects() |
Fetches a list of the objects in the dictionary |
listIndexes() |
Fetches a list of the indexes defined on a given table |
listEvents() |
Fetches a list of the events defined in the dictionary |
removeCachedTable() |
Removes a table from the local cache |
removeCachedIndex() |
Removes an index from the local cache |
For detailed descriptions, signatures, and examples of use for each
of these methods, see Section 2.3.3.1, “Dictionary Methods”.
Important
Objects created using the
Dictionary::create
methods are not visible from the MySQL Server. For this reason, it
is usually preferable to avoid using them.
*()
Note
The Dictionary class does not have any methods for working
directly with columns. You must use Column
class methods for this purpose — see
Section 2.3.1, “The Column Class”, for details.
Types.
See Section 2.3.7, “The List Class”, and Section 2.3.27, “The Element Structure”.
Dictionary Class and Subclass Diagram.
This diagram shows all the public members of the
Dictionary class and its subclasses:
