







|
Chapter 17. MySQL Cluster NDB 6.X/7.X
This chapter contains information about MySQL
Cluster, which is a high-availability, high-redundancy
version of MySQL adapted for the distributed computing environment.
Current releases of MySQL Cluster use versions 6 and 7 of the
NDBCLUSTER storage engine (also known
as NDB) to enable running several
computers with MySQL servers and other software in a cluster.
Beginning with MySQL 5.1.24, support for the
NDBCLUSTER storage engine was removed
from the standard MySQL server binaries built by MySQL. Instead,
users of MySQL Cluster binaries built by MySQL should upgrade to the
most recent binary release of MySQL Cluster NDB 6.3 or MySQL Cluster
7.0 for supported platforms — these include RPMs that should
work with most Linux distributions. MySQL Cluster users who build
from source should be aware that, also beginning with MySQL 5.1.24,
NDBCLUSTER sources in the standard
MySQL 5.1 tree are no longer maintained; these users should use the
sources provided for MySQL Cluster NDB 6.2 or later. (Locations
where the sources can be obtained are listed later in this section.)
Note
MySQL Cluster NDB 6.1, 6.2, and 6.3 were formerly known as
“MySQL Cluster Carrier Grade Edition”. Beginning with
MySQL Cluster NDB 6.2.15 and MySQL Cluster NDB 6.3.14, this term
is no longer applied to the MySQL Cluster software — which
is now known simply as “MySQL Cluster” — but
rather to a commercial licensing and support package. You can
learn more about available options for commercial licensing of
MySQL Cluster from
MySQL
Cluster Features, on the MySQL web site.
This chapter contains information about MySQL Cluster in MySQL 5.1
mainline releases through MySQL 5.1.23, MySQL Cluster NDB 6.2
releases through 5.1.41-ndb-6.2.19, MySQL Cluster NDB 6.3
releases through 5.1.41-ndb-6.3.32, MySQL Cluster NDB 7.0
releases through 5.1.41-ndb-7.0.12 and MySQL Cluster NDB
7.1 releases through 5.1.41-ndb-7.1.2. Currently, the
MySQL Cluster NDB 6.3 and MySQL Cluster NDB 7.0 (formerly known as
“MySQL Cluster NDB 6.4”) release series are Generally
Available (GA). MySQL Cluster NDB 6.2, a previous GA release series,
is still supported, although we recommend that new deployments use
MySQL Cluster NDB 6.3 or MySQL Cluster NDB 7.0. MySQL Cluster NDB
7.1 is currently under development; we expect to make source and
binaries built from the MySQL Cluster NDB 7.1 available for
evaluation and testing purposes in the near future.
This chapter also contains historical information about MySQL
Cluster NDB 6.1, although this release series is no longer in active
development, and should not be used in new deployments. Users of
MySQL Cluster NDB 6.1 should upgrade to a later MySQL Cluster NDB
6.x or 7.x release series as soon as possible.
Platforms supported.
MySQL Cluster is currently available and supported on a number of
platforms, including Linux, Solaris, Mac OS X, and other
Unix-style operating systems on a variety of hardware. Beginning
with MySQL Cluster NDB 7.0, MySQL Cluster is also available (on an
experimental basis) on Microsoft Windows platforms. For exact
levels of support available for on specific combinations of
operating system versions, operating system distributions, and
hardware platforms, please refer to
http://www.mysql.com/support/supportedplatforms/cluster.html,
maintained by the MySQL Support Team on the MySQL web site.
We are continuing to work to make MySQL Cluster available on all
operating systems supported by MySQL; we will update the information
provided here as this work continues.
Availability.
MySQL Cluster NDB 6.2, MySQL Cluster NDB 6.3, and MySQL Cluster
NDB 7.0 binary and source packages are available for supported
platforms from http://dev.mysql.com/downloads/select.php?id=14.
Note
Binary releases and RPMs were not available for MySQL Cluster NDB
6.2 prior to MySQL Cluster NDB 6.2.15.
MySQL Cluster release numbers.
Starting with MySQL Cluster NDB 6.1 and 6.2, MySQL Cluster follows
a somewhat different release pattern from the mainline MySQL 5.1
Cluster series of releases. In this Manual and other MySQL
documentation, we identify these and later MySQL Cluster releases
employing a version number that begins with “NDB”.
This version number is that of the
NDBCLUSTER storage engine used, and
not of the MySQL server version on which the MySQL Cluster release
is based.
Version strings used in MySQL Cluster NDB 6.x and 7.x software.
The version string displayed by MySQL Cluster NDB 6.x and 7.x
software uses this format:
mysql-mysql_server_version-ndb-ndbcluster_engine_version
mysql_server_version represents the
version of the MySQL Server on which the MySQL Cluster release is
based. For all MySQL Cluster NDB 6.x and 7.x releases, this is
“5.1”.
ndbcluster_engine_version is the
version of the NDBCLUSTER storage
engine used by this release of the MySQL Cluster software. You can
see this format used in the mysql client, as
shown here:
shell> mysql
Welcome to the MySQL monitor. Commands end with ; or \g.
Your MySQL connection id is 2
Server version: 5.1.41-ndb-7.0.12 Source distribution
Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
mysql> SELECT VERSION()\G
*************************** 1. row ***************************
VERSION(): 5.1.41-ndb-7.0.12
1 row in set (0.00 sec)
This version string is also displayed in the output of the
SHOW command in the ndb_mgm
client:
ndb_mgm> SHOW
Connected to Management Server at: localhost:1186
Cluster Configuration
---------------------
[ndbd(NDB)] 2 node(s)
id=1 @10.0.10.6 (5.1.41-ndb-7.0.12, Nodegroup: 0, Master)
id=2 @10.0.10.8 (5.1.41-ndb-7.0.12, Nodegroup: 0)
[ndb_mgmd(MGM)] 1 node(s)
id=3 @10.0.10.2 (5.1.41-ndb-7.0.12)
[mysqld(API)] 2 node(s)
id=4 @10.0.10.10 (5.1.41-ndb-7.0.12)
id=5 (not connected, accepting connect from any host)
The version string identifies the mainline MySQL version from
which the MySQL Cluster release was branched and the version of
the NDBCLUSTER storage engine used.
For example, the full version string for MySQL Cluster NDB 7.0.5
(the first GA MySQL Cluster NDB 7.0 binary release) was
mysql-5.1.32-ndb-7.0.5. From this we can
determine the following:
Since the portion of the version string preceding
“-ndb-” is the base MySQL
Server version, this means that MySQL Cluster NDB 7.0.5
derives from the MySQL 5.1.32, and contains all feature
enhancements and bugfixes from MySQL 5.1 up to and including
MySQL 5.1.32.
Since the portion of the version string following
“-ndb-” represents the
version number of the NDB (or
NDBCLUSTER) storage engine,
MySQL Cluster NDB 7.0.5 uses version 7.0.5 of the
NDBCLUSTER storage engine.
New MySQL Cluster releases are numbered according to updates in the
NDB storage engine, and do not necessarily
correspond in a linear fashion with mainline MySQL Server releases.
For example, MySQL Cluster NDB 7.0.5 (as previously noted) is based
on MySQL 5.1.32, and MySQL Cluster NDB 7.0.6 is based on MySQL
5.1.34 (version string: mysql-5.1.34-ndb-7.0.6).
Compatibility with standard MySQL 5.1 releases.
While many standard MySQL schemas and applications can work using
MySQL Cluster, it is also true that unmodified applications and
database schemas may be slightly incompatible or have suboptimal
performance when run using MySQL Cluster (see
Section 17.1.5, “Known Limitations of MySQL 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. Moreover, from MySQL 5.1.24 onwards, the MySQL
Server and MySQL Cluster codebases diverge considerably (and
NDB storage engine support dropped
from subsequent MySQL Server releases), so that the standard
mysqld cannot function as a dropin replacement
for the version of mysqld that is supplied with
MySQL Cluster.
MySQL Cluster development source trees.
MySQL Cluster development trees can also be accessed via
https://code.launchpad.net/~mysql/:
The MySQL Cluster development sources maintained at
https://code.launchpad.net/~mysql/ are licensed
under the GPL. For information about obtaining MySQL sources using
Bazaar and building them yourself, see
Section 2.3.3, “Installing from the Development Source Tree”.
Currently, MySQL Cluster NDB 6.2, MySQL Cluster NDB 6.3, and MySQL
Cluster NDB 7.0 releases are all Generally Available (GA), although
we recommend that new deployments use MySQL Cluster 6.3 or MySQL
Cluster 7.0. MySQL Cluster NDB 7.1 is in early development; we
intend to make the source tree for this release series available in
the near future. MySQL Cluster NDB 6.1 is no longer in active
development. For an overview of major features added in MySQL
Cluster NDB 6.x and 7.x, see
Section 17.1.4, “MySQL Cluster Development History”.
This chapter represents a work in progress, and its contents are
subject to revision as MySQL Cluster continues to evolve. Additional
information regarding MySQL Cluster can be found on the MySQL Web
site at http://www.mysql.com/products/cluster/.
Additional Resources.
More information may be found in the following places:
17.1. MySQL Cluster Overview
MySQL Cluster is a technology that enables
clustering of in-memory databases in a shared-nothing system. The
shared-nothing architecture allows the system to work with very
inexpensive hardware, and with a minimum of specific requirements
for hardware or software.
MySQL Cluster is designed not to have any single point of failure.
In a shared-nothing system, each component is expected to have its
own memory and disk, and the use of shared storage mechanisms such
as network shares, network file systems, and SANs is not recommended
or supported.
MySQL Cluster integrates the standard MySQL server with an in-memory
clustered storage engine called NDB
(which stands for “Network
DataBase”). In our
documentation, the term NDB refers to
the part of the setup that is specific to the storage engine,
whereas “MySQL Cluster” refers to the combination of
one or more MySQL servers with the NDB
storage engine.
A MySQL Cluster consists of a set of computers, known as
hosts, each running one or more processes.
These processes, known as nodes, may include
MySQL servers (for access to NDB data), data nodes (for storage of
the data), one or more management servers, and possibly other
specialized data access programs. The relationship of these
components in a MySQL Cluster is shown here:
All these programs work together to form a MySQL Cluster (see
Section 17.4, “MySQL Cluster Programs”. When data is stored by the
NDB storage engine, the tables (and
table data) are stored in the data nodes. Such tables are directly
accessible from all other MySQL servers (SQL nodes) in the cluster.
Thus, in a payroll application storing data in a cluster, if one
application updates the salary of an employee, all other MySQL
servers that query this data can see this change immediately.
Although a MySQL Cluster SQL node uses the mysqld
server damon, it differs in a number of critical respects from the
mysqld binary supplied with the MySQL
5.1 distributions, and the two versions of
mysqld are not interchangeable.
In addition, a MySQL server that is not connected to a MySQL Cluster
cannot use the NDB storage engine and
cannot access any MySQL Cluster data.
The data stored in the data nodes for MySQL Cluster can be mirrored;
the cluster can handle failures of individual data nodes with no
other impact than that a small number of transactions are aborted
due to losing the transaction state. Because transactional
applications are expected to handle transaction failure, this should
not be a source of problems.
Individual nodes can be stopped and restarted, and can then rejoin
the system (cluster). Rolling restarts (in which all nodes are
restarted in turn) are used in making configuration changes and
software upgrades (see
Section 17.2.6.1, “Performing a Rolling Restart of a MySQL Cluster”). In MySQL Cluster
NDB 7.0 and later, rolling restarts are also used as part of the
process of adding new data nodes online (see
Section 17.5.11, “Adding MySQL Cluster Data Nodes Online”). For more
information about data nodes, how they are organized in a MySQL
Cluster, and how they handle and store MySQL Cluster data, see
Section 17.1.2, “MySQL Cluster Nodes, Node Groups, Replicas, and Partitions”.
Backing up and restoring MySQL Cluster databases can be done using
the NDB native functionality found in the MySQL Cluster management
client and the ndb_restore program included in
the MySQL Cluster distribution. For more information, see
Section 17.5.3, “Online Backup of MySQL Cluster”, and
Section 17.4.17, “ndb_restore — Restore a MySQL Cluster Backup”. You can also
use the standard MySQL functionality provided for this purpose in
mysqldump and the MySQL server. See
Section 4.5.4, “mysqldump — A Database Backup Program”, for more information.
MySQL Cluster nodes can use a number of different transport
mechanisms for inter-node communications, including TCP/IP using
standard 100 Mbps or faster Ethernet hardware. It is also possible
to use the high-speed Scalable Coherent
Interface (SCI) protocol with MySQL Cluster, although
this is not required to use MySQL Cluster. SCI requires special
hardware and software; see
Section 17.3.5, “Using High-Speed Interconnects with MySQL Cluster”, for more about SCI
and using it with MySQL Cluster.
17.1.1. MySQL Cluster Core Concepts
NDBCLUSTER
(also known as NDB) is an in-memory
storage engine offering high-availability and data-persistence
features.
The NDBCLUSTER storage engine can be
configured with a range of failover and load-balancing options,
but it is easiest to start with the storage engine at the cluster
level. MySQL Cluster's NDB storage
engine contains a complete set of data, dependent only on other
data within the cluster itself.
The “Cluster” portion of MySQL Cluster is configured
independently of the MySQL servers. In a MySQL Cluster, each part
of the cluster is considered to be a node.
Note
In many contexts, the term “node” is used to
indicate a computer, but when discussing MySQL Cluster it means
a process. It is possible to run multiple
nodes on a single computer; for a computer on which one or more
cluster nodes are being run we use the term cluster
host.
There are three types of cluster nodes, and in a minimal MySQL
Cluster configuration, there will be at least three nodes, one of
each of these types:
Management node (MGM node): The role of
this type of node is to manage the other nodes within the
MySQL Cluster, performing such functions as providing
configuration data, starting and stopping nodes, running
backup, and so forth. Because this node type manages the
configuration of the other nodes, a node of this type should
be started first, before any other node. An MGM node is
started with the command ndb_mgmd.
Data node: This type of node stores
cluster data. There are as many data nodes as there are
replicas, times the number of fragments (see
Section 17.1.2, “MySQL Cluster Nodes, Node Groups, Replicas, and Partitions”). For example,
with two replicas, each having two fragments, you need four
data nodes. One replica is sufficient for data storage, but
provides no redundancy; therefore, it is recommended to have 2
(or more) replicas to provide redundancy, and thus high
availability. A data node is started with the command
ndbd (see
Section 17.4.2, “ndbd — The MySQL Cluster Data Node Daemon”). In MySQL
Cluster NDB 7.0 and later, ndbmtd can also
be used for the data node process; see
Section 17.4.3, “ndbmtd — The MySQL Cluster Data Node Daemon (Multi-Threaded)”, for more
information.
MySQL Cluster tables in MySQL 5.1 are normally
stored completely in memory rather than on disk (this is why
we refer to MySQL cluster as an
in-memory database). In MySQL 5.1,
MySQL Cluster NDB 6.X, and later, some MySQL Cluster data can
be stored on disk; see
Section 17.5.10, “MySQL Cluster Disk Data Tables”, for more
information.
SQL node: This is a node that accesses
the cluster data. In the case of MySQL Cluster, an SQL node is
a traditional MySQL server that uses the
NDBCLUSTER storage engine. An SQL
node is a mysqld process started with the
--ndbcluster and
--ndb-connectstring options, which are
explained elsewhere in this chapter, possibly with additional
MySQL server options as well.
An SQL node is actually just a specialized type of
API node, which designates any
application which accesses Cluster data. Another example of an
API node is the ndb_restore utility that is
used to restore a cluster backup. It is possible to write such
applications using the NDB API. For basic information about
the NDB API, see Getting Started with the NDB API.
Important
It is not realistic to expect to employ a three-node setup in a
production environment. Such a configuration provides no
redundancy; in order to benefit from MySQL Cluster's
high-availability features, you must use multiple data and SQL
nodes. The use of multiple management nodes is also highly
recommended.
For a brief introduction to the relationships between nodes, node
groups, replicas, and partitions in MySQL Cluster, see
Section 17.1.2, “MySQL Cluster Nodes, Node Groups, Replicas, and Partitions”.
Configuration of a cluster involves configuring each individual
node in the cluster and setting up individual communication links
between nodes. MySQL Cluster is currently designed with the
intention that data nodes are homogeneous in terms of processor
power, memory space, and bandwidth. In addition, to provide a
single point of configuration, all configuration data for the
cluster as a whole is located in one configuration file.
The management server (MGM node) manages the cluster configuration
file and the cluster log. Each node in the cluster retrieves the
configuration data from the management server, and so requires a
way to determine where the management server resides. When
interesting events occur in the data nodes, the nodes transfer
information about these events to the management server, which
then writes the information to the cluster log.
In addition, there can be any number of cluster client processes
or applications. These are of two types:
Standard MySQL clients.
MySQL Cluster can be used with existing MySQL applications
written in PHP, Perl, C, C++, Java, Python, Ruby, and so on.
Such client applications send SQL statements to and receive
responses from MySQL servers acting as MySQL Cluster SQL
nodes in much the same way that they interact with
standalone MySQL servers.
MySQL clients using a MySQL Cluster as a data source can be
modified to take advantage of the ability to connect with
multiple MySQL servers to achieve load balancing and failover.
For example, Java clients using Connector/J 5.0.6 and later
can use jdbc:mysql:loadbalance:// URLs
(improved in Connector/J 5.1.7) to achieve load balancing
transparently. See Section 21.3, “MySQL Connector/J”, for more
information.
Management clients.
These clients connect to the management server and provide
commands for starting and stopping nodes gracefully,
starting and stopping message tracing (debug versions only),
showing node versions and status, starting and stopping
backups, and so on. Such clients — such as the
ndb_mgm management client supplied with
MySQL Cluster (see
Section 17.4.5, “ndb_mgm — The MySQL Cluster Management Client”) —
are written using the MGM API, a C-language API that
communicates directly with one or more MySQL Cluster
management servers. For more information, see
The MGM API.
Event logs.
MySQL Cluster logs events by category (startup, shutdown,
errors, checkpoints, and so on), priority, and severity. A
complete listing of all reportable events may be found in
Section 17.5.4, “Event Reports Generated in MySQL Cluster”. Event logs are of
two types:
Note
Under normal circumstances, it is necessary and sufficient to
keep and examine only the cluster log. The node logs need be
consulted only for application development and debugging
purposes.
Checkpoint.
Generally speaking, when data is saved to disk, it is said that
a checkpoint has been reached. More specific to Cluster, it is a
point in time where all committed transactions are stored on
disk. With regard to the NDB
storage engine, there are two types of checkpoints which work
together to ensure that a consistent view of the cluster's data
is maintained:
Local Checkpoint (LCP).
This is a checkpoint that is specific to a single node;
however, LCP's take place for all nodes in the cluster more
or less concurrently. An LCP involves saving all of a node's
data to disk, and so usually occurs every few minutes. The
precise interval varies, and depends upon the amount of data
stored by the node, the level of cluster activity, and other
factors.
Global Checkpoint (GCP).
A GCP occurs every few seconds, when transactions for all
nodes are synchronized and the redo-log is flushed to disk.
17.1.2. MySQL Cluster Nodes, Node Groups, Replicas, and Partitions
This section discusses the manner in which MySQL Cluster divides
and duplicates data for storage.
Central to an understanding of this topic are the following
concepts, listed here with brief definitions:
(Data) Node.
An ndbd process, which stores a
replica —that is, a copy of the
partition (see below) assigned to the
node group of which the node is a member.
Each data node should be located on a separate computer. While
it is also possible to host multiple ndbd
processes on a single computer, such a configuration is not
supported.
It is common for the terms “node” and “data
node” to be used interchangeably when referring to an
ndbd process; where mentioned, management
(MGM) nodes (ndb_mgmd processes) and SQL
nodes (mysqld processes) are specified as
such in this discussion.
Node Group.
A node group consists of one or more nodes, and stores
partitions, or sets of replicas (see
next item).
The number of node groups in a MySQL Cluster is not directly
configurable; it is function of the number of data nodes and
of the number of replicas (NumberOfReplicas
configuration parameter), as shown here:
[number_of_node_groups] = number_of_data_nodes / NumberOfReplicas
Thus, a MySQL Cluster with 4 data nodes has 4 node groups if
NumberOfReplicas is set to 1 in the
config.ini file, 2 node groups if
NumberOfReplicas is set to 2, and 1 node
group if NumberOfReplicas is set to 4.
Replicas are discussed later in this section; for more
information about NumberOfReplicas, see
Section 17.3.2.6, “Defining MySQL Cluster Data Nodes”.
Note
All node groups in a MySQL Cluster must have the same number
of data nodes.
Prior to MySQL Cluster NDB 7.0, it was not possible to add new
data nodes to a MySQL Cluster without shutting down the
cluster completely and reloading all of its data. In MySQL
Cluster NDB 7.0 (beginning with MySQL Cluster version NDB
6.4.0), you can add new node groups (and thus new data nodes)
to a running MySQL Cluster — see
Section 17.5.11, “Adding MySQL Cluster Data Nodes Online”, for
information about how this can be done.
Partition.
This is a portion of the data stored by the cluster. There
are as many cluster partitions as nodes participating in the
cluster. Each node is responsible for keeping at least one
copy of any partitions assigned to it (that is, at least one
replica) available to the cluster.
A replica belongs entirely to a single node; a node can (and
usually does) store several replicas.
MySQL Cluster normally partitions
NDBCLUSTER tables automatically.
However, in MySQL 5.1 and later MySQL Cluster releases, it is
possible to employ user-defined partitioning with
NDBCLUSTER tables. This is
subject to the following limitations:
Only KEY and LINEAR
KEY partitioning schemes can be used with
NDBCLUSTER tables.
The maximum number of partitions that may be definied
explicitly for any NDBCLUSTER
table is 8 per node group. (The number of node groups in a
MySQL Cluster is determined as discussed previously in
this section.)
For more information relating to MySQL Cluster and
user-defined partitioning, see
Section 17.1.5, “Known Limitations of MySQL Cluster”, and
Section 18.5.2, “Partitioning Limitations Relating to Storage Engines”.
Replica.
This is a copy of a cluster partition. Each node in a node
group stores a replica. Also sometimes known as a
partition replica. The number of
replicas is equal to the number of nodes per node group.
The following diagram illustrates a MySQL Cluster with four data
nodes, arranged in two node groups of two nodes each; nodes 1 and
2 belong to node group 0, and nodes 3 and 4 belong to node group
1. Note that only data (ndbd) nodes are shown
here; although a working cluster requires an
ndb_mgm process for cluster management and at
least one SQL node to access the data stored by the cluster, these
have been omitted in the figure for clarity.
The data stored by the cluster is divided into four partitions,
numbered 0, 1, 2, and 3. Each partition is stored — in
multiple copies — on the same node group. Partitions are
stored on alternate node groups:
Partition 0 is stored on node group 0; a primary
replica (primary copy) is stored on node 1, and a
backup replica (backup copy of the
partition) is stored on node 2.
Partition 1 is stored on the other node group (node group 1);
this partition's primary replica is on node 3, and its backup
replica is on node 4.
Partition 2 is stored on node group 0. However, the placing of
its two replicas is reversed from that of Partition 0; for
Partition 2, the primary replica is stored on node 2, and the
backup on node 1.
Partition 3 is stored on node group 1, and the placement of
its two replicas are reversed from those of partition 1. That
is, its primary replica is located on node 4, with the backup
on node 3.
What this means regarding the continued operation of a MySQL
Cluster is this: so long as each node group participating in the
cluster has at least one node operating, the cluster has a
complete copy of all data and remains viable. This is illustrated
in the next diagram.
In this example, where the cluster consists of two node groups of
two nodes each, any combination of at least one node in node group
0 and at least one node in node group 1 is sufficient to keep the
cluster “alive” (indicated by arrows in the diagram).
However, if both nodes from
either node group fail, the remaining two
nodes are not sufficient (shown by the arrows marked out with an
X); in either case, the cluster
has lost an entire partition and so can no longer provide access
to a complete set of all cluster data.
17.1.3. MySQL Cluster Hardware, Software, and Networking Requirements
One of the strengths of MySQL Cluster is that it can be run on
commodity hardware and has no unusual requirements in this regard,
other than for large amounts of RAM, due to the fact that all live
data storage is done in memory. (It is possible to reduce this
requirement using Disk Data tables — see
Section 17.5.10, “MySQL Cluster Disk Data Tables”, for more information
about these.) Naturally, multiple and faster CPUs can enhance
performance. Memory requirements for other Cluster processes are
relatively small.
The software requirements for Cluster are also modest. Host
operating systems do not require any unusual modules, services,
applications, or configuration to support MySQL Cluster. For
supported operating systems, a standard installation should be
sufficient. The MySQL software requirements are simple: all that
is needed is a production release of MySQL
5.1.41-ndb-6.2.19 or 5.1.41-ndb-6.3.32 to have
Cluster support. It is not necessary to compile MySQL yourself
merely to be able to use Cluster. In this
How-To, we assume that you are using the
server binary appropriate to your platform, available via the
MySQL Cluster software downloads page at
http://dev.mysql.com/downloads/select.php?id=14.
For communication between nodes, Cluster supports TCP/IP
networking in any standard topology, and the minimum expected for
each host is a standard 100 Mbps Ethernet card, plus a switch,
hub, or router to provide network connectivity for the cluster as
a whole. We strongly recommend that a MySQL Cluster be run on its
own subnet which is not shared with non-Cluster machines for the
following reasons:
Security.
Communications between Cluster nodes are not encrypted or
shielded in any way. The only means of protecting
transmissions within a MySQL Cluster is to run your Cluster
on a protected network. If you intend to use MySQL Cluster
for Web applications, the cluster should definitely reside
behind your firewall and not in your network's
De-Militarized Zone
(DMZ)
or elsewhere.
See
Section 17.5.9.1, “MySQL Cluster Security and Networking Issues”,
for more information.
Efficiency.
Setting up a MySQL Cluster on a private or protected network
allows the cluster to make exclusive use of bandwidth
between cluster hosts. Using a separate switch for your
MySQL Cluster not only helps protect against unauthorized
access to Cluster data, it also ensures that Cluster nodes
are shielded from interference caused by transmissions
between other computers on the network. For enhanced
reliability, you can use dual switches and dual cards to
remove the network as a single point of failure; many device
drivers support failover for such communication links.
It is also possible to use the high-speed Scalable Coherent
Interface (SCI) with MySQL Cluster, but this is not a requirement.
See Section 17.3.5, “Using High-Speed Interconnects with MySQL Cluster”, for more about
this protocol and its use with MySQL Cluster.
17.1.4. MySQL Cluster Development History
In this section, we discuss changes in the implementation of MySQL
Cluster in MySQL 5.1 and MySQL Cluster NDB 6.x as
compared to MySQL 5.0.
We also discuss our roadmap for further improvements to MySQL
Cluster planned for MySQL Cluster NDB 7.0 and later.
There are a number of significant changes in the implementation of
the NDBCLUSTER storage engine in
mainline MySQL 5.1 releases up to and including MySQL 5.1.23 as
compared to that in MySQL 5.0; MySQL Cluster NDB makes further
changes and improvements in MySQL Cluster in addition to these.
The changes and features most likely to be of interest are shown
in the following table:
17.1.4.1. Development History of MySQL Cluster in MySQL 5.1
A number of features for MySQL Cluster were implemented in MySQL
5.1 through MySQL 5.1.23, when support for MySQL Cluster was
moved to MySQL Cluster NDB. All of the features in the following
list are also available in all MySQL Cluster NDB (6.1 and later)
releases.
Integration of MySQL Cluster into MySQL Replication.
MySQL Cluster Replication makes it possible to replicate
from one MySQL Cluster to another. Updates on any SQL node
(MySQL server) in the cluster acting as the master are
replicated to the slave cluster; the state of the slave
side remains consistent with the cluster acting as the
master. This is sometimes referred to as
asynchronous replication between
clusters, providing geographic
redundancy. It is also possible to replicate
from a MySQL Cluster acting as the master to a standalone
MySQL server acting as the slave, or from a standalone
MySQL master server to to a slave cluster; in either of
these cases, the standalone MySQL server uses a storage
engine other than NDBCLUSTER.
Multi-master replication setups such as circular
replication are also supported.
See Section 17.6, “MySQL Cluster Replication”.
Support for storage of rows on disk.
Storage of NDBCLUSTER table
data on disk is now supported. Indexed columns, including
the primary key hash index, must still be stored in RAM;
however, all other columns can be stored on disk.
See Section 17.5.10, “MySQL Cluster Disk Data Tables”.
Variable-size columns.
In MySQL 5.0, an NDBCLUSTER
table column defined as VARCHAR(255)
used 260 bytes of storage independent of what was stored
in any particular record. In MySQL 5.1 Cluster tables,
only the portion of the column actually taken up by the
record is stored. This makes possible a significant
reduction in space requirements for such columns as
compared to previous release series — by a factor of
up to 5 in many cases.
User-defined partitioning.
Users can define partitions based on columns that are part
of the primary key. It is possible to partition
NDB tables based on
KEY and LINEAR KEY
schemes. This feature is also available for many other
MySQL storage engines, which support additional
partitioning types that are not available with
NDBCLUSTER tables.
For additional general information about user-defined
partitioning in MySQL 5.1, see
Chapter 18, Partitioning. Specifics of partitioning
types are discussed in Section 18.2, “Partition Types”.
The MySQL Server can also determine whether it is possible
to “prune away” some of the partitions from the
WHERE clause, which can greatly speed up
some queries. See Section 18.4, “Partition Pruning”,
for information about designing tables and queries to take
advantage of partition pruning.
Autodiscovery of table schema changes.
In MySQL 5.0, it was necessary to issue a
FLUSH
TABLES statement or a “dummy”
SELECT in order for new
NDBCLUSTER tables or changes
made to schemas of existing
NDBCLUSTER tables on one SQL
node to be visible on the cluster's other SQL nodes.
In MySQL 5.1, this is no longer necessary; new Cluster
tables and changes in the definitions of existing
NDBCLUSTER tables made on one
SQL node are immediately visible to all SQL nodes
connected to the cluster.
Note
When creating a new database, it is still necessary in
MySQL 5.1 to issue a CREATE
DATABASE or
CREATE
SCHEMA statement on each SQL node in the
cluster.
Distribution awareness (NDB API).
Distribution awareness is a
mechanism by which the best data node is automatically
selected to be queried for information. (Conceptually, it
is similar in some ways to partition pruning (see
Section 18.4, “Partition Pruning”). To take advantage
of distribution awareness, you should do the following:
Determine which table column is most likely to be
used for finding matching records.
Make this column part of the table's primary
key.
Explicitly partition the table by
KEY, using this column as the
table' partitioning key.
Following these steps causes records with the same value
for the partitioning column to be stored on the same
partition (that is, in the same node group). When reading
data, transactions are begun on the data node actually
having the desired rows instead of this node being
determined by the usual round-robin mechanism.
Important
In order to see a measureable impact on performance,
the cluster must have at least four data nodes, since,
with only two data nodes, both data nodes have exactly
the same data.
Using distribution awareness can yield performance
increase of as great as 45% when using four data nodes,
and possibly more when using a greater number of data
nodes.
Note
In mainline MySQL 5.1 releases, distribution awareness
was supported only when using the NDB API; support was
added for SQL and API nodes in MySQL Cluster NDB 6.3
(see
Section 17.1.4.4, “MySQL Cluster Development in MySQL Cluster NDB 6.3”,
which includes an example showing how to create a
table in order to take advantage of distribution
awareness).
See Section 17.1.5.11, “Previous MySQL Cluster Issues Resolved in MySQL 5.1, MySQL Cluster NDB
6.x, and MySQL Cluster NDB 7.x”, for
more information.
17.1.4.2. MySQL Cluster Development in MySQL Cluster NDB 6.1
The following list provides an overview of significant feature
additions and changes made in MySQL Cluster NDB 6.1. All of the
changes in this list are also available in MySQL Cluster NDB 6.2
and 6.3 releases. For detailed information about all changes
made in MySQL Cluster NDB 6.1, see
Section 17.7.5, “Changes in MySQL Cluster NDB 6.1”.
Increased number of cluster nodes.
The maximum number of all nodes in a MySQL Cluster has
been increased to 255. For more information, see
Section 17.1.5.10, “Limitations Relating to Multiple MySQL Cluster Nodes”.
Disabling arbitration.
It is now possible to disable arbitration by setting
ArbitrationRank=0 on all cluster
management and SQL nodes. For more information, see
Defining
the Management Server:
ArbitrationRank
and
Defining
SQL and Other API Nodes:
ArbitrationRank.
Additional DUMP commands.
New management client DUMP commands
provide help with tracking transactions, scan
operations, and locks. See
Section 17.5.2, “Commands in the MySQL Cluster Management Client”, and
DUMP Commands, for more
information.
Faster Disk Data backups.
Improvements in backups of Disk Data tables can yield a
10 to 15% increase in backup speed of Disk Data tables.
Batched slave updates.
Batching of updates on cluster replication slaves,
enabled using the
--slave-allow-batching option for
mysqld, increases replication
efficiency. For more information, see
Section 17.6.6, “Starting MySQL Cluster Replication (Single Replication Channel)”.
17.1.4.3. MySQL CLuster Development in MySQL Cluster NDB 6.2
The following list provides an overview of significant feature
additions and changes made in MySQL Cluster NDB 6.2. All of the
changes in this list are also available in MySQL Cluster NDB 6.3
. For more detailed information about all feature changes and
bugfixes made in MySQL Cluster NDB 6.2, see
Section 17.7.4, “Changes in MySQL Cluster NDB 6.2”.
Enhanced backup status reporting.
Backup status reporting has been improved, aided in part
by the introduction of a
BackupReportFrequency configuration
parameter; see
Defining
Data Nodes:
BackupReportFrequency,
for more information.
Multiple cluster connections per SQL node.
A single MySQL server acting as a MySQL Cluster SQL node
can employ multiple connections to the cluster using the
--ndb-cluster-connection-pool startup
option for mysqld. This option is
described in
MySQL
Cluster-Related Command Options for
mysqld:
--ndb-cluster-connection-pool
option.
New data access interface.
The NdbRecord interface provides a
new and simplified data handler for use in NDB API
applications. See The NdbRecord Interface, for
more information.
New reporting commands.
The new management client REPORT
BackupStatus and REPORT
MemoryUsage commands provide better access to
information about the status of MySQL Cluster backups
and how much memory is being used by MySQL Cluster for
data and index storage. See
Section 17.5.2, “Commands in the MySQL Cluster Management Client”, for
more information about the REPORT
commands. In addition, in-progress status reporting is
provided by the ndb_restore utility;
see
Section 17.4.17, “ndb_restore — Restore a MySQL Cluster Backup”.
Improved memory allocation and configuration.
Memory is now allocated by the
NDB kernel to tables on a
page-by-page basis, which significantly reduces the
memory overhead required for maintaining
NDBCLUSTER tables. In
addition, the MaxAllocate
configuration parameter now makes it possible to set the
maximum size of the allocation unit used for table
memory; for more information about this configuration
parameter, see
Defining
Data Nodes:
MaxAllocate.
Choice of fixed-width or variable-width columns.
You can control whether fixed-width or variable-width
storage is used for a given column of an
NDB table by employing of
the COLUMN_FORMAT specifier as part
of the column's definition in a
CREATE TABLE or
ALTER TABLE statement. In
addition, the ability to control whether a given column
of an NDB table is stored
in memory or on disk, using the
STORAGE specifier as part of the
column's definition in a CREATE
TABLE or ALTER
TABLE statement. For more information, see
Section 12.1.17, “CREATE TABLE Syntax”, and
Section 12.1.7, “ALTER TABLE Syntax”.
Controlling management client connections.
The --bind-address cluster management
server startup option makes it possible to restrict
management client connections to
ndb_mgmd to a single host (IP address
or host name) and port, which can make MySQL Cluster
management operations more secure. For more information
about this option, see
Section 17.4.4, “ndb_mgmd — The MySQL Cluster Management Server Daemon”.
Micro-GCPs.
Due to a change in the protocol for handling of global
checkpoints (GCPs handled in this manner sometimes being
referred to as “micro-GCPs”), it is now
possible to control how often the GCI number is updated,
and how often global checkpoints are written to disk,
using the TimeBetweenEpochs
configuration parameter. This improves the reliability
and performance of MySQL Cluster Replication. For more
information, see
Defining
Data Nodes:
TimeBetweenEpochs
and
Defining
Data Nodes:
TimeBetweenEpochsTimeout.
Core online schema change support.
Support for the online ALTER
TABLE operations ADD
COLUMN, ADD INDEX, and
DROP INDEX is available.
When the ONLINE keyword is used, the
ALTER TABLE is
noncopying, which means that indexes do not have to be
re-created, which provides these benefits:
Single user mode is no longer required for
ALTER TABLE
operations that can be performed online.
Transactions can continue during
ALTER TABLE
operations that can be performed online.
Tables being altered online are not locked against
access by other SQL nodes.
However, such tables are locked against other
operations on the same SQL
node for the duration of the
ALTER TABLE. We are
working to overcome this limitation in a future
MySQL Cluster release.
Online CREATE INDEX and
DROP INDEX statements are
also supported. Online changes can be suppressed using
the OFFLINE key word. See
Section 12.1.7, “ALTER TABLE Syntax”,
Section 12.1.13, “CREATE INDEX Syntax”, and
Section 12.1.24, “DROP INDEX Syntax”, for more detailed
information.
mysql.ndb_binlog_index improvements.
More information has been added to the
mysql.ndb_binlog_index table so that
it is possible to determine which originating epochs
have been applied inside an epoch. This is particularly
useful for 3-way replication. See
Section 17.6.4, “MySQL Cluster Replication Schema and Tables”, for
more information.
Epoch lag control.
The MaxBufferedEpochs data node
configuration parameter provides a means to control the
maximum number of unprocessed epochs by which a
subscribing node can lag. Subscribers which exceed this
number are disconnected and forced to reconnect. For a
discussion of this configuration parameter, see
Defining
Data Nodes:
MaxBufferedEpochs.
Fully automatic database discovery.
It is no longer a requirement for database autodiscovery
that an SQL node already be connected to the cluster at
the time that a database is created on another SQL node,
or for a CREATE DATABASE
or
CREATE
SCHEMA statement to be issued on the new SQL
node after it joins the cluster.
Multiple data node processes per host.
In earlier MySQL Cluster release series, we did not
support MySQL Cluster deployments in production where
more than one ndbd process was run on
a single physical machine. However, beginning with MySQL
Cluster NDB 6.2.0, you can use multiple data node
processes on a single host.
Improved Disk Data filesystem configuration.
As of MySQL Cluster NDB 6.2.17, you can specify default
locations for MySQL Cluster Disk Data data files and
undo log files using the data node configuration
parameters FileSystemPathDD,
FileSystemPathDataFiles, and
FileSystemPathUndoFiles. This
eliminates the need to use symbolic links in order to
place Disk Data files separately from other files in
data node filesystems to improve Disk Data performance.
For more information, see
Disk Data filesystem parameters.
Automatic creation of Disk Data log file groups and tablespaces.
Beginning with MySQL Cluster NDB 6.2.17, using the data
node configuration parameters
InitialLogFileGroup and
InitialTablespace, you can cause the
creation of a MySQL Cluster Disk Data log file group,
tablespace, or both, when the cluster is first started.
When using these parameters, no SQL statements are
required to create these Disk Data objects. For more
information, see
Disk
Data object creation parameters.
17.1.4.4. MySQL Cluster Development in MySQL Cluster NDB 6.3
The following list provides an overview of significant feature
additions and changes first made in MySQL Cluster NDB 6.3. For
more detailed information about all feature changes and bugfixes
made in MySQL Cluster NDB 6.3, see
Section 17.7.3, “Changes in MySQL Cluster NDB 6.3”.
Conflict detection and resolution.
It is now possible to detect and resolve conflicts that
arise in multi-master replication scenarios, such as
circular replication, when different masters may try to
update the same row on the slave with different data.
Both “greatest timestamp wins” and
“same timestamp wins” scenarios are
supported. For more information, see
Section 17.6.11, “MySQL Cluster Replication Conflict Resolution”.
Recovery of “one master, many slaves” replication setups.
Recovery of multi-way replication setups (“one
master, many slaves”) is now supported via the
--ndb-log-orig server option and
changes in the mysql.ndb_binlog_index
table. See
Section 17.6.4, “MySQL Cluster Replication Schema and Tables”, for
more information.
Enhanced selection options for transaction coordinator.
New values and behaviors are introduced for
--ndb_optimized_node_selection allowing
for greater flexibility when an SQL node chooses a
transaction coordinator. For more information, see the
description of
ndb_optimized_node_selection
in Section 17.3.4.3, “MySQL Cluster System Variables”.
Replication heartbeats.
Replication heartbeats facilitate the task of monitoring
and detecting failures in master-slave connections in
real time. This feature is implemented via a new
MASTER_HEARTBEAT_PERIOD =
value clause for
the CHANGE MASTER TO
statement and the addition of two status variables
Slave_heartbeat_period
and
Slave_received_heartbeats.
For more information, see
Section 12.6.2.1, “CHANGE MASTER TO Syntax”.
NDB thread locks.
It is possible to lock NDB
execution threads and maintenance threads (such as file
system and other operating system threads) to specific
CPUs on multiprocessor data node hosts, and to leverage
real-time scheduling.
Improved performance of updates using primary keys or unique keys.
The number of unnecessary reads when performing a
primary key or unique key update has been greatly
reduced. Since it is seldom necessary to read a record
prior to an update, this can yield a considerable
improvement in performance. In addition, primary key
columns are no longer written to when not needed during
update operations.
Batching improvements.
Support of batched DELETE
and UPDATE operations has
been significantly improved. Batching of UPDATE
WHERE... and multiple
DELETE operations is also
now implemented.
Improved SQL statement performance metrics.
The Ndb_execute_count
system status variable measures the number of round
trips made by SQL statements to the
NDB kernel, providing an
improved metric for determining efficiency with which
statements are excuted. For more information, see
MySQL
Cluster Status Variables:
Ndb_execute_count.
Compressed LCPs and backups.
Compressed local checkpoints and backups can save 50% or
more of the disk space used by uncompressed LCPs and
backups. These can be enabled using the two new data
node configuration parameters
CompressedLCP and
CompressedBackup, respectively. See
MySQL
Cluster Status Variables:
CompressedBackup,
and
MySQL
Cluster Status Variables:
CompressedLCP, for
more information about these parameters.
OPTIMIZE TABLE support with
NDBCLUSTER tables.
OPTIMIZE TABLE is
supported for dynamic columns of in-memory
NDB tables. In such cases,
it is no longer necessary to drop (and possibly to
re-create) a table, or to perform a rolling restart, in
order to recover memory from deleted rows for general
re-use by Cluster. The performance of
OPTIMIZE on Cluster tables can be
tuned by adjusting the value of the
ndb_optimization_delay system
variable, which controls the number of milliseconds to
wait between processing batches of rows by
OPTIMIZE TABLE. In
addition, OPTIMIZE TABLE
on an NDBCLUSTER table can
be interrupted by, for example, killing the SQL thread
performing the OPTIMIZE operation.
Batching of transactions.
It is possible to cause statements occurring within the
same transaction to be run as a batch by setting the
session variable
transaction_allow_batching to
1 or ON. To use
this feature,
autocommit must be set
to 0 or OFF. Batch
sizes can be controlled using the
--ndb-batch-size option for
mysqld. For more information, see
Section 17.3.4.2, “mysqld Command Options for MySQL Cluster”,
and Section 17.3.4.3, “MySQL Cluster System Variables”.
Attribute promotion with ndb_restore.
It is possible using ndb_restore to
restore data reliably from a column of a given type to a
column that uses a “larger” type. This is
sometimes referred to as attribute
promotion. For example, MySQL Cluster backup
data that originated in a
SMALLINT column can be
restored to a MEDIUMINT,
INT, or
BIGINT column. See
Section 17.4.17, “ndb_restore — Restore a MySQL Cluster Backup”,
for more information.
Parallel data node recovery.
Recovery of multiple data nodes can now be done in
parallel, rather than sequentially. In other words,
several data nodes can be restored concurrently, which
can often result in much faster recovery times than when
they are restored one at a time.
Increased local checkpoint efficiency.
Only 2 local checkpoints are stored, rather than 3,
lowering disk space requirements and the size and number
of redo log files.
NDBCLUSTER table persistence control.
Persistence of NDB tables
can be controlled using the session variables
ndb_table_temporary and
ndb_table_no_logging.
ndb_table_no_logging causes
NDB tables not to be
checkpointed to disk;
ndb_table_temporary does the same,
and in addition, no schema files are created. See
Section 17.3.4.1, “MySQL Cluster Server Option and Variable Reference”.
Epoll support (Linux only).
Epoll is an improved method for
handling file descriptors, which is more efficient than
scanning to determine whether a file descriptor has data
to be read. (The term epoll is
specific to Linux and equivalent functionality is known
by other names on other platforms such as Solaris and
FreeBSD.) Currently, MySQL Cluster supports this
functionality on Linux only.
Distribution awareness (SQL nodes).
In MySQL Cluster NDB 6.3, SQL nodes can take advantage
of
distribution
awareness. Here we provide a brief example
showing how to design a table to make a given class of
queries distrubtion-aware. Suppose an
NDBCLUSTER table
t1 has the following schema:
CREATE TABLE t1 (
userid INT NOT NULL,
serviceid INT NOT NULL AUTO_INCREMENT PRIMARY KEY,
data VARCHAR(255)
) ENGINE=NDBCLUSTER;
Suppose further that most of the queries to be used in
our application test values of the
userid column of this table. The form
of such a query looks something like this:
SELECT columns FROM t1
WHERE userid relation value;
In this query, relation
represents some relational operator, such as
=, <,
>, and so on. Queries using
IN and a list of values can also be
used:
SELECT columns FROM t1
WHERE userid IN value_list;
In order to make use of distribution awareness, we need
to make the userid column part of the
table's primary key, then explicitly partition the
table with this column being used as the partitioning
key. (Recall that for a partitioned table having one or
more unique keys, all columns of the table's
partitioning key must also be part of all of the unique
keys — for more information and examples, see
Section 18.5.1, “Partitioning Keys, Primary Keys, and Unique Keys”.)
In other words, the table schema should be equivalent to
the following CREATE
TABLE statement:
CREATE TABLE t1 (
userid INT NOT NULL,
serviceid INT NOT NULL AUTO_INCREMENT,
data VARCHAR(255),
PRIMARY KEY p (userid,serviceid)
) ENGINE=NDBCLUSTER
PARTITION BY KEY(userid);
When the table is partitioned in this way, all rows
having the same userid value are
found on the same node group, and the MySQL Server can
immediately select the optimal node to use as the
transaction coordinator.
Realtime extensions for multiple CPUs.
When running MySQL Cluster data nodes on hosts with
multiple processors, the realtime extensions make it
possible to give priority to the data node process and
control on which CPU cores it should operate. This can
be done using the data node configuration parameters
RealtimeScheduler,
SchedulerExecutionTimer and
SchedulerSpinTimer. Doing so properly
can significantly lower response times and make them
much more predictable response. For more information
about using these parameters, see
Defining
Data Nodes: Realtime Performance Parameters
Fully automatic database discovery.
It is no longer a requirement for database autodiscovery
that an SQL node already be connected to the cluster at
the time that a database is created on another SQL node,
or for a CREATE DATABASE
or
CREATE
SCHEMA statement to be issued on the new SQL
node after it joins the cluster.
Restoring specific databases, tables, or columns from a MySQL Cluster
backup.
It is now possible to exercise more fine-grained control
when restoring a MySQL Cluster from backup using
ndb_restore. Beginning with MySQL
Cluster NDB 6.3.22, you can choose to restore only
specified tables or databases, or exclude specific
tables or databases from being restored, using the new
ndb_restore options
--include-tables,
--include-databases,
--exclude-tables, and
--exclude-databases. Beginning with
MySQL Cluster NDB 6.3.26, it is also possible to restore
to a table having fewer columns than the original using
the --exclude-missing-columns option.
For more information about all of these options, see
Section 17.4.17, “ndb_restore — Restore a MySQL Cluster Backup”.
Improved Disk Data filesystem configuration.
As of MySQL Cluster NDB 6.3.22, you can specify default
locations for MySQL Cluster Disk Data data files and
undo log files using the data node configuration
parameters FileSystemPathDD,
FileSystemPathDataFiles, and
FileSystemPathUndoFiles. This
eliminates the need to use symbolic links in order to
place Disk Data files separately from other files in
data node filesystems to improve Disk Data performance.
For more information, see
Disk Data filesystem parameters.
Automatic creation of Disk Data log file groups and tablespaces.
Beginning with MySQL Cluster NDB 6.3.22, using the data
node configuration parameters
InitialLogFileGroup and
InitialTablespace, you can cause the
creation of a MySQL Cluster Disk Data log file group,
tablespace, or both, when the cluster is first started.
When using these parameters, no SQL statements are
required to create these Disk Data objects. For more
information, see
Disk
Data object creation parameters.
Configuration parameter data dumps.
Starting with MySQL Cluster NDB 6.3.25, the
ndb_config utility supports a
--configinfo option that causes it to
dump a list of all configuration parameters supported by
the cluster, along with brief descriptions, information
about the parameters' default and allowed values,
and the sections of the config.ini
file in which the parameters apply. An additional
--xml switch causes
ndb_config to use XML rather than
plaintext output. Using ndb_config
--configinfo or
ndb_config --configinfo
--xml requires no access to a running
MySQL Cluster, any other programs, or any files. For
more information and examples, see
Section 17.4.6, “ndb_config — Extract MySQL Cluster Configuration Information”.
Per-table reporting of free space on disk.
The
INFORMATION_SCHEMA.FILES
table shows information about used and free space in
MySQL Cluster Disk Data data files, but this information
is not applicable to individual tables. In MySQL Cluster
NDB 6.3.27 and later, the ndb_desc
utility provides two additional columns in its output
that show the amount of space allocated on disk for a
given NDB table as well the
amount of space that remains available for additional
storage of disk-based column data for that table. For
more information, see
Section 17.4.9, “ndb_desc — Describe NDB Tables”.
Improved restart times.
Optimizations in redo log handling and other filesystem
operations introduced in MySQL Cluster NDB 6.3.28 have
the potential to reduce considerably the time required
for restarts. While actual performance benefits observed
in production setups will naturally vary depending on
database size, hardware, and other conditions, our own
preliminary testing has shown that these improvements
can yield startup times that are faster than those
typical of previous MySQL Cluster NDB 6.3 releases by a
factor of 50 or more.
Increased flexibility in online upgrade procedure.
Previously, when performing an upgrade of a running
MySQL cluster, the order in which the types of cluster
nodes had to be upgraded was very strict. However,
beginning with MySQL Cluster NDB 6.3.29, MySQL Cluster
supports online upgrading of API nodes (including MySQL
servers running as SQL nodes) before upgrading
management nodes, data nodes, or both.
New replication conflict resolution strategy.
Beginning with MySQL Cluster NDB 6.3.31, the function
NDB$MAX_DELETE_WIN() is available to
implement “greatest timestamp, delete wins”
conflict resolution. See
NDB$MAX_DELETE_WIN(column_name),
for more information.
Heartbeat thread policy and priority.
Beginning with MySQL Cluster NDB 6.3.32, a new
configuration parameter
HeartbeatThreadPriority makes it
possible to set the policy and the priority for the
heartbeat thread on management and API nodes.
17.1.4.5. MySQL Cluster Development in MySQL Cluster NDB 7.0
The following list provides an overview of significant feature
additions and changes made in MySQL Cluster NDB 7.0. For more
detailed information about all feature changes and bugfixes made
in MySQL Cluster NDB 7.0, see
Section 17.7.2, “Changes in MySQL Cluster NDB 7.0”.
Important
Early development versions of MySQL Cluster NDB 7.0 were known
as “MySQL Cluster NDB 6.4”, and the first four
releases in this series were identified as MySQL Cluster NDB
6.4.0 through 6.4.3. Any information relating to these MySQL
Cluster NDB 6.4.x releases appearing in this documentation
apply to MySQL Cluster NDB 7.0.
MySQL Cluster NDB 7.0.4 is the fifth MySQL Cluster NDB 7.0
release; it is the successor to MySQL Cluster NDB 6.4.3.
MySQL Cluster on Windows (alpha).
MySQL Cluster is now available on an experimental basis
for Windows operating systems. Features and behavior
comparable to those found on platforms that are already
supported — such as Linux and Solaris — are
planned for MySQL Cluster on Windows. Currently, you must
build from source, although we intend to start making
Windows binaries available in the near future. To enable
MySQL Cluster support on Windows, you must configure the
build using the
WITH_NDBCLUSTER_STORAGE_ENGINE option.
For more information, see
Section 2.5.10, “Installing MySQL from Source on Windows”.
Ability to add nodes and node groups online.
Beginning with MySQL Cluster NDB 6.4.0, it is possible to
add new node groups (and thus new data nodes) to a running
MySQL Cluster without shutting down and reloading the
cluster. As part of enabling this feature, a new command
CREATE NODEGROUP has been added to the
cluster management client and the functionality of the
ALTER ONLINE
TABLE ... REORGANIZE PARTITION SQL statement has
been extended. For more information, see
Section 17.5.11, “Adding MySQL Cluster Data Nodes Online”.
Data node multithreading support.
Beginning with MySQL Cluster NDB 6.4.0, a multithreaded
version of the data node daemon, named
ndbmtd, is available for use on data
node hosts with multiple CPU cores. This binary is built
automatically when compiling with MySQL Cluster support;
no additional options other than those needed to provide
MySQL Cluster support are needed when configuring the
build. In most respects, ndbmtd
functions in the same way as ndbd, and
can use the same command-line options and configuration
parameters. In addition, the new
MaxNoOfExecutionThreads configuration
parameter can be used to determine the number of data node
process threads for ndbmtd. For more
information, see
Section 17.4.3, “ndbmtd — The MySQL Cluster Data Node Daemon (Multi-Threaded)”.
Note
Disk Data tables are not yet supported for use with
ndbmtd.
Configuration cache.
Formerly, MySQL Cluster configuration was stateless
— that is, configuration information was reloaded
from the cluster's global configuration file (usually
config.ini) each time
ndb_mgmd was started. Beginning with
MySQL Cluster NDB 6.4.0, the cluster's configuration
is cached internally, and the global configuration file is
no longer automatically re-read when the management server
is restarted. This behavior can be controlled via the
three new management server options
--configdir, --initial,
and --reload. For more information about
this change, see
Section 17.3.2, “MySQL Cluster Configuration Files”. For more
information about the new management server options, see
Section 17.4.4, “ndb_mgmd — The MySQL Cluster Management Server Daemon”.
Snapshot options for backups.
Beginning with MySQL Cluster NDB 6.4.0, you can determine
when performing a cluster backup whether the backup
matches the state of the data when the backup was started
or when it was completed, using the new options
SNAPSHOTSTART and
SNAPSHOTEND for the management
client's START BACKUP command. See
Section 17.5.3.2, “Using The MySQL Cluster Management Client to Create a Backup”,
for more information.
Dynamic NDB transporter send buffer memory allocation.
Previously, the NDB kernel used a fixed-size send buffer
for every data node in the cluster, which was allocated
when the node started. Because the size of this buffer
could not be changed after the cluster was started, it was
necessary to make it large enough in advance to accomodate
the maximum possible load on any transporter socket.
However, this was an inefficient use of memory, since much
of it often went unused. Beginning with MySQL Cluster NDB
6.4.0, send buffer memory is allocated dynamically from a
memory pool shared between all transporters, which means
that the size of the send buffer can be adjusted as
necessary. This change is reflected by the addition of the
configuration parameters
TotalSendBufferMemory,
ReservedSendBufferMemory, and
OverLoadLimit, as well as a change in
how the existing SendBufferMemory
configuration parameter is used. For more information, see
Section 17.3.2.13, “Configuring MySQL Cluster Send Buffer Parameters”.
Robust DDL operations.
Beginning with MySQL Cluster NDB 6.4.0, DDL operations
(such as CREATE TABLE or
ALTER TABLE) are protected
from data node failures; in the event of a data node
failure, such operations are now rolled back gracefully.
Previously, if a data node failed while trying to perform
a DDL operation, the MySQL Cluster data dictionary became
locked and no further DDL statements could be executed
without restarting the cluster.
IPv6 support in MySQL Cluster Replication.
Beginning with MySQL Cluster NDB 6.4.1, IPv6 networking is
supported between MySQL Cluster SQL nodes, which makes it
possible to replicate between instances of MySQL Cluster
using IPv6 addresses. However, IPv6 is supported only for
direct connections between MySQL servers; all connections
within an individual MySQL Cluster
must use IPv4. For more information, see
Section 17.6.3, “Known Issues in MySQL Cluster Replication”.
Restoring specific databases, tables, or columns from a MySQL Cluster
backup.
It is now possible to exercise more fine-grained control
when restoring a MySQL Cluster from backup using
ndb_restore. Beginning with MySQL
Cluster NDB 6.4.3, you can choose to restore only
specified tables or databases, or exclude specific tables
or databases from being restored, using the new
ndb_restore options
--include-tables,
--include-databases,
--exclude-tables, and
--exclude-databases. Beginning with MySQL
Cluster NDB 7.0.7, it is also possible to restore to a
table having fewer columns than the original using the
--exclude-missing-columns option. For
more information about all of these options, see
Section 17.4.17, “ndb_restore — Restore a MySQL Cluster Backup”.
Improved Disk Data filesystem configuration.
As of MySQL Cluster NDB 6.4.3, you can specify default
locations for MySQL Cluster Disk Data data files and undo
log files using the data node configuration parameters
FileSystemPathDD,
FileSystemPathDataFiles, and
FileSystemPathUndoFiles. This
eliminates the need to use symbolic links in order to
place Disk Data files separately from other files in data
node filesystems to improve Disk Data performance. For
more information, see
Disk Data filesystem parameters.
Automatic creation of Disk Data log file groups and tablespaces.
Beginning with MySQL Cluster NDB 6.4.3, using the data
node configuration parameters
InitialLogFileGroup and
InitialTablespace, you can cause the
creation of a MySQL Cluster Disk Data log file group,
tablespace, or both, when the cluster is first started.
When using these parameters, no SQL statements are
required to create these Disk Data objects. For more
information, see
Disk
Data object creation parameters.
Improved internal message passing and record handling.
MySQL Cluster NDB 7.0 contains 2 changes that optimize the
use of network connections by addressing the size and
number of messages passed between data nodes, and between
data nodes and API nodes, which can increase MySQL Cluster
and application performance:
Packed reads.
Formerly, each read request signal contained a
list of columns to be retrieved, each of these
column identifiers using 4 bytes within the
message. This meant that the message size
increased as the number of columns being fetched
increased. In addition, in the response from the
data node, each column result was packed to a
4-byte boundary, which resulted in wasted space.
In MySQL Cluster NDB 7.0, messaging for read
operations is optimized in both directions, using
a bitmap in the read request to specify the
columns to be fetched. Where many fields are
requested, this can result in a significant
message size reduction as compared with the old
method. In addition, the 4-byte packing in
responses is no longer used, which means that
smaller fields consume less space.
Long signal transactions.
This enhancement reduces the number of messages
and signals that are sent to data nodes for
complex requests. Prior to MySQL Cluster NDB 7.0,
there was a 100 byte limit on the size of the
request signal, which meant that complex requests
had to be split up between multiple messages prior
to transmission, then reassembled on the receiving
end. In addition to actual payload data, each
message required its own operating system and
protocol overhead such as header information. This
often wasted network bandwidth and data node CPU.
The maximum size of the message is now 32 KB,
which is sufficient to accommodate most queries.
Both of these optimizations are internal to the NDB API, and
so is transparent to applications; this is true whether an
application uses the NDB API directly or does so indirectly
through an SQL node.
Configuration parameter data dumps.
Starting with MySQL Cluster NDB 7.0.6, the
ndb_config utility supports a
--configinfo option that causes it to
dump a list of all configuration parameters supported by
the cluster, along with brief descriptions, information
about the parameters' default and allowed values, and
the sections of the config.ini file
in which the parameters apply. An additional
--xml switch causes
ndb_config to use XML rather than
plaintext output. Using ndb_config
--configinfo or
ndb_config --configinfo
--xml requires no access to a running
MySQL Cluster, any other programs, or any files. For more
information and examples, see
Section 17.4.6, “ndb_config — Extract MySQL Cluster Configuration Information”.
Per-table reporting of free space on disk.
The INFORMATION_SCHEMA.FILES
table shows information about used and free space in MySQL
Cluster Disk Data data files, but this information is not
applicable to individual tables. In MySQL Cluster NDB
7.0.8 and later, the ndb_desc utility
provides two additional columns in its output that show
the amount of space allocated on disk for a given
NDB table as well the amount
of space that remains available for additional storage of
disk-based column data for that table. For more
information, see
Section 17.4.9, “ndb_desc — Describe NDB Tables”.
Improved restart times.
Optimizations in redo log handling and other filesystem
operations introduced in MySQL Cluster NDB 7.0.9 have the
potential to reduce considerably the time required for
restarts. While actual performance benefits observed in
production setups will naturally vary depending on
database size, hardware, and other conditions, our own
preliminary testing has shown that these improvements can
yield startup times that are faster than those typical of
previous MySQL Cluster NDB 7.0 releases by a factor of 50
or more.
--nowait-nodes option for management
servers.
Starting with MySQL Cluster NDB 7.0.10, it is possible to
configure a cluster with two management servers, but to
start the cluster using only one of them by starting the
management node daemon with the
--nowait-nodes option.
The other management server can then be started at a later
time to join the running MySQL Cluster.
Increased flexibility in online upgrade procedure.
Previously, when performing an upgrade of a running MySQL
cluster, the order in which the types of cluster nodes had
to be upgraded was very strict. However, beginning with
MySQL Cluster NDB 7.0.10, MySQL Cluster supports online
upgrading of API nodes (including MySQL servers running as
SQL nodes) online upgrading management nodes, data nodes,
or both.
New replication conflict resolution strategy.
Beginning with MySQL Cluster NDB 7.0.11, the function
NDB$MAX_DELETE_WIN() is available to
implement “greatest timestamp, delete wins”
conflict resolution. See
NDB$MAX_DELETE_WIN(column_name),
for more information.
Improved lock handling for primary key lookups on
BLOB tables.
A MySQL Cluster table stores all but the first 256 bytes
of any BLOB or
TEXT column values in a
separate BLOB table; when
executing queries against such tables, a shared lock is
obtained. Previously, when the query used a primary key
lookup and took place within a transaction, the lock was
held for the duration of the transaction, even after no
more data was being read from the
NDB table. Now in such cases,
the lock is released when all
BLOB data associated with
the table has been read. (Bug#49190)
Note
A shared lock is also taken for unique key lookups; it is
still the case that this lock is held for the duration of
the transaction.
Heartbeat thread policy and priority.
Beginning with MySQL Cluster NDB 7.0.13, a new
configuration parameter
HeartbeatThreadPriority makes it
possible to set the policy and the priority for the
heartbeat thread on management and API nodes.
17.1.4.6. MySQL Cluster Development in MySQL Cluster NDB 7.1
The following improvements to MySQL Cluster have been made in
MySQL Cluster NDB 7.1.
Important
These features are in early development
phase. Timing, availability, and implementation
details are not guaranteed, and are subject to change at any
time without notice.
Java connectors for MySQL Cluster.
The MySQL Cluster distribution now includes 2 new Java
user APIs, ClusterJ and ClusterJPA. ClusterJ is an
object-relational interface in a manner similar to that of
Java persistence frameworks such as Hibernate. Cluster JPA
is a reimplementation of OpenJPA. ClusterJ uses a backend
library (NdbJTie) that provides access to the
NDB storage engine without
using a MySQL Server connection or JDBC. ClusterJPA also
uses NdbJTie when it improves performance, but can also
process complex queries using JDBC and a MySQL Server
connection, where it can take advantage of the MySQL query
optimizer.
ClusterJ and Cluster JPA can also be made to work with
recent MySQL Cluster NDB 7.0 releases although the necessary
library and JAR files are included only in MySQL Cluster NDB
7.1.1 and later.
MySQL Cluster information database (ndbinfo).
The ndbinfo information database makes
it possible to obtain real-time characteristics of a MySQL
Cluster by issuing queries from the
mysql client or other MySQL client
applications. ndbinfo provides metadata
specific to MySQL Cluster similarly to how the
INFORMATION_SCHEMA database provides
metadata for the standard MySQL Server. This eliminates
much of the need to read log files, issue
REPORT or DUMP
commands in the ndb_mgm client, or
parse the output of ndb_config in order
to get configuration and status information from a running
MySQL Cluster.
For more information, see
Section 17.5.8, “The ndbinfo MySQL Cluster Information Database”.
Native support for default column values.
Starting with MySQL Cluster NDB 7.1.0, default values for
table columns are stored in the NDB kernel rather than by
the MySQL server as was done previously. This means that
inserts on tables having column value defaults can be
smaller and faster than before, because less data must be
sent from SQL nodes to NDBCLUSTER.
Tables created using previous MySQL Cluster releases can
still be used in MySQL Cluster 7.1.0 and later; however,
they do not support native default values until they are
upgraded. You can upgrade a table with non-native default
values to support native default values using an offline
ALTER TABLE statement.
Further enhancements based on this work that we hope to
implement in future MySQL Cluster releases include the
following:
Decrease NDB space
requirements, since there is no longer any need to
store the default value for every row
Implement REPLACE more
efficiently, because there is no need any longer to
read the current row before replacing it
Provide idempotency in replication for tables having
non-nullable columns
--nowait-nodes option for management
servers.
It is now possible to configure a cluster with two
management servers, but to start the cluster using only
one of them by starting the management node daemon with
the --nowait-nodes
option. The other management server can then be started at
a later time to join the running MySQL Cluster.
Heartbeat thread policy and priority.
Beginning with MySQL Cluster NDB 7.1.2, a new
configuration parameter
HeartbeatThreadPriority makes it
possible to set the policy and the priority for the
heartbeat thread on management and API nodes.
17.1.5. Known Limitations of MySQL Cluster
In the sections that follow, we discuss known limitations in
current releases of MySQL Cluster as compared with the features
available when using the MyISAM and
InnoDB storage engines. If you check the
“Cluster” category in the MySQL bugs database at
http://bugs.mysql.com, you can find known bugs in
the following categories under “MySQL Server:” in the
MySQL bugs database at http://bugs.mysql.com, which
we intend to correct in upcoming releases of MySQL Cluster:
This information is intended to be complete with respect to the
conditions just set forth. You can report any discrepancies that
you encounter to the MySQL bugs database using the instructions
given in Section 1.7, “How to Report Bugs or Problems”. If we do not plan to fix
the problem in MySQL Cluster NDB 6.X or 7.X, we will add it to the
list.
See Section 17.1.5.11, “Previous MySQL Cluster Issues Resolved in MySQL 5.1, MySQL Cluster NDB
6.x, and MySQL Cluster NDB 7.x” for a
list of issues in MySQL Cluster in MySQL 5.0 that
have been resolved in the current version.
17.1.5.1. Noncompliance with SQL Syntax in MySQL Cluster
Some SQL statements relating to certain MySQL features produce
errors when used with NDB tables,
as described in the following list:
Temporary tables.
Temporary tables are not supported. Trying either to
create a temporary table that uses the
NDB storage engine or to
alter an existing temporary table to use
NDB fails with the error
Table storage engine 'ndbcluster' does not
support the create option 'TEMPORARY'.
Indexes and keys in NDB tables.
Keys and indexes on MySQL Cluster tables are subject to
the following limitations:
Column width.
Attempting to create an index on an
NDB table column whose width is
greater than 3072 bytes succeeds, but only the first
3072 bytes are actually used for the index. In such
cases, a warning Specified key was too
long; max key length is 3072 bytes is
issued, and a SHOW CREATE
TABLE statement shows the length of the
index as 3072.
TEXT and
BLOB columns.
You cannot create indexes on
NDB table columns that
use any of the TEXT or
BLOB data types.
FULLTEXT indexes.
The NDB storage engine
does not support FULLTEXT indexes,
which are possible for MyISAM
tables only.
However, you can create indexes on
VARCHAR columns of
NDB tables.
Prefixes.
There are no prefix indexes; only entire columns can
be indexed. (The size of an NDB
column index is always the same as the width of the
column in bytes, up to and including 3072 bytes, as
described earlier in this section. Also see
Section 17.1.5.6, “Unsupported or Missing Features in MySQL Cluster”,
for additional information.)
BIT columns.
A BIT column cannot be
a primary key, unique key, or index, nor can it be
part of a composite primary key, unique key, or index.
AUTO_INCREMENT columns.
Like other MySQL storage engines, the
NDB storage engine can
handle a maximum of one
AUTO_INCREMENT column per table.
However, in the case of a Cluster table with no
explicit primary key, an
AUTO_INCREMENT column is
automatically defined and used as a
“hidden” primary key. For this reason,
you cannot define a table that has an explicit
AUTO_INCREMENT column unless that
column is also declared using the PRIMARY
KEY option. Attempting to create a table
with an AUTO_INCREMENT column that
is not the table's primary key, and using the
NDB storage engine, fails
with an error.
MySQL Cluster and geometry data types.
Geometry datatypes (WKT and
WKB) are supported in
NDB tables in MySQL 5.1
(including MySQL Cluster NDB 6.X and 7.X through 7.1).
However, spatial indexes are not supported.
Character sets and binary log files.
Currently, the ndb_apply_status and
ndb_binlog_index tables are created
using the latin1 (ASCII) character set.
Because names of binary logs are recorded in this table,
binary log files named using non-Latin characters are not
referenced correctly in these tables. This is a known
issue, which we are working to fix. (Bug#50226)
To work around this problem, use only Latin-1 characters
when naming binary log files or setting any the
--basedir,
--log-bin, or
--log-bin-index options.
Creating NDBCLUSTER tables with
user-defined partitioning.
Support for user-defined partitioning for MySQL Cluster in
MySQL 5.1 (including MySQL Cluster NDB 6.X and 7.X through
7.1) is restricted to [LINEAR]
KEY partitioning. Beginning with MySQL
5.1.12, using any other partitioning type with
ENGINE=NDB or
ENGINE=NDBCLUSTER in a
CREATE TABLE statement
results in an error.
Default partitioning scheme.
As of MySQL 5.1.6, all MySQL Cluster tables are by default
partitioned by KEY using the table's
primary key as the partitioning key. If no primary key is
explicitly set for the table, the “hidden”
primary key automatically created by the
NDBCLUSTER storage engine is
used instead. For additional discussion of these and
related issues, see Section 18.2.4, “KEY Partitioning”.
Beginning with MySQL Cluster NDB 6.2.18, MySQL Cluster NDB
6.3.25, and MySQL Cluster NDB 7.0.6,
CREATE TABLE and
ALTER TABLE statements that
would cause a user-partitioned
NDBCLUSTER table not to meet
either or both of the following two requirements are
disallowed, and fail with an error (Bug#40709):
The table must have an explicit primary key.
All columns listed in the table's partitioning
expression must be part of the primary key.
Exception.
If a user-partitioned
NDBCLUSTER table is created
using an empty column-list (that is, using
PARTITION BY [LINEAR] KEY()), then no
explicit primary key is required.
Maximum number of partitions for NDBCLUSTER
tables.
The maximum number of partitions that can defined for a
NDBCLUSTER table when
employing user-defined partitioning is 8 per node group.
(See Section 17.1.2, “MySQL Cluster Nodes, Node Groups, Replicas, and Partitions”, for
more information about MySQL Cluster node groups.
DROP PARTITION not supported.
It is not possible to drop partitions from
NDB tables using
ALTER TABLE ... DROP PARTITION. The
other partitioning extensions to
ALTER TABLE —
ADD PARTITION, REORGANIZE
PARTITION, and COALESCE
PARTITION — are supported for Cluster
tables, but use copying and so are not optimised. See
Section 18.3.1, “Management of RANGE and LIST
Partitions” and
Section 12.1.7, “ALTER TABLE Syntax”.
Row-based replication.
When using row-based replication with MySQL Cluster,
binary logging cannot be disabled. That is, the
NDB storage engine ignores
the value of sql_log_bin.
(Bug#16680)
17.1.5.2. Limits and Differences of MySQL Cluster from Standard MySQL Limits
In this section, we list limits found in MySQL Cluster that
either differ from limits found in, or that are not found in,
standard MySQL.
Memory usage and recovery.
Memory consumed when data is inserted into an
NDB table is not automatically
recovered when deleted, as it is with other storage engines.
Instead, the following rules hold true:
A DELETE statement on an
NDB table makes the memory
formerly used by the deleted rows available for re-use by
inserts on the same table only. This memory cannot be used
by other NDB tables.
A DROP TABLE or
TRUNCATE TABLE operation on
an NDB table frees the memory
that was used by this table for re-use by any
NDB table, either by the same
table or by another NDB table.
Memory freed by DELETE
operations but still allocated to a specific table can also
be made available for general re-use by performing a rolling
restart of the cluster. See
Section 17.2.6.1, “Performing a Rolling Restart of a MySQL Cluster”.
Beginning with MySQL Cluster NDB 6.3.7, this limitation can
be overcome using OPTIMIZE
TABLE. See
Section 17.1.5.11, “Previous MySQL Cluster Issues Resolved in MySQL 5.1, MySQL Cluster NDB
6.x, and MySQL Cluster NDB 7.x”, for
more information.
Limits imposed by the cluster's configuration.
A number of hard limits exist which are configurable, but
available main memory in the cluster sets limits. See the
complete list of configuration parameters in
Section 17.3.2, “MySQL Cluster Configuration Files”. Most
configuration parameters can be upgraded online. These
hard limits include:
Database memory size and index memory size
(DataMemory and
IndexMemory, respectively).
DataMemory is allocated as 32KB
pages. As each DataMemory page is
used, it is assigned to a specific table; once
allocated, this memory cannot be freed except by
dropping the table.
See Section 17.3.2.6, “Defining MySQL Cluster Data Nodes”, for
further information about DataMemory
and IndexMemory.
The maximum number of operations that can be performed
per transaction is set using the configuration
parameters
MaxNoOfConcurrentOperations and
MaxNoOfLocalOperations.
Note
Bulk loading, TRUNCATE
TABLE, and ALTER
TABLE are handled as special cases by
running multiple transactions, and so are not subject
to this limitation.
Different limits related to tables and indexes. For
example, the maximum number of ordered indexes in the
cluster is determined by
MaxNoOfOrderedIndexes, and the
maximum number of ordered inexes per table is 16.
Node and data object maximums.
The following limits apply to numbers of cluster nodes and
metadata objects:
The maximum number of data nodes is 48.
A data node must have a node ID in the range of 1 to 48,
inclusive. (Previous to MySQL Cluster NDB 6.1.1,
management and API nodes were restricted to the range 1
to 63 inclusive as a node ID; starting with MySQL
Cluster NDB 6.1.1, management and API nodes may use node
IDs in the range 1 to 255, inclusive.)
Prior to MySQL Cluster NDB 6.1.1, the total maximum
number of nodes in a MySQL Cluster was 63. Beginning
with MySQL Cluster NDB 6.1.1, the total maximum number
of nodes in a MySQL Cluster is 255. In either case, this
number includes all SQL nodes (MySQL Servers), API nodes
(applications accessing the cluster other than MySQL
servers), data nodes, and management servers.
The maximum number of metadata objects in current
versions of MySQL Cluster is 20320. This limit is
hard-coded.
See Section 17.1.5.11, “Previous MySQL Cluster Issues Resolved in MySQL 5.1, MySQL Cluster NDB
6.x, and MySQL Cluster NDB 7.x”,
for more information.
17.1.5.3. Limits Relating to Transaction Handling in MySQL Cluster
A number of limitations exist in MySQL Cluster with regard to
the handling of transactions. These include the following:
Transaction isolation level.
The NDBCLUSTER storage engine
supports only the READ
COMMITTED transaction isolation level.
(InnoDB, for example, supports
READ COMMITTED,
READ UNCOMMITTED,
REPEATABLE READ, and
SERIALIZABLE.) See
Section 17.5.3.4, “MySQL Cluster Backup Troubleshooting”,
for information on how this can affect backing up and
restoring Cluster databases.)
Transactions and BLOB or
TEXT columns.
NDBCLUSTER stores only part
of a column value that uses any of MySQL's
BLOB or
TEXT data types in the
table visible to MySQL; the remainder of the
BLOB or
TEXT is stored in a
separate internal table that is not accessible to MySQL.
This gives rise to two related issues of which you should
be aware whenever executing
SELECT statements on tables
that contain columns of these types:
For any SELECT from a
MySQL Cluster table: If the
SELECT includes a
BLOB or
TEXT column, the
READ COMMITTED
transaction isolation level is converted to a read with
read lock. This is done to guarantee consistency.
Prior to MySQL Cluster NDB 7.0.12, for any
SELECT which used a
primary key lookup or unique key lookup to retrieve any
columns that used any of the
BLOB or
TEXT data types and that
was executed within a transaction, a shared read lock
was held on the table for the duration of the
transaction — that is, until the transaction was
either committed or aborted.
In MySQL Cluster NDB 7.0.12 and later, for primary key
lookups, the lock is released as soon as all
BLOB or
TEXT data has been read.
(Bug#49190) However, for unique key lookups, the shared
lock continues to be held for the lifetime of the
transaction.
This issue does not occur for queries that use index or
table scans, even against
NDB tables having
BLOB or
TEXT columns.
For example, consider the table t
defined by the following CREATE
TABLE statement:
CREATE TABLE t (
a INT NOT NULL AUTO_INCREMENT PRIMARY KEY,
b INT NOT NULL,
c INT NOT NULL,
d TEXT,
INDEX i(b),
UNIQUE KEY u(c)
) ENGINE = NDB,
Either of the following queries on t
causes a shared read lock, because the first query uses
a primary key lookup and the second uses a unique key
lookup:
SELECT * FROM t WHERE a = 1;
SELECT * FROM t WHERE c = 1;
However, none of the four queries shown here causes a
shared read lock:
SELECT * FROM t WHERE b 1;
SELECT * FROM t WHERE d = '1';
SELECT * FROM t;
SELECT b,c WHERE a = 1;
This is because, of these four queries, the first uses
an index scan, the second and third use table scans, and
the fourth, while using a primary key lookup, does not
retrieve the value of any
BLOB or
TEXT columns.
You can help minimize issues with shared read locks by
avoiding queries that use unique key lookups (or primary
key lookups in MySQL Cluster NDB 7.0.11 and earlier)
that retrieve BLOB or
TEXT columns, or, in
cases where such queries are not avoidable, by
committing transactions as soon as possible afterwards.
Transactions and memory usage.
As noted elsewhere in this chapter, MySQL Cluster does not
handle large transactions well; it is better to perform a
number of small transactions with a few operations each
than to attempt a single large transaction containing a
great many operations. Among other considerations, large
transactions require very large amounts of memory. Because
of this, the transactional behavior of a number of MySQL
statements is effected as described in the following list:
TRUNCATE TABLE is not
transactional when used on
NDB tables. If a
TRUNCATE TABLE fails to
empty the table, then it must be re-run until it is
successful.
DELETE FROM (even with no
WHERE clause) is
transactional. For tables containing a great many rows,
you may find that performance is improved by using
several DELETE FROM ... LIMIT ...
statements to “chunk” the delete operation.
If your objective is to empty the table, then you may
wish to use TRUNCATE
TABLE instead.
LOAD DATA statements.
LOAD DATA
INFILE is not transactional when used on
NDB tables.
Important
When executing a
LOAD DATA
INFILE statement, the
NDB engine performs
commits at irregular intervals that enable better
utilization of the communication network. It is not
possible to know ahead of time when such commits take
place.
LOAD DATA FROM MASTER is not
supported in MySQL Cluster.
ALTER TABLE and transactions.
When copying an NDB table
as part of an ALTER
TABLE, the creation of the copy is
nontransactional. (In any case, this operation is
rolled back when the copy is deleted.)
Transactions and the COUNT() function.
When using MySQL Cluster Replication, it is not possible
to guarantee the transactional consistency of the
COUNT() function on the slave. In other
words, when performing on the master a series of
statements (INSERT,
DELETE, or both) that
changes the number of rows in a table within a single
transaction, executing SELECT COUNT(*) FROM
table queries on the
slave may yield intermediate results. This is due to the
fact that SELECT COUNT(...) may perform
dirty reads, and is not a bug in the
NDB storage engine. (See
Bug#31321 for more information.)
17.1.5.4. MySQL Cluster Error Handling
Starting, stopping, or restarting a node may give rise to
temporary errors causing some transactions to fail. These
include the following cases:
Temporary errors.
When first starting a node, it is possible that you may
see Error 1204 Temporary failure, distribution
changed and similar temporary errors.
Errors due to node failure.
The stopping or failure of any data node can result in a
number of different node failure errors. (However, there
should be no aborted transactions when performing a
planned shutdown of the cluster.)
In either of these cases, any errors that are generated must be
handled within the application. This should be done by retrying
the transaction.
See also Section 17.1.5.2, “Limits and Differences of MySQL Cluster from Standard MySQL Limits”.
17.1.5.5. Limits Associated with Database Objects in MySQL Cluster
Some database objects such as tables and indexes have different
limitations when using the
NDBCLUSTER storage engine:
Identifiers.
Database names, table names and attribute names cannot be
as long in NDB tables as when
using other table handlers. Attribute names are truncated
to 31 characters, and if not unique after truncation give
rise to errors. Database names and table names can total a
maximum of 122 characters. In other words, the maximum
length for an NDB table name
is 122 characters, less the number of characters in the
name of the database of which that table is a part.
Table names containing special characters.
NDB tables whose names
contain characters other than letters, numbers, dashes,
and underscores and which are created on one SQL node were
not always discovered correctly by other SQL nodes.
(Bug#31470)
Note
This issue was fixed in MySQL 5.1.23, MySQL Cluster NDB
6.2.7, and MySQL Cluster NDB 6.3.4.
Number of database objects.
The maximum number of all
NDB database objects in a
single MySQL Cluster — including databases, tables,
and indexes — is limited to 20320.
Attributes per table.
The maximum number of attributes (that is, columns and
indexes) per table is limited to 128.
Attributes per key.
The maximum number of attributes per key is 32.
Row size.
The maximum permitted size of any one row is 8KB. Note
that each BLOB or
TEXT column contributes 256
+ 8 = 264 bytes towards this total.
17.1.5.6. Unsupported or Missing Features in MySQL Cluster
A number of features supported by other storage engines are not
supported for NDB tables. Trying to
use any of these features in MySQL Cluster does not cause errors
in or of itself; however, errors may occur in applications that
expects the features to be supported or enforced:
Foreign key constraints.
The foreign key construct is ignored, just as it is in
MyISAM tables.
Index prefixes.
Prefixes on indexes are not supported for
NDBCLUSTER tables. If a prefix is used
as part of an index specification in a statement such as
CREATE TABLE,
ALTER TABLE, or
CREATE INDEX, the prefix is
ignored.
OPTIMIZE operations.
OPTIMIZE operations are not supported.
Beginning with MySQL Cluster NDB 6.3.7, this limitation has
been lifted. See
Section 17.1.5.11, “Previous MySQL Cluster Issues Resolved in MySQL 5.1, MySQL Cluster NDB
6.x, and MySQL Cluster NDB 7.x”, for
more information.
LOAD TABLE ... FROM MASTER.
LOAD TABLE ... FROM MASTER is not
supported.
Savepoints and rollbacks.
Savepoints and rollbacks to savepoints are ignored as in
MyISAM.
Durability of commits.
There are no durable commits on disk. Commits are
replicated, but there is no guarantee that logs are
flushed to disk on commit.
Replication.
Statement-based replication is not supported. Use
--binlog-format=ROW (or
--binlog-format=MIXED) when
setting up cluster replication. See
Section 17.6, “MySQL Cluster Replication”, for more
information.
InnoDB plugin not supported.
Currently, MySQL Cluster is not compatible with the
InnoDB Plugin. You must use the version
of InnoDB that is supplied
with the MySQL Server. See
Section 17.2.1, “MySQL Cluster Multi-Computer Installation”, for
information about enabling
InnoDB storage engine support
with MySQL Cluster.
17.1.5.7. Limitations Relating to Performance in MySQL Cluster
The following performance issues are specific to or especially
pronounced in MySQL Cluster:
Range scans.
There are query performance issues due to sequential
access to the NDB storage
engine; it is also relatively more expensive to do many
range scans than it is with either
MyISAM or InnoDB.
Reliability of Records in range.
The Records in range statistic is
available but is not completely tested or officially
supported. This may result in nonoptimal query plans in
some cases. If necessary, you can employ USE
INDEX or FORCE INDEX to alter
the execution plan. See Section 12.2.8.2, “Index Hint Syntax”, for
more information on how to do this.
Unique hash indexes.
Unique hash indexes created with USING
HASH cannot be used for accessing a table if
NULL is given as part of the key.
17.1.5.8. Issues Exclusive to MySQL Cluster
The following are limitations specific to the
NDBCLUSTER storage engine:
Machine architecture.
All machines used in the cluster must have the same
architecture. That is, all machines hosting nodes must be
either big-endian or little-endian, and you cannot use a
mixture of both. For example, you cannot have a management
node running on a PowerPC which directs a data node that
is running on an x86 machine. This restriction does not
apply to machines simply running mysql
or other clients that may be accessing the cluster's SQL
nodes.
Binary logging.
MySQL Cluster has the following limitations or
restrictions with regard to binary logging:
sql_log_bin has no
effect on data operations; however, it is supported for
schema operations.
MySQL Cluster cannot produce a binlog for tables having
BLOB columns but no
primary key.
Only the following schema operations are logged in a
cluster binlog which is not on the
mysqld executing the statement:
See also
Section 17.1.5.10, “Limitations Relating to Multiple MySQL Cluster Nodes”.
17.1.5.9. Limitations Relating to MySQL Cluster Disk Data StorageDisk Data object maxmimums and minimums.
Disk data objects are subject to the following maximums and
minimums:
Maximum number of tablespaces:
232 (4294967296)
Maximum number of data files per tablespace:
216 (65535)
The theoretical maximum number of extents per tablespace
data file is 216 (65525);
however, for practical purposes, the recommended maximum
number of extents per data file is
28 (32768).
Maximum data file size: The theoretical limit is 64G;
however, in MySQL 5.1 (including MySQL Cluster NDB 6.X and
7.X through 7.1), the practical upper limit is 32G. This is
equivalent to 32768 extents of 1M each.
The minimum and maximum possible sizes of extents for
tablespace data files are 32K and 2G, respectively. See
Section 12.1.18, “CREATE TABLESPACE Syntax”, for more information.
Disk Data tables and diskless mode.
Use of Disk Data tables is not supported when running the
cluster in diskless mode. Beginning with MySQL 5.1.12, it is
disallowed altogether. (Bug#20008)
17.1.5.10. Limitations Relating to Multiple MySQL Cluster NodesMultiple SQL nodes.
The following are issues relating to the use of multiple MySQL
servers as MySQL Cluster SQL nodes, and are specific to the
NDBCLUSTER storage engine:
No distributed table locks.
A LOCK TABLES works only
for the SQL node on which the lock is issued; no other SQL
node in the cluster “sees” this lock. This is
also true for a lock issued by any statement that locks
tables as part of its operations. (See next item for an
example.)
ALTER TABLE operations.
ALTER TABLE is not fully
locking when running multiple MySQL servers (SQL nodes).
(As discussed in the previous item, MySQL Cluster does not
support distributed table locks.)
Multiple management nodes.
When using multiple management servers:
You must give nodes explicit IDs in connectstrings because
automatic allocation of node IDs does not work across
multiple management servers.
You must take extreme care to have the same configurations
for all management servers. No special checks for this are
performed by the cluster.
Multiple network addresses.
Multiple network addresses per data node are not supported.
Use of these is liable to cause problems: In the event of a
data node failure, an SQL node waits for confirmation that the
data node went down but never receives it because another
route to that data node remains open. This can effectively
make the cluster inoperable.
Note
It is possible to use multiple network hardware
interfaces (such as Ethernet cards) for a
single data node, but these must be bound to the same address.
This also means that it not possible to use more than one
[tcp] section per connection in the
config.ini file. See
Section 17.3.2.8, “MySQL Cluster TCP/IP Connections”, for more
information.
17.1.5.11. Previous MySQL Cluster Issues Resolved in MySQL 5.1, MySQL Cluster NDB
6.x, and MySQL Cluster NDB 7.x
A number of limitations and related issues existing in earlier
versions of MySQL Cluster have been resolved:
Variable-length column support.
The NDBCLUSTER storage engine
now supports variable-length column types for in-memory
tables.
Previously, for example, any Cluster table having one or
more VARCHAR fields which
contained only relatively small values, much more memory and
disk space were required when using the
NDBCLUSTER storage engine than
would have been the case for the same table and data using
the MyISAM engine. In other words, in the
case of a VARCHAR column,
such a column required the same amount of storage as a
CHAR column of the same size.
In MySQL 5.1, this is no longer the case for in-memory
tables, where storage requirements for variable-length
column types such as VARCHAR
and BINARY are comparable to those for
these column types when used in MyISAM
tables (see Section 10.5, “Data Type Storage Requirements”).
Replication with MySQL Cluster.
It is now possible to use MySQL replication with Cluster
databases. For details, see
Section 17.6, “MySQL Cluster Replication”.
Circular Replication.
Circular replication is also supported with MySQL Cluster,
beginning with MySQL 5.1.18. See
Section 17.6.10, “MySQL Cluster Replication — Multi-Master and Circular Replication”.
auto_increment_increment and
auto_increment_offset.
The
auto_increment_increment
and auto_increment_offset
server system variables are supported for Cluster
replication beginning with MySQL 5.1.20, MySQL Cluster NDB
6.2.5, and MySQL Cluster 6.3.2.
Database autodiscovery and online schema changes.
Autodiscovery of databases is now supported for multiple
MySQL servers accessing the same MySQL Cluster. Formerly,
autodiscovery in MySQL Cluster 5.1 and MySQL Cluster NDB
6.x releases required that a given
mysqld was already running and
connected to the cluster at the time that the database was
created on a different mysqld —
in other words, when a mysqld process
connected to the cluster after a database named
db_name was created, it was
necessary to issue a CREATE DATABASE
db_name or
CREATE SCHEMA
db_name statement on
the “new” MySQL server when it first
accesseed that MySQL Cluster. Beginning with MySQL Cluster
NDB 6.2.16 and MySQL Cluster NDB 6.3.18, such a
CREATE statement is no longer required.
(Bug#39612)
This also means that online schema changes in
NDB tables are now possible.
That is, the result of operations such as
ALTER TABLE and
CREATE INDEX performed on one
SQL node in the cluster are now visible to the cluster's
other SQL nodes without any additional action being taken.
Backup and restore between architectures.
Beginning with MySQL 5.1.10, it is possible to perform a
Cluster backup and restore between different
architectures. Previously — for example — you
could not back up a cluster running on a big-endian
platform and then restore from that backup to a cluster
running on a little-endian system. (Bug#19255)
Character set directory.
Beginning with MySQL 5.1.10, it is possible to install
MySQL with Cluster support to a nondefault location and
change the search path for font description files using
either the --basedir or
--character-sets-dir
options. (Previously, ndbd in MySQL 5.1
searched only the default path — typically
/usr/local/mysql/share/mysql/charsets
— for character sets.)
Multiple management servers.
In MySQL 5.1 (including all MySQL Cluster NDB 6.x
versions), it is no longer necessary, when running
multiple management servers, to restart all the
cluster's data nodes to enable the management nodes
to see one another.
Also, when using multiple management servers and starting
concurrently several API nodes (possibly including one or
more SQL nodes) whose connectstrings listed the management
servers in different order, it was possible for 2 API nodes
to be assigned the same node ID. This issue is resolved in
MySQL Cluster NDB 6.2.17, 6.3.23, and 6.4.3. (Bug#42973)
Multiple data node processes per host.
Beginning with MySQL Cluster NDB 6.2.0, you can use
multiple data node processes on a single host. (In MySQL
Cluster NDB 6.1, MySQL 5.1, and earlier release series, we
did not support production MySQL Cluster deployments in
which more than one ndbd process was
run on a single physical machine.)
In addition, MySQL Cluster NDB 7.0 introduces support for
multi-threaded data nodes (ndbmtd). See
Section 17.1.4.5, “MySQL Cluster Development in MySQL Cluster NDB 7.0”, and
Section 17.4.3, “ndbmtd — The MySQL Cluster Data Node Daemon (Multi-Threaded)”, for more
information.
Length of CREATE TABLE statements.
CREATE TABLE statements may
be no more than 4096 characters in length. This
limitation affects MySQL 5.1.6, 5.1.7, and 5.1.8
only. (See Bug#17813)
IGNORE and REPLACE
functionality.
In MySQL 5.1.7 and earlier,
INSERT
IGNORE,
UPDATE
IGNORE, and
REPLACE were supported only
for primary keys, but not for unique keys. It was possible
to work around this issue by removing the constraint, then
dropping the unique index, performing any inserts, and
then adding the unique index again.
This limitation was removed for
INSERT
IGNORE and REPLACE
in MySQL 5.1.8. (See Bug#17431.)
AUTO_INCREMENT columns.
In MySQL 5.1.10 and earlier versions, the maximum number
of tables having AUTO_INCREMENT columns
— including those belonging to hidden primary keys
— was 2048.
This limitation was lifted in MySQL 5.1.11.
Maximum number of cluster nodes.
Prior to MySQL Cluster NDB 6.1.1, the total maximum number
of nodes in a MySQL Cluster was 63, including all SQL
nodes (MySQL Servers), API nodes (applications accessing
the cluster other than MySQL servers), data nodes, and
management servers.
Starting with MySQL Cluster NDB 6.1.1, the total maximum
number of nodes in a MySQL Cluster is 255, including all SQL
nodes (MySQL Servers), API nodes (applications accessing the
cluster other than MySQL servers), data nodes, and
management servers. The total number of data nodes and
management nodes beginning with this version is 63, of which
up to 48 can be data nodes.
Note
The limitation that a data node cannot have a node ID
greater than 49 continues to apply.
Recovery of memory from deleted rows.
Beginning with MySQL Cluster NDB 6.3.7, memory can be
reclaimed from an NDB table
for reuse with any NDB table
by employing OPTIMIZE
TABLE, subject to the following limitations:
You can regulate the effects of OPTIMIZE
on performance by adjusting the value of the global system
variable ndb_optimization_delay, which
sets the number of milliseconds to wait between batches of
rows being processed by OPTIMIZE. The
default value is 10 milliseconds. It is possible to set a
lower value (to a minimum of 0), but not
recommended. The maximum is 100000 milliseconds (that is,
100 seconds).
Implicit Rollbacks.
Prior to MySQL Cluster NDB 6.2.17 and MySQL Cluster NDB
6.3.19, MySQL Cluster did not automtically roll back a
transaction that was aborted by a duplicate key or similar
error, and subsequent statements raised ERROR
1296 (HY000): Got error 4350 'Transaction already aborted'
from NDBCLUSTER. In such cases, it was
necessary to issue an explicit
ROLLBACK
statement first, and then to retry the entire transaction.
Beginning with MySQL Cluster NDB 6.2.17 and MySQL Cluster
NDB 6.3.19, this limitation has been removed; now, an error
which causes a transaction to be aborted generates an
implicit rollback of the entire transaction. This is logged
with the warning Storage engine NDB does not
support rollback for this statement. Transaction rolled back
and must be restarted. A statement subsequent to
this starts a new transaction. (Bug#32656)
Note
The NDBCLUSTER storage engine
does not support partial transactions or partial rollbacks
of transactions in any version of MySQL Cluster.
Number of tables.
Previously, the maximum number of
NDBCLUSTER tables in a single
MySQL Cluster was 1792, but this is no longer the case in
MySQL 5.1 and later MySQL Cluster releases. However, the
number of tables is still included in the total maximum
number of NDBCLUSTER database
objects (20320). (See
Section 17.1.5.5, “Limits Associated with Database Objects in MySQL Cluster”.)
DDL operations.
Beginning with MySQL Cluster NDB 6.4.0, DDL operations
(such as CREATE TABLE or
ALTER TABLE) are protected
from data node failures. Previously, if a data node failed
while trying to perform one of these, the data dictionary
became locked and no further DDL statements could be
executed without restarting the cluster (Bug#36718).
Adding and dropping of data nodes.
In MySQL Cluster NDB 6.3 and previous versions of MySQL
Cluster, the online adding or dropping of data nodes was
not possible; such operations required a complete shutdown
and restart of the entire cluster. In MySQL Cluster NDB
7.0 (beginning with MySQL Cluster NDB 6.4.0) and later
MySQL Cluster release series, it is possible to add new
data nodes to a running MySQL Cluster by performing a
rolling restart, so that the cluster and the data stored
in it remain available to applications.
When planning to increase the number of data nodes in the
cluster online in MySQL Cluster NDB 7.0 or MySQL Cluster NDB
7.1, you should be aware of and take into account the
following issues:
New data nodes can be added online to a MySQL Cluster
only as part of a new node group.
New data nodes can be added online, but cannot yet be
dropped online. Reducing the number of data nodes still
requires a system restart of the cluster.
As in previous MySQL Cluster releases, it is not
possible to change online either the number of replicas
(NoOfReplicas configuration
parameter) or the number of data nodes per node group.
These changes require a system restart.
Redistribution of existing cluster data using the new
data nodes is not automatic; however, this can be
accomplished using simple SQL statements in the
mysql client or other MySQL client
application once the nodes have been added. During this
procedure, it is not possible to perform DDL operations,
although DML operations can continue as normal.
The distribution of new cluster data (that is, data
stored in the cluster after the new
nodes have been added) uses the new nodes without manual
intervention.
For more information, see
Section 17.5.11, “Adding MySQL Cluster Data Nodes Online”.
Native support for default column values.
Starting with MySQL Cluster NDB 7.1.0, default values for
table columns are stored by
NDBCLUSTER, rather than by
the MySQL server as was previously the case. Because less
data must be sent from an SQL node to the data nodes,
inserts on tables having column value defaults can be
performed more efficiently than before.
Tables created using previous MySQL Cluster releases can
still be used in MySQL Cluster 7.1.0 and later, although
they do not support native default values and continue to
use defaults supplied by the MySQL server until they are
upgraded. This can be done by means of an offline
ALTER TABLE statement.
Important
You cannot set or change a table column's default
value using an online ALTER
TABLE operation
17.2. MySQL Cluster Multi-Computer How-To
This section is a “How-To” that describes the basics
for how to plan, install, configure, and run a MySQL Cluster.
Whereas the examples in
Section 17.3, “MySQL Cluster Configuration” provide more in-depth
information on a variety of clustering options and configuration,
the result of following the guidelines and procedures outlined here
should be a usable MySQL Cluster which meets the
minimum requirements for availability and
safeguarding of data.
This section covers hardware and software requirements; networking
issues; installation of MySQL Cluster; configuration issues;
starting, stopping, and restarting the cluster; loading of a sample
database; and performing queries.
Basic assumptions.
This How-To makes the following
assumptions:
The cluster is to be set up with four nodes, each on a separate
host, and each with a fixed network address on a typical
Ethernet network as shown here:
This may be made clearer in the following diagram:
In the interest of simplicity (and reliability), this
How-To uses only numeric IP addresses.
However, if DNS resolution is available on your network, it is
possible to use host names in lieu of IP addresses in
configuring Cluster. Alternatively, you can use the
/etc/hosts file or your operating
system's equivalent for providing a means to do host lookup
if such is available.
Note
A common problem when trying to use host names for Cluster
nodes arises because of the way in which some operating
systems (including some Linux distributions) set up the
system's own host name in the /etc/hosts
during installation. Consider two machines with the host names
ndb1 and ndb2, both in
the cluster network domain. Red Hat Linux
(including some derivatives such as CentOS and Fedora) places
the following entries in these machines'
/etc/hosts files:
# ndb1 /etc/hosts:
127.0.0.1 ndb1.cluster ndb1 localhost.localdomain localhost
# ndb2 /etc/hosts:
127.0.0.1 ndb2.cluster ndb2 localhost.localdomain localhost
SUSE Linux (including OpenSUSE) places these entries in the
machines' /etc/hosts files:
# ndb1 /etc/hosts:
127.0.0.1 localhost
127.0.0.2 ndb1.cluster ndb1
# ndb2 /etc/hosts:
127.0.0.1 localhost
127.0.0.2 ndb2.cluster ndb2
In both instances, ndb1 routes
ndb1.cluster to a loopback IP address, but
gets a public IP address from DNS for
ndb2.cluster, while ndb2
routes ndb2.cluster to a loopback address
and obtains a public address for
ndb1.cluster. The result is that each data
node connects to the management server, but cannot tell when
any other data nodes have connected, and so the data nodes
appear to hang while starting.
You should also be aware that you cannot mix
localhost and other host names or IP
addresses in config.ini. For these
reasons, the solution in such cases (other than to use IP
addresses for all
config.ini HostName
entries) is to remove the fully qualified host names from
/etc/hosts and use these in
config.ini for all cluster hosts.
Each host in our scenario is an Intel-based desktop PC running a
common, generic Linux distribution installed to disk in a
standard configuration, and running no unnecessary services. The
core OS with standard TCP/IP networking capabilities should be
sufficient. Also for the sake of simplicity, we also assume that
the file systems on all hosts are set up identically. In the
event that they are not, you will need to adapt these
instructions accordingly.
Standard 100 Mbps or 1 gigabit Ethernet cards are installed on
each machine, along with the proper drivers for the cards, and
that all four hosts are connected via a standard-issue Ethernet
networking appliance such as a switch. (All machines should use
network cards with the same throughout. That is, all four
machines in the cluster should have 100 Mbps cards
or all four machines should have 1 Gbps
cards.) MySQL Cluster will work in a 100 Mbps network; however,
gigabit Ethernet will provide better performance.
Note that MySQL Cluster is not intended for
use in a network for which throughput is less than 100 Mbps. For
this reason (among others), attempting to run a MySQL Cluster
over a public network such as the Internet is not likely to be
successful, and is not recommended.
For our sample data, we will use the world
database which is available for download from the MySQL Web
site. As this database takes up a relatively small amount of
space, we assume that each machine has 256MB RAM, which should
be sufficient for running the operating system, host NDB
process, and (for the data nodes) for storing the database.
Although we refer to a Linux operating system in this How-To, the
instructions and procedures that we provide here should be easily
adaptable to other supported operating systems. We also assume that
you already know how to perform a minimal installation and
configuration of the operating system with networking capability, or
that you are able to obtain assistance in this elsewhere if needed.
For information about MySQL Cluster hardware, software, and
networking requirements, see
Section 17.1.3, “MySQL Cluster Hardware, Software, and Networking Requirements”.
17.2.1. MySQL Cluster Multi-Computer Installation
Each MySQL Cluster host computer running an SQL node must have
installed on it a MySQL binary. For management nodes and data
nodes, it is not necessary to install the MySQL server binary, but
management nodes require the management server daemon
(ndb_mgmd) and data nodes require the data node
daemon (ndbd; in MySQL Cluster NDB 7.0 and
later, you can use ndbmtd instead). It is also
a good idea to install the management client
(ndb_mgm) on the management server host. This
section covers the steps necessary to install the correct binaries
for each type of Cluster node.
Sun Microsystems, Inc. provides precompiled binaries that support
Cluster. However, we also include information relating to
installing a MySQL Cluster after building MySQL from source. For
setting up a cluster using MySQL's binaries, the first step
in the installation process for each cluster host is to download
the latest MySQL Cluster NDB 6.2, MySQL Cluster NDB 6.3, or MySQL
Cluster NDB 7.0 binary archive
(mysql-cluster-gpl-6.2.19-linux-i686-glibc23.tar.gz,
mysql-cluster-gpl-6.3.32-linux-i686-glibc23.tar.gz,
or
mysql-cluster-gpl-7.0.12-linux-i686-glibc23.tar.gz,
respectively) from the
MySQL Cluster downloads
area. We assume that you have placed this file in each
machine's /var/tmp directory. (If you do
require a custom binary, see
Section 2.3.3, “Installing from the Development Source Tree”.)
When compiling MySQL Cluster NDB 7.0 from source, no special
options are required for building multi-threaded data node
binaries. On Unix platforms, configuring the build with any of the
options --plugins=max,
--plugins=max-no-innodb, or
--with-ndbcluster causes
ndbmtd to be built automatically; make
install places the ndbmtd binary in
the libexec directory along with
mysqld, ndbd, and
ndb_mgm.
On Windows, beginning with MySQL Cluster NDB 7.0.11, using
WITH_NDBCLUSTER_STORAGE_ENGINE with
configure.js causes
ndbmtd.exe to be built automatically, and to be
found in the bin directory of the archive
created by make_win_bin_dist.
Important
Currently, MySQL Cluster is not compatible with the
InnoDB Plugin. You must use the version of
InnoDB that is supplied with the
MySQL Server. You can build MySQL Cluster with
InnoDB storage engine support using
the --with-plugins=max or
--with-innodb option for
configure.
This is a known issue, which we are working to address in a
future MySQL Cluster release.
RPMs are also available for both 32-bit and 64-bit Linux
platforms. For a MySQL Cluster, three RPMs are required:
The Server RPM (for example,
MySQL-Cluster-gpl-server-6.2.19-0.sles10.i586.rpm,
MySQL-Cluster-gpl-server-6.3.32-0.sles10.i586.rpm,
or
MySQL-Cluster-gpl-server-7.0.12-0.sles10.i586.rpm),
which supplies the core files needed to run a MySQL Server
with NDBCLUSTER storage engine
support (that is, as a MySQL Cluster SQL node).
If you do not have your own client application capable of
administering a MySQL server, you should also obtain and
install the Client RPM (for
example,
MySQL-Cluster-gpl-client-6.2.19-0.sles10.i586.rpm,
MySQL-Cluster-gpl-client-6.3.32-0.sles10.i586.rpm,
or
MySQL-Cluster-gpl-client-7.0.12-0.sles10.i586.rpm).
The Cluster storage engine
RPM (for example,
MySQL-Cluster-gpl-storage-6.2.19-0.sles10.i586.rpm,
MySQL-Cluster-gpl-storage-6.3.32-0.sles10.i586.rpm,
or
MySQL-Cluster-gpl-storage-7.0.12-0.sles10.i586.rpm),
which supplies the MySQL Cluster data node binary
(ndbd).
The Cluster storage engine management
RPM (for example,
MySQL-Cluster-gpl-management-6.2.19-0.sles10.i586.rpm,
MySQL-Cluster-gpl-management-6.3.32-0.sles10.i586.rpm,
or
MySQL-Cluster-gpl-management-7.0.12-0.sles10.i586.rpm)
which provides the MySQL Cluster management server binary
(ndb_mgmd).
In addition, you should also obtain the NDB
Cluster - Storage engine basic tools RPM (for example,
MySQL-Cluster-gpl-tools-6.2.19-0.sles10.i586.rpm,
MySQL-Cluster-gpl-tools-6.3.32-0.sles10.i586.rpm,
or
MySQL-Cluster-gpl-tools-7.0.12-0.sles10.i586.rpm),
which supplies several useful applications for working with a
MySQL Cluster. The most important of these is the MySQL Cluster
management client (ndb_mgm). The
NDB Cluster - Storage engine extra
tools RPM (for example,
MySQL-Cluster-gpl-extra-6.2.19-0.sles10.i586.rpm,
MySQL-Cluster-gpl-extra-6.3.32-0.sles10.i586.rpm,
or
MySQL-Cluster-gpl-extra-7.0.12-0.sles10.i586.rpm)
contains some additional testing and monitoring programs, but is
not required to install a MySQL Cluster. (For more information
about these additional programs, see
Section 17.4, “MySQL Cluster Programs”.)
The MySQL Cluster version number in the RPM file names (shown here
as 6.2.19,
6.3.32, or
7.0.12) can vary according to
the version which you are actually using. It is very
important that all of the Cluster RPMs to be installed have the
same version number. The glibc
version number (if present), and architecture designation (shown
here as i586) should be appropriate to the
machine on which the RPM is to be installed.
See Section 2.6.1, “Installing MySQL from RPM Packages on Linux”, for general information about
installing MySQL using RPMs supplied by Sun Microsystems, Inc.
After installing from RPM, you still need to configure the cluster
as discussed in Section 17.2.2, “MySQL Cluster Multi-Computer Configuration”.
Note
After completing the installation, do not yet start any of the
binaries. We show you how to do so following the configuration
of all nodes.
Data and SQL Node Installation — .tar.gz
Binary.
On each of the machines designated to host data or SQL nodes,
perform the following steps as the system
root user:
Check your /etc/passwd and
/etc/group files (or use whatever
tools are provided by your operating system for managing
users and groups) to see whether there is already a
mysql group and
mysql user on the system. Some OS
distributions create these as part of the operating system
installation process. If they are not already present,
create a new mysql user group, and then
add a mysql user to this group:
shell> groupadd mysql
shell> useradd -g mysql mysql
The syntax for useradd and
groupadd may differ slightly on
different versions of Unix, or they may have different
names such as adduser and
addgroup.
Change location to the directory containing the downloaded
file, unpack the archive, and create a symlink to the
mysql directory named
mysql. Note that the actual file and
directory names will vary according to the MySQL Cluster
version number.
shell> cd /var/tmp
shell> tar -C /usr/local -xzvf mysql-cluster-gpl-7.0.12-linux-i686-glibc23.tar.gz
shell> ln -s /usr/local/mysql-cluster-gpl-7.0.12-linux-i686-glibc23.tar.gz /usr/local/mysql
Change location to the mysql
directory and run the supplied script for creating the
system databases:
shell> cd mysql
shell> scripts/mysql_install_db --user=mysql
Set the necessary permissions for the MySQL server and
data directories:
shell> chown -R root .
shell> chown -R mysql data
shell> chgrp -R mysql .
Note that the data directory on each machine hosting a
data node is /usr/local/mysql/data.
This piece of information is essential when configuring
the management node. (See
Section 17.2.2, “MySQL Cluster Multi-Computer Configuration”.)
Copy the MySQL startup script to the appropriate
directory, make it executable, and set it to start when
the operating system is booted up:
shell> cp support-files/mysql.server /etc/rc.d/init.d/
shell> chmod +x /etc/rc.d/init.d/mysql.server
shell> chkconfig --add mysql.server
(The startup scripts directory may vary depending on your
operating system and version — for example, in some
Linux distributions, it is
/etc/init.d.)
Here we use Red Hat's chkconfig for
creating links to the startup scripts; use whatever means
is appropriate for this purpose on your operating system
and distribution, such as update-rc.d
on Debian.
Remember that the preceding steps must be repeated on each
machine where an SQL node is to reside.
SQL node installation — RPM files.
On each machine to be used for hosting a cluster SQL node,
install the Server RPM by
executing the following command as the system root user,
replacing the name shown for the RPM as necessary to match the
name of the RPM downloaded from the MySQL web site:
shell> rpm -Uhv MySQL-Cluster-gpl-server-7.0.12-0.sles10.i586.rpm
This installs the MySQL server binary
(mysqld) in the
/usr/sbin directory, as well as all needed
MySQL Server support files. It also installs the
mysql.server and
mysqld_safe startup scripts in
/usr/share/mysql and
/usr/bin, respectively. The RPM installer
should take care of general configuration issues (such as
creating the mysql user and group, if needed)
automatically.
Note
To administer the SQL node (MySQL server), you should also
install the Client RPM, as
shown here:
shell> rpm -Uhv MySQL-Cluster-gpl-client-7.0.12-0.sles10.i586.rpm
This installs the mysql client program.
SQL node installation — building from source.
If you compile MySQL with clustering support (for example, by
using the
BUILD/compile-platform_name-max
script appropriate to your platform), and perform the default
installation (using make install as the root
user), mysqld is placed in
/usr/local/mysql/bin. Follow the steps
given in Section 2.3, “MySQL Installation Using a Source Distribution” to make
mysqld ready for use. If you want to run
multiple SQL nodes, you can use a copy of the same
mysqld executable and its associated support
files on several machines. The easiest way to do this is to copy
the entire /usr/local/mysql directory and
all directories and files contained within it to the other SQL
node host or hosts, then repeat the steps from
Section 2.3, “MySQL Installation Using a Source Distribution” on each machine. If you
configure the build with a nondefault
--prefix, you need to adjust
the directory accordingly.
Data node installation — RPM Files.
On a computer that is to host a cluster data node it is
necessary to install only the NDB Cluster
- Storage engine RPM. To do so, copy this RPM to the
data node host, and run the following command as the system root
user, replacing the name shown for the RPM as necessary to match
that of the RPM downloaded from the MySQL web site:
shell> rpm -Uhv MySQL-Cluster-gpl-storage-7.0.12-0.sles10.i586.rpm
The previous command installs the MySQL Cluster data node binary
(ndbd) in the /usr/sbin
directory.
Data node installation — building from source.
The only executable required on a data node host is
ndbd or (in MySQL Cluster NDB 7.0 and later)
ndbmtd (mysqld, for
example, does not have to be present on the host machine). By
default when doing a source build, this file is placed in the
directory /usr/local/mysql/libexec. For
installing on multiple data node hosts, only
ndbd need be copied to the other host machine
or machines. (This assumes that all data node hosts use the same
architecture and operating system; otherwise you may need to
compile separately for each different platform.)
ndbd need not be in any particular location
on the host's file system, as long as the location is known.
Note
ndbmtd was not built on Windows prior to
MySQL Cluster NDB 7.0.11.
Management node installation — .tar.gz binary.
Installation of the management node does not require the
mysqld binary. Only the MySQL Cluster
management server (ndb_mgmd) is required; you
most likely want to install the management client
(ndb_mgm) as well. Both of these binaries
also be found in the .tar.gz archive.
Again, we assume that you have placed this archive in
/var/tmp.
As system root (that is, after using
sudo, su root, or your
system's equivalent for temporarily assuming the system
administrator account's privileges), perform the following steps
to install ndb_mgmd and
ndb_mgm on the Cluster management node host:
Change location to the /var/tmp
directory, and extract the ndb_mgm and
ndb_mgmd from the archive into a suitable
directory such as /usr/local/bin:
shell> cd /var/tmp
shell> tar -zxvf mysql-5.1.41-ndb-7.0.12-linux-i686-glibc23.tar.gz
shell> cd mysql-5.1.41-ndb-7.0.12-linux-i686-glibc23
shell> cp bin/ndb_mgm* /usr/local/bin
(You can safely delete the directory created by unpacking
the downloaded archive, and the files it contains, from
/var/tmp once
ndb_mgm and ndb_mgmd
have been copied to the executables directory.)
Change location to the directory into which you copied the
files, and then make both of them executable:
shell> cd /usr/local/bin
shell> chmod +x ndb_mgm*
Management node installation — RPM file.
To install the MySQL Cluster management server, it is necessary
only to use the NDB Cluster - Storage
engine management RPM. Copy this RPM to the computer
intended to host the management node, and then install it by
running the following command as the system root user (replace
the name shown for the RPM as necessary to match that of the
Storage engine management RPM
downloaded from the MySQL web site):
shell> rpm -Uhv MySQL-Cluster-gpl-management-7.0.12-0.sles10.i586.rpm
This installs the management server binary
(ndb_mgmd) to the
/usr/sbin directory.
You should also install the NDB
management client, which is supplied by the
Storage engine basic tools RPM.
Copy this RPM to the same computer as the management node, and
then install it by running the following command as the system
root user (again, replace the name shown for the RPM as necessary
to match that of the Storage engine basic
tools RPM downloaded from the MySQL web site):
shell> rpm -Uhv MySQL-Cluster-gpl-tools-7.0.12-0.sles10.i586.rpm
The Storage engine basic tools
RPM installs the MySQL Cluster management client
(ndb_mgm) to the /usr/bin
directory.
Note
You can also install the Cluster storage
engine extra tools RPM, if you wish, as shown here:
shell> rpm -Uhv MySQL-Cluster-gpl-extra-7.0.12-0.sles10.i586.rpm
You may find the extra tools useful; however the
Cluster storage engine extra
tools RPM is not required to
install a working MySQL Cluster.
Management node installation — building from source.
When building from source and running the default make
install, the management server binary
(ndb_mgmd) is placed in
/usr/local/mysql/libexec, while the
management client binary (ndb_mgm) can be
found in /usr/local/mysql/bin. Only
ndb_mgmd is required to be present on a
management node host; however, it is also a good idea to have
ndb_mgm present on the same host machine.
Neither of these executables requires a specific location on the
host machine's file system.
In Section 17.2.2, “MySQL Cluster Multi-Computer Configuration”, we create
configuration files for all of the nodes in our example MySQL
Cluster.
MySQL Cluster on Windows (alpha).
In MySQL Cluster NDB 7.0, experimental support is added for
Microsoft Windows platforms. To compile MySQL Cluster from
source on Windows, you must configure the build using the
WITH_NDBCLUSTER_STORAGE_ENGINE option before
creating the Visual Studio project files. After running
make_win_bin_dist, the MySQL Cluster binaries
can be found in the bin directory of the
resulting archive. For more information, see
Section 2.5.10, “Installing MySQL from Source on Windows”.
17.2.2. MySQL Cluster Multi-Computer Configuration
For our four-node, four-host MySQL Cluster, it is necessary to
write four configuration files, one per node host.
Each data node or SQL node requires a
my.cnf file that provides two pieces of
information: a connectstring that tells
the node where to find the management node, and a line telling
the MySQL server on this host (the machine hosting the data
node) to enable the NDBCLUSTER
storage engine.
For more information on connectstrings, see
Section 17.3.2.3, “The MySQL Cluster Connectstring”.
The management node needs a config.ini
file telling it how many replicas to maintain, how much memory
to allocate for data and indexes on each data node, where to
find the data nodes, where to save data to disk on each data
node, and where to find any SQL nodes.
Configuring the Storage and SQL
Nodes
The my.cnf file needed for the data nodes is
fairly simple. The configuration file should be located in the
/etc directory and can be edited using any
text editor. (Create the file if it does not exist.) For example:
shell> vi /etc/my.cnf
Note
We show vi being used here to create the
file, but any text editor should work just as well.
For each data node and SQL node in our example setup,
my.cnf should look like this:
# Options for mysqld process:
[mysqld]
ndbcluster # run NDB storage engine
ndb-connectstring=192.168.0.10 # location of management server
# Options for ndbd process:
[mysql_cluster]
ndb-connectstring=192.168.0.10 # location of management server
After entering the preceding information, save this file and exit
the text editor. Do this for the machines hosting data node
“A”, data node “B”, and the SQL node.
Important
Once you have started a mysqld process with
the NDBCLUSTER and
ndb-connectstring parameters in the
[mysqld] in the my.cnf
file as shown previously, you cannot execute any
CREATE TABLE or
ALTER TABLE statements without
having actually started the cluster. Otherwise, these statements
will fail with an error. This is by design.
Configuring the management node.
The first step in configuring the management node is to create
the directory in which the configuration file can be found and
then to create the file itself. For example (running as
root):
shell> mkdir /var/lib/mysql-cluster
shell> cd /var/lib/mysql-cluster
shell> vi config.ini
For our representative setup, the config.ini
file should read as follows:
# Options affecting ndbd processes on all data nodes:
[ndbd default]
NoOfReplicas=2 # Number of replicas
DataMemory=80M # How much memory to allocate for data storage
IndexMemory=18M # How much memory to allocate for index storage
# For DataMemory and IndexMemory, we have used the
# default values. Since the "world" database takes up
# only about 500KB, this should be more than enough for
# this example Cluster setup.
# TCP/IP options:
[tcp default]
portnumber=2202 # This the default; however, you can use any port that is free
# for all the hosts in the cluster
# Note: It is recommended that you do not specify the port
# number at all and allow the default value to be used instead
# Management process options:
[ndb_mgmd]
hostname=192.168.0.10 # Hostname or IP address of management node
datadir=/var/lib/mysql-cluster # Directory for management node log files
# Options for data node "A":
[ndbd]
# (one [ndbd] section per data node)
hostname=192.168.0.30 # Hostname or IP address
datadir=/usr/local/mysql/data # Directory for this data node's data files
# Options for data node "B":
[ndbd]
hostname=192.168.0.40 # Hostname or IP address
datadir=/usr/local/mysql/data # Directory for this data node's data files
# SQL node options:
[mysqld]
hostname=192.168.0.20 # Hostname or IP address
# (additional mysqld connections can be
# specified for this node for various
# purposes such as running ndb_restore)
After all the configuration files have been created and these
minimal options have been specified, you are ready to proceed with
starting the cluster and verifying that all processes are running.
We discuss how this is done in
Section 17.2.3, “Initial Startup of MySQL Cluster”.
For more detailed information about the available MySQL Cluster
configuration parameters and their uses, see
Section 17.3.2, “MySQL Cluster Configuration Files”, and
Section 17.3, “MySQL Cluster Configuration”. For configuration
of MySQL Cluster as relates to making backups, see
Section 17.5.3.3, “Configuration for MySQL Cluster Backups”.
Note
The default port for Cluster management nodes is 1186; the
default port for data nodes is 2202. However, the cluster can
automatically allocate ports for data nodes from those that are
already free.
17.2.3. Initial Startup of MySQL Cluster
Starting the cluster is not very difficult after it has been
configured. Each cluster node process must be started separately,
and on the host where it resides. The management node should be
started first, followed by the data nodes, and then finally by any
SQL nodes:
On the management host, issue the following command from the
system shell to start the management node process:
shell> ndb_mgmd -f /var/lib/mysql-cluster/config.ini
On each of the data node hosts, run this command to start the
ndbd process:
shell> ndbd
If you used RPM files to install MySQL on the cluster host
where the SQL node is to reside, you can (and should) use the
supplied startup script to start the MySQL server process on
the SQL node.
If all has gone well, and the cluster has been set up correctly,
the cluster should now be operational. You can test this by
invoking the ndb_mgm management node client.
The output should look like that shown here, although you might
see some slight differences in the output depending upon the exact
version of MySQL that you are using:
shell> ndb_mgm
-- NDB Cluster -- Management Client --
ndb_mgm> SHOW
Connected to Management Server at: localhost:1186
Cluster Configuration
---------------------
[ndbd(NDB)] 2 node(s)
id=2 @192.168.0.30 (Version: 5.1.41-ndb-6.3.32, Nodegroup: 0, Master)
id=3 @192.168.0.40 (Version: 5.1.41-ndb-6.3.32, Nodegroup: 0)
[ndb_mgmd(MGM)] 1 node(s)
id=1 @192.168.0.10 (Version: 5.1.41-ndb-6.3.32)
[mysqld(API)] 1 node(s)
id=4 @192.168.0.20 (Version: 5.1.41-ndb-6.3.32)
The SQL node is referenced here as
[mysqld(API)], which reflects the fact that the
mysqld process is acting as a MySQL Cluster API
node.
Note
The IP address shown for a given MySQL Cluster SQL or other API
node in the output of SHOW
is the address used by the SQL or API node to connect to the
cluster data nodes, and not to any management node.
You should now be ready to work with databases, tables, and data
in MySQL Cluster. See
Section 17.2.4, “Loading Sample Data into MySQL Cluster and Performing Queries”, for a
brief discussion.
17.2.4. Loading Sample Data into MySQL Cluster and Performing Queries
Working with data in MySQL Cluster is not much different from
doing so in MySQL without Cluster. There are two points to keep in
mind:
For a table to be replicated in the cluster, it must use the
NDBCLUSTER storage engine. To
specify this, use the ENGINE=NDBCLUSTER or
ENGINE=NDB option when creating the table:
CREATE TABLE tbl_name (col_name column_definitions) ENGINE=NDBCLUSTER;
Alternatively, for an existing table that uses a different
storage engine, use ALTER TABLE
to change the table to use
NDBCLUSTER:
ALTER TABLE tbl_name ENGINE=NDBCLUSTER;
Each NDBCLUSTER table
must have a primary key. If no primary
key is defined by the user when a table is created, the
NDBCLUSTER storage engine
automatically generates a hidden one.
Note
This hidden key takes up space just as does any other table
index. It is not uncommon to encounter problems due to
insufficient memory for accommodating these automatically
created indexes.)
If you are importing tables from an existing database using the
output of mysqldump, you can open the SQL
script in a text editor and add the ENGINE
option to any table creation statements, or replace any existing
ENGINE (or TYPE) options.
Suppose that you have the world sample database
on another MySQL server that does not support MySQL Cluster, and
you want to export the City table:
shell> mysqldump --add-drop-table world City > city_table.sql
The resulting city_table.sql file will
contain this table creation statement (and the
INSERT statements necessary to
import the table data):
DROP TABLE IF EXISTS `City`;
CREATE TABLE `City` (
`ID` int(11) NOT NULL auto_increment,
`Name` char(35) NOT NULL default '',
`CountryCode` char(3) NOT NULL default '',
`District` char(20) NOT NULL default '',
`Population` int(11) NOT NULL default '0',
PRIMARY KEY (`ID`)
) ENGINE=MyISAM DEFAULT CHARSET=latin1;
INSERT INTO `City` VALUES (1,'Kabul','AFG','Kabol',1780000);
INSERT INTO `City` VALUES (2,'Qandahar','AFG','Qandahar',237500);
INSERT INTO `City` VALUES (3,'Herat','AFG','Herat',186800);
(remaining INSERT statements omitted)
You need to make sure that MySQL uses the
NDBCLUSTER storage engine for this
table. There are two ways that this can be accomplished. One of
these is to modify the table definition
before importing it into the Cluster
database. Using the City table as an example,
modify the ENGINE option of the definition as
follows:
DROP TABLE IF EXISTS `City`;
CREATE TABLE `City` (
`ID` int(11) NOT NULL auto_increment,
`Name` char(35) NOT NULL default '',
`CountryCode` char(3) NOT NULL default '',
`District` char(20) NOT NULL default '',
`Population` int(11) NOT NULL default '0',
PRIMARY KEY (`ID`)
) ENGINE=NDBCLUSTER DEFAULT CHARSET=latin1;
INSERT INTO `City` VALUES (1,'Kabul','AFG','Kabol',1780000);
INSERT INTO `City` VALUES (2,'Qandahar','AFG','Qandahar',237500);
INSERT INTO `City` VALUES (3,'Herat','AFG','Herat',186800);
(remaining INSERT statements omitted)
This must be done for the definition of each table that is to be
part of the clustered database. The easiest way to accomplish this
is to do a search-and-replace on the file that contains the
definitions and replace all instances of
TYPE=engine_name or
ENGINE=engine_name
with ENGINE=NDBCLUSTER. If you do not want to
modify the file, you can use the unmodified file to create the
tables, and then use ALTER TABLE to
change their storage engine. The particulars are given later in
this section.
Assuming that you have already created a database named
world on the SQL node of the cluster, you can
then use the mysql command-line client to read
city_table.sql, and create and populate the
corresponding table in the usual manner:
shell> mysql world < city_table.sql
It is very important to keep in mind that the preceding command
must be executed on the host where the SQL node is running (in
this case, on the machine with the IP address
192.168.0.20).
To create a copy of the entire world database
on the SQL node, use mysqldump on the
noncluster server to export the database to a file named
world.sql; for example, in the
/tmp directory. Then modify the table
definitions as just described and import the file into the SQL
node of the cluster like this:
shell> mysql world < /tmp/world.sql
If you save the file to a different location, adjust the preceding
instructions accordingly.
Running SELECT queries on the SQL
node is no different from running them on any other instance of a
MySQL server. To run queries from the command line, you first need
to log in to the MySQL Monitor in the usual way (specify the
root password at the Enter
password: prompt):
shell> mysql -u root -p
Enter password:
Welcome to the MySQL monitor. Commands end with ; or \g.
Your MySQL connection id is 1 to server version: 5.1.41-ndb-6.2.19
Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
mysql>
We simply use the MySQL server's root
account and assume that you have followed the standard security
precautions for installing a MySQL server, including setting a
strong root password. For more information, see
Section 2.13.2, “Securing the Initial MySQL Accounts”.
It is worth taking into account that Cluster nodes do
not make use of the MySQL privilege system
when accessing one another. Setting or changing MySQL user
accounts (including the root account) effects
only applications that access the SQL node, not interaction
between nodes. See
Section 17.5.9.2, “MySQL Cluster and MySQL Privileges”, for
more information.
If you did not modify the ENGINE clauses in the
table definitions prior to importing the SQL script, you should
run the following statements at this point:
mysql> USE world;
mysql> ALTER TABLE City ENGINE=NDBCLUSTER;
mysql> ALTER TABLE Country ENGINE=NDBCLUSTER;
mysql> ALTER TABLE CountryLanguage ENGINE=NDBCLUSTER;
Selecting a database and running a SELECT query
against a table in that database is also accomplished in the usual
manner, as is exiting the MySQL Monitor:
mysql> USE world;
mysql> SELECT Name, Population FROM City ORDER BY Population DESC LIMIT 5;
+-----------+------------+
| Name | Population |
+-----------+------------+
| Bombay | 10500000 |
| Seoul | 9981619 |
| S?o Paulo | 9968485 |
| Shanghai | 9696300 |
| Jakarta | 9604900 |
+-----------+------------+
5 rows in set (0.34 sec)
mysql> \q
Bye
shell>
Applications that use MySQL can employ standard APIs to access
NDB tables. It is important to
remember that your application must access the SQL node, and not
the management or data nodes. This brief example shows how we
might execute the SELECT statement
just shown by using the PHP 5.X mysqli
extension running on a Web server elsewhere on the network:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type"
content="text/html; charset=iso-8859-1">
<title>SIMPLE mysqli SELECT</title>
</head>
<body>
<?php
# connect to SQL node:
$link = new mysqli('192.168.0.20', 'root', 'root_password', 'world');
# parameters for mysqli constructor are:
# host, user, password, database
if( mysqli_connect_errno() )
die("Connect failed: " . mysqli_connect_error());
$query = "SELECT Name, Population
FROM City
ORDER BY Population DESC
LIMIT 5";
# if no errors...
if( $result = $link->query($query) )
{
?>
<table border="1" width="40%" cellpadding="4" cellspacing ="1">
<tbody>
<tr>
<th width="10%">City</th>
<th>Population</th>
</tr>
<?
# then display the results...
while($row = $result->fetch_object())
printf("<tr>\n <td align=\"center\">%s</td><td>%d</td>\n</tr>\n",
$row->Name, $row->Population);
?>
</tbody
</table>
<?
# ...and verify the number of rows that were retrieved
printf("<p>Affected rows: %d</p>\n", $link->affected_rows);
}
else
# otherwise, tell us what went wrong
echo mysqli_error();
# free the result set and the mysqli connection object
$result->close();
$link->close();
?>
</body>
</html>
We assume that the process running on the Web server can reach the
IP address of the SQL node.
In a similar fashion, you can use the MySQL C API, Perl-DBI,
Python-mysql, or MySQL Connectors to perform the tasks of data
definition and manipulation just as you would normally with MySQL.
17.2.5. Safe Shutdown and Restart of MySQL Cluster
To shut down the cluster, enter the following command in a shell
on the machine hosting the management node:
shell> ndb_mgm -e shutdown
The -e option here is used to pass a command to
the ndb_mgm client from the shell. (See
Section 17.4.23, “Options Common to MySQL Cluster Programs”, for more
information about this option.) The command causes the
ndb_mgm, ndb_mgmd, and any
ndbd processes to terminate gracefully. Any SQL
nodes can be terminated using mysqladmin
shutdown and other means.
To restart the cluster, run these commands:
On the management host (192.168.0.10 in our
example setup):
shell> ndb_mgmd -f /var/lib/mysql-cluster/config.ini
On each of the data node hosts
(192.168.0.30 and
192.168.0.40):
shell> ndbd
On the SQL host (192.168.0.20):
shell> mysqld_safe &
In a production setting, it is usually not desirable to shut down
the cluster completely. In many cases, even when making
configuration changes, or performing upgrades to the cluster
hardware or software (or both), which require shutting down
individual host machines, it is possible to do so without shutting
down the cluster as a whole by performing a rolling
restart of the cluster. For more information about
doing this, see Section 17.2.6.1, “Performing a Rolling Restart of a MySQL Cluster”.
17.2.6. Upgrading and Downgrading MySQL Cluster
This portion of the MySQL Cluster chapter covers upgrading and
downgrading a MySQL Cluster from one MySQL release to another. It
discusses different types of Cluster upgrades and downgrades, and
provides a Cluster upgrade/downgrade compatibility matrix (see
Section 17.2.6.2, “MySQL Cluster 5.1 and MySQL Cluster NDB 6.x/7.x Upgrade and Downgrade
Compatibility”).
You are expected already to be familiar with installing and
configuring a MySQL Cluster prior to attempting an upgrade or
downgrade. See Section 17.3, “MySQL Cluster Configuration”.
For more information about upgrading or downgrading between MySQL
Cluster NDB releases, or between MySQL Cluster NDB releases and
mainline MySQL releases, see the changelogs relating to the
applicable MySQL Cluster versions.
This section remains in development, and continues to be updated
and expanded.
17.2.6.1. Performing a Rolling Restart of a MySQL Cluster
This section discusses how to perform a rolling
restart of a MySQL Cluster installation, so called
because it involves stopping and starting (or restarting) each
node in turn, so that the cluster itself remains operational.
This is often done as part of a rolling
upgrade or rolling downgrade,
where high availability of the cluster is mandatory and no
downtime of the cluster as a whole is permissible. Where we
refer to upgrades, the information provided here also generally
applies to downgrades as well.
There are a number of reasons why a rolling restart might be
desirable:
Cluster configuration change.
To make a change in the cluster's configuration, such
as adding an SQL node to the cluster, or setting a
configuration parameter to a new value.
Cluster software upgrade/downgrade.
To upgrade the cluster to a newer version of the MySQL
Cluster software (or to downgrade it to an older version).
This is usually referred to as a “rolling
upgrade” (or “rolling downgrade”, when
reverting to an older version of MySQL Cluster).
Change on node host.
To make changes in the hardware or operating system on
which one or more cluster nodes are running.
Cluster reset.
To reset the cluster because it has reached an undesirable
state. In such cases it is often desirable to reload the
data and metadata of one or more data nodes. This can be
done 1 of 3 ways:
Freeing of resources.
To allow memory allocated to a table by successive
INSERT and
DELETE operations to be
freed for re-use by other MySQL Cluster tables.
The process for performing a rolling restart may be generalized
as follows:
Stop all cluster management nodes
(ndb_mgmd processes), reconfigure them,
then restart them.
Stop, reconfigure, then restart each cluster data node
(ndbd process) in turn.
Stop, reconfigure, then restart each cluster SQL node
(mysqld process) in turn.
The specifics for implementing a particular rolling upgrade
depend upon the actual changes being made. A more detailed view
of the process is presented here:
In the previous diagram, the
Stop and
Start steps indicate that the
process must be stopped completely using a shell command (such
as kill on most Unix systems) or the
management client STOP command, then started
again from a system shell by invoking the
ndbd or ndb_mgmd
executable as appropriate.
Restart indicates the process
may be restarted using the ndb_mgm management
client RESTART command.
Prior to MySQL Cluster NDB 6.3.29 and MySQL Cluster NDB 7.0.10.
When performing an upgrade or downgrade of the cluster
software, you must upgrade or downgrade
the management nodes first, then the data
nodes, and finally the SQL nodes. Doing so in any other order
may leave the cluster in an unusable state.
MySQL Cluster NDB 6.3.29 and later; MySQL Cluster NDB 7.0.10 and later.
MySQL Cluster supports a more flexible order for upgrading the
cluster nodes. When upgrading a cluster running MySQL Cluster
NDB 6.3.29 or later, or a cluster that is running MySQL
Cluster NDB 7.0.10 or later, you may upgrade API nodes
(including SQL nodes) before upgrading the management nodes,
data nodes, or both. In other words, you are permitted to
upgrade the API and SQL nodes in any order. This is subject to
the following provisions:
This functionality is intended for use as part of an online
upgrade only. A mix of node binaries from different MySQL
Cluster releases is neither intended nor supported for
constant, long-term use in a production setting.
All management nodes must be upgraded before any data nodes
are upgraded. This remains true regardless of the order in
which you upgrade the cluster's API and SQL nodes.
For MySQL Cluster NDB 6.3, the ability to upgrade API nodes
in any order relative to upgading management nodes and data
nodes is supported only for MySQL Cluster NDB 6.3.29 and
later; for MySQL Cluster NDB 7.0, it supported only for
MySQL Cluster NDB 7.0.10 and later. This means that, if you
are upgrading from a MySQL Cluster NDB 6.3 release to a
MySQL Cluster NDB 7.0 release, the “old”
NDB engine version must be
6.3.29 or later, and the “new”
NDB engine version must be
7.0.10 or later.
When upgrading the cluster from a MySQL Cluster NDB 6.3
release to a MySQL Cluster NDB 7.0 release: Once you have
started upgraded the API nodes, you should not perform DDL
operations until all management nodes and data nodes have
been upgraded. DML operations should be unaffected, and can
continue while the upgrade is in progress.
However, it is possible to perform DDL from an
“old” (NDB 6.3 version) API node as long as the
master data node is also running the “old”
version of MySQL Cluster. You should keep in mind that a
data node restart could result in the master node running a
“new” (NDB 7.0 version) binary while one or
more data nodes are still using the “old” (NDB
6.3) version; in this situation, no DDL can be performed
from any API node, because the master
data node is no longer using an NDB 6.3 binary, but the
cluster still contains nodes which are not yet using NDB
7.0. For this reason, we recommend that you avoid performing
DDL at any time while the upgrade is in progress.
Features specific to the “new” version must not
be used until all management nodes and data nodes have been
upgraded.
This also applies to any MySQL Server version change that
may apply, in addition to the NDB engine version change, so
do not forget to take this into account when planning the
upgrade. (This is true for online upgrades of MySQL Cluster
in general.)
See also Bug#48528 and Bug#49163.
17.2.6.2. MySQL Cluster 5.1 and MySQL Cluster NDB 6.x/7.x Upgrade and Downgrade
Compatibility
This section provides information about MySQL Cluster software
and table file compatibility between MySQL 5.1 and
MySQL Cluster NDB 6.x releases with regard to performing
upgrades and downgrades.
Important
Only compatibility between MySQL versions with regard to
NDBCLUSTER is taken into account
in this section, and there are likely other issues to be
considered. As with any other MySQL software upgrade
or downgrade, you are strongly encouraged to review the
relevant portions of the MySQL Manual for the MySQL versions
from which and to which you intend to migrate, before
attempting an upgrade or downgrade of the MySQL Cluster
software. See Section 2.4.1, “Upgrading MySQL”.
The following table shows Cluster upgrade and downgrade
compatibility between different releases of MySQL
5.1:
Notes — MySQL 5.1.
MySQL 5.1.3 was the first public release in this series.
Direct upgrades or downgrades between MySQL Cluster 5.0
and 5.1 are not supported; you must dump all
NDBCLUSTER tables using
mysqldump, install the new version of
the software, and then reload the tables from the dump.
You cannot downgrade a MySQL 5.1.6 or later Cluster
using Disk Data tables to MySQL 5.1.5 or earlier unless
you convert all such tables to in-memory Cluster tables
first.
MySQL 5.1.8, MySQL 5.1.10, and MySQL 5.1.13 were not
released.
Online cluster upgrades and downgrades between MySQL
5.1.11 (or an earlier version) and 5.1.12 (or a later
version) are not possible due to major changes in the
cluster file system. In such cases, you must perform a
backup or dump, upgrade (or downgrade) the software,
start each data node with --initial,
and then restore from the backup or dump. You can use
NDB backup/restore or
mysqldump for this purpose.
Online downgrades from MySQL 5.1.14 or later to versions
previous to 5.1.14 are not supported due to incompatible
changes in the cluster system tables.
Online upgrades from MySQL 5.1.17 and earlier to 5.1.18
and later MySQL 5.1.x releases are not supported for
clusters using replication due to incompatible changes
in the mysql.ndb_apply_status table.
(Online upgrades from MySQL 5.1 to MySQL Cluster NDB 6.2
and later are not supported, as discussed elsewhere in
this section.) However, it should not be necessary to
shut down the cluster entirely, if you follow this
modified rolling restart procedure:
Stop the management server, update the management
server software, then start the management server
again. For multiple management servers, repeat this
step for each management server in turn.
For each data node in turn: Stop the data node,
update the data node daemon (in MySQL Cluster NDB
7.0 and later, this can be either
ndbd or
ndbmtd) with the new version,
then restart the data node. It should not be
necessary to use --initial when
restarting any of the data nodes after updating the
software.
Stop all SQL nodes. Upgrade the
existing MySQL server installations to the new
version on all SQL nodes, then restart them. It is
not necessary to start them one at a time after
upgrading the MySQL server software, but
there must be a time when none of them is
running before starting any of them again using the
5.1.18 (or later)
mysqld. Otherwise
— due to the fact that
mysql.ndb_apply_status uses the
NDB storage engine and
is thus shared between all SQL nodes — there
may be conflicts between the old and new versions of
the table on different SQL nodes.
You can find more information about the changes to
ndb_apply_status in
Section 17.6.4, “MySQL Cluster Replication Schema and Tables”.
As with any other MySQL Cluster version upgrade, you
should also update the MySQL Cluster management client
(ndb_mgm) and other MySQL Cluster
client programs such as ndb_config
and ndb_error_reporter; however, this
does not have to be done in any particular order.
The internal specifications for columns in
NDBCLUSTER tables changed
in MySQL 5.1.18 to allow compatibility with later MySQL
Cluster releases that allow online adding and dropping
of columns. This change is not
backward-compatible with earlier MySQL
versions.
In order to make tables created in MySQL 5.1.17 and
earlier compatible with online adding and dropping of
columns (available beginning with beginning with MySQL
Cluster NDB 6.2.5 and MySQL Cluster NDB 6.3.3 —
see Section 12.1.7, “ALTER TABLE Syntax”, for more
information), it is necessary to force MySQL 5.1.18 and
later to convert the tables to the new format by
following this procedure:
Back up all
NDBCLUSTER tables.
Upgrade the MySQL Cluster software on all data,
management, and SQL nodes.
Shut down the cluster completely (this includes
all data, management, and API or SQL nodes).
Restart the cluster, starting all data nodes with
the --initial option (to clear
and rebuild the data node file systems).
Restore the
NDBCLUSTER tables
from backup.
This is not necessary for
NDBCLUSTER tables created
in MySQL 5.1.18 and later; such tables will
automatically be compatible with online adding and
dropping of columns (as implemented beginning with MySQL
Cluster NDB 6.2.5 and MySQL Cluster NDB 6.3.2).
In order to minimise possible later difficulties, it is
strongly advised that the procedure outlined above be
followed as soon as possible after to upgrading from
MySQL 5.1.17 or earlier to MySQL 5.1.18 or later.
Information about how this change effects users of MySQL
Cluster NDB 6.x/7.0 is provided later in this section.
MySQL Cluster is not supported in standard MySQL 5.1
releases, beginning with MySQL 5.1.25. If you are using
MySQL Cluster in a standard MySQL 5.1 release, you
should upgrade to the most recent MySQL Cluster NDB 6.2
or 6.3 release.
The following table shows Cluster upgrade and downgrade
compatibility between different releases of MySQL Cluster NDB
6.x/7.x:
Notes — MySQL Cluster NDB 6.x/7.x.
MySQL Cluster NDB 6.1 is no longer in production; if you
are still using a MySQL Cluster NDB 6.1 release, you
should upgrade to the most recent MySQL Cluster NDB 6.2
or 6.3 as soon as possible.
It is not possible to upgrade from MySQL Cluster NDB
6.1.2 (or an older 6.1 release) directly to 6.1.4 or a
newer NDB 6.1 release, or to downgrade from 6.1.4 (or a
newer 6.1 release) directly to 6.1.2 or an older NDB 6.1
release; in either case, you must upgrade or downgrade
to MySQL Cluster NDB 6.1.3 first.
It is not possible to perform an online downgrade from
MySQL Cluster NDB 6.1.8 (or a newer 6.1 release) to
MySQL Cluster NDB 6.1.7 (or an older 6.1 release).
MySQL Cluster NDB 6.1.6 and 6.1.18 were not released.
It is not possible to perform an online upgrade or
downgrade between MySQL Cluster NDB 6.2 and any previous
release series (including mainline MySQL 5.1 and MySQL
Cluster NDB 6.1); it is necessary to perform a dump and
reload. However, it should be possible to perform online
upgrades or downgrades between any MySQL Cluster NDB 6.2
release and any MySQL Cluster NDB 6.3 release up to and
including 6.3.7.
The internal specifications for columns in
NDB tables changed in MySQL
Cluster NDB 6.1.17 and 6.2.1 to allow compatibility with
future MySQL Cluster releases that are expected to
implement online adding and dropping of columns. This
change is not backward-compatible with earlier MySQL or
MySQL Cluster NDB 6.x versions.
In order to make tables created in earlier versions
compatible with online adding and dropping of columns in
later versions, it is necessary to force MySQL Cluster
to convert the tables to the new format by following
this procedure following an upgrade:
Upgrade the MySQL Cluster software on all data,
management, and SQL nodes
Back up all NDB
tables
Shut down the cluster (all data, management, and
SQL nodes)
Restart the cluster, starting all data nodes with
the --initial option (to clear
and rebuild the data node file systems)
Restore the tables from backup
In order to minimise possible later difficulties, it is
strongly advised that the procedure outlined above be
followed as soon as possible after to upgrading between
the versions indicated. The procedure is
not necessary for
NDBCLUSTER tables created
in any of the following versions:
MySQL Cluster NDB 6.1.8 or a later MySQL Cluster
NDB 6.1 release
MySQL Cluster 6.2.1 or a later MySQL Cluster NDB
6.2 release
Any MySQL Cluster NDB 6.3 release
Tables created in the listed versions (or later ones, as
indicated) are already compatible with online adding and
dropping of columns (as implemented beginning with MySQL
Cluster NDB 6.2.5 and MySQL Cluster NDB 6.3.2).
It was not possible to perform an online upgrade between
any MySQL Cluster NDB 6.2 release and MySQL Cluster NDB
6.3.8 and later MySQL Cluster 6.3 releases. This issue
was fixed in MySQL Cluster NDB 6.3.21. (Bug#41435)
Online downgrades between MySQL Cluster NDB 6.2.5 and
earlier releases are not supported.
Online downgrades between MySQL Cluster NDB 6.3.8 and
earlier releases are not supported.
Online upgrades from any MySQL Cluster NDB 7.0 release
up to and including MySQL Cluster NDB 7.0.4 (as well as
all early releases numbered NDB 6.4.x) to MySQL Cluster
NDB 7.0.5 or later are not possible. Upgrades to MySQL
Cluster NDB 7.0.6 or later from MySQL Cluster NDB 6.3.8
or a later MySQL Cluster NDB 6.3 release, or from MySQL
Cluster NDB 7.0.5 or later, are supported. (Bug#44294)
When upgrading online from a MySQL Cluster NDB 6.3
release to a MySQL Cluster NDB 7.0 release, you should
not try to upgrade the data nodes from
ndbd to ndbmtd at
the same time. Instead, perform the upgrade using the
new ndbd executable (from the MySQL
Cluster NDB 7.0.x distribution to which you are
upgrading) to replace the one in use on the data nodes.
Once the version upgrade is complete, you can perform a
second (online) upgrade to replace the data node
executables with ndbmtd from the
MySQL Cluster NDB 7.0.x distribution.
In MySQL Cluster NDB 7.0.4, the default values for a
number of MySQL Cluster configuration parameters
relating to memory usage and buffering changed (see
Section 17.7.2.13, “Changes in MySQL Cluster NDB 7.0.4 (5.1.32-ndb-7.0.4) (18 March 2008)”,
for a list of the parameters whose defaults changed).
For this reason, you may encounter issues if you try to
use a configuration that does not explicitly define each
of these buffers (because it was developed for a
previous version of MySQL Cluster, SendBufferMemory and
ReceiveBufferMemory in particular.
Prior to MySQL Cluster NDB 7.0.7, DML statements failed
if executed while performing an online upgrade from a
MySQL Cluster NDB 6.3 release. (Bug#45917)
Following an upgrade from any MySQL Cluster NDB 6.3.x
release to MySQL Cluster NDB 7.0.6, DDL and backup
operations failed. This issue was resolved in MySQL
Cluster NDB 7.0.7. (Bug#46494, Bug#46563)
In some cases, there could be problems with online
upgrades from MySQL Cluster NDB 6.3 releases to MySQL
Cluster NDB 7.0 releases due to a previous change in the
signalling format used between nodes. This issue was
corrected in MySQL Cluster NDB 7.0.9.
Once an NDB table had an
ALTER
ONLINE TABLE operation performed on it using a
MySQL Cluster NDB 6.3.x release, it could not be
upgraded online to MySQL Cluster NDB 7.0. This issue was
resolved in MySQL Cluster NDB 7.0.8. (See Bug#47542.)
Following an upgrade from MySQL Cluster NDB 6.3 to MySQL
Cluster NDB 7.0, if there were any tables having unique
indexes prior to the upgrade, attempts to create unique
indexes failed. This could also occur when performing
offline ALTER TABLE
operations on tables having indexes that were not
dropped as a result of the ALTER
TABLE. This issue was due to a change in the
way that NDB tracked unique
indexes internally, and was resolved in MySQL Cluster
NDB 7.0.9. (Bug#48416)
Workaround.
For upgrades to MySQL Cluster NDB 7.0 releases prior
to version 7.0.9, a workaround are available:
Following the upgrade, perform a second rolling
restart of the cluster before before performing any
ALTER TABLE operations
involving indexes.
A table created in a previous version of MySQL Cluster
does not automatically support
NDB-native default values
after the cluster is upgraded to MySQL Cluster NDB 7.1.0
or later. Such a table continues to use default values
supplied by the MySQL server until it is upgraded by
performing an offline ALTER
TABLE on it.
When upgrading to a MySQL Cluster NDB 7.1 or later
release from a MySQL Cluster NDB 7.0 release, you should
not attempt to create any new tables until all data
nodes are using the new ndbd or
ndbmtd binary. This is because the
older binaries do not provide support for native default
values; tables created with native default value support
cannot be used with NDB 7.0.x or earlier versions of the
software.
Due to an issue discovered after the release of MySQL
Cluster NDB 7.0.10 (Bug#50433), it is not possible to
perform an online upgrade from MySQL Cluster NDB 7.0.9b
and earlier MySQL Cluster NDB 7.0 releases to MySQL
Cluster NDB 7.0.10. Instead, you should upgrade your
MySQL Cluster NDB 7.0 cluster directly to MySQL Cluster
NDB 7.0.11 or later.
This issue did not appear to affect MySQL Cluster NDB
6.3, and it should be possible to upgrade online from
MySQL Cluster NDB 6.3 to MySQL Cluster NDB 7.0.10
without any problems other than those noted preciously.
17.3. MySQL Cluster Configuration
A MySQL server that is part of a MySQL Cluster differs in one chief
respect from a normal (nonclustered) MySQL server, in that it
employs the NDBCLUSTER storage engine.
This engine is also referred to simply as
NDB, and the two forms of the name are
synonymous.
To avoid unnecessary allocation of resources, the server is
configured by default with the NDB
storage engine disabled. To enable NDB,
you must modify the server's my.cnf
configuration file, or start the server with the
--ndbcluster option.
For more information about
--ndbcluster and other MySQL server
options specific to MySQL Cluster, see
Section 17.3.4.2, “mysqld Command Options for MySQL Cluster”.
The MySQL server is a part of the cluster, so it also must know how
to access an MGM node to obtain the cluster configuration data. The
default behavior is to look for the MGM node on
localhost. However, should you need to specify
that its location is elsewhere, this can be done in
my.cnf or on the MySQL server command line.
Before the NDB storage engine can be
used, at least one MGM node must be operational, as well as any
desired data nodes.
NDB, the MySQL Cluster storage engine,
is available in binary distributions for Linux, Mac OS X, and
Solaris. We are working to support MySQL Cluster on all operating
systems supported by MySQL, including Windows. For information about
installing MySQL Cluster, see
Section 17.2.1, “MySQL Cluster Multi-Computer Installation”.
17.3.1. Quick Test Setup of MySQL Cluster
To familiarize you with the basics, we will describe the simplest
possible configuration for a functional MySQL Cluster. After this,
you should be able to design your desired setup from the
information provided in the other relevant sections of this
chapter.
First, you need to create a configuration directory such as
/var/lib/mysql-cluster, by executing the
following command as the system root user:
shell> mkdir /var/lib/mysql-cluster
In this directory, create a file named
config.ini that contains the following
information. Substitute appropriate values for
HostName and DataDir as
necessary for your system.
# file "config.ini" - showing minimal setup consisting of 1 data node,
# 1 management server, and 3 MySQL servers.
# The empty default sections are not required, and are shown only for
# the sake of completeness.
# Data nodes must provide a hostname but MySQL Servers are not required
# to do so.
# If you don't know the hostname for your machine, use localhost.
# The DataDir parameter also has a default value, but it is recommended to
# set it explicitly.
# Note: [db], [api], and [mgm] are aliases for [ndbd], [mysqld], and [ndb_mgmd],
# respectively. [db] is deprecated and should not be used in new installations.
[ndbd default]
NoOfReplicas= 1
[mysqld default]
[ndb_mgmd default]
[tcp default]
[ndb_mgmd]
HostName= myhost.example.com
[ndbd]
HostName= myhost.example.com
DataDir= /var/lib/mysql-cluster
[mysqld]
[mysqld]
[mysqld]
You can now start the ndb_mgmd management
server. By default, it attempts to read the
config.ini file in its current working
directory, so change location into the directory where the file is
located and then invoke ndb_mgmd:
shell> cd /var/lib/mysql-cluster
shell> ndb_mgmd
Then start a single data node by running ndbd:
shell> ndbd
For command-line options which can be used when starting
ndbd, see
Section 17.4.23, “Options Common to MySQL Cluster Programs”.
By default, ndbd looks for the management
server at localhost on port 1186.
Note
If you have installed MySQL from a binary tarball, you will need
to specify the path of the ndb_mgmd and
ndbd servers explicitly. (Normally, these
will be found in /usr/local/mysql/bin.)
Finally, change location to the MySQL data directory (usually
/var/lib/mysql or
/usr/local/mysql/data), and make sure that
the my.cnf file contains the option necessary
to enable the NDB storage engine:
[mysqld]
ndbcluster
You can now start the MySQL server as usual:
shell> mysqld_safe --user=mysql &
Wait a moment to make sure the MySQL server is running properly.
If you see the notice mysql ended, check the
server's .err file to find out what went
wrong.
If all has gone well so far, you now can start using the cluster.
Connect to the server and verify that the
NDBCLUSTER storage engine is enabled:
shell> mysql
Welcome to the MySQL monitor. Commands end with ; or \g.
Your MySQL connection id is 1 to server version: 5.1.45
Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
mysql> SHOW ENGINES\G
...
*************************** 12. row ***************************
Engine: NDBCLUSTER
Support: YES
Comment: Clustered, fault-tolerant, memory-based tables
*************************** 13. row ***************************
Engine: NDB
Support: YES
Comment: Alias for NDBCLUSTER
...
The row numbers shown in the preceding example output may be
different from those shown on your system, depending upon how your
server is configured.
Try to create an NDBCLUSTER table:
shell> mysql
mysql> USE test;
Database changed
mysql> CREATE TABLE ctest (i INT) ENGINE=NDBCLUSTER;
Query OK, 0 rows affected (0.09 sec)
mysql> SHOW CREATE TABLE ctest \G
*************************** 1. row ***************************
Table: ctest
Create Table: CREATE TABLE `ctest` (
`i` int(11) default NULL
) ENGINE=ndbcluster DEFAULT CHARSET=latin1
1 row in set (0.00 sec)
To check that your nodes were set up properly, start the
management client:
shell> ndb_mgm
Use the SHOW command from within the management
client to obtain a report on the cluster's status:
ndb_mgm> SHOW
Cluster Configuration
---------------------
[ndbd(NDB)] 1 node(s)
id=2 @127.0.0.1 (Version: 3.5.3, Nodegroup: 0, Master)
[ndb_mgmd(MGM)] 1 node(s)
id=1 @127.0.0.1 (Version: 3.5.3)
[mysqld(API)] 3 node(s)
id=3 @127.0.0.1 (Version: 3.5.3)
id=4 (not connected, accepting connect from any host)
id=5 (not connected, accepting connect from any host)
At this point, you have successfully set up a working MySQL
Cluster. You can now store data in the cluster by using any table
created with ENGINE=NDBCLUSTER or its alias
ENGINE=NDB.
17.3.2. MySQL Cluster Configuration Files
Configuring MySQL Cluster requires working with two files:
my.cnf: Specifies options for all MySQL
Cluster executables. This file, with which you should be
familiar with from previous work with MySQL, must be
accessible by each executable running in the cluster.
config.ini: This file, sometimes known as
the global configuration file, is read
only by the MySQL Cluster management server, which then
distributes the information contained therein to all processes
participating in the cluster. config.ini
contains a description of each node involved in the cluster.
This includes configuration parameters for data nodes and
configuration parameters for connections between all nodes in
the cluster. For a quick reference to the sections that can
appear in this file, and what sorts of configuration
parameters may be placed in each section, see
Sections of
the config.ini File.
Caching of configuration data.
Beginning with MySQL Cluster NDB 6.4.0, MySQL Cluster uses
stateful configuration. The global
configuration file is no longer read every time the management
server is restarted. Instead, the management server caches the
configuration the first time it is started, and thereafter, the
global confiuration file is read only when one of the following
items is true:
The management server is started using --initial option.
In this case, the global configuration file is re-read,
any existing cache files are deleted, and the management
server creates a new configuration cache.
The management server is started using --reload option.
In this case, the management server compares its cache
with the global configuration file. If they differ, the
management server creates a new configuration cache; any
existing configuration cache is preserved, but not used.
If the management server's cache and the global
configuration file contain the same configuration data,
then the existing cache is used, and no new cache is
created.
No configuration cache is found.
In this case, the management server reads the global
configuration file and creates a cache containing the
same configuration data as found in the file.
Configuration cache files.
Beginning with MySQL Cluster 6.4.0, the management server by
default creates configuration cache files in a directory named
mysql-cluster in the MySQL installation
directory. (If you build MySQL Cluster from source on a Unix
system, the default location is
/usr/local/mysql-cluster.) This can be
overridden at run time by starting the management server with
the --configdir option. Configuration cache
files are binary files named according to the pattern
ndb_node_id_config.bin.seq_id,
where node_id is the management
server's node ID in the cluster, and
seq_id is a cache idenitifer. Cache
files are numbered sequentially using
seq_id, in the order in which they
are created. The management server uses the latest cache file as
determined by the seq_id.
Note
It is possible to roll back to a previous configuration by
deleting later configuration cache files, or by renaming an
earlier cache file so that it has a higher
seq_id. However, since configuration
cache files are written in a binary format, you should not
attempt to edit their contents by hand.
For more information about the --configdir,
--initial, and --reload options
for the MySQL Cluster management server, see
Section 17.4.4, “ndb_mgmd — The MySQL Cluster Management Server Daemon”.
We are continuously making improvements in Cluster configuration
and attempting to simplify this process. Although we strive to
maintain backward compatibility, there may be times when introduce
an incompatible change. In such cases we will try to let Cluster
users know in advance if a change is not backward compatible. If
you find such a change and we have not documented it, please
report it in the MySQL bugs database using the instructions given
in Section 1.7, “How to Report Bugs or Problems”.
17.3.2.1. MySQL Cluster Configuration — Basic Example
To support MySQL Cluster, you will need to update
my.cnf as shown in the following example.
You may also specify these parameters on the command line when
invoking the executables.
Note
The options shown here should not be confused with those that
are used in config.ini global
configuration files. Global configuration options are
discussed later in this section.
# my.cnf
# example additions to my.cnf for MySQL Cluster
# (valid in MySQL 5.1)
# enable ndbcluster storage engine, and provide connectstring for
# management server host (default port is 1186)
[mysqld]
ndbcluster
ndb-connectstring=ndb_mgmd.mysql.com
# provide connectstring for management server host (default port: 1186)
[ndbd]
connect-string=ndb_mgmd.mysql.com
# provide connectstring for management server host (default port: 1186)
[ndb_mgm]
connect-string=ndb_mgmd.mysql.com
# provide location of cluster configuration file
[ndb_mgmd]
config-file=/etc/config.ini
(For more information on connectstrings, see
Section 17.3.2.3, “The MySQL Cluster Connectstring”.)
# my.cnf
# example additions to my.cnf for MySQL Cluster
# (will work on all versions)
# enable ndbcluster storage engine, and provide connectstring for management
# server host to the default port 1186
[mysqld]
ndbcluster
ndb-connectstring=ndb_mgmd.mysql.com:1186
Important
Once you have started a mysqld process with
the NDBCLUSTER and
ndb-connectstring parameters in the
[mysqld] in the my.cnf
file as shown previously, you cannot execute any
CREATE TABLE or
ALTER TABLE statements without
having actually started the cluster. Otherwise, these
statements will fail with an error. This is by
design.
You may also use a separate [mysql_cluster]
section in the cluster my.cnf file for
settings to be read and used by all executables:
# cluster-specific settings
[mysql_cluster]
ndb-connectstring=ndb_mgmd.mysql.com:1186
For additional NDB variables that
can be set in the my.cnf file, see
Section 17.3.4.3, “MySQL Cluster System Variables”.
The MySQL Cluster global configuration file is named
config.ini by default. It is read by
ndb_mgmd at startup and can be placed
anywhere. Its location and name are specified by using
--config-file=path_name
on the ndb_mgmd command line. If the
configuration file is not specified, ndb_mgmd
by default tries to read a file named
config.ini located in the current working
directory.
The global configuration file for MySQL Cluster uses INI format,
which consists of sections preceded by section headings
(surrounded by square brackets), followed by the appropriate
parameter names and values. One deviation from the standard INI
format is that the parameter name and value can be separated by
a colon (“:”) as well as the
equals sign (“=”); however, the
equals sign is preferred. Another deviation is that sections are
not uniquely identified by section name. Instead, unique
sections (such as two different nodes of the same type) are
identified by a unique ID specified as a parameter within the
section.
Default values are defined for most parameters, and can also be
specified in config.ini. (Prior to MySQL
Cluster NDB 6.3.25 and MySQL Cluster NDB 7.0.6, there was no
default value for NoOfReplicas, which always
had to be specified explicitly in the [ndbd
default] section. Beginning with versions just stated,
the default value is 2, which is the recommended setting in most
common usage scenarios.) To create a default value section,
simply add the word default to the section
name. For example, an [ndbd] section contains
parameters that apply to a particular data node, whereas an
[ndbd default] section contains parameters
that apply to all data nodes. Suppose that all data nodes should
use the same data memory size. To configure them all, create an
[ndbd default] section that contains a
DataMemory line to specify the data memory
size.
The global configuration file must define the computers and
nodes involved in the cluster and on which computers these nodes
are located. An example of a simple configuration file for a
cluster consisting of one management server, two data nodes and
two MySQL servers is shown here:
# file "config.ini" - 2 data nodes and 2 SQL nodes
# This file is placed in the startup directory of ndb_mgmd (the
# management server)
# The first MySQL Server can be started from any host. The second
# can be started only on the host mysqld_5.mysql.com
[ndbd default]
NoOfReplicas= 2
DataDir= /var/lib/mysql-cluster
[ndb_mgmd]
Hostname= ndb_mgmd.mysql.com
DataDir= /var/lib/mysql-cluster
[ndbd]
HostName= ndbd_2.mysql.com
[ndbd]
HostName= ndbd_3.mysql.com
[mysqld]
[mysqld]
HostName= mysqld_5.mysql.com
Each node has its own section in the
config.ini file. For example, this cluster
has two data nodes, so the preceding configuration file contains
two [ndbd] sections defining these nodes.
Note
Do not place comments on the same line as a section heading in
the config.ini file; this causes the
management server not to start because it cannot parse the
configuration file in such cases.
Sections of the
config.ini File
There are six different sections that you can use in the
config.ini configuration file, as described
in the following list:
[computer]: Defines cluster hosts. This
is not required to configure a viable MySQL Cluster, but be
may used as a convenience when setting up a large cluster.
See Section 17.3.2.4, “Defining Computers in a MySQL Cluster”, for
more information.
[ndbd]: Defines a cluster data node
(ndbd process). See
Section 17.3.2.6, “Defining MySQL Cluster Data Nodes”, for
details.
[mysqld]: Defines the cluster's MySQL
server nodes (also called SQL or API nodes). For a
discussion of SQL node configuration, see
Section 17.3.2.7, “Defining SQL and Other API Nodes in a MySQL Cluster”.
[mgm] or [ndb_mgmd]:
Defines a cluster management server (MGM) node. For
information concerning the configuration of MGM nodes, see
Section 17.3.2.5, “Defining a MySQL Cluster Management Server”.
[tcp]: Defines a TCP/IP connection
between cluster nodes, with TCP/IP being the default
connection protocol. Normally, [tcp] or
[tcp default] sections are not required
to set up a MySQL Cluster, as the cluster handles this
automatically; however, it may be necessary in some
situations to override the defaults provided by the cluster.
See Section 17.3.2.8, “MySQL Cluster TCP/IP Connections”, for
information about available TCP/IP configuration parameters
and how to use them. (You may also find
Section 17.3.2.9, “MySQL Cluster TCP/IP Connections Using Direct Connections” to be
of interest in some cases.)
[shm]: Defines shared-memory connections
between nodes. In MySQL 5.1, it is enabled by
default, but should still be considered experimental. For a
discussion of SHM interconnects, see
Section 17.3.2.10, “MySQL Cluster Shared-Memory Connections”.
[sci]:Defines Scalable
Coherent Interface connections between cluster
data nodes. Such connections require software which, while
freely available, is not part of the MySQL Cluster
distribution, as well as specialized hardware. See
Section 17.3.2.11, “SCI Transport Connections in MySQL Cluster” for detailed
information about SCI interconnects.
You can define default values for each
section. All Cluster parameter names are case-insensitive, which
differs from parameters specified in my.cnf
or my.ini files.
17.3.2.2. Recommended Starting Configurations for MySQL Cluster NDB 6.2 and Later
Achieving the best performance from a MySQL Cluster depends on a
number of factors including the following:
MySQL Cluster software version
Numbers of data nodes and SQL nodes
Hardware
Operating system
Amount of data to be stored
Size and type of load under which the cluster is to operate
Therefore, obtaining an optimum configuration is likely to be an
iterative process, the outcome of which can vary widely with the
specifics of each MySQL Cluster deployment. Changes in
configuration are also likely to be indicated when changes are
made in the platform on which the cluster is run, or in
applications that use the MySQL Cluster's data. For these
reasons, it is not possible to offer a single configuration that
is ideal for all usage scenarios. However, in this section, we
provide recommended base configurations for MySQL Cluster NDB
6.2 and 6.3 that can serve as reasonable starting points.
Starting configuration for MySQL Cluster NDB 6.2.
The following is a recommended starting point for configuring
a cluster running MySQL Cluster NDB 6.2.
# TCP PARAMETERS
[tcp default]
SendBufferMemory=2M
ReceiveBufferMemory=2M
# Increasing the sizes of these 2 buffers beyond the default values
# helps prevent bottlenecks due to slow disk I/O.
# MANAGEMENT NODE PARAMETERS
[ndb_mgmd default]
DataDir=path/to/management/server/data/directory
# It is possible to use a different data directory for each management
# server, but for ease of administration it is preferable to be
# consistent.
[ndb_mgmd]
HostName=management-server-1-hostname
# Id=management-server-A-id
[ndb_mgmd]
HostName=management-server-2-hostname
# Using 2 management servers helps guarantee that there is always an
# arbitrator in the event of network partitioning, and so is
# recommended for high availability. Each management server must be
# identified by a HostName. You may for the sake of convenience specify
# a node ID for any management server, although one will be allocated
# for it automatically; if you do so, it must be in the range 1-255
# inclusive and must be unique among all IDs specified for cluster
# nodes.
# DATA NODE PARAMETERS
[ndbd default]
NoOfReplicas=2
# Using 2 replicas is recommended to guarantee availability of data;
# using only 1 replica does not provide any redundancy, which means
# that the failure of a single data node causes the entire cluster to
# shut down. We do not recommend using more than 2 replicas, since 2 is
# sufficient to provide high availability, and we do not currently test
# with greater values for this parameter.
LockPagesInMainMemory=1
# On Linux and Solaris systems, setting this parameter locks data node
# processes into memory. Doing so prevents them from swapping to disk,
# which can severely degrade cluster performance.
DataMemory=3072M
IndexMemory=384M
# The values provided for DataMemory and IndexMemory assume 4 GB RAM
# per data node. However, for best results, you should first calculate
# the memory that would be used based on the data you actually plan to
# store (you may find the ndb_size.pl utility helpful in estimating
# this), then allow an extra 20% over the calculated values. Naturally,
# you should ensure that each data node host has at least as much
# physical memory as the sum of these two values.
# ODirect=1
# Enabling this parameter causes NDBCLUSTER to try using O_DIRECT
# writes for local checkpoints and redo logs; this can reduce load on
# CPUs. We recommend doing so when using MySQL Cluster NDB 6.2.3 or
# newer on systems running Linux kernel 2.6 or later.
NoOfFragmentLogFiles=300
DataDir=path/to/data/node/data/directory
MaxNoOfConcurrentOperations=100000
TimeBetweenGlobalCheckpoints=1000
TimeBetweenEpochs=200
DiskCheckpointSpeed=10M
DiskCheckpointSpeedInRestart=100M
RedoBuffer=32M
# MaxNoOfLocalScans=64
MaxNoOfTables=1024
MaxNofOfOrderedIndexes=256
[ndbd]
HostName=data-node-A-hostname
# Id=data-node-A-id
[ndbd]
HostName=data-node-B-hostname
# Id=data-node-B-id
# You must have an [ndbd] section for every data node in the cluster;
# each of these sections must include a HostName. Each section may
# optionally include an Id for convenience, but in most cases, it is
# sufficient to allow the cluster to allocate node IDs dynamically. If
# you do specify the node ID for a data node, it must be in the range 1
# to 48 inclusive and must be unique among all IDs specified for
# cluster nodes.
# SQL NODE / API NODE PARAMETERS
[mysqld]
# HostName=SQL-node-1-hostname
# Id=sql-node-A-id
[mysqld]
[mysqld]
# Each API or SQL node that connects to the cluster requires a [mysqld]
# or [api] section of its own. Each such section defines a connection
# “slot”; you should have at least as many of these sections in the
# config.ini file as the total number of API nodes and SQL nodes that
# you wish to have connected to the cluster at any given time. There is
# no performance or other penalty for having extra slots available in
# case you find later that you want or need more API or SQL nodes to
# connect to the cluster at the same time.
# If no HostName is specified for a given [mysqld] or [api] section,
# then any API or SQL node may use that slot to connect to the
# cluster. You may wish to use an explicit HostName for one connection slot
# to guarantee that an API or SQL node from that host can always
# connect to the cluster. If you wish to prevent API or SQL nodes from
# connecting from other than a desired host or hosts, then use a
# HostName for every [mysqld] or [api] section in the config.ini file.
# You can if you wish define a node ID (Id parameter) for any API or
# SQL node, but this is not necessary; if you do so, it must be in the
# range 1 to 255 inclusive and must be unique among all IDs specified
# for cluster nodes.
Starting configuration for MySQL Cluster NDB 6.3.
The following is a recommended starting point for configuring
a cluster running MySQL Cluster NDB 6.3. It is similar to the
recommendation for MySQL Cluster NDB 6.2, with the addition of
parameters for better control of
NDBCLUSTER process threads.
# TCP PARAMETERS
[tcp default]
SendBufferMemory=2M
ReceiveBufferMemory=2M
# Increasing the sizes of these 2 buffers beyond the default values
# helps prevent bottlenecks due to slow disk I/O.
# MANAGEMENT NODE PARAMETERS
[ndb_mgmd default]
DataDir=path/to/management/server/data/directory
# It is possible to use a different data directory for each management
# server, but for ease of administration it is preferable to be
# consistent.
[ndb_mgmd]
HostName=management-server-1-hostname
# Id=management-server-A-id
[ndb_mgmd]
HostName=management-server-2-hostname
# Using 2 management servers helps guarantee that there is always an
# arbitrator in the event of network partitioning, and so is
# recommended for high availability. Each management server must be
# identified by a HostName. You may for the sake of convenience specify
# a node ID for any management server, although one will be allocated
# for it automatically; if you do so, it must be in the range 1-255
# inclusive and must be unique among all IDs specified for cluster
# nodes.
# DATA NODE PARAMETERS
[ndbd default]
NoOfReplicas=2
# Using 2 replicas is recommended to guarantee availability of data;
# using only 1 replica does not provide any redundancy, which means
# that the failure of a single data node causes the entire cluster to
# shut down. We do not recommend using more than 2 replicas, since 2 is
# sufficient to provide high availability, and we do not currently test
# with greater values for this parameter.
LockPagesInMainMemory=1
# On Linux and Solaris systems, setting this parameter locks data node
# processes into memory. Doing so prevents them from swapping to disk,
# which can severely degrade cluster performance.
DataMemory=3072M
IndexMemory=384M
# The values provided for DataMemory and IndexMemory assume 4 GB RAM
# per data node. However, for best results, you should first calculate
# the memory that would be used based on the data you actually plan to
# store (you may find the ndb_size.pl utility helpful in estimating
# this), then allow an extra 20% over the calculated values. Naturally,
# you should ensure that each data node host has at least as much
# physical memory as the sum of these two values.
# ODirect=1
# Enabling this parameter causes NDBCLUSTER to try using O_DIRECT
# writes for local checkpoints and redo logs; this can reduce load on
# CPUs. We recommend doing so when using MySQL Cluster NDB 6.2.3 or
# newer on systems running Linux kernel 2.6 or later.
NoOfFragmentLogFiles=300
DataDir=path/to/data/node/data/directory
MaxNoOfConcurrentOperations=100000
SchedulerSpinTimer=400
SchedulerExecutionTimer=100
RealTimeScheduler=1
# Setting these parameters allows you to take advantage of real-time scheduling
# of NDBCLUSTER threads (introduced in MySQL Cluster NDB 6.3.4) to get higher
# throughput.
TimeBetweenGlobalCheckpoints=1000
TimeBetweenEpochs=200
DiskCheckpointSpeed=10M
DiskCheckpointSpeedInRestart=100M
RedoBuffer=32M
# CompressedLCP=1
# CompressedBackup=1
# Enabling CompressedLCP and CompressedBackup causes, respectively, local
checkpoint files and backup files to be compressed, which can result in a space
savings of up to 50% over noncompressed LCPs and backups.
# MaxNoOfLocalScans=64
MaxNoOfTables=1024
MaxNofOfOrderedIndexes=256
[ndbd]
HostName=data-node-A-hostname
# Id=data-node-A-id
LockExecuteThreadToCPU=1
LockMaintThreadsToCPU=0
# On systems with multiple CPUs, these parameters can be used to lock NDBCLUSTER
# threads to specific CPUs
[ndbd]
HostName=data-node-B-hostname
# Id=data-node-B-id
LockExecuteThreadToCPU=1
LockMaintThreadsToCPU=0
# You must have an [ndbd] section for every data node in the cluster;
# each of these sections must include a HostName. Each section may
# optionally include an Id for convenience, but in most cases, it is
# sufficient to allow the cluster to allocate node IDs dynamically. If
# you do specify the node ID for a data node, it must be in the range 1
# to 48 inclusive and must be unique among all IDs specified for
# cluster nodes.
# SQL NODE / API NODE PARAMETERS
[mysqld]
# HostName=SQL-node-1-hostname
# Id=sql-node-A-id
[mysqld]
[mysqld]
# Each API or SQL node that connects to the cluster requires a [mysqld]
# or [api] section of its own. Each such section defines a connection
# “slot”; you should have at least as many of these sections in the
# config.ini file as the total number of API nodes and SQL nodes that
# you wish to have connected to the cluster at any given time. There is
# no performance or other penalty for having extra slots available in
# case you find later that you want or need more API or SQL nodes to
# connect to the cluster at the same time.
# If no HostName is specified for a given [mysqld] or [api] section,
# then any API or SQL node may use that slot to connect to the
# cluster. You may wish to use an explicit HostName for one connection slot
# to guarantee that an API or SQL node from that host can always
# connect to the cluster. If you wish to prevent API or SQL nodes from
# connecting from other than a desired host or hosts, then use a
# HostName for every [mysqld] or [api] section in the config.ini file.
# You can if you wish define a node ID (Id parameter) for any API or
# SQL node, but this is not necessary; if you do so, it must be in the
# range 1 to 255 inclusive and must be unique among all IDs specified
# for cluster nodes.
Recommended my.cnf options for SQL nodes.
MySQL Servers acting as MySQL Cluster SQL nodes must always be
started with the --ndbcluster
and --ndb-connectstring options, either on
the command line or in my.cnf. In
addition, set the following options for all
mysqld processes in the cluster, unless
your setup requires otherwise:
17.3.2.3. The MySQL Cluster Connectstring
With the exception of the MySQL Cluster management server
(ndb_mgmd), each node that is part of a MySQL
Cluster requires a connectstring that
points to the management server's location. This connectstring
is used in establishing a connection to the management server as
well as in performing other tasks depending on the node's role
in the cluster. The syntax for a connectstring is as follows:
[nodeid=node_id, ]host-definition[, host-definition[, ...]]
host-definition:
host_name[:port_number]
node_id is an integer larger than 1 which
identifies a node in config.ini.
host_name is a string representing a
valid Internet host name or IP address.
port_number is an integer referring
to a TCP/IP port number.
example 1 (long): "nodeid=2,myhost1:1100,myhost2:1100,192.168.0.3:1200"
example 2 (short): "myhost1"
localhost:1186 is used as the default
connectstring value if none is provided. If
port_num is omitted from the
connectstring, the default port is 1186. This port should always
be available on the network because it has been assigned by IANA
for this purpose (see
http://www.iana.org/assignments/port-numbers for
details).
By listing multiple host definitions, it is possible to
designate several redundant management servers. A MySQL Cluster
data or API node attempts to contact successive management
servers on each host in the order specified, until a successful
connection has been established.
Beginning with MySQL Cluster NDB 6.3.19, it is also possible in
a connectstring to specify one or more bind addresses to be used
by nodes having multiple network interfaces for connecting to
management servers. A bind address consists of a hostname or
network address and an optional port number. This enhanced
syntax for connectstrings is shown here:
[nodeid=node_id, ]
[bind-address=host-definition, ]
host-definition[; bind-address=host-definition]
host-definition[; bind-address=host-definition]
[, ...]]
host-definition:
host_name[:port_number]
If a single bind address is used in the connectstring
prior to specifying any management hosts,
then this address is used as the default for connecting to any
of them (unless overridden for a given management server; see
later in this section for an example). For example, the
following connectstring causes the node to use
192.168.178.242 regardless of the management
server to which it connects:
bind-address=192.168.178.242, poseidon:1186, perch:1186
If a bind address is specified following a
management host definition, then it is used only for connecting
to that management node. Consider the following connectstring:
poseidon:1186;bind-address=localhost, perch:1186;bind-address=192.168.178.242
In this case, the node uses localhost to
connect to the management server running on the host named
poseidon and
192.168.178.242 to connect to the management
server running on the host named perch.
You can specify a default bind address and then override this
default for one or more specific management hosts. In the
following example, localhost is used for
connecting to the management server running on host
poseidon; since
192.168.178.242 is specified first (before
any management server definitions), it is the default bind
address and so is used for connecting to the management servers
on hosts perch and orca:
bind-address=192.168.178.242,poseidon:1186;bind-address=localhost,perch:1186,orca:2200
There are a number of different ways to specify the
connectstring:
Each executable has its own command-line option which
enables specifying the management server at startup. (See
the documentation for the respective executable.)
It is also possible to set the connectstring for all nodes
in the cluster at once by placing it in a
[mysql_cluster] section in the management
server's my.cnf file.
For backward compatibility, two other options are available,
using the same syntax:
Set the NDB_CONNECTSTRING environment
variable to contain the connectstring.
Write the connectstring for each executable into a text
file named Ndb.cfg and place this
file in the executable's startup directory.
However, these are now deprecated and should not be used for
new installations.
The recommended method for specifying the connectstring is to
set it on the command line or in the my.cnf
file for each executable.
The maximum length of a connectstring is 1024 characters.
17.3.2.4. Defining Computers in a MySQL Cluster
The [computer] section has no real
significance other than serving as a way to avoid the need of
defining host names for each node in the system. All parameters
mentioned here are required.
Id
This is a unique identifier, used to refer to the host
computer elsewhere in the configuration file.
Important
The computer ID is not the same as
the node ID used for a management, API, or data node.
Unlike the case with node IDs, you cannot use
NodeId in place of
Id in the [computer]
section of the config.ini file.
HostName
This is the computer's hostname or IP address.
17.3.2.5. Defining a MySQL Cluster Management Server
The [ndb_mgmd] section is used to configure
the behavior of the management server. [mgm]
can be used as an alias; the two section names are equivalent.
All parameters in the following list are optional and assume
their default values if omitted.
Note
If neither the ExecuteOnComputer nor the
HostName parameter is present, the default
value localhost will be assumed for both.
Id
Each node in the cluster has a unique identity. For a
management node, this is represented by an integer value in
the range 1 to 63 inclusive (previous to MySQL Cluster NDB
6.1.1), or in the range 1 to 255 inclusive (MySQL Cluster
NDB 6.1.1 and later). This ID is used by all internal
cluster messages for addressing the node, and so must be
unique for each MySQL Cluster node, regardless of the type
of node.
Note
Data node IDs must be less than 49, regardless of the
MySQL Cluster version used. If you plan to deploy a large
number of data nodes, it is a good idea to limit the node
IDs for management nodes (and API nodes) to values greater
than 48.
This parameter can also be written as
NodeId, although the short form is
sufficient (and preferred for this reason).
ExecuteOnComputer
This refers to the Id set for one of the
computers defined in a [computer] section
of the config.ini file.
PortNumber
This is the port number on which the management server
listens for configuration requests and management commands.
HostName
Specifying this parameter defines the hostname of the
computer on which the management node is to reside. To
specify a hostname other than localhost,
either this parameter or
ExecuteOnComputer is required.
LogDestination
This parameter specifies where to send cluster logging
information. There are three options in this regard —
CONSOLE, SYSLOG, and
FILE — with FILE
being the default:
CONSOLE outputs the log to
stdout:
CONSOLE
SYSLOG sends the log to a
syslog facility, possible values
being one of auth,
authpriv, cron,
daemon, ftp,
kern, lpr,
mail, news,
syslog, user,
uucp, local0,
local1, local2,
local3, local4,
local5, local6, or
local7.
Note
Not every facility is necessarily supported by every
operating system.
SYSLOG:facility=syslog
FILE pipes the cluster log output to
a regular file on the same machine. The following values
can be specified:
filename: The name of the log
file.
maxsize: The maximum size (in
bytes) to which the file can grow before logging
rolls over to a new file. When this occurs, the old
log file is renamed by appending
.N to the file name,
where N is the next
number not yet used with this name.
maxfiles: The maximum number of
log files.
FILE:filename=cluster.log,maxsize=1000000,maxfiles=6
The default value for the FILE
parameter is
FILE:filename=ndb_node_id_cluster.log,maxsize=1000000,maxfiles=6,
where node_id is the ID of
the node.
It is possible to specify multiple log destinations
separated by semicolons as shown here:
CONSOLE;SYSLOG:facility=local0;FILE:filename=/var/log/mgmd
ArbitrationRank
This parameter is used to define which nodes can act as
arbitrators. Only management nodes and SQL nodes can be
arbitrators. ArbitrationRank can take one
of the following values:
0: The node will never be used as an
arbitrator.
1: The node has high priority; that
is, it will be preferred as an arbitrator over
low-priority nodes.
2: Indicates a low-priority node
which be used as an arbitrator only if a node with a
higher priority is not available for that purpose.
Normally, the management server should be configured as an
arbitrator by setting its ArbitrationRank
to 1 (the default for management nodes) and those for all
SQL nodes to 0 (the default for SQL nodes).
Beginning with MySQL 5.1.16 and MySQL Cluster NDB 6.1.3, it
is possible to disable arbitration completely by setting
ArbitrationRank to 0 on all management
and SQL nodes. In MySQL Cluster NDB 7.0.7 and later
releases, you can also control arbitration by overriding
this parameter; to do this, set the
Arbitration
parameter in the [ndbd default] section
of the config.ini global configuration
file.
ArbitrationDelay
An integer value which causes the management server's
responses to arbitration requests to be delayed by that
number of milliseconds. By default, this value is 0; it is
normally not necessary to change it.
DataDir
This specifies the directory where output files from the
management server will be placed. These files include
cluster log files, process output files, and the daemon's
process ID (PID) file. (For log files, this location can be
overridden by setting the FILE parameter
for LogDestination as discussed
previously in this section.)
The default value for this parameter is the directory in
which ndb_mgmd is located.
HeartbeatThreadPriority
Beginning with MySQL Cluster NDB 6.3.32, MySQL Cluster NDB
7.0.13, and MySQL Cluster NDB 7.1.2, it is possible to use
this parameter to set the scheduling policy and priority of
heartbeat threads for management and API nodes.
The syntax for setting this parameter is shown here:
HeartbeatThreadPriority = policy[, priority]
policy:
{FIFO | RR}
When setting this parameter, you must specify a policy. This
is one of FIFO (first in, first in) or
RR (round robin). This followed
optionally by the priority (an integer).
TotalSendBufferMemory
This parameter is available beginning with MySQL Cluster NDB
6.4.0. It is used to determine the total amount of memory to
allocate on this node for shared send buffer memory among
all configured transporters.
If this parameter is set, its minimum allowed value is 256K;
the maxmimum is 4294967039. For more detailed information
about the behavior and use of
TotalSendBufferMemory and configuring
send buffer memory parameters in MySQL Cluster NDB 6.4.0 and
later, see
Section 17.3.2.13, “Configuring MySQL Cluster Send Buffer Parameters”.
Note
After making changes in a management node's
configuration, it is necessary to perform a rolling restart of
the cluster in order for the new configuration to take effect.
To add new management servers to a running MySQL Cluster, it
is also necessary to perform a rolling restart of all cluster
nodes after modifying any existing
config.ini files. For more information
about issues arising when using multiple management nodes, see
Section 17.1.5.10, “Limitations Relating to Multiple MySQL Cluster Nodes”.
17.3.2.6. Defining MySQL Cluster Data Nodes
The [ndbd] and [ndbd
default] sections are used to configure the behavior
of the cluster's data nodes.
[ndbd] and [ndbd default]
are always used as the section names whether you are using
ndbd or (in MySQL Cluster NDB 6.4.0 and
later) ndbmtd binaries for the data node
processes.
There are many parameters which control buffer sizes, pool
sizes, timeouts, and so forth. The only mandatory parameters
are:
Either ExecuteOnComputer or
HostName, which must be defined in the
local [ndbd] section.
The parameter NoOfReplicas, which must be
defined in the[ndbd default]section, as
it is common to all Cluster data nodes.
Note
It is no longer strictly necessary to set
NoOfReplicas starting with MySQL Cluster
NDB 6.3.25 and MySQL Cluster NDB 7.0.6, where it acquires a
default value (2). However, it remains good practice to set it
explicitly.
Most data node parameters are set in the [ndbd
default] section. Only those parameters explicitly
stated as being able to set local values are allowed to be
changed in the [ndbd] section. Where present,
HostName, Id and
ExecuteOnComputer must
be defined in the local [ndbd] section, and
not in any other section of config.ini. In
other words, settings for these parameters are specific to one
data node.
For those parameters affecting memory usage or buffer sizes, it
is possible to use K, M,
or G as a suffix to indicate units of 1024,
1024?1024, or 1024?1024?1024. (For example,
100K means 100 ? 1024 = 102400.)
Parameter names and values are currently case-sensitive.
Information about configuration parameters specific to MySQL
Cluster Disk Data tables can be found later in this section.
Beginning with MySQL Cluster NDB 6.4.0, all of these parameters
also apply to ndbmtd (the multi-threaded
version of ndbd). An additional data node
configuration parameter
MaxNoOfExecutionThreads applies to
ndbmtd only, and has no effect when used with
ndbd. For more information, see
Section 17.4.3, “ndbmtd — The MySQL Cluster Data Node Daemon (Multi-Threaded)”.
Identifying data nodes.
The Id value (that is, the data node
identifier) can be allocated on the command line when the node
is started or in the configuration file.
Id
This is the node ID used as the address of the node for all
cluster internal messages. For data nodes, this is an
integer in the range 1 to 48 inclusive. Each node in the
cluster must have a unique identifier.
This parameter can also be written as
NodeId, although the short form is
sufficient (and preferred for this reason).
ExecuteOnComputer
This refers to the Id set for one of the
computers defined in a [computer]
section.
HostName
Specifying this parameter defines the hostname of the
computer on which the data node is to reside. To specify a
hostname other than localhost, either
this parameter or ExecuteOnComputer is
required.
ServerPort
Each node in the cluster uses a port to connect to other
nodes. By default, this port is allocated dynamically in
such a way as to ensure that no two nodes on the same host
computer receive the same port number, so it should normally
not be necessary to specify a value for this parameter.
However, if you need to be able to open specific ports in a
firewall to permit communication between data nodes and API
nodes (including SQL nodes), you can set this parameter to
the number of the desired port in an
[ndbd] section or (if you need to do this
for multiple data nodes) the [ndbd
default] section of the
config.ini file, and then open the port
having that number for incoming connections from SQL nodes,
API nodes, or both.
TcpBind_INADDR_ANY
Setting this parameter to TRUE or
1 binds IP_ADDR_ANY so
that connections can be made from anywhere (for
autogenerated connections). The default is
FALSE (0).
This parameter was added in MySQL Cluster NDB 6.2.0.
NodeGroup
This parameter can be used to assign a data node to a
specific node group. It is read only when the cluster is
started for the first time, and cannot be used to reassign a
data node to a different node group online. It is generally
not desirable to use this parameter in the [ndbd
default] section of the
config.ini file, and care must be taken
not to assign nodes to node groups in such a way that an
invalid numbers of nodes are assigned to any node groups.
The NodeGroup parameter is chiefly
intended for use in adding a new node group to a running
MySQL Cluster without having to perform a rolling restart.
For this purpose, you should set it to 65535 (the maximum
value). You are not required to set a
NodeGroup value for all cluster data
nodes, only for those nodes which are to be started and
added to the cluster as a new node group at a later time.
For more information, see
Section 17.5.11.3, “Adding MySQL Cluster Data Nodes Online: Detailed Example”.
This parameter was added in MySQL Cluster NDB 6.4.0.
NoOfReplicas
This global parameter can be set only in the [ndbd
default] section, and defines the number of
replicas for each table stored in the cluster. This
parameter also specifies the size of node groups. A node
group is a set of nodes all storing the same information.
Node groups are formed implicitly. The first node group is
formed by the set of data nodes with the lowest node IDs,
the next node group by the set of the next lowest node
identities, and so on. By way of example, assume that we
have 4 data nodes and that NoOfReplicas
is set to 2. The four data nodes have node IDs 2, 3, 4 and
5. Then the first node group is formed from nodes 2 and 3,
and the second node group by nodes 4 and 5. It is important
to configure the cluster in such a manner that nodes in the
same node groups are not placed on the same computer because
a single hardware failure would cause the entire cluster to
fail.
If no node IDs are provided, the order of the data nodes
will be the determining factor for the node group. Whether
or not explicit assignments are made, they can be viewed in
the output of the management client's
SHOW command.
Prior to MySQL Cluster NDB 6.3.25 and MySQL Cluster NDB
7.0.6, there was no default value for
NoOfReplicas; beginning with these
versions, the default value is 2, which is the recommended
setting in most common usage scenarios. (Bug#44746)
The maximum possible value is 4; currently, only
the values 1 and 2 are actually supported (see
Bug#18621).
Important
Setting NoOfReplicas to 1 means that
there is only a single copy of all Cluster data; in this
case, the loss of a single data node causes the cluster to
fail because there are no additional copies of the data
stored by that node.
The value for this parameter must divide evenly into the
number of data nodes in the cluster. For example, if there
are two data nodes, then NoOfReplicas
must be equal to either 1 or 2, since 2/3 and 2/4 both yield
fractional values; if there are four data nodes, then
NoOfReplicas must be equal to 1, 2, or 4.
DataDir
This parameter specifies the directory where trace files,
log files, pid files and error logs are placed.
The default is the data node process working directory.
FileSystemPath
This parameter specifies the directory where all files
created for metadata, REDO logs, UNDO logs (for Disk Data
tables), and data files are placed. The default is the
directory specified by DataDir.
Note
This directory must exist before the
ndbd process is initiated.
The recommended directory hierarchy for MySQL Cluster
includes /var/lib/mysql-cluster, under
which a directory for the node's file system is created. The
name of this subdirectory contains the node ID. For example,
if the node ID is 2, this subdirectory is named
ndb_2_fs.
BackupDataDir
This parameter specifies the directory in which backups are
placed. If omitted, the default backup location is the
directory named BACKUP under the
location specified by the FileSystemPath
parameter. (See above.)
Data Memory, Index Memory, and String
Memory
DataMemory and IndexMemory
are [ndbd] parameters specifying the size of
memory segments used to store the actual records and their
indexes. In setting values for these, it is important to
understand how DataMemory and
IndexMemory are used, as they usually need to
be updated to reflect actual usage by the cluster:
DataMemory
This parameter defines the amount of space (in bytes)
available for storing database records. The entire amount
specified by this value is allocated in memory, so it is
extremely important that the machine has sufficient physical
memory to accommodate it.
The memory allocated by DataMemory is
used to store both the actual records and indexes. There is
a 16-byte overhead on each record; an additional amount for
each record is incurred because it is stored in a 32KB page
with 128 byte page overhead (see below). There is also a
small amount wasted per page due to the fact that each
record is stored in only one page.
For variable-size table attributes in MySQL 5.1, the data is
stored on separate datapages, allocated from
DataMemory. Variable-length records use a
fixed-size part with an extra overhead of 4 bytes to
reference the variable-size part. The variable-size part has
2 bytes overhead plus 2 bytes per attribute.
The maximum record size is currently 8052 bytes.
The memory space defined by DataMemory is
also used to store ordered indexes, which use about 10 bytes
per record. Each table row is represented in the ordered
index. A common error among users is to assume that all
indexes are stored in the memory allocated by
IndexMemory, but this is not the case:
Only primary key and unique hash indexes use this memory;
ordered indexes use the memory allocated by
DataMemory. However, creating a primary
key or unique hash index also creates an ordered index on
the same keys, unless you specify USING
HASH in the index creation statement. This can be
verified by running ndb_desc -d
db_name
table_name in the
management client.
The memory space allocated by DataMemory
consists of 32KB pages, which are allocated to table
fragments. Each table is normally partitioned into the same
number of fragments as there are data nodes in the cluster.
Thus, for each node, there are the same number of fragments
as are set in NoOfReplicas.
In addition, due to the way in which new pages are allocated
when the capacity of the current page is exhausted, there is
an additional overhead of approximately 18.75%. When more
DataMemory is required, more than one new
page is allocated, according to the following formula:
number of new pages = FLOOR(number of current pages ? 0.1875) + 1
For example, if 15 pages are currently allocated to a given
table and an insert to this table requires additional
storage space, the number of new pages allocated to the
table is FLOOR(15 ? 0.1875) + 1 =
FLOOR(2.8125) + 1 = 2 + 1 =
3. Now 15 + 3 = 18 memory pages are
allocated to the table. When the last of these 18 pages
becomes full, FLOOR(18 ? 0.1875) + 1
= FLOOR(3.3750) + 1 = 3 + 1 =
4 new pages are allocated, so the total number of
pages allocated to the table is now 22.
Note
The “18.75% + 1” overhead is no longer
required beginning with MySQL Cluster NDB 6.2.3 and MySQL
Cluster NDB 6.3.0.
Once a page has been allocated, it is currently not possible
to return it to the pool of free pages, except by deleting
the table. (This also means that
DataMemory pages, once allocated to a
given table, cannot be used by other tables.) Performing a
node recovery also compresses the partition because all
records are inserted into empty partitions from other live
nodes.
The DataMemory memory space also contains
UNDO information: For each update, a copy of the unaltered
record is allocated in the DataMemory.
There is also a reference to each copy in the ordered table
indexes. Unique hash indexes are updated only when the
unique index columns are updated, in which case a new entry
in the index table is inserted and the old entry is deleted
upon commit. For this reason, it is also necessary to
allocate enough memory to handle the largest transactions
performed by applications using the cluster. In any case,
performing a few large transactions holds no advantage over
using many smaller ones, for the following reasons:
Large transactions are not any faster than smaller ones
Large transactions increase the number of operations
that are lost and must be repeated in event of
transaction failure
Large transactions use more memory
The default value for DataMemory is 80MB;
the minimum is 1MB. There is no maximum size, but in reality
the maximum size has to be adapted so that the process does
not start swapping when the limit is reached. This limit is
determined by the amount of physical RAM available on the
machine and by the amount of memory that the operating
system may commit to any one process. 32-bit operating
systems are generally limited to 2–4GB per process;
64-bit operating systems can use more. For large databases,
it may be preferable to use a 64-bit operating system for
this reason.
IndexMemory
This parameter controls the amount of storage used for hash
indexes in MySQL Cluster. Hash indexes are always used for
primary key indexes, unique indexes, and unique constraints.
Note that when defining a primary key and a unique index,
two indexes will be created, one of which is a hash index
used for all tuple accesses as well as lock handling. It is
also used to enforce unique constraints.
The size of the hash index is 25 bytes per record, plus the
size of the primary key. For primary keys larger than 32
bytes another 8 bytes is added.
The default value for IndexMemory is
18MB. The minimum is 1MB.
StringMemory
This parameter determines how much memory is allocated for
strings such as table names, and is specified in an
[ndbd] or [ndbd
default] section of the
config.ini file. A value between
0 and 100 inclusive is
interpreted as a percent of the maximum default value, which
is calculated based on a number of factors including the
number of tables, maximum table name size, maximum size of
.FRM files,
MaxNoOfTriggers, maximum column name
size, and maximum default column value. In general it is
safe to assume that the maximum default value is
approximately 5 MB for a MySQL Cluster having 1000 tables.
A value greater than 100 is interpreted
as a number of bytes.
Beginning with MySQL Cluster NDB 6.2.18, MySQL Cluster NDB
6.3.24, and MySQL Cluster NDB 7.0.5, the default value is 25
— that is, 25 percent of the default maximum, or
approximately 25 KB. (Previously, the default value was 5
beginning with MySQL 5.1.6; prior to MySQL 5.1.6, the
default was 0.)
Under most circumstances, the default value should be
sufficient, but when you have a great many Cluster tables
(1000 or more), it is possible to get Error 773
Out of string memory, please modify StringMemory
config parameter: Permanent error: Schema error,
in which case you should increase this value.
25 (25 percent) is not excessive, and
should prevent this error from recurring in all but the most
extreme conditions.
The following example illustrates how memory is used for a
table. Consider this table definition:
CREATE TABLE example (
a INT NOT NULL,
b INT NOT NULL,
c INT NOT NULL,
PRIMARY KEY(a),
UNIQUE(b)
) ENGINE=NDBCLUSTER;
For each record, there are 12 bytes of data plus 12 bytes
overhead. Having no nullable columns saves 4 bytes of overhead.
In addition, we have two ordered indexes on columns
a and b consuming roughly
10 bytes each per record. There is a primary key hash index on
the base table using roughly 29 bytes per record. The unique
constraint is implemented by a separate table with
b as primary key and a as
a column. This other table consumes an additional 29 bytes of
index memory per record in the example table
as well 8 bytes of record data plus 12 bytes of overhead.
Thus, for one million records, we need 58MB for index memory to
handle the hash indexes for the primary key and the unique
constraint. We also need 64MB for the records of the base table
and the unique index table, plus the two ordered index tables.
You can see that hash indexes takes up a fair amount of memory
space; however, they provide very fast access to the data in
return. They are also used in MySQL Cluster to handle uniqueness
constraints.
Currently, the only partitioning algorithm is hashing and
ordered indexes are local to each node. Thus, ordered indexes
cannot be used to handle uniqueness constraints in the general
case.
An important point for both IndexMemory and
DataMemory is that the total database size is
the sum of all data memory and all index memory for each node
group. Each node group is used to store replicated information,
so if there are four nodes with two replicas, there will be two
node groups. Thus, the total data memory available is 2 ?
DataMemory for each data node.
It is highly recommended that DataMemory and
IndexMemory be set to the same values for all
nodes. Data distribution is even over all nodes in the cluster,
so the maximum amount of space available for any node can be no
greater than that of the smallest node in the cluster.
DataMemory and IndexMemory
can be changed, but decreasing either of these can be risky;
doing so can easily lead to a node or even an entire MySQL
Cluster that is unable to restart due to there being
insufficient memory space. Increasing these values should be
acceptable, but it is recommended that such upgrades are
performed in the same manner as a software upgrade, beginning
with an update of the configuration file, and then restarting
the management server followed by restarting each data node in
turn.
Updates do not increase the amount of index memory used. Inserts
take effect immediately; however, rows are not actually deleted
until the transaction is committed.
Transaction parameters.
The next three [ndbd] parameters that we
discuss are important because they affect the number of
parallel transactions and the sizes of transactions that can
be handled by the system.
MaxNoOfConcurrentTransactions sets the
number of parallel transactions possible in a node.
MaxNoOfConcurrentOperations sets the number
of records that can be in update phase or locked
simultaneously.
Both of these parameters (especially
MaxNoOfConcurrentOperations) are likely
targets for users setting specific values and not using the
default value. The default value is set for systems using small
transactions, to ensure that these do not use excessive memory.
MaxNoOfConcurrentTransactions
Each cluster data node requires a transaction record for
each active transaction in the cluster. The task of
coordinating transactions is distributed among all of the
data nodes. The total number of transaction records in the
cluster is the number of transactions in any given node
times the number of nodes in the cluster.
Transaction records are allocated to individual MySQL
servers. Each connection to a MySQL server requires at least
one transaction record, plus an additional transaction
object per table accessed by that connection. This means
that a reasonable minimum for this parameter is
MaxNoOfConcurrentTransactions =
(maximum number of tables accessed in any single transaction + 1)
* number of cluster SQL nodes
Suppose that there are 4 SQL nodes using the cluster. A
single join involving 5 tables requires 6 transaction
records; if there are 5 such joins in a transaction, then 5
* 6 = 30 transaction records are required for this
transaction, per MySQL server, or 30 * 4 = 120 transaction
records total.
This parameter must be set to the same value for all cluster
data nodes. This is due to the fact that, when a data node
fails, the oldest surviving node re-creates the transaction
state of all transactions that were ongoing in the failed
node.
Changing the value of
MaxNoOfConcurrentTransactions requires a
complete shutdown and restart of the cluster.
The default value is 4096.
MaxNoOfConcurrentOperations
It is a good idea to adjust the value of this parameter
according to the size and number of transactions. When
performing transactions of only a few operations each and
not involving a great many records, there is no need to set
this parameter very high. When performing large transactions
involving many records need to set this parameter higher.
Records are kept for each transaction updating cluster data,
both in the transaction coordinator and in the nodes where
the actual updates are performed. These records contain
state information needed to find UNDO records for rollback,
lock queues, and other purposes.
This parameter should be set to the number of records to be
updated simultaneously in transactions, divided by the
number of cluster data nodes. For example, in a cluster
which has four data nodes and which is expected to handle
1,000,000 concurrent updates using transactions, you should
set this value to 1000000 / 4 = 250000.
Read queries which set locks also cause operation records to
be created. Some extra space is allocated within individual
nodes to accommodate cases where the distribution is not
perfect over the nodes.
When queries make use of the unique hash index, there are
actually two operation records used per record in the
transaction. The first record represents the read in the
index table and the second handles the operation on the base
table.
The default value is 32768.
This parameter actually handles two values that can be
configured separately. The first of these specifies how many
operation records are to be placed with the transaction
coordinator. The second part specifies how many operation
records are to be local to the database.
A very large transaction performed on an eight-node cluster
requires as many operation records in the transaction
coordinator as there are reads, updates, and deletes
involved in the transaction. However, the operation records
of the are spread over all eight nodes. Thus, if it is
necessary to configure the system for one very large
transaction, it is a good idea to configure the two parts
separately. MaxNoOfConcurrentOperations
will always be used to calculate the number of operation
records in the transaction coordinator portion of the node.
It is also important to have an idea of the memory
requirements for operation records. These consume about 1KB
per record.
MaxNoOfLocalOperations
By default, this parameter is calculated as 1.1 ?
MaxNoOfConcurrentOperations. This fits
systems with many simultaneous transactions, none of them
being very large. If there is a need to handle one very
large transaction at a time and there are many nodes, it is
a good idea to override the default value by explicitly
specifying this parameter.
Transaction temporary storage.
The next set of [ndbd] parameters is used
to determine temporary storage when executing a statement that
is part of a Cluster transaction. All records are released
when the statement is completed and the cluster is waiting for
the commit or rollback.
The default values for these parameters are adequate for most
situations. However, users with a need to support transactions
involving large numbers of rows or operations may need to
increase these values to enable better parallelism in the
system, whereas users whose applications require relatively
small transactions can decrease the values to save memory.
MaxNoOfConcurrentIndexOperations
For queries using a unique hash index, another temporary set
of operation records is used during a query's execution
phase. This parameter sets the size of that pool of records.
Thus, this record is allocated only while executing a part
of a query. As soon as this part has been executed, the
record is released. The state needed to handle aborts and
commits is handled by the normal operation records, where
the pool size is set by the parameter
MaxNoOfConcurrentOperations.
The default value of this parameter is 8192. Only in rare
cases of extremely high parallelism using unique hash
indexes should it be necessary to increase this value. Using
a smaller value is possible and can save memory if the DBA
is certain that a high degree of parallelism is not required
for the cluster.
MaxNoOfFiredTriggers
The default value of MaxNoOfFiredTriggers
is 4000, which is sufficient for most situations. In some
cases it can even be decreased if the DBA feels certain the
need for parallelism in the cluster is not high.
A record is created when an operation is performed that
affects a unique hash index. Inserting or deleting a record
in a table with unique hash indexes or updating a column
that is part of a unique hash index fires an insert or a
delete in the index table. The resulting record is used to
represent this index table operation while waiting for the
original operation that fired it to complete. This operation
is short-lived but can still require a large number of
records in its pool for situations with many parallel write
operations on a base table containing a set of unique hash
indexes.
TransactionBufferMemory
The memory affected by this parameter is used for tracking
operations fired when updating index tables and reading
unique indexes. This memory is used to store the key and
column information for these operations. It is only very
rarely that the value for this parameter needs to be altered
from the default.
The default value for
TransactionBufferMemory is 1MB.
Normal read and write operations use a similar buffer, whose
usage is even more short-lived. The compile-time parameter
ZATTRBUF_FILESIZE (found in
ndb/src/kernel/blocks/Dbtc/Dbtc.hpp)
set to 4000 ? 128 bytes (500KB). A similar buffer for
key information, ZDATABUF_FILESIZE (also
in Dbtc.hpp) contains 4000 ? 16 =
62.5KB of buffer space. Dbtc is the
module that handles transaction coordination.
Scans and buffering.
There are additional [ndbd] parameters in
the Dblqh module (in
ndb/src/kernel/blocks/Dblqh/Dblqh.hpp)
that affect reads and updates. These include
ZATTRINBUF_FILESIZE, set by default to
10000 ? 128 bytes (1250KB) and
ZDATABUF_FILE_SIZE, set by default to
10000*16 bytes (roughly 156KB) of buffer space. To date, there
have been neither any reports from users nor any results from
our own extensive tests suggesting that either of these
compile-time limits should be increased.
MaxNoOfConcurrentScans
This parameter is used to control the number of parallel
scans that can be performed in the cluster. Each transaction
coordinator can handle the number of parallel scans defined
for this parameter. Each scan query is performed by scanning
all partitions in parallel. Each partition scan uses a scan
record in the node where the partition is located, the
number of records being the value of this parameter times
the number of nodes. The cluster should be able to sustain
MaxNoOfConcurrentScans scans concurrently
from all nodes in the cluster.
Scans are actually performed in two cases. The first of
these cases occurs when no hash or ordered indexes exists to
handle the query, in which case the query is executed by
performing a full table scan. The second case is encountered
when there is no hash index to support the query but there
is an ordered index. Using the ordered index means executing
a parallel range scan. The order is kept on the local
partitions only, so it is necessary to perform the index
scan on all partitions.
The default value of
MaxNoOfConcurrentScans is 256. The
maximum value is 500.
MaxNoOfLocalScans
Specifies the number of local scan records if many scans are
not fully parallelized. If the number of local scan records
is not provided, it is calculated as the product of
MaxNoOfConcurrentScans and the number of
data nodes in the system. The minimum value is 32.
BatchSizePerLocalScan
This parameter is used to calculate the number of lock
records used to handle concurrent scan operations.
The default value is 64; this value has a strong connection
to the ScanBatchSize defined in the SQL
nodes.
LongMessageBuffer
This is an internal buffer used for passing messages within
individual nodes and between nodes. Although it is highly
unlikely that this would need to be changed, it is
configurable. In MySQL Cluster NDB 6.4.3 and earlier, the
default is 1MB; beginning with MySQL Cluster NDB 7.0.4, it
is 4MB.
Memory Allocation
MaxAllocate
This is the maximum size of the memory unit to use when
allocating memory for tables. In cases where
NDB gives Out of
memory errors, but it is evident by examining the
cluster logs or the output of DUMP 1000 (see
DUMP 1000) that all
available memory has not yet been used, you can increase the
value of this parameter (or MaxNoOfTables, or
both) in order to cause NDB to make
sufficient memory available.
This parameter was introduced in MySQL 5.1.20, MySQL Cluster NDB
6.1.12 and MySQL Cluster NDB 6.2.3.
Logging and checkpointing
The following [ndbd] parameters control log
and checkpoint behavior.
NoOfFragmentLogFiles
This parameter sets the number of REDO log files for the
node, and thus the amount of space allocated to REDO
logging. Because the REDO log files are organized in a ring,
it is extremely important that the first and last log files
in the set (sometimes referred to as the “head”
and “tail” log files, respectively) do not
meet. When these approach one another too closely, the node
begins aborting all transactions encompassing updates due to
a lack of room for new log records.
A REDO log record is not removed until
the required number of local checkpoints has been completed
since that log record was inserted (prior to MySQL Cluster
NDB 6.3.8, this was 3 local checkpoints; in later versions
of MySQL Cluster, only 2 local checkpoints are necessary).
Checkpointing frequency is determined by its own set of
configuration parameters discussed elsewhere in this
chapter.
How these parameters interact and proposals for how to
configure them are discussed in
Section 17.3.2.12, “Configuring MySQL Cluster Parameters for Local Checkpoints”.
The default parameter value is 16, which by default means 16
sets of 4 16MB files for a total of 1024MB. Beginning with
MySQL Cluster NDB 6.1.1, the size of the individual log
files is configurable using the
FragmentLogFileSize parameter; more
information about this parameter can be found
here.
In scenarios requiring a great many updates, the value for
NoOfFragmentLogFiles may need to be set
as high as 300 or even higher to provide sufficient space
for REDO logs.
If the checkpointing is slow and there are so many writes to
the database that the log files are full and the log tail
cannot be cut without jeopardizing recovery, all updating
transactions are aborted with internal error code 410
(Out of log file space temporarily). This
condition prevails until a checkpoint has completed and the
log tail can be moved forward.
Important
This parameter cannot be changed “on the
fly”; you must restart the node using
--initial. If you wish to change this
value for all data nodes in a running cluster, you can do
so via a rolling node restart (using
--initial when starting each data node).
FragmentLogFileSize
Setting this parameter allows you to control directly the
size of redo log files. This can be useful in situations
when MySQL Cluster is operating under a high load and it is
unable to close fragment log files quickly enough before
attempting to open new ones (only 2 fragment log files can
be open at one time); increasing the size of the fragment
log files gives the cluster more time before having to open
each new fragment log file. The default value for this
parameter is 16M. FragmentLogFileSize was
added in MySQL Cluster NDB 6.1.11.
For more information about fragment log files, see the
description of the
NoOfFragmentLogFiles
parameter.
InitFragmentLogFiles
By default, fragment log files are created sparsely when
performing an initial start of a data node — that is,
depending on the operating system and file system in use,
not all bytes are necessarily written to disk. Beginning
with MySQL Cluster NDB 6.3.19, it is possible to override
this behavior and force all bytes to be written regardless
of the platform and file system type being used by mean of
this parameter.
InitFragmentLogFiles takes one of two
values:
Depending on your operating system and file system, setting
InitFragmentLogFiles=FULL may help
eliminate I/O errors on writes to the REDO log.
MaxNoOfOpenFiles
This parameter sets a ceiling on how many internal threads
to allocate for open files. Any situation
requiring a change in this parameter should be reported as a
bug.
The default value is 0. (Prior to MySQL 5.1.16, the default
was 40.) However, the minimum value to which this parameter
can be set is 20.
InitialNoOfOpenFiles
This parameter sets the initial number of internal threads
to allocate for open files.
The default value is 27.
MaxNoOfSavedMessages
This parameter sets the maximum number of trace files that
are kept before overwriting old ones. Trace files are
generated when, for whatever reason, the node crashes.
The default is 25 trace files.
MaxLCPStartDelay
In parallel data node recovery (supported in MySQL Cluster
NDB 6.3.8 and later), only table data is actually copied and
synchronized in parallel; synchronization of metadata such
as dictionary and checkpoint information is done in a serial
fashion. In addition, recovery of dictionary and checkpoint
information cannot be executed in parallel with performing
of local checkpoints. This means that, when starting or
restarting many data nodes concurrently, data nodes may be
forced to wait while a local checkpoint is performed, which
can result in longer node recovery times.
Beginning with MySQL Cluster NDB 6.3.23 and MySQL Cluster
NDB 6.4.3, it is possible to force a delay in the local
checkpoint to allow more (and possibly all) data nodes to
complete metadata synchronization; once each data
node's metadata synchronization is complete, all of the
data nodes can recover table data in parallel, even while
the local checkpoint is being executed.
To force such a delay, you can set
MaxLCPStartDelay, which determines the
number of seconds the cluster can wait to begin a local
checkpoint while data nodes continue to synchronize
metadata. This parameter should be set in the [ndbd
default] section of the
config.ini file, so that it is the same
for all data nodes. The maximum value is 600; the default is
0.
Metadata objects.
The next set of [ndbd] parameters defines
pool sizes for metadata objects, used to define the maximum
number of attributes, tables, indexes, and trigger objects
used by indexes, events, and replication between clusters.
Note that these act merely as “suggestions” to
the cluster, and any that are not specified revert to the
default values shown.
MaxNoOfAttributes
Defines the number of attributes that can be defined in the
cluster.
The default value is 1000, with the minimum possible value
being 32. The maximum is 4294967039. Each attribute consumes
around 200 bytes of storage per node due to the fact that
all metadata is fully replicated on the servers.
When setting MaxNoOfAttributes, it is
important to prepare in advance for any
ALTER TABLE statements that
you might want to perform in the future. This is due to the
fact, during the execution of ALTER
TABLE on a Cluster table, 3 times the number of
attributes as in the original table are used, and a good
practice is to allow double this amount. For example, if the
MySQL Cluster table having the greatest number of attributes
(greatest_number_of_attributes)
has 100 attributes, a good starting point for the value of
MaxNoOfAttributes would be 6 *
greatest_number_of_attributes =
600.
You should also estimate the average number of attributes
per table and multiply this by
MaxNoOfTables. If this value is larger
than the value obtained in the previous paragraph, you
should use the larger value instead.
Assuming that you can create all desired tables without any
problems, you should also verify that this number is
sufficient by trying an actual ALTER
TABLE after configuring the parameter. If this is
not successful, increase
MaxNoOfAttributes by another multiple of
MaxNoOfTables and test it again.
MaxNoOfTables
A table object is allocated for each table and for each
unique hash index in the cluster. This parameter sets the
maximum number of table objects for the cluster as a whole.
For each attribute that has a
BLOB data type an extra table
is used to store most of the
BLOB data. These tables also
must be taken into account when defining the total number of
tables.
The default value of this parameter is 128. The minimum is 8
and the maximum is 20320. Each table object consumes
approximately 20KB per node.
Note
The sum of MaxNoOfTables,
MaxNoOfOrderedIndexes, and
MaxNoOfUniqueHashIndexes must not
exceed 232 –
2 (4294967294).
MaxNoOfOrderedIndexes
| |