In addition to the central configuration file, a cluster may also be controlled through a command-line interface available through the management client ndb_mgm. This is the primary administrative interface to a running cluster.
Commands for the event logs are given in Section 17.5.6, “Event Reports Generated in MySQL Cluster”; commands for creating backups and restoring from them are provided in Section 17.5.3, “Online Backup of MySQL Cluster”.
Using ndb_mgm with MySQL Cluster Manager.
MySQL Cluster Manager handles starting and stopping processes and tracks their
states internally, so it is not necessary to use
ndb_mgm for these tasks for a MySQL Cluster
that is under MySQL Cluster Manager control. it is recommended
not to use the ndb_mgm
command-line client that comes with the MySQL Cluster
distribution to perform operations that involve starting or
stopping nodes. These include but are not limited to the
commands. For more information, see
MySQL Cluster Manager Process Commands.
The management client has the following basic commands. In the
listing that follows,
either a database node ID or the keyword
which indicates that the command should be applied to all of the
cluster's data nodes.
Displays information on all available commands.
Displays information on the cluster's status. Possible
node status values include
Beginning with MySQL Cluster NDB 6.2.8 and MySQL Cluster NDB
6.3.6, the output from this command indicates when the cluster
is in single user mode (status
Prior to MySQL Cluster NDB 7.0.26 and MySQL Cluster NDB 7.1.5,
in a cluster having multiple management nodes, this command
displayed information only for data nodes that were actually
connected to the current management server; in addition,
management servers could not find each other until all nodes
had been started. Beginning with these versions, such issues
are fixed (see Bug #12352191), and management nodes can be
additionally be reported with status
Brings online the data node identified by
node_id (or all data nodes).
ALL START works on all data nodes only, and
does not affect management nodes.
Stops the data or management node identified by
node_id. Note that
STOP works to stop all data nodes only, and does not
affect management nodes.
-a option causes the node to be stopped
immediately, without waiting for the completion of any pending
STOP fails if the result would
cause an incomplete cluster. The
added in MySQL Cluster NDB 7.0.19 and MySQL Cluster NDB 7.1.8,
forces the node to shut down without checking for this. If
this option is used and the result is an incomplete cluster,
the cluster immediately shuts down.
Use of the
-a option also disables the
safety check otherwise performed when
STOP is invoked to insure that stopping
the node does not cause an incomplete cluster. In other
words, you should exercise extreme care when using the
-a option with the
command, due to the fact that this option makes it possible
for the cluster to undergo a forced shutdown because it no
longer has a complete copy of all data stored in
Restarts the data node identified by
node_id (or all data nodes).
-i option with
RESTART causes the data node to perform an
initial restart; that is, the node's file system is deleted
and recreated. The effect is the same as that obtained from
stopping the data node process and then starting it again
--initial from the
system shell. Note that backup files and Disk Data files are
not removed when this option is used.
-n option causes the data node
process to be restarted, but the data node is not actually
brought online until the appropriate
command is issued. The effect of this option is the same as
that obtained from stopping the data node and then starting it
again using ndbd
-n from the system
-a causes all current transactions
relying on this node to be aborted. No GCP check is done when
the node rejoins the cluster.
RESTART fails if taking the node
offline would result in an incomplete cluster. The
-f option, added in MySQL Cluster NDB 7.0.19
and MySQL Cluster NDB 7.1.8, forces the node to restart
without checking for this. If this option is used and the
result is an incomplete cluster, the entire cluster is
Displays status information for the data node identified by
node_id (or for all data nodes).
Beginning with MySQL Cluster NDB 6.2.8 and MySQL Cluster NDB 6.3.6, the output from this command indicates when the cluster is in single user mode.
Displays a report of type
report-type for the data node
node_id, or for all
data nodes using
Currently, there are two accepted values for
BackupStatus provides a status report
on a cluster backup in progress
MemoryUsage displays how much data
memory and index memory is being used by each data node as
shown in this example:
ALL REPORT MEMORYNode 1: Data usage is 5%(177 32K pages of total 3200) Node 1: Index usage is 0%(108 8K pages of total 12832) Node 2: Data usage is 5%(177 32K pages of total 3200) Node 2: Index usage is 0%(108 8K pages of total 12832)
In MySQL Cluster NDB 7.1.1 and later, this information is
also available from the
report-type is case-insensitive and
MEMORY (as shown in the prior
memory, or even simply
mem). You can
BackupStatus in a similar
Prior to MySQL Cluster NDB 7.0.37 and MySQL Cluster NDB
ALL REPORT BackupStatus did not
work correctly with multi-threaded data nodes. (Bug #15908907)
REPORT command was introduced in MySQL
Cluster NDB 6.2.3 and MySQL Cluster NDB 6.3.0.
Enters single user mode, whereby only the MySQL server
identified by the node ID
is permitted to access the database.
Currently, it is not possible for data nodes to join a MySQL Cluster while it is running in single user mode. (Bug #20395)
Exits single user mode, enabling all SQL nodes (that is, all running mysqld processes) to access the database.
It is possible to use
EXIT SINGLE USER
MODE even when not in single user mode, although
the command has no effect in this case.
Terminates the management client.
This command does not affect any nodes connected to the cluster.
Shuts down all cluster data nodes and management nodes. To
exit the management client after this has been done, use
This command does not shut down any SQL nodes or API nodes that are connected to the cluster.
Creates a new MySQL Cluster node group and causes data nodes to join it.
This command is used after adding new data nodes online to a MySQL Cluster, and causes them to join a new node group and thus to begin participating fully in the cluster. The command takes as its sole parameter a comma-separated list of node IDs—these are the IDs of the nodes just added and started that are to join the new node group. The number of nodes must be the same as the number of nodes in each node group that is already part of the cluster (each MySQL Cluster node group must have the same number of nodes). In other words, if the MySQL Cluster has 2 node groups of 2 data nodes each, then the new node group must also have 2 data nodes.
The node group ID of the new node group created by this command is determined automatically, and always the next highest unused node group ID in the cluster; it is not possible to set it manually.
This command was introduced in MySQL Cluster NDB 6.4.0. For more information, see Section 17.5.13, “Adding MySQL Cluster Data Nodes Online”.
Drops the MySQL Cluster node group with the given
This command can be used to drop a node group from a MySQL
DROP NODEGROUP takes as its sole
argument the node group ID of the node group to be dropped.
DROP NODEGROUP acts only to remove the data
nodes in the effected node group from that node group. It does
not stop data nodes, assign them to a different node group, or
remove them from the cluster's configuration. A data node
that does not belong to a node group is indicated in the
output of the management client
SHOW command with
no nodegroup in place of the node group ID,
like this (indicated using bold text):
id=3 @10.100.2.67 (5.1.73-ndb-7.1.33, no nodegroup)
Prior to MySQL Cluster NDB 7.0.4, the
SHOW output was not
updated correctly following
DROP NODEGROUP works only when all data
nodes in the node group to be dropped are completely empty of
any table data and table definitions. Since there is currently
no way using ndb_mgm or the
mysql client to remove all data from a
specific data node or node group, this means that the command
succeeds only in the two following cases:
TRUNCATE TABLE does not
work for this purpose because this removes only the table
data; the data nodes continue to store an
definition until a
TABLE statement is issued that causes the table
metadata to be dropped.
DROP NODEGROUP was introduced in MySQL
Cluster NDB 6.4.0. For more information, see
Section 17.5.13, “Adding MySQL Cluster Data Nodes Online”.