MySQL :: MySQL Cluster API Developer Guide :: 2.3.4 The Dictionary Class

MySQL Cluster API Developer Guide :: 2 The NDB API :: 2.3 NDB API Classes, Interfaces, and Structures :: 2.3.4 The Dictionary Class

« 2.3.3.1 Datafile Methods

2.3.4.1 Dictionary Methods »

Section Navigation [Toggle]

2.3.4. The `Dictionary` Class

[+/-]

2.3.4.1. Dictionary Methods

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
`createDatafile()`	Creates a datafile
`createEvent()`	Creates an event
`createIndex()`	Creates an index
`createLogfileGroup()`	Creates a logfile group
`createRecord()`	Creates an `Ndbrecord` object
`createTable()`	Creates a table
`createTablespace()`	Creates a tablespace
`createUndofile()`	Creates an undofile
`dropDatafile()`	Drops a datafile
`dropEvent()`	Drops an event
`dropIndex()`	Drops an index
`dropLogfileGroup()`	Drops a logfile group
`dropTable()`	Drops a table
`dropTablespace()`	Drops a tablespace
`dropUndofile()`	Drops an undofile
`getDatafile()`	Gets the datafile having the given name
`getEmptyBitmask()`	Returns an empty column presence bitmask which can be used with `NdbRecord`
`getEvent()`	Gets the event having the given name
`getFirstAttrId()`	Get the first attribute ID specified by a given `NdbRecord` object
`getIndex()`	Gets the index having the given name
`getLogfileGroup()`	Gets the logfile group having the given name
`getNdbError()`	Retrieves the latest error
`getRecordIndexName()`	Gets the name of the index object referred to by an NdbRecord
`getRecordRowLength()`	Get the number of bytes needed to store one row of data using a given `NdbRecord`
`getRecordTableName()`	Gets the name of the table object referred to by an NdbRecord
`getRecordType()`	Gets the RecordType of an NdbRecord
`getTable()`	Gets the table having the given name
`getTablespace()`	Gets the tablespace having the given name
`getUndofile()`	Gets the undofile having the given name
`getValuePtr()`	Returns a pointer to the beginning of stored data specified by attribute ID, using `NdbRecord`
`invalidateTable()`	Invalidates a table object
`isNull()`	Show whether the null bit for a column is true or false
`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
`setNull()`	Set a column's null bit

For detailed descriptions, signatures, and examples of use for each of these methods, see Section 2.3.4.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.2, “The Column Class”, for details.

Types. See Section 2.3.11, “The List Class”, and Section 2.3.5, “The Element Structure”.

Dictionary Class and Subclass Diagram. This diagram shows all the public members of the Dictionary class and its subclasses:

Top / Previous / Next / Up / Table of Contents

2.3.4. The Dictionary Class

2.3.4. The `Dictionary` Class