MySQL Cluster API Developer Guide

MySQL Cluster API Developer Guide

This is the MySQL Cluster API Developer Guide, which provides information about developing applications using MySQL Cluster as a data store. Application interfaces covered in this Guide include the low-level C++-language NDB API for the MySQL NDB storage engine, the C-language MGM API for communicating with and controlling MySQL Cluster management servers, and the MySQL Cluster Connector for Java, which is a collection of Java APIs for writing applications against MySQL Cluster, including JDBC, JPA, and ClusterJ.

MySQL Cluster NDB 7.2 and later also provides support for the Memcache API; for more information, see Chapter 6, ndbmemcache—Memcache API for MySQL Cluster.

MySQL Cluster NDB 7.3 and later also provides support for applications written using Node.js. See Chapter 5, MySQL NoSQL Connector for JavaScript, for more information.

This Guide includes concepts, terminology, class and function references, practical examples, common problems, and tips for using these APIs in applications. It also contains information about NDB internals that may be of interest to developers working with NDB, such as communication protocols employed between nodes, file systems used by management nodes and data nodes, error messages, and debugging (DUMP) commands in the management client.

The information presented in this guide is current for recent releases of MySQL Cluster up to and including MySQL Cluster NDB 7.4.13. Due to significant functional and other changes in MySQL Cluster and its underlying APIs, you should not expect this information to apply to previous releases of the MySQL Cluster software prior to MySQL Cluster NDB 7.2. Users of older MySQL Cluster releases should upgrade to the latest available GA release of MySQL Cluster NDB 7.4.

For legal information, see the Legal Notices.

For help with using MySQL, please visit either the MySQL Forums or MySQL Mailing Lists, where you can discuss your issues with other MySQL users.

For additional documentation on MySQL products, including translations of the documentation into other languages, and downloadable versions in variety of formats, including HTML and PDF formats, see the MySQL Documentation Library.

Third-party licensing information.  This product may include third-party software, used under license. If you are using a Commercial release of MySQL Cluster, see this document for licensing information relating to third-party software that may be included in this Commercial release. If you are using a Community release of MySQL Cluster, see this document for licensing information relating to third-party software that may be included in this Community release.

Document generated on: 2016-10-19 (revision: 49553)

Table of Contents     [+/-]

Preface and Legal Notices
1 MySQL Cluster APIs: Overview and Concepts     [+/-]
2 The NDB API     [+/-]
3 The MGM API     [+/-]
4 MySQL Cluster Connector for Java     [+/-]
5 MySQL NoSQL Connector for JavaScript     [+/-]
6 ndbmemcache—Memcache API for MySQL Cluster     [+/-]
7 MySQL Cluster API Errors     [+/-]
8 MySQL Cluster Internals     [+/-]