Documentation Home
MySQL 8.1 Reference Manual
Related Documentation Download this Manual
PDF (US Ltr) - 40.1Mb
PDF (A4) - 40.2Mb
Man Pages (TGZ) - 264.0Kb
Man Pages (Zip) - 373.1Kb
Info (Gzip) - 4.0Mb
Info (Zip) - 4.0Mb
Excerpts from this Manual

MySQL 8.1 Reference Manual  /  MySQL NDB Cluster 8.1  /  General Information

23.1 General Information

MySQL NDB Cluster uses the MySQL server with the NDB storage engine. Support for the NDB storage engine is not included in standard MySQL Server 8.1 binaries built by Oracle. Instead, users of NDB Cluster binaries from Oracle should upgrade to the most recent binary release of NDB Cluster for supported platforms—these include RPMs that should work with most Linux distributions. NDB Cluster 8.1 users who build from source should use the sources provided for MySQL 8.1 and build with the options required to provide NDB support. (Locations where the sources can be obtained are listed later in this section.)


MySQL NDB Cluster does not support InnoDB Cluster, which must be deployed using MySQL Server InnoDB storage engine as well as additional applications that are not included in the NDB Cluster distribution. MySQL Server 8.1 binaries cannot be used with MySQL NDB Cluster. For more information about deploying and using InnoDB Cluster, see MySQL AdminAPI. Section 23.2.6, “MySQL Server Using InnoDB Compared with NDB Cluster”, discusses differences between the NDB and InnoDB storage engines.

Supported Platforms.  NDB Cluster is currently available and supported on a number of platforms. For exact levels of support available for on specific combinations of operating system versions, operating system distributions, and hardware platforms, please refer to

Availability.  NDB Cluster binary and source packages are available for supported platforms from

NDB Cluster release numbers.  NDB 8.1 is an Innovation Release. In this Manual and other MySQL documentation, we sometimes identify this release employing the version number 8.1.0. This version number is that of the NDBCLUSTER storage engine used in the NDB 8.1 release, and is the same as that of the MySQL 8.1 server version on which the NDB Cluster 8.1 release is based.

Version strings used in NDB Cluster software.  The version string displayed by the mysql client supplied with the MySQL NDB Cluster distribution uses this format:


mysql_server_version represents the version of the MySQL Server on which the NDB Cluster release is based. For all NDB Cluster 8.1 releases, this is 8.1.0 Building from source using -DWITH_NDB or the equivalent adds the -cluster suffix to the version string. (See Section, “Building NDB Cluster from Source on Linux”, and Section, “Compiling and Installing NDB Cluster from Source on Windows”.) You can see this format used in the mysql client, as shown here:

$> mysql
Welcome to the MySQL monitor.  Commands end with ; or \g.
Your MySQL connection id is 2
Server version: 8.1.0-cluster Source distribution

Type 'help;' or '\h' for help. Type '\c' to clear the buffer.

*************************** 1. row ***************************
VERSION(): 8.1.0-cluster
1 row in set (0.00 sec)

The version string displayed by other NDB Cluster programs not normally included with the MySQL 8.1 distribution uses this format:

mysql-mysql_server_version ndb-ndb_engine_version

mysql_server_version represents the version of the MySQL Server on which the NDB Cluster release is based. For the NDB Cluster 8.1 release, this is 8.1.0, where n is the release number. ndb_engine_version is the version of the NDB storage engine used by this release of the NDB Cluster software. For NDB 8.1, this number is the same as the MySQL Server version. You can see this format used in the output of the SHOW command in the ndb_mgm client, like this:

ndb_mgm> SHOW
Connected to Management Server at: localhost:1186
Cluster Configuration
[ndbd(NDB)]     2 node(s)
id=1    @  (mysql-8.1.0 ndb-8.1.0, Nodegroup: 0, *)
id=2    @  (mysql-8.1.0 ndb-8.1.0, Nodegroup: 0)

[ndb_mgmd(MGM)] 1 node(s)
id=3    @  (mysql-8.1.0 ndb-8.1.0)

[mysqld(API)]   2 node(s)
id=4    @  (mysql-8.1.0 ndb-8.1.0)
id=5 (not connected, accepting connect from any host)

Compatibility with standard MySQL 8.1 releases.  While many standard MySQL schemas and applications can work using NDB Cluster, it is also true that unmodified applications and database schemas may be slightly incompatible or have suboptimal performance when run using NDB Cluster (see Section 23.2.7, “Known Limitations of NDB Cluster”). Most of these issues can be overcome, but this also means that you are very unlikely to be able to switch an existing application datastore—that currently uses, for example, MyISAM or InnoDB—to use the NDB storage engine without allowing for the possibility of changes in schemas, queries, and applications. A mysqld compiled without NDB support (that is, built without -DWITH_NDB or -DWITH_NDBCLUSTER_STORAGE_ENGINE) cannot function as a drop-in replacement for a mysqld that is built with it.

NDB Cluster development source trees.  NDB Cluster development trees can also be accessed from

The NDB Cluster development sources maintained at are licensed under the GPL. For information about obtaining MySQL sources using Git and building them yourself, see Section 2.8.5, “Installing MySQL Using a Development Source Tree”.


As with MySQL Server 8.1, NDB Cluster 8.1 releases are built using CMake.

NDB Cluster 8.1 is available as an Innovation release, with new features under development and intended for preview and testing. NDB Cluster 8.0 is the current GA release series, and is recommended for new deployments (see MySQL NDB Cluster 8.0). NDB Cluster 7.6 and 7.5 are previous GA releases still supported in production; for information about NDB Cluster 7.6, see What is New in NDB Cluster 7.6. For similar information about NDB Cluster 7.5, see What is New in NDB Cluster 7.5. NDB Cluster 7.4 and 7.3 are previous GA releases which are no longer maintained or supported. We recommend MySQL NDB Cluster 8.0 for any new deployments intended to be used in production.

The contents of this chapter are subject to revision as NDB Cluster continues to evolve. Additional information regarding NDB Cluster can be found on the MySQL website at

Additional Resources.  More information about NDB Cluster can be found in the following places: