In the following section, we answer questions that are frequently
asked about MySQL Cluster and the
- A.10.1. Which versions of the MySQL software support Cluster? Do I have to compile from source?
- A.10.2. What do “NDB” and “NDBCLUSTER” mean?
- A.10.3. Do I need any special networking to run MySQL Cluster? How do computers in a cluster communicate?
- A.10.4. How many computers do I need to run a MySQL Cluster, and why?
- A.10.5. What do the different computers do in a MySQL Cluster?
- A.10.6. When I run the SHOW command in the MySQL Cluster management client, I see a line of output that looks like this:
- A.10.7. With which operating systems can I use MySQL Cluster?
- A.10.8. What are the hardware requirements for running MySQL Cluster?
- A.10.9. How much RAM do I need to use MySQL Cluster? Is it possible to use disk memory at all?
- A.10.10. What file systems can I use with MySQL Cluster? What about network file systems or network shares?
- A.10.11. Can I run MySQL Cluster nodes inside virtual machines (such as those created by VMWare, Parallels, or Xen)?
- A.10.12. I am trying to populate a MySQL Cluster database. The loading process terminates prematurely and I get an error message like this one:
- A.10.13. MySQL Cluster uses TCP/IP. Does this mean that I can run it over the Internet, with one or more nodes in remote locations?
- A.10.14. Do I have to learn a new programming or query language to use MySQL Cluster?
- A.10.15. What programming languages and APIs are supported by MySQL Cluster?
- A.10.16. Does MySQL Cluster include any management tools?
- A.10.17. How do I find out what an error or warning message means when using MySQL Cluster?
- A.10.18. Is MySQL Cluster transaction-safe? What isolation levels are supported?
- A.10.19. What storage engines are supported by MySQL Cluster?
- A.10.20. In the event of a catastrophic failure— for example, the whole city loses power and my UPS fails—would I lose all my data?
- A.10.21. Is it possible to use FULLTEXT indexes with MySQL Cluster?
- A.10.22. Can I run multiple nodes on a single computer?
- A.10.23. Can I add data nodes to a MySQL Cluster without restarting it?
- A.10.24. Are there any limitations that I should be aware of when using MySQL Cluster?
- A.10.25. Does MySQL Cluster support foreign keys?
- A.10.26. How do I import an existing MySQL database into a MySQL Cluster?
- A.10.27. How do MySQL Cluster nodes communicate with one another?
- A.10.28. What is an arbitrator?
- A.10.29. What data types are supported by MySQL Cluster?
- A.10.30. How do I start and stop MySQL Cluster?
- A.10.31. What happens to MySQL Cluster data when the MySQL Cluster is shut down?
- A.10.32. Is it a good idea to have more than one management node for a MySQL Cluster?
- A.10.33. Can I mix different kinds of hardware and operating systems in one MySQL Cluster?
- A.10.34. Can I run two data nodes on a single host? Two SQL nodes?
- A.10.35. Can I use host names with MySQL Cluster?
- A.10.36. Does MySQL Cluster support IPv6?
- A.10.37. How do I handle MySQL users in a MySQL Cluster having multiple MySQL servers?
- A.10.38. How do I continue to send queries in the event that one of the SQL nodes fails?
- A.10.39. How do I back up and restore a MySQL Cluster?
- A.10.40. What is an “angel process”?
Which versions of the MySQL software support Cluster? Do I have to compile from source?
MySQL Cluster is not supported in standard MySQL Server 5.7 releases. Instead, MySQL Cluster is provided as a separate product. Currently, the following MySQL Cluster release series are available for production use:
You should use MySQL Cluster NDB 7.3 or MySQL Cluster NDB 7.4 for any new deployments; if you are using an older version of MySQL Cluster, you should upgrade to one of these soon as possible. For an overview of improvements made in MySQL Cluster NDB 7.4, see What is New in MySQL Cluster NDB 7.4; for information about improvements made in MySQL Cluster NDB 7.3, see What is New in MySQL Cluster NDB 7.3.
What do “NDB” and “NDBCLUSTER” mean?
“NDB” stands for
Do I need any special networking to run MySQL Cluster? How do computers in a cluster communicate?
MySQL Cluster is intended to be used in a high-bandwidth environment, with computers connecting using TCP/IP. Its performance depends directly upon the connection speed between the cluster's computers. The minimum connectivity requirements for MySQL Cluster include a typical 100-megabit Ethernet network or the equivalent. We recommend you use gigabit Ethernet whenever available.
How many computers do I need to run a MySQL Cluster, and why?
A minimum of three computers is required to run a viable cluster. However, the minimum recommended number of computers in a MySQL Cluster is four: one each to run the management and SQL nodes, and two computers to serve as data nodes. The purpose of the two data nodes is to provide redundancy; the management node must run on a separate machine to guarantee continued arbitration services in the event that one of the data nodes fails.
To provide increased throughput and high availability, you should use multiple SQL nodes (MySQL Servers connected to the cluster). It is also possible (although not strictly necessary) to run multiple management servers.
What do the different computers do in a MySQL Cluster?
A MySQL Cluster has both a physical and logical organization, with computers being the physical elements. The logical or functional elements of a cluster are referred to as nodes, and a computer housing a cluster node is sometimes referred to as a cluster host. There are three types of nodes, each corresponding to a specific role within the cluster. These are:
When I run the
id=2 @10.100.10.32 (Version: 5.6.34-ndb-7.3.15 Nodegroup: 0, *)
What does the
The simplest answer is, “It's not something you can control, and it's nothing that you need to worry about in any case, unless you're a software engineer writing or analyzing the MySQL Cluster source code”.
If you don't find that answer satisfactory, here's a longer and more technical version:
A number of mechanisms in MySQL Cluster require distributed coordination among the data nodes. These distributed algorithms and protocols include global checkpointing, DDL (schema) changes, and node restart handling. To make this coordination simpler, the data nodes “elect” one of their number to act as leader. (This node was once referred to as a “master”, but this terminology was dropped to avoid confusion with master server in MySQL Replication.) There is no user-facing mechanism for influencing this selection, which is completely automatic; the fact that it is automatic is a key part of MySQL Cluster's internal architecture.
When a node acts as the “leader” for any of these mechanisms, it is usually the point of coordination for the activity, and the other nodes act as “followers”, carrying out their parts of the activity as directed by the leader. If the node acting as leader fails, then the remaining nodes elect a new leader. Tasks in progress that were being coordinated by the old leader may either fail or be continued by the new leader, depending on the actual mechanism involved.
It is possible for some of these different mechanisms and
protocols to have different leader nodes, but in general the
same leader is chosen for all of them. The node indicated as the
leader in the output of
MySQL Cluster is designed in such a way that the choice of leader has no discernible effect outside the cluster itself. For example, the current leader does not have significantly higher CPU or resource usage than the other data nodes, and failure of the leader should not have a significantly different impact on the cluster than the failure of any other data node.
With which operating systems can I use MySQL Cluster?
MySQL Cluster is supported on most Unix-like operating systems. MySQL Cluster is also supported in production settings on Microsoft Windows operating systems.
For more detailed information concerning the level of support which is offered for MySQL Cluster on various operating system versions, operating system distributions, and hardware platforms, please refer to http://www.mysql.com/support/supportedplatforms/cluster.html.
What are the hardware requirements for running MySQL Cluster?
MySQL Cluster should run on any platform for which
How much RAM do I need to use MySQL Cluster? Is it possible to use disk memory at all?
Formerly MySQL Cluster was in-memory only. MySQL 5.1 and later also provide the ability to store MySQL Cluster on disk. (Note that we have no plans to backport this capability to previous releases.) See Section 19.5.13, “MySQL Cluster Disk Data Tables”, for more information.
(SizeofDatabase × NumberOfReplicas × 1.1 ) / NumberOfDataNodes
To calculate the memory requirements more exactly requires determining, for each table in the cluster database, the storage space required per row (see Section 12.8, “Data Type Storage Requirements”, for details), and multiplying this by the number of rows. You must also remember to account for any column indexes as follows:
Creating MySQL Cluster tables with
When calculating Cluster memory requirements, you may find
useful the ndb_size.pl utility which is
available in recent MySQL 5.7 releases. This Perl
script connects to a current (non-Cluster) MySQL database and
creates a report on how much space that database would require
if it used the
It is especially important to keep in mind that every
MySQL Cluster table must have a primary key. The
You can determine how much memory is being used for storage of
MySQL Cluster data and indexes at any given time using the
What file systems can I use with MySQL Cluster? What about network file systems or network shares?
Generally, any file system that is native to the host operating system should work well with MySQL Cluster. If you find that a given file system works particularly well (or not so especially well) with MySQL Cluster, we invite you to discuss your findings in the MySQL Cluster Forums.
For Windows, we recommend that you use
MySQL Cluster is implemented as a shared-nothing solution; the idea behind this is that the failure of a single piece of hardware should not cause the failure of multiple cluster nodes, or possibly even the failure of the cluster as a whole. For this reason, the use of network shares or network file systems is not supported for MySQL Cluster. This also applies to shared storage devices such as SANs.
Can I run MySQL Cluster nodes inside virtual machines (such as those created by VMWare, Parallels, or Xen)?
MySQL Cluster is supported for use in virtual machines beginning with MySQL Cluster NDB 7.2. We currently support and test using Oracle VM.
Some MySQL Cluster users have successfully deployed MySQL Cluster using other virtualization products; in such cases, Oracle can provide MySQL Cluster support, but issues specific to the virtual environment must be referred to that product's vendor.
I am trying to populate a MySQL Cluster database. The loading process terminates prematurely and I get an error message like this one:
Why is this happening?
The cause is very likely to be that your setup does not provide
sufficient RAM for all table data and all indexes,
including the primary key required by the
It is also worth noting that all data nodes should have the same amount of RAM, since no data node in a cluster can use more memory than the least amount available to any individual data node. For example, if there are four computers hosting Cluster data nodes, and three of these have 3GB of RAM available to store Cluster data while the remaining data node has only 1GB RAM, then each data node can devote at most 1GB to MySQL Cluster data and indexes.
In some cases it is possible to get Table is
full errors in MySQL client applications even when
ndb_mgm -e "ALL REPORT MEMORYUSAGE" shows
For similar reasons, you can also sometimes encounter problems
with data node restarts on nodes that are heavily loaded with
data. In MySQL Cluster NDB 7.1 and later, the addition of the
MySQL Cluster uses TCP/IP. Does this mean that I can run it over the Internet, with one or more nodes in remote locations?
It is very unlikely that a cluster would perform reliably under such conditions, as MySQL Cluster was designed and implemented with the assumption that it would be run under conditions guaranteeing dedicated high-speed connectivity such as that found in a LAN setting using 100 Mbps or gigabit Ethernet—preferably the latter. We neither test nor warrant its performance using anything slower than this.
Also, it is extremely important to keep in mind that communications between the nodes in a MySQL Cluster are not secure; they are neither encrypted nor safeguarded by any other protective mechanism. The most secure configuration for a cluster is in a private network behind a firewall, with no direct access to any Cluster data or management nodes from outside. (For SQL nodes, you should take the same precautions as you would with any other instance of the MySQL server.) For more information, see Section 19.5.12, “MySQL Cluster Security Issues”.
Do I have to learn a new programming or query language to use MySQL Cluster?
No. Although some specialized commands are used to manage and configure the cluster itself, only standard (My)SQL statements are required for the following operations:
Some specialized configuration parameters and files are required to set up a MySQL Cluster—see Section 19.3.3, “MySQL Cluster Configuration Files”, for information about these.
A few simple commands are used in the MySQL Cluster management client (ndb_mgm) for tasks such as starting and stopping cluster nodes. See Section 19.5.2, “Commands in the MySQL Cluster Management Client”.
What programming languages and APIs are supported by MySQL Cluster?
MySQL Cluster supports the same programming APIs and languages as the standard MySQL Server, including ODBC, .Net, the MySQL C API, and numerous drivers for popular scripting languages such as PHP, Perl, and Python. MySQL Cluster applications written using these APIs behave similarly to other MySQL applications; they transmit SQL statements to a MySQL Server (in the case of MySQL Cluster, an SQL node), and receive responses containing rows of data. For more information about these APIs, see Chapter 25, Connectors and APIs.
MySQL Cluster also supports application programming using the
NDB API, which provides a low-level C++ interface to MySQL
Cluster data without needing to go through a MySQL Server. See
The NDB API. In addition, many
MySQL Cluster (NDB 7.1 and later) also supports Java application programming using ClusterJ, which supports a domain object model of data using sessions and transactions. See Java and MySQL Cluster, for more information.
MySQL Cluster (NDB 7.2 and later) also supports
MySQL Cluster NDB 7.3 adds adapters supporting NoSQL
applications written against
Does MySQL Cluster include any management tools?
MySQL Cluster includes a command line client for performing basic management functions. See Section 19.4.5, “ndb_mgm — The MySQL Cluster Management Client”, and Section 19.5.2, “Commands in the MySQL Cluster Management Client”.
MySQL Cluster NDB 7.0 and later is also supported by MySQL Cluster Manager, a separate product providing an advanced command line interface that can automate many MySQL Cluster management tasks such as rolling restarts and configuration changes. For more information about MySQL Cluster Manager, see MySQL™ Cluster Manager 1.4.0 User Manual.
MySQL Cluster NDB 7.3 introduces a graphical, browser-based Auto-Installer for setting up and deploying MySQL Cluster, as part of the MySQL Cluster software distribution. For more information, see Section 19.2.1, “The MySQL Cluster Auto-Installer”.
How do I find out what an error or warning message means when using MySQL Cluster?
There are two ways in which this can be done:
Is MySQL Cluster transaction-safe? What isolation levels are supported?
What storage engines are supported by MySQL Cluster?
Clustering with MySQL is supported only by the
It is possible to create tables using other storage engines
In the event of a catastrophic failure— for example, the whole city loses power and my UPS fails—would I lose all my data?
All committed transactions are logged. Therefore, although it is possible that some data could be lost in the event of a catastrophe, this should be quite limited. Data loss can be further reduced by minimizing the number of operations per transaction. (It is not a good idea to perform large numbers of operations per transaction in any case.)
Is it possible to use
Can I run multiple nodes on a single computer?
It is possible but not always advisable. One of the chief reasons to run a cluster is to provide redundancy. To obtain the full benefits of this redundancy, each node should reside on a separate machine. If you place multiple nodes on a single machine and that machine fails, you lose all of those nodes. For this reason, if you do run multiple data nodes on a single machine, it is extremely important that they be set up in such a way that the failure of this machine does not cause the loss of all the data nodes in a given node group.
Given that MySQL Cluster can be run on commodity hardware loaded with a low-cost (or even no-cost) operating system, the expense of an extra machine or two is well worth it to safeguard mission-critical data. It also worth noting that the requirements for a cluster host running a management node are minimal. This task can be accomplished with a 300 MHz Pentium or equivalent CPU and sufficient RAM for the operating system, plus a small amount of overhead for the ndb_mgmd and ndb_mgm processes.
It is acceptable to run multiple cluster data nodes on a single host that has multiple CPUs, cores, or both. MySQL Cluster NDB 7.0 and later also provide a multi-threaded version of the data node binary intended for use on such systems. For more information, see Section 19.4.3, “ndbmtd — The MySQL Cluster Data Node Daemon (Multi-Threaded)”.
It is also possible in some cases to run data nodes and SQL nodes concurrently on the same machine; how well such an arrangement performs is dependent on a number of factors such as number of cores and CPUs as well as the amount of disk and memory available to the data node and SQL node processes, and you must take these factors into account when planning such a configuration.
Can I add data nodes to a MySQL Cluster without restarting it?
It is possible to add new data nodes to a running MySQL Cluster without taking the cluster offline. For more information, see Section 19.5.14, “Adding MySQL Cluster Data Nodes Online”.
For other types of MySQL Cluster nodes, a rolling restart is all that is required (see Section 19.5.5, “Performing a Rolling Restart of a MySQL Cluster”).
Are there any limitations that I should be aware of when using MySQL Cluster?
For a complete listing of limitations in MySQL Cluster, see Section 19.1.6, “Known Limitations of MySQL Cluster”. See also Previous MySQL Cluster Issues Resolved in MySQL Cluster NDB 7.3.
Does MySQL Cluster support foreign keys?
MySQL Cluster NDB 7.3 and later provide support for foreign key
constraints, comparable to that found in the
How do I import an existing MySQL database into a MySQL Cluster?
You can import databases into MySQL Cluster much as you would
with any other version of MySQL. Other than the limitations
mentioned elsewhere in this FAQ, the only other special
requirement is that any tables to be included in the cluster
must use the
It is also possible to convert existing tables that use other
storage engines to
How do MySQL Cluster nodes communicate with one another?
Cluster nodes can communicate through any of three different transport mechanisms: TCP/IP, SHM (shared memory), and SCI (Scalable Coherent Interface). Where available, SHM is used by default between nodes residing on the same cluster host; however, this is considered experimental. SCI is a high-speed (1 gigabit per second and higher), high-availability protocol used in building scalable multi-processor systems; it requires special hardware and drivers. See Section 19.3.4, “Using High-Speed Interconnects with MySQL Cluster”, for more about using SCI as a transport mechanism for MySQL Cluster.
What is an arbitrator?
If one or more data nodes in a cluster fail, it is possible that not all cluster data nodes will be able to “see” one another. In fact, it is possible that two sets of data nodes might become isolated from one another in a network partitioning, also known as a “split-brain” scenario. This type of situation is undesirable because each set of data nodes tries to behave as though it is the entire cluster. An arbitrator is required to decide between the competing sets of data nodes.
When all data nodes in at least one node group are alive,
network partitioning is not an issue, because no single subset
of the cluster can form a functional cluster on its own. The
real problem arises when no single node group has all its nodes
alive, in which case network partitioning (the
“split-brain” scenario) becomes possible. Then an
arbitrator is required. All cluster nodes recognize the same
node as the arbitrator, which is normally the management server;
however, it is possible to configure any of the MySQL Servers in
the cluster to act as the arbitrator instead. The arbitrator
accepts the first set of cluster nodes to contact it, and tells
the remaining set to shut down. Arbitrator selection is
controlled by the
The role of arbitrator does not in and of itself impose any heavy demands upon the host so designated, and thus the arbitrator host does not need to be particularly fast or to have extra memory especially for this purpose.
What data types are supported by MySQL Cluster?
MySQL Cluster supports all of the usual MySQL data types,
including those associated with MySQL's spatial extensions;
MySQL Cluster Disk Data tables (that is, tables created with
See Section 19.1.6, “Known Limitations of MySQL Cluster”, for more information about these issues.
How do I start and stop MySQL Cluster?
It is necessary to start each node in the cluster separately, in the following order:
Each of these commands must be run from a system shell on the
machine housing the affected node. (You do not have to be
physically present at the machine—a remote login shell can
be used for this purpose.) You can verify that the cluster is
running by starting the
To shut down a running cluster, issue the command
(The quotation marks in this example are optional, since there
are no spaces in the command string following the
For more information, see Section 19.5.2, “Commands in the MySQL Cluster Management Client”, and Section 19.2.7, “Safe Shutdown and Restart of MySQL Cluster”.
What happens to MySQL Cluster data when the MySQL Cluster is shut down?
The data that was held in memory by the cluster's data nodes is written to disk, and is reloaded into memory the next time that the cluster is started.
Is it a good idea to have more than one management node for a MySQL Cluster?
It can be helpful as a fail-safe. Only one management node controls the cluster at any given time, but it is possible to configure one management node as primary, and one or more additional management nodes to take over in the event that the primary management node fails.
See Section 19.3.3, “MySQL Cluster Configuration Files”, for information on how to configure MySQL Cluster management nodes.
Can I mix different kinds of hardware and operating systems in one MySQL Cluster?
Yes, as long as all machines and operating systems have the same “endianness” (all big-endian or all little-endian).
It is also possible to use software from different MySQL Cluster releases on different nodes. However, we support this only as part of a rolling upgrade procedure (see Section 19.5.5, “Performing a Rolling Restart of a MySQL Cluster”).
Can I run two data nodes on a single host? Two SQL nodes?
Yes, it is possible to do this. In the case of multiple data nodes, it is advisable (but not required) for each node to use a different data directory. If you want to run multiple SQL nodes on one machine, each instance of mysqld must use a different TCP/IP port.
Can I use host names with MySQL Cluster?
Yes, it is possible to use DNS and DHCP for cluster hosts. However, if your application requires “five nines” availability, you should use fixed (numeric) IP addresses, since making communication between Cluster hosts dependent on services such as DNS and DHCP introduces additional potential points of failure.
Does MySQL Cluster support IPv6?
IPv6 is supported for connections between SQL nodes (MySQL servers), but connections between all other types of MySQL Cluster nodes must use IPv4.
In practical terms, this means that you can use IPv6 for replication between MySQL Clusters, but connections between nodes in the same MySQL Cluster must use IPv4. For more information, see Section 19.6.3, “Known Issues in MySQL Cluster Replication”.
How do I handle MySQL users in a MySQL Cluster having multiple MySQL servers?
MySQL user accounts and privileges are normally not automatically propagated between different MySQL servers accessing the same MySQL Cluster. MySQL Cluster NDB 7.2 and later provides support for distributed privileges. While privilege distribution is not enabled automatically, you can activate it by following a procedure provided in the MySQL Cluster documentation. See Section 19.5.15, “Distributed MySQL Privileges for MySQL Cluster”, for more information.
How do I continue to send queries in the event that one of the SQL nodes fails?
MySQL Cluster does not provide any sort of automatic failover between SQL nodes. Your application must be prepared to handle the loss of SQL nodes and to fail over between them.
How do I back up and restore a MySQL Cluster?
You can use the NDB native backup and restore functionality in the MySQL Cluster management client and the ndb_restore program. See Section 19.5.3, “Online Backup of MySQL Cluster”, and Section 19.4.20, “ndb_restore — Restore a MySQL Cluster Backup”.
You can also use the traditional functionality provided for this purpose in mysqldump and the MySQL server. See Section 5.5.4, “mysqldump — A Database Backup Program”, for more information.
What is an “angel process”?
This process monitors and, if necessary, attempts to restart the data node process. If you check the list of active processes on your system after starting ndbd, you can see that there are actually 2 processes running by that name, as shown here (we omit the output from ndb_mgmd and ndbd for brevity):
The ndbd process showing 0 memory and CPU
usage is the angel process. It actually does use a very small
amount of each, of course. It simply checks to see if the main
ndbd process (the primary data node process
that actually handles the data) is running. If permitted to do
so (for example, if the