MySQL :: The MySQL Cluster API Developer Guide

Section Navigation [Toggle]

The NDB API is a MySQL Cluster application interface that implements transactions. It consists of the following fundamental classes:

Ndb_cluster_connection represents a connection to a cluster.

See Section 2.3.24, “The Ndb_cluster_connection Class”.
Ndb is the main class, and represents a connection to a database.

See Section 2.3.8, “The Ndb Class”.
NdbDictionary provides meta-information about tables and attributes.

See Section 2.3.10, “The NdbDictionary Class”.
NdbTransaction represents a transaction.

See Section 2.3.19, “The NdbTransaction Class”.
NdbOperation represents an operation using a primary key.

See Section 2.3.15, “The NdbOperation Class”.
NdbScanOperation represents an operation performing a full table scan.

See Section 2.3.18, “The NdbScanOperation Class”.
NdbIndexOperation represents an operation using a unique hash index.

See Section 2.3.12, “The NdbIndexOperation Class”.
NdbIndexScanOperation represents an operation performing a scan using an ordered index.

See Section 2.3.13, “The NdbIndexScanOperation Class”.
NdbRecAttr represents an attribute value.

See Section 2.3.16, “The NdbRecAttr Class”.

In addition, the NDB API defines an NdbError structure, which contains the specification for an error.

It is also possible to receive events triggered when data in the database is changed. This is accomplished through the NdbEventOperation class.

The NDB event notification API is not supported prior to MySQL 5.1. (Bug#19719)

For more information about these classes as well as some additional auxiliary classes not listed here, see Section 2.3, “NDB API Classes, Interfaces, and Structures”.