Chapter 5 Configuration of NDB Cluster

Table of Contents

5.1 Quick Test Setup of NDB Cluster
5.2 Overview of NDB Cluster Configuration Parameters, Options, and Variables
5.2.1 NDB Cluster Data Node Configuration Parameters
5.2.2 NDB Cluster Management Node Configuration Parameters
5.2.3 NDB Cluster SQL Node and API Node Configuration Parameters
5.2.4 Other NDB Cluster Configuration Parameters
5.2.5 NDB Cluster mysqld Option and Variable Reference
5.3 NDB Cluster Configuration Files
5.3.1 NDB Cluster Configuration: Basic Example
5.3.2 Recommended Starting Configuration for NDB Cluster
5.3.3 NDB Cluster Connection Strings
5.3.4 Defining Computers in an NDB Cluster
5.3.5 Defining an NDB Cluster Management Server
5.3.6 Defining NDB Cluster Data Nodes
5.3.7 Defining SQL and Other API Nodes in an NDB Cluster
5.3.8 MySQL Server Options and Variables for NDB Cluster
5.3.9 NDB Cluster TCP/IP Connections
5.3.10 NDB Cluster TCP/IP Connections Using Direct Connections
5.3.11 NDB Cluster Shared-Memory Connections
5.3.12 SCI Transport Connections in NDB Cluster
5.3.13 Configuring NDB Cluster Send Buffer Parameters
5.4 Using High-Speed Interconnects with NDB Cluster

A MySQL server that is part of an NDB Cluster differs in one chief respect from a normal (nonclustered) MySQL server, in that it employs the NDB storage engine. This engine is also referred to sometimes as NDBCLUSTER, although NDB is preferred.

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.

This MySQL server is a part of the cluster, so it also must know how to access a management node to obtain the cluster configuration data. The default behavior is to look for the management node on localhost. However, should you need to specify that its location is elsewhere, this can be done in my.cnf, or with the mysql client. Before the NDB storage engine can be used, at least one management node must be operational, as well as any desired data nodes.

For more information about --ndbcluster and other mysqld options specific to NDB Cluster , see Section 5.3.8.1, “MySQL Server Options for NDB Cluster”.

You can use also the NDB Cluster Auto-Installer to set up and deploy an NDB Cluster on one or more hosts using a browser-based GUI. For more information, see Section 4.1, “The NDB Cluster Auto-Installer”.

For general information about installing NDB Cluster , see Chapter 4, NDB Cluster Installation.

5.1 Quick Test Setup of NDB Cluster

To familiarize you with the basics, we will describe the simplest possible configuration for a functional NDB 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 6.27, “Options Common to NDB Cluster Programs — Options Common to NDB 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.7.18
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: 5.7.16-ndb-7.5.5, Nodegroup: 0, *)
[ndb_mgmd(MGM)] 1 node(s)
id=1    @127.0.0.1  (Version: 5.7.16-ndb-7.5.5)
[mysqld(API)]   3 node(s)
id=3    @127.0.0.1  (Version: 5.7.16-ndb-7.5.5)
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 NDB Cluster . You can now store data in the cluster by using any table created with ENGINE=NDBCLUSTER or its alias ENGINE=NDB.

5.2 Overview of NDB Cluster Configuration Parameters, Options, and Variables

The next several sections provide summary tables of NDB Cluster node configuration parameters used in the config.ini file to govern various aspects of node behavior, as well as of options and variables read by mysqld from a my.cnf file or from the command line when run as an NDB Cluster process. Each of the node parameter tables lists the parameters for a given type (ndbd, ndb_mgmd, mysqld, computer, tcp, shm, or sci). All tables include the data type for the parameter, option, or variable, as well as its default, mimimum, and maximum values as applicable.

Considerations when restarting nodes.  For node parameters, these tables also indicate what type of restart is required (node restart or system restart)—and whether the restart must be done with --initial—to change the value of a given configuration parameter. When performing a node restart or an initial node restart, all of the cluster's data nodes must be restarted in turn (also referred to as a rolling restart). It is possible to update cluster configuration parameters marked as node online—that is, without shutting down the cluster—in this fashion. An initial node restart requires restarting each ndbd process with the --initial option.

A system restart requires a complete shutdown and restart of the entire cluster. An initial system restart requires taking a backup of the cluster, wiping the cluster file system after shutdown, and then restoring from the backup following the restart.

In any cluster restart, all of the cluster's management servers must be restarted for them to read the updated configuration parameter values.

Important

Values for numeric cluster parameters can generally be increased without any problems, although it is advisable to do so progressively, making such adjustments in relatively small increments. Many of these can be increased online, using a rolling restart.

However, decreasing the values of such parameters—whether this is done using a node restart, node initial restart, or even a complete system restart of the cluster—is not to be undertaken lightly; it is recommended that you do so only after careful planning and testing. This is especially true with regard to those parameters that relate to memory usage and disk space. In addition, it is the generally the case that configuration parameters relating to memory and disk usage can be raised using a simple node restart, but they require an initial node restart to be lowered.

Because some of these parameters can be used for configuring more than one type of cluster node, they may appear in more than one of the tables.

Note

4294967039 often appears as a maximum value in these tables. This value is defined in the NDBCLUSTER sources as MAX_INT_RNIL and is equal to 0xFFFFFEFF, or 232 − 28 − 1.

5.2.1 NDB Cluster Data Node Configuration Parameters

The summary table in this section provides information about parameters used in the [ndbd] or [ndbd default] sections of a config.ini file for configuring NDB Cluster data nodes. For detailed descriptions and other additional information about each of these parameters, see Section 5.3.6, “Defining NDB Cluster Data Nodes”.

These parameters also apply to ndbmtd, the multi-threaded version of ndbd. For more information, see Section 6.3, “ndbmtd — The NDB Cluster Data Node Daemon (Multi-Threaded)”.

Restart types.  Changes in NDB Cluster configuration parameters do not take effect until the cluster is restarted. The type of restart required to change a given parameter is indicated in the summary table as follows:

For more information about restart types, see Section 5.2, “Overview of NDB Cluster Configuration Parameters, Options, and Variables”.

NDB Cluster also supports the addition of new data node groups online, to a running cluster. For more information, see Section 7.14, “Adding NDB Cluster Data Nodes Online”.

Table 5.1 Data Node Configuration Parameters

Parameter NameType or UnitsRestart TypeIn Version ... (and later)
Default Value
Minimum/Maximum or Permitted Values

Arbitration

enumerationNNDB 7.5.0
Default
Default, Disabled, WaitExternal

ArbitrationTimeout

millisecondsNNDB 7.5.0
7500
10 / 4294967039 (0xFFFFFEFF)

BackupDataBufferSize

bytesNNDB 7.5.1
16M
512K / 4294967039 (0xFFFFFEFF)

BackupDataDir

pathINNDB 7.5.0
FileSystemPath
...

BackupDiskWriteSpeedPct

percentNNDB 7.5.0
50
0 / 90

BackupLogBufferSize

bytesNNDB 7.5.0
16M
2M / 4294967039 (0xFFFFFEFF)

BackupMaxWriteSize

bytesNNDB 7.5.0
1M
256K / 4294967039 (0xFFFFFEFF)

BackupMemory

bytesNNDB 7.5.0
32M
0 / 4294967039 (0xFFFFFEFF)

BackupReportFrequency

secondsNNDB 7.5.0
0
0 / 4294967039 (0xFFFFFEFF)

BackupWriteSize

bytesNNDB 7.5.0
256K
32K / 4294967039 (0xFFFFFEFF)

BatchSizePerLocalScan

integerNNDB 7.5.0
256
1 / 992

BuildIndexThreads

numericSNDB 7.5.0
0
0 / 128

CompressedBackup

booleanNNDB 7.5.0
false
true, false

CompressedLCP

booleanNNDB 7.5.0
false
true, false

ConnectCheckIntervalDelay

millisecondsNNDB 7.5.0
0
0 / 4294967039 (0xFFFFFEFF)

CrashOnCorruptedTuple

booleanSNDB 7.5.0
true
true, false

DataDir

pathINNDB 7.5.0
.
...

DataMemory

bytesNNDB 7.5.0
80M
1M / 1024G

DefaultHashMapSize

LDM threadsNNDB 7.5.0
3840
0 / 3840

DictTrace

bytesNNDB 7.5.0
undefined
0 / 100

DiskIOThreadPool

threadsNNDB 7.5.0
2
0 / 4294967039 (0xFFFFFEFF)

Diskless

true|false (1|0)ISNDB 7.5.0
false
true, false

DiskPageBufferEntries

32K pagesNNDB 7.5.0
10
1 / 1000

DiskPageBufferMemory

bytesNNDB 7.5.0
64M
4M / 1T

DiskSyncSize

bytesNNDB 7.5.0
4M
32K / 4294967039 (0xFFFFFEFF)

ExecuteOnComputer

nameSNDB 7.5.0
[none]
...

ExtraSendBufferMemory

bytesNNDB 7.5.0
0
0 / 32G

FileSystemPath

pathINNDB 7.5.0
DataDir
...

FileSystemPathDataFiles

filenameINNDB 7.5.0
[see text]
...

FileSystemPathDD

filenameINNDB 7.5.0
FileSystemPath
...

FileSystemPathUndoFiles

filenameINNDB 7.5.0
[see text]
...

FragmentLogFileSize

bytesINNDB 7.5.0
16M
4M / 1G

HeartbeatIntervalDbApi

millisecondsNNDB 7.5.0
1500
100 / 4294967039 (0xFFFFFEFF)

HeartbeatIntervalDbDb

millisecondsNNDB 7.5.0
5000
10 / 4294967039 (0xFFFFFEFF)

HeartbeatOrder

numericSNDB 7.5.0
0
0 / 65535

HostName

name or IP addressNNDB 7.5.0
localhost
...

IndexMemory

bytesNNDB 7.5.0
18M
1M / 1T

IndexStatAutoCreate

booleanSNDB 7.5.0
false
false, true

IndexStatAutoUpdate

booleanSNDB 7.5.0
false
false, true

IndexStatSaveScale

percentageINNDB 7.5.0
100
0 / 4294967039 (0xFFFFFEFF)

IndexStatSaveSize

bytesINNDB 7.5.0
32768
0 / 4294967039 (0xFFFFFEFF)

IndexStatTriggerPct

percentageINNDB 7.5.0
100
0 / 4294967039 (0xFFFFFEFF)

IndexStatTriggerScale

percentageINNDB 7.5.0
100
0 / 4294967039 (0xFFFFFEFF)

IndexStatUpdateDelay

secondsINNDB 7.5.0
60
0 / 4294967039 (0xFFFFFEFF)

InitFragmentLogFiles

[see values]INNDB 7.5.0
SPARSE
SPARSE, FULL

InitialLogFileGroup

stringSNDB 7.5.0
[see text]
...

InitialNoOfOpenFiles

filesNNDB 7.5.0
27
20 / 4294967039 (0xFFFFFEFF)

InitialTablespace

stringSNDB 7.5.0
[see text]
...

LateAlloc

numericNNDB 7.5.0
1
0 / 1

LcpScanProgressTimeout

secondNNDB 7.5.0
60
0 / 4294967039 (0xFFFFFEFF)

LockExecuteThreadToCPU

CPU IDNNDB 7.5.0
64K
0 / 64K

LockMaintThreadsToCPU

CPU IDNNDB 7.5.0
[none]
0 / 64K

LockPagesInMainMemory

numericNNDB 7.5.0
0
0 / 2

LogLevelCheckpoint

log levelNNDB 7.5.0
0
0 / 15

LogLevelCongestion

levelrNNDB 7.5.0
0
0 / 15

LogLevelConnection

integerNNDB 7.5.0
0
0 / 15

LogLevelError

integerNNDB 7.5.0
0
0 / 15

LogLevelInfo

integerNNDB 7.5.0
0
0 / 15

LogLevelNodeRestart

integerNNDB 7.5.0
0
0 / 15

LogLevelShutdown

integerNNDB 7.5.0
0
0 / 15

LogLevelStartup

integerNNDB 7.5.0
1
0 / 15

LogLevelStatistic

integerNNDB 7.5.0
0
0 / 15

LongMessageBuffer

bytesNNDB 7.5.0
64M
512K / 4294967039 (0xFFFFFEFF)

MaxAllocate

unsignedNNDB 7.5.0
32M
1M / 1G

MaxBufferedEpochs

epochsNNDB 7.5.0
100
0 / 100000

MaxBufferedEpochBytes

bytesNNDB 7.5.0
26214400
26214400 (0x01900000) / 4294967039 (0xFFFFFEFF)

MaxDiskWriteSpeed

numericSNDB 7.5.0
20M
1M / 1024G

MaxDiskWriteSpeedOtherNodeRestart

numericSNDB 7.5.0
50M
1M / 1024G

MaxDiskWriteSpeedOwnRestart

numericSNDB 7.5.0
200M
1M / 1024G

MaxDMLOperationsPerTransaction

operations (DML)NNDB 7.5.0
4294967295
32 / 4294967295

MaxLCPStartDelay

secondsNNDB 7.5.0
0
0 / 600

MaxNoOfAttributes

integerNNDB 7.5.0
1000
32 / 4294967039 (0xFFFFFEFF)

MaxNoOfConcurrentIndexOperations

integerNNDB 7.5.0
8K
0 / 4294967039 (0xFFFFFEFF)

MaxNoOfConcurrentOperations

integerNNDB 7.5.0
32K
32 / 4294967039 (0xFFFFFEFF)

MaxNoOfConcurrentScans

integerNNDB 7.5.0
256
2 / 500

MaxNoOfConcurrentSubOperations

unsignedNNDB 7.5.0
256
0 / 4294967039 (0xFFFFFEFF)

MaxNoOfConcurrentTransactions

integerNNDB 7.5.0
4096
32 / 4294967039 (0xFFFFFEFF)

MaxNoOfFiredTriggers

integerNNDB 7.5.0
4000
0 / 4294967039 (0xFFFFFEFF)

MaxNoOfLocalOperations

integerNNDB 7.5.0
UNDEFINED
32 / 4294967039 (0xFFFFFEFF)

MaxNoOfLocalScans

integerNNDB 7.5.0
[see text]
32 / 4294967039 (0xFFFFFEFF)

MaxNoOfOpenFiles

unsignedNNDB 7.5.0
0
20 / 4294967039 (0xFFFFFEFF)

MaxNoOfOrderedIndexes

integerNNDB 7.5.0
128
0 / 4294967039 (0xFFFFFEFF)

MaxNoOfSavedMessages

integerNNDB 7.5.0
25
0 / 4294967039 (0xFFFFFEFF)

MaxNoOfSubscribers

unsignedNNDB 7.5.0
0
0 / 4294967039 (0xFFFFFEFF)

MaxNoOfSubscriptions

unsignedNNDB 7.5.0
0
0 / 4294967039 (0xFFFFFEFF)

MaxNoOfTables

integerNNDB 7.5.0
128
8 / 20320

MaxNoOfTriggers

integerNNDB 7.5.0
768
0 / 4294967039 (0xFFFFFEFF)

MaxParallelCopyInstances

integerSNDB 7.5.0
0
0 / 64

MaxParallelScansPerFragment

bytesNNDB 7.5.0
256
1 / 4294967039 (0xFFFFFEFF)

MaxStartFailRetries

unsignedNNDB 7.5.0
3
0 / 4294967039 (0xFFFFFEFF)

MemReportFrequency

unsignedNNDB 7.5.0
0
0 / 4294967039 (0xFFFFFEFF)

MinDiskWriteSpeed

numericSNDB 7.5.0
10M
1M / 1024G

MinFreePct

unsignedNNDB 7.5.0
5
0 / 100

NodeGroup

 ISNDB 7.5.0
[none]
0 / 65536

NodeId

unsignedISNDB 7.5.0
[none]
1 / 48

NoOfFragmentLogFiles

integerINNDB 7.5.0
16
3 / 4294967039 (0xFFFFFEFF)

NoOfReplicas

integerISNDB 7.5.0
2
1 / 4

Numa

booleanNNDB 7.5.0
1
...

ODirect

booleanNNDB 7.5.0
false
true, false

RealtimeScheduler

booleanNNDB 7.5.0
false
true, false

RedoBuffer

bytesNNDB 7.5.0
32M
1M / 4294967039 (0xFFFFFEFF)

RedoOverCommitCounter

numericNNDB 7.5.0
3
0 / 4294967039 (0xFFFFFEFF)

RedoOverCommitLimit

secondsNNDB 7.5.0
20
0 / 4294967039 (0xFFFFFEFF)

RestartOnErrorInsert

error codeNNDB 7.5.0
2
0 / 4

SchedulerExecutionTimer

µsNNDB 7.5.0
50
0 / 11000

SchedulerResponsiveness

integerSNDB 7.5.0
5
0 / 10

SchedulerSpinTimer

µsNNDB 7.5.0
0
0 / 500

ServerPort

unsignedSNDB 7.5.0
[none]
1 / 64K

SharedGlobalMemory

bytesNNDB 7.5.0
128M
0 / 64T

StartFailRetryDelay

unsignedNNDB 7.5.0
0
0 / 4294967039 (0xFFFFFEFF)

StartFailureTimeout

millisecondsNNDB 7.5.0
0
0 / 4294967039 (0xFFFFFEFF)

StartNoNodeGroupTimeout

millisecondsNNDB 7.5.0
15000
0 / 4294967039 (0xFFFFFEFF)

StartPartialTimeout

millisecondsNNDB 7.5.0
30000
0 / 4294967039 (0xFFFFFEFF)

StartPartitionedTimeout

millisecondsNNDB 7.5.0
60000
0 / 4294967039 (0xFFFFFEFF)

StartupStatusReportFrequency

secondsNNDB 7.5.0
0
0 / 4294967039 (0xFFFFFEFF)

StopOnError

booleanNNDB 7.5.0
1
0, 1

StringMemory

% or bytesSNDB 7.5.0
25
0 / 4294967039 (0xFFFFFEFF)

TcpBind_INADDR_ANY

booleanNNDB 7.5.0
false
true, false

TimeBetweenEpochs

millisecondsNNDB 7.5.0
100
0 / 32000

TimeBetweenEpochsTimeout

millisecondsNNDB 7.5.0
0
0 / 256000

TimeBetweenGlobalCheckpoints

millisecondsNNDB 7.5.0
2000
20 / 32000

TimeBetweenGlobalCheckpointsTimeout

millisecondsNNDB 7.5.0
120000
10 / 4294967039 (0xFFFFFEFF)

TimeBetweenInactiveTransactionAbortCheck

millisecondsNNDB 7.5.0
1000
1000 / 4294967039 (0xFFFFFEFF)

TimeBetweenLocalCheckpoints

number of 4-byte words, as a base-2 logarithmNNDB 7.5.0
20
0 / 31

TimeBetweenWatchDogCheck

millisecondsNNDB 7.5.0
6000
70 / 4294967039 (0xFFFFFEFF)

TimeBetweenWatchDogCheckInitial

millisecondsNNDB 7.5.0
6000
70 / 4294967039 (0xFFFFFEFF)

TotalSendBufferMemory

bytesNNDB 7.5.0
0
256K / 4294967039 (0xFFFFFEFF)

TransactionBufferMemory

bytesNNDB 7.5.0
1M
1K / 4294967039 (0xFFFFFEFF)

TransactionDeadlockDetectionTimeout

millisecondsNNDB 7.5.0
1200
50 / 4294967039 (0xFFFFFEFF)

TransactionInactiveTimeout

millisecondsNNDB 7.5.0
[see text]
0 / 4294967039 (0xFFFFFEFF)

TwoPassInitialNodeRestartCopy

booleanNNDB 7.5.0
false
true, false

UndoDataBuffer

unsignedNNDB 7.5.0
16M
1M / 4294967039 (0xFFFFFEFF)

UndoIndexBuffer

unsignedNNDB 7.5.0
2M
1M / 4294967039 (0xFFFFFEFF)

Table 5.2 Multi-Threaded Data Node Configuration Parameters

Parameter NameType or UnitsRestart TypeIn Version ... (and later)
Default Value
Minimum/Maximum or Permitted Values

MaxNoOfExecutionThreads

integerISNDB 7.5.0
2
2 / 72

NoOfFragmentLogParts

numericINNDB 7.5.0
4
4, 8, 12, 16, 24, 32

ThreadConfig

stringISNDB 7.5.0
''
...

5.2.2 NDB Cluster Management Node Configuration Parameters

The summary table in this section provides information about parameters used in the [ndb_mgmd] or [mgm] sections of a config.ini file for configuring NDB Cluster management nodes. For detailed descriptions and other additional information about each of these parameters, see Section 5.3.5, “Defining an NDB Cluster Management Server”.

Restart types.  Changes in NDB Cluster configuration parameters do not take effect until the cluster is restarted. The type of restart required to change a given parameter is indicated in the summary table as follows:

For more information about restart types, see Section 5.2, “Overview of NDB Cluster Configuration Parameters, Options, and Variables”.

Table 5.3 Management Node Configuration Parameters

Parameter NameType or UnitsRestart TypeIn Version ... (and later)
Default Value
Minimum/Maximum or Permitted Values

ArbitrationDelay

millisecondsNNDB 7.5.0
0
0 / 4294967039 (0xFFFFFEFF)

ArbitrationRank

0-2NNDB 7.5.0
1
0 / 2

DataDir

pathNNDB 7.5.0
.
...

ExecuteOnComputer

nameSNDB 7.5.0
[none]
...

HeartbeatIntervalMgmdMgmd

millisecondsNNDB 7.5.0
1500
100 / 4294967039 (0xFFFFFEFF)

HeartbeatThreadPriority

stringSNDB 7.5.0
[none]
...

HostName

name or IP addressNNDB 7.5.0
[none]
...

Id

unsignedISNDB 7.5.0
[none]
1 / 255

LogDestination

{CONSOLE|SYSLOG|FILE}NNDB 7.5.0
[see text]
...

NodeId

unsignedISNDB 7.5.0
[none]
1 / 255

PortNumber

unsignedSNDB 7.5.0
1186
0 / 64K

PortNumberStats

unsignedNNDB 7.5.0
[none]
0 / 64K

TotalSendBufferMemory

bytesNNDB 7.5.0
0
256K / 4294967039 (0xFFFFFEFF)

wan

booleanNNDB 7.5.0
false
true, false

Note

After making changes in a management node's configuration, it is necessary to perform a rolling restart of the cluster for the new configuration to take effect. See Section 5.3.5, “Defining an NDB Cluster Management Server”, for more information.

To add new management servers to a running NDB Cluster , it is also necessary 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 3.6.10, “Limitations Relating to Multiple NDB Cluster Nodes”.

5.2.3 NDB Cluster SQL Node and API Node Configuration Parameters

The summary table in this section provides information about parameters used in the [mysqld] and [api] sections of a config.ini file for configuring NDB Cluster SQL nodes and API nodes. For detailed descriptions and other additional information about each of these parameters, see Section 5.3.7, “Defining SQL and Other API Nodes in an NDB Cluster”.

Note

For a discussion of MySQL server options for NDB Cluster , see Section 5.3.8.1, “MySQL Server Options for NDB Cluster”; for information about MySQL server system variables relating to NDB Cluster , see Section 5.3.8.2, “NDB Cluster System Variables”.

Restart types.  Changes in NDB Cluster configuration parameters do not take effect until the cluster is restarted. The type of restart required to change a given parameter is indicated in the summary table as follows:

For more information about restart types, see Section 5.2, “Overview of NDB Cluster Configuration Parameters, Options, and Variables”.

Table 5.4 SQL Node / API Node Configuration Parameters

Parameter NameType or UnitsRestart TypeIn Version ... (and later)
Default Value
Minimum/Maximum or Permitted Values

ApiVerbose

bytesNNDB 7.5.2
undefined
0 / 100

ArbitrationDelay

millisecondsNNDB 7.5.0
0
0 / 4294967039 (0xFFFFFEFF)

ArbitrationRank

0-2NNDB 7.5.0
0
0 / 2

AutoReconnect

booleanNNDB 7.5.0
false
true, false

BatchByteSize

bytesNNDB 7.5.0
16K
1024 / 1M

BatchSize

recordsNNDB 7.5.0
256
1 / 992

ConnectBackoffMaxTime

integerNNDB 7.5.0
0
0 / 4294967039 (0xFFFFFEFF)

ConnectionMap

stringNNDB 7.5.0
[none]
...

DefaultHashMapSize

bucketsNNDB 7.5.0
3840
0 / 3840

DefaultOperationRedoProblemAction

enumerationSNDB 7.5.0
QUEUE
ABORT, QUEUE

EventLogBufferSize

bytesSNDB 7.5.0
8192
0 / 64K

ExecuteOnComputer

nameSNDB 7.5.0
[none]
...

ExtraSendBufferMemory

bytesNNDB 7.5.0
0
0 / 4294967039 (0xFFFFFEFF)

HeartbeatThreadPriority

stringSNDB 7.5.0
[none]
...

HostName

name or IP addressNNDB 7.5.0
[none]
...

Id

unsignedISNDB 7.5.0
[none]
1 / 255

MaxScanBatchSize

bytesNNDB 7.5.0
256K
32K / 16M

NodeId

unsignedISNDB 7.5.0
[none]
1 / 255

StartConnectBackoffMaxTime

integerNNDB 7.5.0
0
0 / 4294967039 (0xFFFFFEFF)

TotalSendBufferMemory

bytesNNDB 7.5.0
0
256K / 4294967039 (0xFFFFFEFF)

wan

booleanNNDB 7.5.0
false
true, false

Note

To add new SQL or API nodes to the configuration of a running NDB Cluster , it is necessary to perform a rolling restart of all cluster nodes after adding new [mysqld] or [api] sections to the config.ini file (or files, if you are using more than one management server). This must be done before the new SQL or API nodes can connect to the cluster.

It is not necessary to perform any restart of the cluster if new SQL or API nodes can employ previously unused API slots in the cluster configuration to connect to the cluster.

5.2.4 Other NDB Cluster Configuration Parameters

The summary tables in this section provide information about parameters used in the [computer], [tcp], [shm], and [sci] sections of a config.ini file for configuring NDB Cluster management nodes. For detailed descriptions and other additional information about individual parameters, see Section 5.3.9, “NDB Cluster TCP/IP Connections”, Section 5.3.11, “NDB Cluster Shared-Memory Connections”, or Section 5.3.12, “SCI Transport Connections in NDB Cluster”, as appropriate.

Restart types.  Changes in NDB Cluster configuration parameters do not take effect until the cluster is restarted. The type of restart required to change a given parameter is indicated in the summary tables as follows:

For more information about restart types, see Section 5.2, “Overview of NDB Cluster Configuration Parameters, Options, and Variables”.

Table 5.5 Computer Configuration Parameters

Parameter NameType or UnitsRestart TypeIn Version ... (and later)
Default Value
Minimum/Maximum or Permitted Values

HostName

name or IP addressNNDB 7.5.0
[none]
...

Id

stringISNDB 7.5.0
[none]
...

Table 5.6 TCP Configuration Parameters

Parameter NameType or UnitsRestart TypeIn Version ... (and later)
Default Value
Minimum/Maximum or Permitted Values

Checksum

booleanNNDB 7.5.0
false
true, false

Group

unsignedNNDB 7.5.0
55
0 / 200

NodeId1

numericNNDB 7.5.0
[none]
...

NodeId2

numericNNDB 7.5.0
[none]
...

NodeIdServer

numericNNDB 7.5.0
[none]
...

OverloadLimit

bytesNNDB 7.5.0
0
0 / 4294967039 (0xFFFFFEFF)

PortNumber

unsignedSNDB 7.5.0
[none]
0 / 64K

Proxy

stringNNDB 7.5.0
[none]
...

ReceiveBufferMemory

bytesNNDB 7.5.0
2M
16K / 4294967039 (0xFFFFFEFF)

SendBufferMemory

unsignedNNDB 7.5.0
2M
256K / 4294967039 (0xFFFFFEFF)

SendSignalId

booleanNNDB 7.5.0
[see text]
true, false

TCP_MAXSEG_SIZE

unsignedNNDB 7.5.0
0
0 / 2G

TCP_RCV_BUF_SIZE

unsignedNNDB 7.5.0
0
0 / 2G

TCP_SND_BUF_SIZE

unsignedNNDB 7.5.0
0
0 / 2G

TcpBind_INADDR_ANY

booleanNNDB 7.5.0
false
true, false

Table 5.7 Shared Memory Configuration Parameters

Parameter NameType or UnitsRestart TypeIn Version ... (and later)
Default Value
Minimum/Maximum or Permitted Values

Checksum

booleanNNDB 7.5.0
true
true, false

Group

unsignedNNDB 7.5.0
35
0 / 200

NodeId1

numericNNDB 7.5.0
[none]
...

NodeId2

numericNNDB 7.5.0
[none]
...

NodeIdServer

numericNNDB 7.5.0
[none]
...

OverloadLimit

bytesNNDB 7.5.0
0
0 / 4294967039 (0xFFFFFEFF)

PortNumber

unsignedSNDB 7.5.0
[none]
0 / 64K

SendSignalId

booleanNNDB 7.5.0
false
true, false

ShmKey

unsignedNNDB 7.5.0
[none]
0 / 4294967039 (0xFFFFFEFF)

ShmSize

bytesNNDB 7.5.0
1M
64K / 4294967039 (0xFFFFFEFF)

Signum

unsignedNNDB 7.5.0
[none]
0 / 4294967039 (0xFFFFFEFF)

Table 5.8 SCI Configuration Parameters

Parameter NameType or UnitsRestart TypeIn Version ... (and later)
Default Value
Minimum/Maximum or Permitted Values

Checksum

booleanNNDB 7.5.0
false
true, false

Group

unsignedNNDB 7.5.0
15
0 / 200

Host1SciId0

unsignedNNDB 7.5.0
[none]
0 / 4294967039 (0xFFFFFEFF)

Host1SciId1

unsignedNNDB 7.5.0
0
0 / 4294967039 (0xFFFFFEFF)

Host2SciId0

unsignedNNDB 7.5.0
[none]
0 / 4294967039 (0xFFFFFEFF)

Host2SciId1

unsignedNNDB 7.5.0
0
0 / 4294967039 (0xFFFFFEFF)

NodeId1

numericNNDB 7.5.0
[none]
...

NodeId2

numericNNDB 7.5.0
[none]
...

NodeIdServer

numericNNDB 7.5.0
[none]
...

OverloadLimit

bytesNNDB 7.5.0
0
0 / 4294967039 (0xFFFFFEFF)

PortNumber

unsignedSNDB 7.5.0
[none]
0 / 64K

SendLimit

unsignedNNDB 7.5.0
8K
128 / 32K

SendSignalId

booleanNNDB 7.5.0
true
true, false

SharedBufferSize

unsignedNNDB 7.5.0
10M
64K / 4294967039 (0xFFFFFEFF)

5.2.5 NDB Cluster mysqld Option and Variable Reference

The following table provides a list of the command-line options, server and status variables applicable within mysqld when it is running as an SQL node in an NDB Cluster . For a table showing all command-line options, server and status variables available for use with mysqld, see Server Option and Variable Reference.

Table 5.9 MySQL Server Options and Variables for MySQL Cluster: MySQL Cluster NDB 7.5

Option or Variable Name
Command Line System Variable Status Variable
Option File Scope Dynamic
Notes

Com_show_ndb_status

No No Yes
No Both No

DESCRIPTION: Count of SHOW NDB STATUS statements

Handler_discover

No No Yes
No Both No

DESCRIPTION: Number of times that tables have been discovered

ndb-batch-size

Yes Yes No
Yes Global No

DESCRIPTION: Size (in bytes) to use for NDB transaction batches

ndb-blob-read-batch-bytes

Yes Yes No
Yes Both Yes

DESCRIPTION: Specifies size in bytes that large BLOB reads should be batched into. 0 = no limit.

ndb-blob-write-batch-bytes

Yes Yes No
Yes Both Yes

DESCRIPTION: Specifies size in bytes that large BLOB writes should be batched into. 0 = no limit.

ndb-cluster-connection-pool

Yes Yes Yes
Yes Global No

DESCRIPTION: Number of connections to the cluster used by MySQL

ndb-cluster-connection-pool-nodeids

Yes Yes No
Yes Global No

DESCRIPTION: Comma-separated list of node IDs for connections to the cluster used by MySQL; the number of nodes in the list must be the same as the value set for --ndb-cluster-connection-pool

ndb-connectstring

Yes No No
Yes No

DESCRIPTION: Point to the management server that distributes the cluster configuration

ndb-default-column-format

Yes Yes No
Yes Global Yes

DESCRIPTION: Use this value (FIXED or DYNAMIC) by default for COLUMN_FORMAT and ROW_FORMAT options when creating or adding columns to a table.

ndb-deferred-constraints

Yes Yes No
Yes Both Yes

DESCRIPTION: Specifies that constraint checks on unique indexes (where these are supported) should be deferred until commit time. Not normally needed or used; for testing purposes only.

ndb-distribution

Yes Yes No
Yes Global Yes

DESCRIPTION: Default distribution for new tables in NDBCLUSTER (KEYHASH or LINHASH, default is KEYHASH)

ndb-log-apply-status

Yes Yes No
Yes Global No

DESCRIPTION: Cause a MySQL server acting as a slave to log mysql.ndb_apply_status updates received from its immediate master in its own binary log, using its own server ID. Effective only if the server is started with the --ndbcluster option.

ndb-log-empty-epochs

Yes Yes No
Yes Global Yes

DESCRIPTION: When enabled, causes epochs in which there were no changes to be written to the ndb_apply_status and ndb_binlog_index tables, even when --log-slave-updates is enabled.

ndb-log-empty-update

Yes Yes No
Yes Global Yes

DESCRIPTION: When enabled, causes updates that produced no changes to be written to the ndb_apply_status and ndb_binlog_index tables, even when --log-slave-updates is enabled.

ndb-log-exclusive-reads

Yes Yes No
Yes Both Yes

DESCRIPTION: Log primary key reads with exclusive locks; allow conflict resolution based on read conflicts.

ndb-log-orig

Yes Yes No
Yes Global No

DESCRIPTION: Log originating server id and epoch in mysql.ndb_binlog_index table.

ndb-log-transaction-id

Yes Yes No
Yes Global No

DESCRIPTION: Write NDB transaction IDs in the binary log. Requires --log-bin-v1-events=OFF.

ndb-mgmd-host

Yes No No
Yes No

DESCRIPTION: Set the host (and port, if desired) for connecting to management server

ndb-nodeid

Yes No Yes
Yes Global No

DESCRIPTION: MySQL Cluster node ID for this MySQL server

ndb-recv-thread-activation-threshold

Yes No No
Yes No

DESCRIPTION: Activation threshold when receive thread takes over the polling of the cluster connection (measured in concurrently active threads)

ndb-recv-thread-cpu-mask

Yes No No
Yes No

DESCRIPTION: CPU mask for locking receiver threads to specific CPUs; specified as hexadecimal. See documentation for details.

ndb-transid-mysql-connection-map

Yes No No
No No

DESCRIPTION: Enable or disable the ndb_transid_mysql_connection_map plugin; that is, enable or disable the INFORMATION_SCHEMA table having that name.

ndb-wait-connected

Yes Yes No
Yes Global No

DESCRIPTION: Time (in seconds) for the MySQL server to wait for connection to cluster management and data nodes before accepting MySQL client connections.

ndb-wait-setup

Yes Yes No
Yes Global No

DESCRIPTION: Time (in seconds) for the MySQL server to wait for NDB engine setup to complete.

ndb-allow-copying-alter-table

Yes Yes No
Yes Both Yes

DESCRIPTION: Set to OFF to keep ALTER TABLE from using copying operations on NDB tables

Ndb_api_bytes_received_count

No No Yes
No Global No

DESCRIPTION: Amount of data (in bytes) received from the data nodes by this MySQL Server (SQL node).

Ndb_api_bytes_received_count_session

No No Yes
No Session No

DESCRIPTION: Amount of data (in bytes) received from the data nodes in this client session.

Ndb_api_bytes_received_count_slave

No No Yes
No Global No

DESCRIPTION: Amount of data (in bytes) received from the data nodes by this slave.

Ndb_api_bytes_sent_count

No No Yes
No Global No

DESCRIPTION: Amount of data (in bytes) sent to the data nodes by this MySQL Server (SQL node).

Ndb_api_bytes_sent_count_slave

No No Yes
No Global No

DESCRIPTION: Amount of data (in bytes) sent to the data nodes by this slave.

Ndb_api_event_bytes_count_injector

No No Yes
No Global No

DESCRIPTION: Number of bytes of events received by the NDB binary log injector thread.

Ndb_api_event_data_count_injector

No No Yes
No Global No

DESCRIPTION: Number of row change events received by the NDB binary log injector thread.

Ndb_api_event_nondata_count_injector

No No Yes
No Global No

DESCRIPTION: Number of events received, other than row change events, by the NDB binary log injector thread.

Ndb_api_pk_op_count

No No Yes
No Global No

DESCRIPTION: Number of operations based on or using primary keys by this MySQL Server (SQL node).

Ndb_api_pk_op_count_session

No No Yes
No Session No

DESCRIPTION: Number of operations based on or using primary keys in this client session.

Ndb_api_pk_op_count_slave

No No Yes
No Global No

DESCRIPTION: Number of operations based on or using primary keys by this slave.

Ndb_api_pruned_scan_count

No No Yes
No Global No

DESCRIPTION: Number of scans that have been pruned to a single partition by this MySQL Server (SQL node).

Ndb_api_pruned_scan_count_session

No No Yes
No Session No

DESCRIPTION: Number of scans that have been pruned to a single partition in this client session.

Ndb_api_range_scan_count_slave

No No Yes
No Global No

DESCRIPTION: Number of range scans that have been started by this slave.

Ndb_api_read_row_count

No No Yes
No Global No

DESCRIPTION: Total number of rows that have been read by this MySQL Server (SQL node).

Ndb_api_read_row_count_session

No No Yes
No Session No

DESCRIPTION: Total number of rows that have been read in this client session.

Ndb_api_scan_batch_count_slave

No No Yes
No Global No

DESCRIPTION: Number of batches of rows received by this slave.

Ndb_api_table_scan_count

No No Yes
No Global No

DESCRIPTION: Number of table scans that have been started, including scans of internal tables, by this MySQL Server (SQL node).

Ndb_api_table_scan_count_session

No No Yes
No Session No

DESCRIPTION: Number of table scans that have been started, including scans of internal tables, in this client session.

Ndb_api_trans_abort_count

No No Yes
No Global No

DESCRIPTION: Number of transactions aborted by this MySQL Server (SQL node).

Ndb_api_trans_abort_count_session

No No Yes
No Session No

DESCRIPTION: Number of transactions aborted in this client session.

Ndb_api_trans_abort_count_slave

No No Yes
No Global No

DESCRIPTION: Number of transactions aborted by this slave.

Ndb_api_trans_close_count

No No Yes
No Global No

DESCRIPTION: Number of transactions aborted (may be greater than the sum of TransCommitCount and TransAbortCount) by this MySQL Server (SQL node).

Ndb_api_trans_close_count_session

No No Yes
No Session No

DESCRIPTION: Number of transactions aborted (may be greater than the sum of TransCommitCount and TransAbortCount) in this client session.

Ndb_api_trans_close_count_slave

No No Yes
No Global No

DESCRIPTION: Number of transactions aborted (may be greater than the sum of TransCommitCount and TransAbortCount) by this slave.

Ndb_api_trans_commit_count

No No Yes
No Global No

DESCRIPTION: Number of transactions committed by this MySQL Server (SQL node).

Ndb_api_trans_commit_count_session

No No Yes
No Session No

DESCRIPTION: Number of transactions committed in this client session.

Ndb_api_trans_commit_count_slave

No No Yes
No Global No

DESCRIPTION: Number of transactions committed by this slave.

Ndb_api_trans_local_read_row_count_slave

No No Yes
No Global No

DESCRIPTION: Total number of rows that have been read by this slave.

Ndb_api_trans_start_count

No No Yes
No Global No

DESCRIPTION: Number of transactions started by this MySQL Server (SQL node).

Ndb_api_trans_start_count_session

No No Yes
No Session No

DESCRIPTION: Number of transactions started in this client session.

Ndb_api_trans_start_count_slave

No No Yes
No Global No

DESCRIPTION: Number of transactions started by this slave.

Ndb_api_uk_op_count

No No Yes
No Global No

DESCRIPTION: Number of operations based on or using unique keys by this MySQL Server (SQL node).

Ndb_api_uk_op_count_slave

No No Yes
No Global No

DESCRIPTION: Number of operations based on or using unique keys by this slave.

Ndb_api_wait_exec_complete_count

No No Yes
No Global No

DESCRIPTION: Number of times thread has been blocked while waiting for execution of an operation to complete by this MySQL Server (SQL node).

Ndb_api_wait_exec_complete_count_session

No No Yes
No Session No

DESCRIPTION: Number of times thread has been blocked while waiting for execution of an operation to complete in this client session.

Ndb_api_wait_exec_complete_count_slave

No No Yes
No Global No

DESCRIPTION: Number of times thread has been blocked while waiting for execution of an operation to complete by this slave.

Ndb_api_wait_meta_request_count

No No Yes
No Global No

DESCRIPTION: Number of times thread has been blocked waiting for a metadata-based signal by this MySQL Server (SQL node).

Ndb_api_wait_meta_request_count_session

No No Yes
No Session No

DESCRIPTION: Number of times thread has been blocked waiting for a metadata-based signal in this client session.

Ndb_api_wait_nanos_count

No No Yes
No Global No

DESCRIPTION: Total time (in nanoseconds) spent waiting for some type of signal from the data nodes by this MySQL Server (SQL node).

Ndb_api_wait_nanos_count_session

No No Yes
No Session No

DESCRIPTION: Total time (in nanoseconds) spent waiting for some type of signal from the data nodes in this client session.

Ndb_api_wait_nanos_count_slave

No No Yes
No Global No

DESCRIPTION: Total time (in nanoseconds) spent waiting for some type of signal from the data nodes by this slave.

Ndb_api_wait_scan_result_count

No No Yes
No Global No

DESCRIPTION: Number of times thread has been blocked while waiting for a scan-based signal by this MySQL Server (SQL node).

Ndb_api_wait_scan_result_count_session

No No Yes
No Session No

DESCRIPTION: Number of times thread has been blocked while waiting for a scan-based signal in this client session.

Ndb_api_wait_scan_result_count_slave

No No Yes
No Global No

DESCRIPTION: Number of times thread has been blocked while waiting for a scan-based signal by this slave.

ndb_autoincrement_prefetch_sz

Yes Yes No
Yes Both Yes

DESCRIPTION: NDB auto-increment prefetch size

ndb_cache_check_time

Yes Yes No
Yes Global Yes

DESCRIPTION: Number of milliseconds between checks of cluster SQL nodes made by the MySQL query cache

ndb_clear_apply_status

Yes Yes No
No Global Yes

DESCRIPTION: Causes RESET SLAVE to clear all rows from the ndb_apply_status table. ON by default.

Ndb_cluster_node_id

No No Yes
No Both No

DESCRIPTION: If the server is acting as a MySQL Cluster node, then the value of this variable its node ID in the cluster

Ndb_config_from_host

No No Yes
No Both No

DESCRIPTION: The host name or IP address of the Cluster management server. Formerly Ndb_connected_host

Ndb_config_from_port

No No Yes
No Both No

DESCRIPTION: The port for connecting to Cluster management server. Formerly Ndb_connected_port

Ndb_conflict_fn_epoch_trans

No No Yes
No Global No

DESCRIPTION: Number of rows that have been found in conflict by the NDB$EPOCH_TRANS() conflict detection function

Ndb_conflict_fn_max

No No Yes
No Global No

DESCRIPTION: If the server is part of a MySQL Cluster involved in cluster replication, the value of this variable indicates the number of times that conflict resolution based on "greater timestamp wins" has been applied

Ndb_conflict_fn_old

No No Yes
No Global No

DESCRIPTION: If the server is part of a MySQL Cluster involved in cluster replication, the value of this variable indicates the number of times that "same timestamp wins" conflict resolution has been applied

Ndb_conflict_trans_detect_iter_count

No No Yes
No Global No

DESCRIPTION: Number of internal iterations required to commit an epoch transaction. Should be (slightly) greater than or equal to Ndb_conflict_trans_conflict_commit_count.

Ndb_conflict_trans_row_reject_count

No No Yes
No Global No

DESCRIPTION: Total number of rows realigned after being found in conflict by a transactional conflict function. Includes Ndb_conflict_trans_row_conflict_count and any rows included in or dependent on conflicting transactions.

ndb_data_node_neighbour

Yes Yes No
Yes Global Yes

DESCRIPTION: Specifies cluster data node "closest" to this MySQL Server, for transaction hinting and fully replicated tables

ndb_default_column_format

Yes Yes No
Yes Global Yes

DESCRIPTION: Sets default row format and column format (FIXED or DYNAMIC) used for new NDB tables.

ndb_deferred_constraints

Yes Yes No
Yes Both Yes

DESCRIPTION: Specifies that constraint checks should be deferred (where these are supported). Not normally needed or used; for testing purposes only.

ndb_distribution

Yes Yes No
Yes Global Yes

DESCRIPTION: Default distribution for new tables in NDBCLUSTER (KEYHASH or LINHASH, default is KEYHASH)

ndb_eventbuffer_free_percent

Yes Yes No
Yes Global Yes

DESCRIPTION: Percentage of free memory that should be available in event buffer before resumption of buffering, after reaching limit set by ndb_eventbuffer_max_alloc.

ndb_eventbuffer_max_alloc

Yes Yes No
Yes Global Yes

DESCRIPTION: Maximum memory that can be allocated for buffering events by the NDB API. Defaults to 0 (no limit).

ndb_extra_logging

Yes Yes No
Yes Global Yes

DESCRIPTION: Controls logging of MySQL Cluster schema, connection, and data distribution events in the MySQL error log

ndb_force_send

Yes Yes No
Yes Both Yes

DESCRIPTION: Forces sending of buffers to NDB immediately, without waiting for other threads

ndb_fully_replicated

Yes Yes No
Yes Both Yes

DESCRIPTION: Whether new NDB tables are fully replicated

ndb_index_stat_enable

Yes Yes No
Yes Both Yes

DESCRIPTION: Use NDB index statistics in query optimization

ndb_index_stat_option

Yes Yes No
Yes Both Yes

DESCRIPTION: Comma-separated list of tunable options for NDB index statistics; the list should contain no spaces

ndb_join_pushdown

No Yes No
No Both Yes

DESCRIPTION: Enables pushing down of joins to data nodes

ndb_log_apply_status

Yes Yes No
Yes Global No

DESCRIPTION: Whether or not a MySQL server acting as a slave logs mysql.ndb_apply_status updates received from its immediate master in its own binary log, using its own server ID.

ndb_log_bin

Yes Yes No
No Both Yes

DESCRIPTION: Write updates to NDB tables in the binary log. Effective only if binary logging is enabled with --log-bin.

ndb_log_binlog_index

Yes Yes No
No Global Yes

DESCRIPTION: Insert mapping between epochs and binary log positions into the ndb_binlog_index table. Defaults to ON. Effective only if binary logging is enabled on the server.

ndb_log_empty_epochs

Yes Yes No
Yes Global Yes

DESCRIPTION: When enabled, epochs in which there were no changes are written to the ndb_apply_status and ndb_binlog_index tables, even when log_slave_updates is enabled.

ndb_log_empty_update

Yes Yes No
Yes Global Yes

DESCRIPTION: When enabled, updates which produce no changes are written to the ndb_apply_status and ndb_binlog_index tables, even when log_slave_updates is enabled.

ndb_log_exclusive_reads

Yes Yes No
Yes Both Yes

DESCRIPTION: Log primary key reads with exclusive locks; allow conflict resolution based on read conflicts.

ndb_log_orig

Yes Yes No
Yes Global No

DESCRIPTION: Whether the id and epoch of the originating server are recorded in the mysql.ndb_binlog_index table. Set using the --ndb-log-orig option when starting mysqld.

ndb_log_transaction_id

No Yes No
No Global No

DESCRIPTION: Whether NDB transaction IDs are written into the binary log. (Read-only.)

ndb_log_updated_only

Yes Yes No
Yes Global Yes

DESCRIPTION: Log complete rows (ON) or updates only (OFF)

Ndb_number_of_data_nodes

No No Yes
No Global No

DESCRIPTION: If the server is part of a MySQL Cluster, the value of this variable is the number of data nodes in the cluster

ndb_optimization_delay

No Yes No
No Global Yes

DESCRIPTION: Sets the number of milliseconds to wait between processing sets of rows by OPTIMIZE TABLE on NDB tables.

ndb_optimized_node_selection

Yes Yes No
Yes Global No

DESCRIPTION: Determines how an SQL node chooses a cluster data node to use as transaction coordinator

Ndb_pushed_queries_defined

No No Yes
No Global No

DESCRIPTION: Number of joins that API nodes have attempted to push down to the data nodes

Ndb_pushed_queries_executed

No No Yes
No Global No

DESCRIPTION: Number of joins successfully pushed down and executed on the data nodes

ndb_read_backup

Yes Yes No
Yes Global Yes

DESCRIPTION: Enable read from any replica

ndb_recv_thread_activation_threshold

No No No
No No

DESCRIPTION: Activation threshold when receive thread takes over the polling of the cluster connection (measured in concurrently active threads)

ndb_recv_thread_cpu_mask

No Yes No
No Global Yes

DESCRIPTION: CPU mask for locking receiver threads to specific CPUs; specified as hexadecimal. See documentation for details.

ndb_report_thresh_binlog_epoch_slip

Yes Yes No
Yes Global Yes

DESCRIPTION: NDB 7.5.4 and later: Threshold for number of epochs completely buffered, but not yet consumed by binlog injector thread which when exceeded generates BUFFERED_EPOCHS_OVER_THRESHOLD event buffer status message; prior to NDB 7.5.4: Threshold for number of epochs to lag behind before reporting binary log status

ndb_report_thresh_binlog_mem_usage

Yes Yes No
Yes Global Yes

DESCRIPTION: This is a threshold on the percentage of free memory remaining before reporting binary log status

Ndb_scan_count

No No Yes
No Global No

DESCRIPTION: The total number of scans executed by NDB since the cluster was last started

ndb_show_foreign_key_mock_tables

Yes Yes No
Yes Global Yes

DESCRIPTION: Show the mock tables used to support foreign_key_checks=0.

ndb_slave_conflict_role

Yes Yes No
Yes Global Yes

DESCRIPTION: Role for slave to play in conflict detection and resolution. Value is one of PRIMARY, SECONDARY, PASS, or NONE (default). Can be changed only when slave SQL thread is stopped. See documentation for further information.

Ndb_slave_max_replicated_epoch

No Yes No
No Global No

DESCRIPTION: The most recently committed NDB epoch on this slave. When this value is greater than or equal to Ndb_conflict_last_conflict_epoch, no conflicts have yet been detected.

ndb_table_no_logging

No Yes No
No Session Yes

DESCRIPTION: NDB tables created when this setting is enabled are not checkpointed to disk (although table schema files are created). The setting in effect when the table is created with or altered to use NDBCLUSTER persists for the lifetime of the table.

ndb_table_temporary

No Yes No
No Session Yes

DESCRIPTION: NDB tables are not persistent on disk: no schema files are created and the tables are not logged

ndb_use_exact_count

No Yes No
No Both Yes

DESCRIPTION: Use exact row count when planning queries

ndb_use_transactions

Yes Yes No
Yes Both Yes

DESCRIPTION: Forces NDB to use a count of records during SELECT COUNT(*) query planning to speed up this type of query

ndb_version

No Yes No
No Global No

DESCRIPTION: Shows build and NDB engine version as an integer.

ndb_version_string

No Yes No
No Global No

DESCRIPTION: Shows build information including NDB engine version in ndb-x.y.z format.

ndbcluster

Yes No No
Yes No

DESCRIPTION: Enable NDB Cluster (if this version of MySQL supports it)

Disabled by --skip-ndbcluster

ndbinfo_database

No Yes No
No Global No

DESCRIPTION: The name used for the NDB information database; read only.

ndbinfo_max_bytes

Yes Yes No
No Both Yes

DESCRIPTION: Used for debugging only.

ndbinfo_max_rows

Yes Yes No
No Both Yes

DESCRIPTION: Used for debugging only.

ndbinfo_offline

No Yes No
No Global Yes

DESCRIPTION: Put the ndbinfo database into offline mode, in which no rows are returned from tables or views.

ndbinfo_show_hidden

Yes Yes No
No Both Yes

DESCRIPTION: Whether to show ndbinfo internal base tables in the mysql client. The default is OFF.

ndbinfo_table_prefix

Yes Yes No
No Both Yes

DESCRIPTION: The prefix to use for naming ndbinfo internal base tables

ndbinfo_version

No Yes No
No Global No

DESCRIPTION: The version of the ndbinfo engine; read only.

server-id-bits

Yes Yes No
Yes Global No

DESCRIPTION: Sets the number of least significant bits in the server_id actually used for identifying the server, permitting NDB API applications to store application data in the most significant bits. server_id must be less than 2 to the power of this value.

server_id_bits

Yes Yes No
Yes Global No

DESCRIPTION: The effective value of server_id if the server was started with the --server-id-bits option set to a nondefault value.

slave_allow_batching

Yes Yes No
Yes Global Yes

DESCRIPTION: Turns update batching on and off for a replication slave

transaction_allow_batching

No Yes No
No Session Yes

DESCRIPTION: Allows batching of statements within a transaction. Disable AUTOCOMMIT to use.


5.3 NDB Cluster Configuration Files

Configuring NDB Cluster requires working with two files:

  • my.cnf: Specifies options for all NDB 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 NDB 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.  NDB uses stateful configuration. Rather than reading the global configuration file every time the management server is restarted, the management server caches the configuration the first time it is started, and thereafter, the global configuration file is read only when one of the following conditions is true:

  • The management server is started using the --initial option.  When --initial is used, 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 the --reload option.  The --reload option causes the management server to compare 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.

  • The management server is started using --config-cache=FALSE.  This disables --config-cache (enabled by default), and can be used to force the management server to bypass configuration caching altogether. In this case, the management server ignores any configuration files that may be present, always reading its configuration data from the config.ini file instead.

  • 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.  The management server by default creates configuration cache files in a directory named mysql-cluster in the MySQL installation directory. (If you build NDB Cluster from source on a Unix system, the default location is /usr/local/mysql-cluster.) This can be overridden at runtime 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, --config-cache, --initial, and --reload options for the NDB Cluster management server, see Section 6.4, “ndb_mgmd — The NDB 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 How to Report Bugs or Problems.

5.3.1 NDB Cluster Configuration: Basic Example

To support NDB 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 NDB Cluster 
# (valid in MySQL 5.7)
# enable ndbcluster storage engine, and provide connection string for
# management server host (default port is 1186)
[mysqld]
ndbcluster
ndb-connectstring=ndb_mgmd.mysql.com
# provide connection string for management server host (default port: 1186)
[ndbd]
connect-string=ndb_mgmd.mysql.com
# provide connection string 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 connection strings, see Section 5.3.3, “NDB Cluster Connection Strings”.)

# my.cnf
# example additions to my.cnf for NDB Cluster 
# (will work on all versions)
# enable ndbcluster storage engine, and provide connection string 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 5.3.8.2, “NDB Cluster System Variables”.

The NDB Cluster global configuration file is by convention named config.ini (but this is not required). If needed, it is read by ndb_mgmd at startup and can be placed in any location that can be read by it. The location and name of the configuration are specified using --config-file=path_name with ndb_mgmd on the command line. This option has no default value, and is ignored if ndb_mgmd uses the configuration cache.

The global configuration file for NDB 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 equal sign (=); however, the equal 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. 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.

Note

In some older releases of NDB Cluster , there was no default value for NoOfReplicas, which always had to be specified explicitly in the [ndbd default] section. Although this parameter now has a default value of 2, which is the recommended setting in most common usage scenarios, it is still recommended practice to set this parameter explicitly.

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
Note

The preceding example is intended as a minimal starting configuration for purposes of familiarization with NDB Cluster , and is almost certain not to be sufficient for production settings. See Section 5.3.2, “Recommended Starting Configuration for NDB Cluster”, which provides a more complete example starting configuration.

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:

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.

5.3.2 Recommended Starting Configuration for NDB Cluster

Achieving the best performance from an NDB Cluster depends on a number of factors including the following:

  • NDB 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 NDB 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 NDB 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 a recommended base configuration.

Starting config.ini file.  The following config.ini file is a recommended starting point for configuring a cluster running NDB Cluster 7.5:

# 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-A-hostname
# NodeId=management-server-A-nodeid
[ndb_mgmd]
HostName=management-server-B-hostname
# NodeId=management-server-B-nodeid
# 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 NodeId 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 NDB Cluster  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 NDB threads to achieve increased throughput when using ndbd. They
# are not needed when using ndbmtd; in particular, you should not set
# RealTimeScheduler for ndbmtd data nodes.
TimeBetweenGlobalCheckpoints=1000
TimeBetweenEpochs=200
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
MaxNoOfOrderedIndexes=256
[ndbd]
HostName=data-node-A-hostname
# NodeId=data-node-A-nodeid
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
# NodeId=data-node-B-nodeid
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 a NodeId 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-A-hostname
# NodeId=sql-node-A-nodeid
[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 (NodeId 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 NDB 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:

  • --ndb-use-exact-count=0

  • --ndb-index-stat-enable=0

  • --ndb-force-send=1

  • --engine-condition-pushdown=1

5.3.3 NDB Cluster Connection Strings

With the exception of the NDB Cluster management server (ndb_mgmd), each node that is part of an NDB Cluster requires a connection string that points to the management server's location. This connection string 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 connection string is as follows:

[nodeid=node_id, ]host-definition[, host-definition[, ...]]
host-definition:
    host_name[:port_number]

node_id is an integer greater than or equal to 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 connection string value if none is provided. If port_num is omitted from the connection string, 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. An NDB 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.

It is also possible to specify in a connection string 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 connection strings 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 connection string 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 connection string 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 connection string:

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 connection string:

  • 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 connection string 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:

    1. Set the NDB_CONNECTSTRING environment variable to contain the connection string.

    2. Write the connection string 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 connection string is to set it on the command line or in the my.cnf file for each executable.

5.3.4 Defining Computers in an NDB 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

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0string[none]...IS

    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

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0name or IP address[none]...N

    This is the computer's hostname or IP address.

5.3.5 Defining an NDB Cluster Management Server

The [ndb_mgmd] section is used to configure the behavior of the management server. If multiple management servers are employed, you can specify parameters common to all of them in an [ndb_mgmd default] section. [mgm] and [mgm default] are older aliases for these, supported for backward compatibility.

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

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned[none]1 - 255IS

    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 255, inclusive. This ID is used by all internal cluster messages for addressing the node, and so must be unique for each NDB Cluster node, regardless of the type of node.

    Note

    Data node IDs must be less than 49. 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.

    The use of the Id parameter for identifying management nodes is deprecated in favor of NodeId. Although Id continues to be supported for backward compatibility, it now generates a warning and is subject to removal in a future version of NDB Cluster .

  • NodeId

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned[none]1 - 255IS

    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 255 inclusive. This ID is used by all internal cluster messages for addressing the node, and so must be unique for each NDB Cluster node, regardless of the type of node.

    Note

    Data node IDs must be less than 49. 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.

    NodeId is the preferred parameter name to use when identifying management nodes. Although the older Id continues to be supported for backward compatibility, it is now deprecated and generates a warning when used; it is also subject to removal in a future NDB Cluster release.

  • ExecuteOnComputer

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0name[none]...S

    This refers to the Id set for one of the computers defined in a [computer] section of the config.ini file.

    Important

    This parameter is deprecated as of NDB 7.5.0, and is subject to removal in a future release. Use the HostName parameter instead.

  • PortNumber

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned11860 - 64KS

    This is the port number on which the management server listens for configuration requests and management commands.

  • HostName

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0name or IP address[none]...N

    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

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0{CONSOLE|SYSLOG|FILE}[see text]...N

    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.

        The default log file name used in such cases is ndb_nodeid_cluster.log.

      • 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

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.00-210 - 2N

    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).

    You can disable arbitration completely either by setting ArbitrationRank to 0 on all management and SQL nodes, or by setting the Arbitration parameter in the [ndbd default] section of the config.ini global configuration file. Setting Arbitration causes any settings for ArbitrationRank to be disregarded.

  • ArbitrationDelay

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0milliseconds00 - 4294967039 (0xFFFFFEFF)N

    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

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0path....N

    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.

  • PortNumberStats

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned[none]0 - 64KN

    This parameter specifies the port number used to obtain statistical information from an NDB Cluster management server. It has no default value.

  • Wan

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0booleanfalsetrue, falseN

    Use WAN TCP setting as default.

  • HeartbeatThreadPriority

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0string[none]...S

    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 out) or RR (round robin). The policy value is followed optionally by the priority (an integer).

  • TotalSendBufferMemory

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0bytes0256K - 4294967039 (0xFFFFFEFF)N

    This parameter 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 permitted value is 256KB; 0 indicates that the parameter has not been set. For more detailed information, see Section 5.3.13, “Configuring NDB Cluster Send Buffer Parameters”.

  • HeartbeatIntervalMgmdMgmd

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0milliseconds1500100 - 4294967039 (0xFFFFFEFF)N

    Specify the interval between heartbeat messages used to determine whether another management node is on contact with this one. The management node waits after 3 of these intervals to declare the connection dead; thus, the default setting of 1500 milliseconds causes the management node to wait for approximately 1600 ms before timing out.

Note

After making changes in a management node's configuration, it is necessary to perform a rolling restart of the cluster for the new configuration to take effect.

To add new management servers to a running NDB 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 3.6.10, “Limitations Relating to Multiple NDB Cluster Nodes”.

5.3.6 Defining NDB 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 ndbmtd binaries for the data node processes.

There are many parameters which control buffer sizes, pool sizes, timeouts, and so forth. The only mandatory parameter is either one of ExecuteOnComputer or HostName; this must be defined in the local [ndbd] section.

The parameter NoOfReplicas should be defined in the [ndbd default] section, as it is common to all Cluster data nodes. It is not strictly necessary to set NoOfReplicas, but it is 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 permitted to be changed in the [ndbd] section. Where present, HostName, NodeId 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 NDB Cluster Disk Data tables can be found later in this section (see Disk Data Configuration Parameters).

All of these parameters also apply to ndbmtd (the multi-threaded version of ndbd). Three additional data node configuration parameters—MaxNoOfExecutionThreads, ThreadConfig, and NoOfFragmentLogParts—apply to ndbmtd only; these have no effect when used with ndbd. For more information, see Multi-Threading Configuration Parameters (ndbmtd). See also Section 6.3, “ndbmtd — The NDB Cluster Data Node Daemon (Multi-Threaded)”.

Identifying data nodes.  The NodeId or 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.

  • NodeId

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned[none]1 - 48IS

    A unique node ID is used as the node's address 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.

    NodeId is the only supported parameter name to use when identifying data nodes. (Id was removed in NDB 7.5.0.)

  • ExecuteOnComputer

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0name[none]...S

    This refers to the Id set for one of the computers defined in a [computer] section.

    Important

    This parameter is deprecated as of NDB 7.5.0, and is subject to removal in a future release. Use the HostName parameter instead.

  • HostName

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0name or IP addresslocalhost...N

    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

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned[none]1 - 64KS

    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.

    Note

    Connections from data nodes to management nodes is done using the ndb_mgmd management port (the management server's PortNumber) so outgoing connections to that port from any data nodes should always be permitted.

  • 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).

  • NodeGroup

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0 [none]0 - 65536IS

    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 NDB Cluster without having to perform a rolling restart. For this purpose, you should set it to 65536 (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 7.14.3, “Adding NDB Cluster Data Nodes Online: Detailed Example”.

  • NoOfReplicas

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0integer21 - 4IS

    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.

    The default value for NoOfReplicas is 2, which is the recommended setting in most common usage scenarios.

    The maximum possible value is 4; currently, only the values 1 and 2 are actually supported.

    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

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0path....IN

    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

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0pathDataDir...IN

    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 NDB 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

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0path[see text]...IN

    This parameter specifies the directory in which backups are placed.

    Important

    The string '/BACKUP' is always appended to this value. For example, if you set the value of BackupDataDir to /var/lib/cluster-data, then all backups are stored under /var/lib/cluster-data/BACKUP. This also means that the effective default backup location is the directory named BACKUP under the location specified by the FileSystemPath parameter.

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

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0bytes80M1M - 1024GN

    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, the data is stored on separate data pages, 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 14000 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.

    Currently, NDB Cluster can use a maximum of 512 MB for hash indexes per partition, which means in some cases it is possible to get Table is full errors in MySQL client applications even when ndb_mgm -e "ALL REPORT MEMORYUSAGE" shows significant free DataMemory. This can also pose a problem with data node restarts on nodes that are heavily loaded with data. You can force NDB to create extra partitions for NDB Cluster tables and thus have more memory available for hash indexes by using the MAX_ROWS option for CREATE TABLE. In general, setting MAX_ROWS to twice the number of rows that you expect to store in the table should be sufficient. You can also use the MinFreePct configuration parameter to help avoid problems with node restarts. (Bug #13436216)

    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.

    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 data 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

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0bytes18M1M - 1TN

    This parameter controls the amount of storage used for hash indexes in NDB Cluster . Hash indexes are always used for primary key indexes, unique indexes, and unique constraints. When defining a primary key or a unique index, two indexes are created, one of which is a hash index used for all tuple accesses as well as lock handling. This index is also used to enforce unique constraints.

    You can estimate the size of a hash index using this formula:

                size  = ( (fragments * 32K) + (rows * 18) )
                * replicas
              

    fragments is the number of fragments, replicas is the number of replicas (normally 2), and rows is the number of rows. If a table has one million rows, 8 fragments, and 2 replicas, the expected index memory usage is calculated as shown here:

              
      ((8 * 32K) + (1000000 * 18)) * 2 = ((8 * 32768) + (1000000 * 18)) * 2
      = (262144 + 18000000) * 2
      = 18262144 * 2 = 36524288 bytes = ~35MB
    

    Index statistics for ordered indexes (when these are enabled) are stored in the mysql.ndb_index_stat_sample table. Since this table has a hash index, this adds to index memory usage. An upper bound to the number of rows for a given ordered index can be calculated as follows:

      sample_size= key_size + ((key_attributes + 1) * 4)
      sample_rows = IndexStatSaveSize
                    * ((0.01 * IndexStatSaveScale * log2(rows * sample_size)) + 1)
                    / sample_size
    

    In the preceding formula, key_size is the size of the ordered index key in bytes, key_attributes is the number ot attributes in the ordered index key, and rows is the number of rows in the base table.

    Assume that table t1 has 1 million rows and an ordered index named ix1 on two four-byte integers. Assume in addition that IndexStatSaveSize and IndexStatSaveScale are set to their default values (32K and 100, respectively). Using the previous 2 formulas, we can calculate as follows:

      sample_size = 8  + ((1 + 2) * 4) = 20 bytes
      sample_rows = 32K
                    * ((0.01 * 100 * log2(1000000*20)) + 1)
                    / 20
                    = 32768 * ( (1 * ~16.811) +1) / 20
                    = 32768 * ~17.811 / 20
                    = ~29182 rows
    

    The expected index memory usage is thus 2 * 18 * 29182 = ~1050550 bytes.

    The default value for IndexMemory is 18MB. The minimum is 1MB.

  • StringMemory

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0% or bytes250 - 4294967039 (0xFFFFFEFF)S

    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.

    A value greater than 100 is interpreted as a number of bytes.

    The default value is 25—that is, 25 percent of the default maximum.

    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 NDB 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 NDB 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.

MinFreePct.  A proportion (5% by default) of data node resources including DataMemory and IndexMemory is kept in reserve to insure that the data node does not exhaust its memory when performing a restart. This can be adjusted using the MinFreePct data node configuration parameter (default 5).

Effective VersionType/UnitsDefaultRange/ValuesRestart Type
NDB 7.5.0unsigned50 - 100N

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 few [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.

MaxDMLOperationsPerTransaction sets the maximum number of DML operations that can be performed in a given transaction.

  • MaxNoOfConcurrentTransactions

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0integer409632 - 4294967039 (0xFFFFFEFF)N

    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 the total number of transactions in the cluster can be expressed as

    MinTotalNoOfConcurrentTransactions =
        (maximum number of tables accessed in any single transaction + 1)
        * number of SQL nodes
    

    Suppose that there are 10 SQL nodes using the cluster. A single join involving 10 tables requires 11 transaction records; if there are 10 such joins in a transaction, then 10 * 11 = 110 transaction records are required for this transaction, per MySQL server, or 110 * 10 = 1100 transaction records total. Each data node can be expected to handle MinTotalNoOfConcurrentTransactions / number of data nodes. For an NDB Cluster having 4 data nodes, this would mean setting MaxNoOfConcurrentTransactions on each data node to 1100 / 4 = 275. In addition, you should provide for failure recovery by ensuring that a single node group can accommodate all concurrent transactions; in other words, that each data node's MaxNoOfConcurrentTransactions is sufficient to cover a number of transactions equal to MinTotalNoOfConcurrentTransactions / number of node groups. If this cluster has a single node group, then MaxNoOfConcurrentTransactions should be set to 1100 (the same as the total number of concurrent transactions for the entire cluster).

    In addition, each transaction involves at least one operation; for this reason, the value set for MaxNoOfConcurrentTransactions should always be no more than the value of MaxNoOfConcurrentOperations.

    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.

    It is possible to change this value using a rolling restart, but the amount of traffic on the cluster must be such that no more transactions occur than the lower of the old and new levels while this is taking place.

    The default value is 4096.

  • MaxNoOfConcurrentOperations

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0integer32K32 - 4294967039 (0xFFFFFEFF)N

    It is a good idea to adjust the value of this parameter according to the size and number of transactions. When performing transactions which involve only a few operations and records, the default value for this parameter is usually sufficient. Performing large transactions involving many records usually requires that you increase its value.

    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 at a minimum 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 one million concurrent updates using transactions, you should set this value to 1000000 / 4 = 250000. To help provide resiliency against failures, it is suggested that you set this parameter to a value that is high enough to permit an individual data node to handle the load for its node group. In other words, you should set the value equal to total number of concurrent operations / number of node groups. (In the case where there is a single node group, this is the same as the total number of concurrent operations for the entire cluster.)

    Because each transaction always involves at least one operation, the value of MaxNoOfConcurrentOperations should always be greater than or equal to the value of MaxNoOfConcurrentTransactions.

    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

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0integerUNDEFINED32 - 4294967039 (0xFFFFFEFF)N

    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.

  • MaxDMLOperationsPerTransaction

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0operations (DML)429496729532 - 4294967295N

    This parameter limits the size of a transaction. The transaction is aborted if it requires more than this many DML operations. The minimum number of operations per transaction is 32; however, you can set MaxDMLOperationsPerTransaction to 0 to disable any limitation on the number of DML operations per transaction. The maximum (and default) is 4294967295.

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

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0integer8K0 - 4294967039 (0xFFFFFEFF)N

    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

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0integer40000 - 4294967039 (0xFFFFFEFF)N

    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

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0bytes1M1K - 4294967039 (0xFFFFFEFF)N

    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

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0integer2562 - 500N

    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

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0integer[see text]32 - 4294967039 (0xFFFFFEFF)N

    Specifies the number of local scan records if many scans are not fully parallelized. When the number of local scan records is not provided, it is calculated as shown here:

    4 * MaxNoOfConcurrentScans * [# data nodes] + 2
    

    The minimum value is 32.

  • BatchSizePerLocalScan

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0integer2561 - 992N

    This parameter is used to calculate the number of lock records used to handle concurrent scan operations.

    BatchSizePerLocalScan has a strong connection to the BatchSize defined in the SQL nodes.

  • LongMessageBuffer

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0bytes64M512K - 4294967039 (0xFFFFFEFF)N

    This is an internal buffer used for passing messages within individual nodes and between nodes. The default is 64MB.

    This parameter seldom needs to be changed from the default.

  • MaxParallelCopyInstances

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0integer00 - 64S

    This parameter sets the parallelization used in the copy phase of a node restart or system restart, when a node that is currently just starting is synchronised with a node that already has current data by copying over any changed records from the node that is up to date. Because full parallelism in such cases can lead to overload situations, MaxParallelCopyInstances provides a means to decrease it. This parameter's default value 0. This value means that the effective parallelism is equal to the number of LDM instances in the node just starting as well as the node updating it.

  • MaxParallelScansPerFragment

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0bytes2561 - 4294967039 (0xFFFFFEFF)N

    It is possible to configure the maximum number of parallel scans (TUP scans and TUX scans) allowed before they begin queuing for serial handling. You can increase this to take advantage of any unused CPU when performing large number of scans in parallel and improve their performance.

    The default value for this parameter is 256.

Memory Allocation

MaxAllocate

Effective VersionType/UnitsDefaultRange/ValuesRestart Type
NDB 7.5.0unsigned32M1M - 1GN

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 that all available memory has not yet been used, you can increase the value of this parameter (or MaxNoOfTables, or both) to cause NDB to make sufficient memory available.

Hash Map Size

DefaultHashMapSize

Effective VersionType/UnitsDefaultRange/ValuesRestart Type
NDB 7.5.0LDM threads38400 - 3840N

The size of the table hash maps used by NDB is configurable using this parameter. DefaultHashMapSize can take any of three possible values (0, 240, 3840). These values and their effects are described in the following table:

ValueDescription / Effect
0Use the lowest value set, if any, for this parameter among all data nodes and API nodes in the cluster; if it is not set on any data or API node, use the default value.
240Original hash map size (used by default in all NDB Cluster releases prior to NDB 7.2.7)
3840Larger hash map size (used by default beginning with NDB 7.2.7)

The original intended use for this parameter was to facilitate upgrades and especially downgrades to and from very old releases with differing default hash map sizes. This is not an issue when upgrading from NDB Cluster 7.4 to NDB Cluster 7.5.

Logging and checkpointing.  The following [ndbd] parameters control log and checkpoint behavior.

  • NoOfFragmentLogFiles

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0integer163 - 4294967039 (0xFFFFFEFF)IN

    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 both required local checkpoints have been completed since that log record was inserted. Checkpointing frequency is determined by its own set of configuration parameters discussed elsewhere in this chapter.

    The default parameter value is 16, which by default means 16 sets of 4 16MB files for a total of 1024MB. The size of the individual log files is configurable using the FragmentLogFileSize parameter. 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 using a rolling node restart (using --initial when starting each data node).

  • FragmentLogFileSize

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0bytes16M4M - 1GIN

    Setting this parameter enables you to control directly the size of redo log files. This can be useful in situations when NDB 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.

    For more information about fragment log files, see the description for NoOfFragmentLogFiles.

  • InitFragmentLogFiles

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0[see values]SPARSESPARSE, FULLIN

    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. However, 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 means of this parameter. InitFragmentLogFiles takes either of two values:

    • SPARSE. Fragment log files are created sparsely. This is the default value.

    • FULL. Force all bytes of the fragment log file to be written to disk.

    Depending on your operating system and file system, setting InitFragmentLogFiles=FULL may help eliminate I/O errors on writes to the REDO log.

  • MaxNoOfOpenFiles

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned020 - 4294967039 (0xFFFFFEFF)N

    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. However, the minimum value to which this parameter can be set is 20.

  • InitialNoOfOpenFiles

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0files2720 - 4294967039 (0xFFFFFEFF)N

    This parameter sets the initial number of internal threads to allocate for open files.

    The default value is 27.

  • MaxNoOfSavedMessages

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0integer250 - 4294967039 (0xFFFFFEFF)N

    This parameter sets the maximum number of errors written in the error log as well as the maximum number of trace files that are kept before overwriting the existing ones. Trace files are generated when, for whatever reason, the node crashes.

    The default is 25, which sets these maximums to 25 error messages and 25 trace files.

  • MaxLCPStartDelay

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0seconds00 - 600N

    In parallel data node recovery, 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.

    It is possible to force a delay in the local checkpoint to permit 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, 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.

  • LcpScanProgressTimeout

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0second600 - 4294967039 (0xFFFFFEFF)N

    A local checkpoint fragment scan watchdog checks periodically for no progress in each fragment scan performed as part of a local checkpoint, and shuts down the node if there is no progress after a given amount of time has elapsed. This interval can be set using the LcpScanProgressTimeout data node configuration parameter, which sets the maximum time for which the local checkpoint can be stalled before the LCP fragment scan watchdog shuts down the node.

    The default value is 60 seconds (providing compatibility with previous releases). Setting this parameter to 0 disables the LCP fragment scan watchdog altogether.

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

These act merely as suggestions to the cluster, and any that are not specified revert to the default values shown.

  • MaxNoOfAttributes

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0integer100032 - 4294967039 (0xFFFFFEFF)N

    This parameter sets a suggested maximum number of attributes that can be defined in the cluster; like MaxNoOfTables, it is not intended to function as a hard upper limit.

    (In older NDB Cluster releases, this parameter was sometimes treated as a hard limit for certain operations. This caused problems with NDB Cluster Replication, when it was possible to create more tables than could be replicated, and sometimes led to confusion when it was possible [or not possible, depending on the circumstances] to create more than MaxNoOfAttributes attributes.)

    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 permit double this amount. For example, if the NDB 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

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0integer1288 - 20320N

    A table object is allocated for each table and for each unique hash index in the cluster. This parameter sets a suggested maximum number of table objects for the cluster as a whole; like MaxNoOfAttributes, it is not intended to function as a hard upper limit.

    (In older NDB Cluster releases, this parameter was sometimes treated as a hard limit for certain operations. This caused problems with NDB Cluster Replication, when it was possible to create more tables than could be replicated, and sometimes led to confusion when it was possible [or not possible, depending on the circumstances] to create more than MaxNoOfTables tables.)

    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 and MaxNoOfOrderedIndexes must not exceed 232 − 2 (4294967294).

  • MaxNoOfOrderedIndexes

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0integer1280 - 4294967039 (0xFFFFFEFF)N

    For each ordered index in the cluster, an object is allocated describing what is being indexed and its storage segments. By default, each index so defined also defines an ordered index. Each unique index and primary key has both an ordered index and a hash index. MaxNoOfOrderedIndexes sets the total number of ordered indexes that can be in use in the system at any one time.

    The default value of this parameter is 128. Each index object consumes approximately 10KB of data per node.

    Note

    The sum of MaxNoOfTables and MaxNoOfOrderedIndexes must not exceed 232 − 2 (4294967294).

  • MaxNoOfTriggers

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0integer7680 - 4294967039 (0xFFFFFEFF)N

    Internal update, insert, and delete triggers are allocated for each unique hash index. (This means that three triggers are created for each unique hash index.) However, an ordered index requires only a single trigger object. Backups also use three trigger objects for each normal table in the cluster.

    Replication between clusters also makes use of internal triggers.

    This parameter sets the maximum number of trigger objects in the cluster.

    The default value is 768.

  • MaxNoOfSubscriptions

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned00 - 4294967039 (0xFFFFFEFF)N

    Each NDB table in an NDB Cluster requires a subscription in the NDB kernel. For some NDB API applications, it may be necessary or desirable to change this parameter. However, for normal usage with MySQL servers acting as SQL nodes, there is not any need to do so.

    The default value for MaxNoOfSubscriptions is 0, which is treated as equal to MaxNoOfTables. Each subscription consumes 108 bytes.

  • MaxNoOfSubscribers

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned00 - 4294967039 (0xFFFFFEFF)N

    This parameter is of interest only when using NDB Cluster Replication. The default value is 0, which is treated as 2 * MaxNoOfTables; that is, there is one subscription per NDB table for each of two MySQL servers (one acting as the replication master and the other as the slave). Each subscriber uses 16 bytes of memory.

    When using circular replication, multi-master replication, and other replication setups involving more than 2 MySQL servers, you should increase this parameter to the number of mysqld processes included in replication (this is often, but not always, the same as the number of clusters). For example, if you have a circular replication setup using three NDB Cluster s, with one mysqld attached to each cluster, and each of these mysqld processes acts as a master and as a slave, you should set MaxNoOfSubscribers equal to 3 * MaxNoOfTables.

    For more information, see Chapter 8, NDB Cluster Replication.

  • MaxNoOfConcurrentSubOperations

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned2560 - 4294967039 (0xFFFFFEFF)N

    This parameter sets a ceiling on the number of operations that can be performed by all API nodes in the cluster at one time. The default value (256) is sufficient for normal operations, and might need to be adjusted only in scenarios where there are a great many API nodes each performing a high volume of operations concurrently.

Boolean parameters.  The behavior of data nodes is also affected by a set of [ndbd] parameters taking on boolean values. These parameters can each be specified as TRUE by setting them equal to 1 or Y, and as FALSE by setting them equal to 0 or N.

  • LateAlloc

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0numeric10 - 1N

    Allocate memory for this data node after a connection to the management server has been established. Enabled by default.

  • LockPagesInMainMemory

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0numeric00 - 2N

    For a number of operating systems, including Solaris and Linux, it is possible to lock a process into memory and so avoid any swapping to disk. This can be used to help guarantee the cluster's real-time characteristics.

    This parameter takes one of the integer values 0, 1, or 2, which act as shown in the following list:

    • 0: Disables locking. This is the default value.

    • 1: Performs the lock after allocating memory for the process.

    • 2: Performs the lock before memory for the process is allocated.

    If the operating system is not configured to permit unprivileged users to lock pages, then the data node process making use of this parameter may have to be run as system root. (LockPagesInMainMemory uses the mlockall function. From Linux kernel 2.6.9, unprivileged users can lock memory as limited by max locked memory. For more information, see ulimit -l and http://linux.die.net/man/2/mlock).

    Note

    In older NDB Cluster releases, this parameter was a Boolean. 0 or false was the default setting, and disabled locking. 1 or true enabled locking of the process after its memory was allocated. NDB Cluster 7.5 treats true or false for the value of this parameter as an error.

    Important

    Beginning with glibc 2.10, glibc uses per-thread arenas to reduce lock contention on a shared pool, which consumes real memory. In general, a data node process does not need per-thread arenas, since it does not perform any memory allocation after startup. (This difference in allocators does not appear to affect performance significantly.)

    The glibc behavior is intended to be configurable via the MALLOC_ARENA_MAX environment variable, but a bug in this mechanism prior to glibc 2.16 meant that this variable could not be set to less than 8, so that the wasted memory could not be reclaimed. (Bug #15907219; see also http://sourceware.org/bugzilla/show_bug.cgi?id=13137 for more information concerning this issue.)

    One possible workaround for this problem is to use the LD_PRELOAD environment variable to preload a jemalloc memory allocation library to take the place of that supplied with glibc.

  • StopOnError

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0boolean10, 1N

    This parameter specifies whether a data node process should exit or perform an automatic restart when an error condition is encountered.

    This parameter's default value is 1; this means that, by default, an error causes the data node process to halt.

    When an error is encountered and StopOnError is 0, the data node process is restarted.

    Important

    If the data node process exits in an uncontrolled fashion (due, for example, to performing kill -9 on the data node process while performing a query, or to a segmentation fault), and StopOnError is set to 0, the angel process attempts to restart it in exactly the same way as it was started previously—that is, using the same startup options that were employed the last time the node was started. Thus, if the data node process was originally started using the --initial option, it is also restarted with --initial. This means that, in such cases, if the failure occurs on a sufficient number of data nodes in a very short interval, the effect is the same as if you had performed an initial restart of the entire cluster, leading to loss of all data. (Bug #24945638)

    Users of MySQL Cluster Manager should note that, when StopOnError equals 1, this prevents the MySQL Cluster Manager agent from restarting any data nodes after it has performed its own restart and recovery. See Starting and Stopping the Agent on Linux, for more information.

  • CrashOnCorruptedTuple

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0booleantruetrue, falseS

    When this parameter is enabled, it forces a data node to shut down whenever it encounters a corrupted tuple. In NDB 7.5, it is enabled by default.

  • Diskless

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0true|false (1|0)falsetrue, falseIS

    It is possible to specify NDB Cluster tables as diskless, meaning that tables are not checkpointed to disk and that no logging occurs. Such tables exist only in main memory. A consequence of using diskless tables is that neither the tables nor the records in those tables survive a crash. However, when operating in diskless mode, it is possible to run ndbd on a diskless computer.

    Important

    This feature causes the entire cluster to operate in diskless mode.

    When this feature is enabled, Cluster online backup is disabled. In addition, a partial start of the cluster is not possible.

    Diskless is disabled by default.

  • ODirect

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0booleanfalsetrue, falseN

    Enabling this parameter causes NDB to attempt using O_DIRECT writes for LCP, backups, and redo logs, often lowering kswapd and CPU usage. When using NDB Cluster on Linux, enable ODirect if you are using a 2.6 or later kernel.

    ODirect is disabled by default.

  • RestartOnErrorInsert

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0error code20 - 4N

    This feature is accessible only when building the debug version where it is possible to insert errors in the execution of individual blocks of code as part of testing.

    This feature is disabled by default.

  • CompressedBackup

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0booleanfalsetrue, falseN

    Setting this parameter to 1 causes backup files to be compressed. The compression used is equivalent to gzip --fast, and can save 50% or more of the space required on the data node to store uncompressed backup files. Compressed backups can be enabled for individual data nodes, or for all data nodes (by setting this parameter in the [ndbd default] section of the config.ini file).

    Important

    You cannot restore a compressed backup to a cluster running a MySQL version that does not support this feature.

    The default value is 0 (disabled).

  • CompressedLCP

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0booleanfalsetrue, falseN

    Setting this parameter to 1 causes local checkpoint files to be compressed. The compression used is equivalent to gzip --fast, and can save 50% or more of the space required on the data node to store uncompressed checkpoint files. Compressed LCPs can be enabled for individual data nodes, or for all data nodes (by setting this parameter in the [ndbd default] section of the config.ini file).

    Important

    You cannot restore a compressed local checkpoint to a cluster running a MySQL version that does not support this feature.

    The default value is 0 (disabled).

Controlling Timeouts, Intervals, and Disk Paging

There are a number of [ndbd] parameters specifying timeouts and intervals between various actions in Cluster data nodes. Most of the timeout values are specified in milliseconds. Any exceptions to this are mentioned where applicable.

  • TimeBetweenWatchDogCheck

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0milliseconds600070 - 4294967039 (0xFFFFFEFF)N

    To prevent the main thread from getting stuck in an endless loop at some point, a watchdog thread checks the main thread. This parameter specifies the number of milliseconds between checks. If the process remains in the same state after three checks, the watchdog thread terminates it.

    This parameter can easily be changed for purposes of experimentation or to adapt to local conditions. It can be specified on a per-node basis although there seems to be little reason for doing so.

    The default timeout is 6000 milliseconds (6 seconds).

  • TimeBetweenWatchDogCheckInitial

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0milliseconds600070 - 4294967039 (0xFFFFFEFF)N

    This is similar to the TimeBetweenWatchDogCheck parameter, except that TimeBetweenWatchDogCheckInitial controls the amount of time that passes between execution checks inside a database node in the early start phases during which memory is allocated.

    The default timeout is 6000 milliseconds (6 seconds).

  • StartPartialTimeout

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0milliseconds300000 - 4294967039 (0xFFFFFEFF)N

    This parameter specifies how long the Cluster waits for all data nodes to come up before the cluster initialization routine is invoked. This timeout is used to avoid a partial Cluster startup whenever possible.

    This parameter is overridden when performing an initial start or initial restart of the cluster.

    The default value is 30000 milliseconds (30 seconds). 0 disables the timeout, in which case the cluster may start only if all nodes are available.

  • StartPartitionedTimeout

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0milliseconds600000 - 4294967039 (0xFFFFFEFF)N

    If the cluster is ready to start after waiting for StartPartialTimeout milliseconds but is still possibly in a partitioned state, the cluster waits until this timeout has also passed. If StartPartitionedTimeout is set to 0, the cluster waits indefinitely.

    This parameter is overridden when performing an initial start or initial restart of the cluster.

    The default timeout is 60000 milliseconds (60 seconds).

  • StartFailureTimeout

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0milliseconds00 - 4294967039 (0xFFFFFEFF)N

    If a data node has not completed its startup sequence within the time specified by this parameter, the node startup fails. Setting this parameter to 0 (the default value) means that no data node timeout is applied.

    For nonzero values, this parameter is measured in milliseconds. For data nodes containing extremely large amounts of data, this parameter should be increased. For example, in the case of a data node containing several gigabytes of data, a period as long as 10−15 minutes (that is, 600000 to 1000000 milliseconds) might be required to perform a node restart.

  • StartNoNodeGroupTimeout

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0milliseconds150000 - 4294967039 (0xFFFFFEFF)N

    When a data node is configured with Nodegroup = 65536, is regarded as not being assigned to any node group. When that is done, the cluster waits StartNoNodegroupTimeout milliseconds, then treats such nodes as though they had been added to the list passed to the --nowait-nodes option, and starts. The default value is 15000 (that is, the management server waits 15 seconds). Setting this parameter equal to 0 means that the cluster waits indefinitely.

    StartNoNodegroupTimeout must be the same for all data nodes in the cluster; for this reason, you should always set it in the [ndbd default] section of the config.ini file, rather than for individual data nodes.

    See Section 7.14, “Adding NDB Cluster Data Nodes Online”, for more information.

  • HeartbeatIntervalDbDb

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0milliseconds500010 - 4294967039 (0xFFFFFEFF)N

    One of the primary methods of discovering failed nodes is by the use of heartbeats. This parameter states how often heartbeat signals are sent and how often to expect to receive them. Heartbeats cannot be disabled.

    After missing four heartbeat intervals in a row, the node is declared dead. Thus, the maximum time for discovering a failure through the heartbeat mechanism is five times the heartbeat interval.

    The default heartbeat interval is 5000 milliseconds (5 seconds). This parameter must not be changed drastically and should not vary widely between nodes. If one node uses 5000 milliseconds and the node watching it uses 1000 milliseconds, obviously the node will be declared dead very quickly. This parameter can be changed during an online software upgrade, but only in small increments.

    See also Network communication and latency, as well as the description of the ConnectCheckIntervalDelay configuration parameter.

  • HeartbeatIntervalDbApi

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0milliseconds1500100 - 4294967039 (0xFFFFFEFF)N

    Each data node sends heartbeat signals to each MySQL server (SQL node) to ensure that it remains in contact. If a MySQL server fails to send a heartbeat in time it is declared dead, in which case all ongoing transactions are completed and all resources released. The SQL node cannot reconnect until all activities initiated by the previous MySQL instance have been completed. The three-heartbeat criteria for this determination are the same as described for HeartbeatIntervalDbDb.

    The default interval is 1500 milliseconds (1.5 seconds). This interval can vary between individual data nodes because each data node watches the MySQL servers connected to it, independently of all other data nodes.

    For more information, see Network communication and latency.

  • HeartbeatOrder

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0numeric00 - 65535S

    Data nodes send heartbeats to one another in a circular fashion whereby each data node monitors the previous one. If a heartbeat is not detected by a given data node, this node declares the previous data node in the circle dead (that is, no longer accessible by the cluster). The determination that a data node is dead is done globally; in other words; once a data node is declared dead, it is regarded as such by all nodes in the cluster.

    It is possible for heartbeats between data nodes residing on different hosts to be too slow compared to heartbeats between other pairs of nodes (for example, due to a very low heartbeat interval or temporary connection problem), such that a data node is declared dead, even though the node can still function as part of the cluster. .

    In this type of situation, it may be that the order in which heartbeats are transmitted between data nodes makes a difference as to whether or not a particular data node is declared dead. If this declaration occurs unnecessarily, this can in turn lead to the unnecessary loss of a node group and as thus to a failure of the cluster.

    Consider a setup where there are 4 data nodes A, B, C, and D running on 2 host computers host1 and host2, and that these data nodes make up 2 node groups, as shown in the following table:

    Node Group

    Nodes Running on host1

    Nodes Running on host2

    Node Group 0:

    Node A

    Node B

    Node Group 1:

    Node C

    Node D

    Suppose the heartbeats are transmitted in the order A->B->C->D->A. In this case, the loss of the heartbeat between the hosts causes node B to declare node A dead and node C to declare node B dead. This results in loss of Node Group 0, and so the cluster fails. On the other hand, if the order of transmission is A->B->D->C->A (and all other conditions remain as previously stated), the loss of the heartbeat causes nodes A and D to be declared dead; in this case, each node group has one surviving node, and the cluster survives.

    The HeartbeatOrder configuration parameter makes the order of heartbeat transmission user-configurable. The default value for HeartbeatOrder is zero; allowing the default value to be used on all data nodes causes the order of heartbeat transmission to be determined by NDB. If this parameter is used, it must be set to a nonzero value (maximum 65535) for every data node in the cluster, and this value must be unique for each data node; this causes the heartbeat transmission to proceed from data node to data node in the order of their HeartbeatOrder values from lowest to highest (and then directly from the data node having the highest HeartbeatOrder to the data node having the lowest value, to complete the circle). The values need not be consecutive; for example, to force the heartbeat transmission order A->B->D->C->A in the scenario outlined previously, you could set the HeartbeatOrder values as shown here:

    NodeHeartbeatOrder
    A10
    B20
    C30
    D25

    To use this parameter to change the heartbeat transmission order in a running NDB Cluster , you must first set HeartbeatOrder for each data node in the cluster in the global configuration (config.ini) file (or files). To cause the change to take effect, you must perform either of the following:

    • A complete shutdown and restart of the entire cluster.

    • 2 rolling restarts of the cluster in succession. All nodes must be restarted in the same order in both rolling restarts.

    You can use DUMP 908 to observe the effect of this parameter in the data node logs.

  • ConnectCheckIntervalDelay

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0milliseconds00 - 4294967039 (0xFFFFFEFF)N

    This parameter enables connection checking between data nodes after one of them has failed heartbeat checks for 5 intervals of up to HeartbeatIntervalDbDb milliseconds.

    Such a data node that further fails to respond within an interval of ConnectCheckIntervalDelay milliseconds is considered suspect, and is considered dead after two such intervals. This can be useful in setups with known latency issues.

    The default value for this parameter is 0 (disabled).

  • TimeBetweenLocalCheckpoints

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0number of 4-byte words, as a base-2 logarithm200 - 31N

    This parameter is an exception in that it does not specify a time to wait before starting a new local checkpoint; rather, it is used to ensure that local checkpoints are not performed in a cluster where relatively few updates are taking place. In most clusters with high update rates, it is likely that a new local checkpoint is started immediately after the previous one has been completed.

    The size of all write operations executed since the start of the previous local checkpoints is added. This parameter is also exceptional in that it is specified as the base-2 logarithm of the number of 4-byte words, so that the default value 20 means 4MB (4 × 220) of write operations, 21 would mean 8MB, and so on up to a maximum value of 31, which equates to 8GB of write operations.

    All the write operations in the cluster are added together. Setting TimeBetweenLocalCheckpoints to 6 or less means that local checkpoints will be executed continuously without pause, independent of the cluster's workload.

  • TimeBetweenGlobalCheckpoints

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0milliseconds200020 - 32000N

    When a transaction is committed, it is committed in main memory in all nodes on which the data is mirrored. However, transaction log records are not flushed to disk as part of the commit. The reasoning behind this behavior is that having the transaction safely committed on at least two autonomous host machines should meet reasonable standards for durability.

    It is also important to ensure that even the worst of cases—a complete crash of the cluster—is handled properly. To guarantee that this happens, all transactions taking place within a given interval are put into a global checkpoint, which can be thought of as a set of committed transactions that has been flushed to disk. In other words, as part of the commit process, a transaction is placed in a global checkpoint group. Later, this group's log records are flushed to disk, and then the entire group of transactions is safely committed to disk on all computers in the cluster.

    This parameter defines the interval between global checkpoints. The default is 2000 milliseconds.

  • TimeBetweenGlobalCheckpointsTimeout

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0milliseconds12000010 - 4294967039 (0xFFFFFEFF)N

    This parameter defines the minimum timeout between global checkpoints. The default is 120000 milliseconds.

  • TimeBetweenEpochs

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0milliseconds1000 - 32000N

    This parameter defines the interval between synchronization epochs for NDB Cluster Replication. The default value is 100 milliseconds.

    TimeBetweenEpochs is part of the implementation of micro-GCPs, which can be used to improve the performance of NDB Cluster Replication.

  • TimeBetweenEpochsTimeout

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0milliseconds00 - 256000N

    This parameter defines a timeout for synchronization epochs for NDB Cluster Replication. If a node fails to participate in a global checkpoint within the time determined by this parameter, the node is shut down. The default value is 0; in other words, the timeout is disabled.

    TimeBetweenEpochsTimeout is part of the implementation of micro-GCPs, which can be used to improve the performance of NDB Cluster Replication.

    The current value of this parameter and a warning are written to the cluster log whenever a GCP save takes longer than 1 minute or a GCP save takes longer than 10 seconds.

    Setting this parameter to zero has the effect of disabling GCP stops caused by save timeouts, commit timeouts, or both. The maximum possible value for this parameter is 256000 milliseconds.

  • MaxBufferedEpochs

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0epochs1000 - 100000N

    The number of unprocessed epochs by which a subscribing node can lag behind. Exceeding this number causes a lagging subscriber to be disconnected.

    The default value of 100 is sufficient for most normal operations. If a subscribing node does lag enough to cause disconnections, it is usually due to network or scheduling issues with regard to processes or threads. (In rare circumstances, the problem may be due to a bug in the NDB client.) It may be desirable to set the value lower than the default when epochs are longer.

    Disconnection prevents client issues from affecting the data node service, running out of memory to buffer data, and eventually shutting down. Instead, only the client is affected as a result of the disconnect (by, for example gap events in the binary log), forcing the client to reconnect or restart the process.

  • MaxBufferedEpochBytes

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0bytes2621440026214400 (0x01900000) - 4294967039 (0xFFFFFEFF)N

    The total number of bytes allocated for buffering epochs by this node.

  • TimeBetweenInactiveTransactionAbortCheck

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0milliseconds10001000 - 4294967039 (0xFFFFFEFF)N

    Timeout handling is performed by checking a timer on each transaction once for every interval specified by this parameter. Thus, if this parameter is set to 1000 milliseconds, every transaction will be checked for timing out once per second.

    The default value is 1000 milliseconds (1 second).

  • TransactionInactiveTimeout

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0milliseconds[see text]0 - 4294967039 (0xFFFFFEFF)N

    This parameter states the maximum time that is permitted to lapse between operations in the same transaction before the transaction is aborted.

    The default for this parameter is 4G (also the maximum). For a real-time database that needs to ensure that no transaction keeps locks for too long, this parameter should be set to a relatively small value. The unit is milliseconds.

  • TransactionDeadlockDetectionTimeout

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0milliseconds120050 - 4294967039 (0xFFFFFEFF)N

    When a node executes a query involving a transaction, the node waits for the other nodes in the cluster to respond before continuing. A failure to respond can occur for any of the following reasons:

    • The node is dead

    • The operation has entered a lock queue

    • The node requested to perform the action could be heavily overloaded.

    This timeout parameter states how long the transaction coordinator waits for query execution by another node before aborting the transaction, and is important for both node failure handling and deadlock detection.

    The default timeout value is 1200 milliseconds (1.2 seconds).

    The minimum for this parameter is 50 milliseconds.

  • DiskSyncSize

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0bytes4M32K - 4294967039 (0xFFFFFEFF)N

    This is the maximum number of bytes to store before flushing data to a local checkpoint file. This is done to prevent write buffering, which can impede performance significantly. This parameter is not intended to take the place of TimeBetweenLocalCheckpoints.

    Note

    When ODirect is enabled, it is not necessary to set DiskSyncSize; in fact, in such cases its value is simply ignored.

    The default value is 4M (4 megabytes).

  • MaxDiskWriteSpeed

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0numeric20M1M - 1024GS

    Set the maximum rate for writing to disk, in bytes per second, by local checkpoints and backup operations when no restarts (by this data node or any other data node) are taking place in this NDB Cluster .

    For setting the maximum rate of disk writes allowed while this data node is restarting, use MaxDiskWriteSpeedOwnRestart. For setting the maximum rate of disk writes allowed while other data nodes are restarting, use MaxDiskWriteSpeedOtherNodeRestart. The minimum speed for disk writes by all LCPs and backup operations can be adjusted by setting MinDiskWriteSpeed.

  • MaxDiskWriteSpeedOtherNodeRestart

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0numeric50M1M - 1024GS

    Set the maximum rate for writing to disk, in bytes per second, by local checkpoints and backup operations when one or more data nodes in this NDB Cluster are restarting, other than this node.

    For setting the maximum rate of disk writes allowed while this data node is restarting, use MaxDiskWriteSpeedOwnRestart. For setting the maximum rate of disk writes allowed when no data nodes are restarting anywhere in the cluster, use MaxDiskWriteSpeed. The minimum speed for disk writes by all LCPs and backup operations can be adjusted by setting MinDiskWriteSpeed.

  • MaxDiskWriteSpeedOwnRestart

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0numeric200M1M - 1024GS

    Set the maximum rate for writing to disk, in bytes per second, by local checkpoints and backup operations while this data node is restarting.

    For setting the maximum rate of disk writes allowed while other data nodes are restarting, use MaxDiskWriteSpeedOtherNodeRestart. For setting the maximum rate of disk writes allowed when no data nodes are restarting anywhere in the cluster, use MaxDiskWriteSpeed. The minimum speed for disk writes by all LCPs and backup operations can be adjusted by setting MinDiskWriteSpeed.

  • MinDiskWriteSpeed

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0numeric10M1M - 1024GS

    Set the minimum rate for writing to disk, in bytes per second, by local checkpoints and backup operations.

    The maximum rates of disk writes allowed for LCPs and backups under various conditions are adjustable using the parameters MaxDiskWriteSpeed, MaxDiskWriteSpeedOwnRestart, and MaxDiskWriteSpeedOtherNodeRestart. See the descriptions of these parameters for more information.

  • ArbitrationTimeout

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0milliseconds750010 - 4294967039 (0xFFFFFEFF)N

    This parameter specifies how long data nodes wait for a response from the arbitrator to an arbitration message. If this is exceeded, the network is assumed to have split.

    The default value is 7500 milliseconds (7.5 seconds).

  • Arbitration

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0enumerationDefaultDefault, Disabled, WaitExternalN

    The Arbitration parameter enables a choice of arbitration schemes, corresponding to one of 3 possible values for this parameter:

    • Default.  This enables arbitration to proceed normally, as determined by the ArbitrationRank settings for the management and API nodes. This is the default value.

    • Disabled.  Setting Arbitration = Disabled in the [ndbd default] section of the config.ini file to accomplishes the same task as setting ArbitrationRank to 0 on all management and API nodes. When Arbitration is set in this way, any ArbitrationRank settings are ignored.

    • WaitExternal.  The Arbitration parameter also makes it possible to configure arbitration in such a way that the cluster waits until after the time determined by ArbitrationTimeout has passed for an external cluster manager application to perform arbitration instead of handling arbitration internally. This can be done by setting Arbitration = WaitExternal in the [ndbd default] section of the config.ini file. For best results with the WaitExternal setting, it is recommended that ArbitrationTimeout be 2 times as long as the interval required by the external cluster manager to perform arbitration.

    Important

    This parameter should be used only in the [ndbd default] section of the cluster configuration file. The behavior of the cluster is unspecified when Arbitration is set to different values for individual data nodes.

  • RestartSubscriberConnectTimeout

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0ms120000 - 4294967039 (0xFFFFFEFF)S

    This parameter determines the time that a data node waits for subscribing API nodes to connect. Once this timeout expires, any missing API nodes are disconnected from the cluster. To disable this timeout, set RestartSubscriberConnectTimeout to 0.

    While this parameter is specified in milliseconds, the timeout itself is resolved to the next-greatest whole second.

Buffering and logging.  Several [ndbd] configuration parameters enable the advanced user to have more control over the resources used by node processes and to adjust various buffer sizes at need.

These buffers are used as front ends to the file system when writing log records to disk. If the node is running in diskless mode, these parameters can be set to their minimum values without penalty due to the fact that disk writes are faked by the NDB storage engine's file system abstraction layer.

  • UndoIndexBuffer

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned2M1M - 4294967039 (0xFFFFFEFF)N

    The UNDO index buffer, whose size is set by this parameter, is used during local checkpoints. The NDB storage engine uses a recovery scheme based on checkpoint consistency in conjunction with an operational REDO log. To produce a consistent checkpoint without blocking the entire system for writes, UNDO logging is done while performing the local checkpoint. UNDO logging is activated on a single table fragment at a time. This optimization is possible because tables are stored entirely in main memory.

    The UNDO index buffer is used for the updates on the primary key hash index. Inserts and deletes rearrange the hash index; the NDB storage engine writes UNDO log records that map all physical changes to an index page so that they can be undone at system restart. It also logs all active insert operations for each fragment at the start of a local checkpoint.

    Reads and updates set lock bits and update a header in the hash index entry. These changes are handled by the page-writing algorithm to ensure that these operations need no UNDO logging.

    This buffer is 2MB by default. The minimum value is 1MB, which is sufficient for most applications. For applications doing extremely large or numerous inserts and deletes together with large transactions and large primary keys, it may be necessary to increase the size of this buffer. If this buffer is too small, the NDB storage engine issues internal error code 677 (Index UNDO buffers overloaded).

    Important

    It is not safe to decrease the value of this parameter during a rolling restart.

  • UndoDataBuffer

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned16M1M - 4294967039 (0xFFFFFEFF)N

    This parameter sets the size of the UNDO data buffer, which performs a function similar to that of the UNDO index buffer, except the UNDO data buffer is used with regard to data memory rather than index memory. This buffer is used during the local checkpoint phase of a fragment for inserts, deletes, and updates.

    Because UNDO log entries tend to grow larger as more operations are logged, this buffer is also larger than its index memory counterpart, with a default value of 16MB.

    This amount of memory may be unnecessarily large for some applications. In such cases, it is possible to decrease this size to a minimum of 1MB.

    It is rarely necessary to increase the size of this buffer. If there is such a need, it is a good idea to check whether the disks can actually handle the load caused by database update activity. A lack of sufficient disk space cannot be overcome by increasing the size of this buffer.

    If this buffer is too small and gets congested, the NDB storage engine issues internal error code 891 (Data UNDO buffers overloaded).

    Important

    It is not safe to decrease the value of this parameter during a rolling restart.

  • RedoBuffer

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0bytes32M1M - 4294967039 (0xFFFFFEFF)N

    All update activities also need to be logged. The REDO log makes it possible to replay these updates whenever the system is restarted. The NDB recovery algorithm uses a fuzzy checkpoint of the data together with the UNDO log, and then applies the REDO log to play back all changes up to the restoration point.

    RedoBuffer sets the size of the buffer in which the REDO log is written. The default value is 32MB; the minimum value is 1MB.

    If this buffer is too small, the NDB storage engine issues error code 1221 (REDO log buffers overloaded). For this reason, you should exercise care if you attempt to decrease the value of RedoBuffer as part of an online change in the cluster's configuration.

    ndbmtd allocates a separate buffer for each LDM thread (see ThreadConfig). For example, with 4 LDM threads, an ndbmtd data node actually has 4 buffers and allocates RedoBuffer bytes to each one, for a total of 4 * RedoBuffer bytes.

  • EventLogBufferSize

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0bytes81920 - 64KS

    Controls the size of the circular buffer used for NDB log events within data nodes.

Controlling log messages.  In managing the cluster, it is very important to be able to control the number of log messages sent for various event types to stdout. For each event category, there are 16 possible event levels (numbered 0 through 15). Setting event reporting for a given event category to level 15 means all event reports in that category are sent to stdout; setting it to 0 means that there will be no event reports made in that category.

By default, only the startup message is sent to stdout, with the remaining event reporting level defaults being set to 0. The reason for this is that these messages are also sent to the management server's cluster log.

An analogous set of levels can be set for the management client to determine which event levels to record in the cluster log.

  • LogLevelStartup

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0integer10 - 15N

    The reporting level for events generated during startup of the process.

    The default level is 1.

  • LogLevelShutdown

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0integer00 - 15N

    The reporting level for events generated as part of graceful shutdown of a node.

    The default level is 0.

  • LogLevelStatistic

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0integer00 - 15N

    The reporting level for statistical events such as number of primary key reads, number of updates, number of inserts, information relating to buffer usage, and so on.

    The default level is 0.

  • LogLevelCheckpoint

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0log level00 - 15N

    The reporting level for events generated by local and global checkpoints.

    The default level is 0.

  • LogLevelNodeRestart

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0integer00 - 15N

    The reporting level for events generated during node restart.

    The default level is 0.

  • LogLevelConnection

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0integer00 - 15N

    The reporting level for events generated by connections between cluster nodes.

    The default level is 0.

  • LogLevelError

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0integer00 - 15N

    The reporting level for events generated by errors and warnings by the cluster as a whole. These errors do not cause any node failure but are still considered worth reporting.

    The default level is 0.

  • LogLevelCongestion

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0levelr00 - 15N

    The reporting level for events generated by congestion. These errors do not cause node failure but are still considered worth reporting.

    The default level is 0.

  • LogLevelInfo

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0integer00 - 15N

    The reporting level for events generated for information about the general state of the cluster.

    The default level is 0.

  • MemReportFrequency

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned00 - 4294967039 (0xFFFFFEFF)N

    This parameter controls how often data node memory usage reports are recorded in the cluster log; it is an integer value representing the number of seconds between reports.

    Each data node's data memory and index memory usage is logged as both a percentage and a number of 32 KB pages of the DataMemory and IndexMemory, respectively, set in the config.ini file. For example, if DataMemory is equal to 100 MB, and a given data node is using 50 MB for data memory storage, the corresponding line in the cluster log might look like this:

    2006-12-24 01:18:16 [MgmSrvr] INFO -- Node 2: Data usage is 50%(1280 32K pages of total 2560)
    

    MemReportFrequency is not a required parameter. If used, it can be set for all cluster data nodes in the [ndbd default] section of config.ini, and can also be set or overridden for individual data nodes in the corresponding [ndbd] sections of the configuration file. The minimum value—which is also the default value—is 0, in which case memory reports are logged only when memory usage reaches certain percentages (80%, 90%, and 100%), as mentioned in the discussion of statistics events in Section 7.6.2, “NDB Cluster Log Events”.

  • StartupStatusReportFrequency

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0seconds00 - 4294967039 (0xFFFFFEFF)N

    When a data node is started with the --initial, it initializes the redo log file during Start Phase 4 (see Section 7.1, “Summary of NDB Cluster Start Phases”). When very large values are set for NoOfFragmentLogFiles, FragmentLogFileSize, or both, this initialization can take a long time.You can force reports on the progress of this process to be logged periodically, by means of the StartupStatusReportFrequency configuration parameter. In this case, progress is reported in the cluster log, in terms of both the number of files and the amount of space that have been initialized, as shown here:

    2009-06-20 16:39:23 [MgmSrvr] INFO -- Node 1: Local redo log file initialization status:
    #Total files: 80, Completed: 60
    #Total MBytes: 20480, Completed: 15557
    2009-06-20 16:39:23 [MgmSrvr] INFO -- Node 2: Local redo log file initialization status:
    #Total files: 80, Completed: 60
    #Total MBytes: 20480, Completed: 15570
    

    These reports are logged each StartupStatusReportFrequency seconds during Start Phase 4. If StartupStatusReportFrequency is 0 (the default), then reports are written to the cluster log only when at the beginning and at the completion of the redo log file initialization process.

Data Node Debugging Parameters.  It is also possible to cause logging of traces for events generated by creating and dropping tables using DictTrace. This parameter is useful only in debugging NDB kernel code. DictTrace takes an integer value. 0 (default - no logging) and 1 (logging enabled) are the only supported values prior to NDB 7.5.2. In NDB 7.5.2 and later, setting this parameter to 2 enables logging of additional DBDICT debugging output (Bug #20368450).

Backup parameters.  The [ndbd] parameters discussed in this section define memory buffers set aside for execution of online backups.

  • BackupDataBufferSize

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0bytes16M512K - 4294967039 (0xFFFFFEFF)N
    NDB 7.5.0bytes16M2M - 4294967039 (0xFFFFFEFF)N
    NDB 7.5.1bytes16M512K - 4294967039 (0xFFFFFEFF)N

    In creating a backup, there are two buffers used for sending data to the disk. The backup data buffer is used to fill in data recorded by scanning a node's tables. Once this buffer has been filled to the level specified as BackupWriteSize, the pages are sent to disk. While flushing data to disk, the backup process can continue filling this buffer until it runs out of space. When this happens, the backup process pauses the scan and waits until some disk writes have completed freeing up memory so that scanning may continue.

    The default value for this parameter is 16MB. The minimum was changed from 2M to 512K in NDB 7.5.1. (Bug #22749509)

  • BackupDiskWriteSpeedPct

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0percent500 - 90N

    During normal operation, data nodes attempt to maximize the disk write speed used for local checkpoints and backups while remaining within the bounds set by MinDiskWriteSpeed and MaxDiskWriteSpeed. Disk write throttling gives each LDM thread an equal share of the total budget. This allows parallel LCPs to take place without exceeding the disk I/O budget. Because a backup is executed by only one LDM thread, this effectively caused a budget cut, resulting in longer backup completion times, and—if the rate of change is sufficiently high—in failure to complete the backup when the backup log buffer fill rate is higher than the achievable write rate.

    This problem can be addressed by using the BackupDiskWriteSpeedPct configuration parameter, which takes a value in the range 0-90 (inclusive) which is interpreted as the percentage of the node's maximum write rate budget that is reserved prior to sharing out the remainder of the budget among LDM threads for LCPs. The LDM thread running the backup receives the whole write rate budget for the backup, plus its (reduced) share of the write rate budget for local checkpoints. (This makes the disk write rate budget behave similarly to how it was handled in NDB Cluster 7.3 and earlier.)

    The default value for this parameter is 50 (interpreted as 50%).

  • BackupLogBufferSize

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0bytes16M2M - 4294967039 (0xFFFFFEFF)N

    The backup log buffer fulfills a role similar to that played by the backup data buffer, except that it is used for generating a log of all table writes made during execution of the backup. The same principles apply for writing these pages as with the backup data buffer, except that when there is no more space in the backup log buffer, the backup fails. For that reason, the size of the backup log buffer must be large enough to handle the load caused by write activities while the backup is being made. See Section 7.3.3, “Configuration for NDB Cluster Backups”.

    The default value for this parameter should be sufficient for most applications. In fact, it is more likely for a backup failure to be caused by insufficient disk write speed than it is for the backup log buffer to become full. If the disk subsystem is not configured for the write load caused by applications, the cluster is unlikely to be able to perform the desired operations.

    It is preferable to configure cluster nodes in such a manner that the processor becomes the bottleneck rather than the disks or the network connections.

    The default value for this parameter is 16MB.

  • BackupMemory

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0bytes32M0 - 4294967039 (0xFFFFFEFF)N

    This parameter is deprecated, and subject to removal in a future version of NDB Cluster . Any setting made for it is ignored.

  • BackupReportFrequency

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0seconds00 - 4294967039 (0xFFFFFEFF)N

    This parameter controls how often backup status reports are issued in the management client during a backup, as well as how often such reports are written to the cluster log (provided cluster event logging is configured to permit it—see Logging and checkpointing). BackupReportFrequency represents the time in seconds between backup status reports.

    The default value is 0.

  • BackupWriteSize

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0bytes256K32K - 4294967039 (0xFFFFFEFF)N

    This parameter specifies the default size of messages written to disk by the backup log and backup data buffers.

    The default value for this parameter is 256KB.

  • BackupMaxWriteSize

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0bytes1M256K - 4294967039 (0xFFFFFEFF)N

    This parameter specifies the maximum size of messages written to disk by the backup log and backup data buffers.

    The default value for this parameter is 1MB.

Note

The location of the backup files is determined by the BackupDataDir data node configuration parameter.

Additional requirements.  When specifying these parameters, the following relationships must hold true. Otherwise, the data node will be unable to start.

  • BackupDataBufferSize >= BackupWriteSize + 188KB

  • BackupLogBufferSize >= BackupWriteSize + 16KB

  • BackupMaxWriteSize >= BackupWriteSize

NDB Cluster Realtime Performance Parameters

The [ndbd] parameters discussed in this section are used in scheduling and locking of threads to specific CPUs on multiprocessor data node hosts.

Note

To make use of these parameters, the data node process must be run as system root.

  • LockExecuteThreadToCPU

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0CPU ID64K0 - 64KN

    When used with ndbd, this parameter (now a string) specifies the ID of the CPU assigned to handle the NDBCLUSTER execution thread. When used with ndbmtd, the value of this parameter is a comma-separated list of CPU IDs assigned to handle execution threads. Each CPU ID in the list should be an integer in the range 0 to 65535 (inclusive).

    The number of IDs specified should match the number of execution threads determined by MaxNoOfExecutionThreads. However, there is no guarantee that threads are assigned to CPUs in any given order when using this parameter. You can obtain more finely-grained control of this type using ThreadConfig.

    LockExecuteThreadToCPU has no default value.

  • LockMaintThreadsToCPU

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0CPU ID[none]0 - 64KN

    This parameter specifies the ID of the CPU assigned to handle NDBCLUSTER maintenance threads.

    The value of this parameter is an integer in the range 0 to 65535 (inclusive). There is no default value.

  • RealtimeScheduler

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0booleanfalsetrue, falseN

    Setting this parameter to 1 enables real-time scheduling of data node threads.

    The default is 0 (scheduling disabled).

  • SchedulerExecutionTimer

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0µs500 - 11000N

    This parameter specifies the time in microseconds for threads to be executed in the scheduler before being sent. Setting it to 0 minimizes the response time; to achieve higher throughput, you can increase the value at the expense of longer response times.

    The default is 50 μsec, which our testing shows to increase throughput slightly in high-load cases without materially delaying requests.

  • SchedulerResponsiveness

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0integer50 - 10S

    Set the balance in the NDB scheduler between speed and throughput. This parameter takes an integer whose value is in the range 0-10 inclusive, with 5 as the default. Higher values provide better response times relative to throughput. Lower values provide increased throughput at the expense of longer response times.

  • SchedulerSpinTimer

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0µs00 - 500N

    This parameter specifies the time in microseconds for threads to be executed in the scheduler before sleeping.

    The default value is 0.

  • BuildIndexThreads

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0numeric00 - 128S

    This parameter determines the number of threads to create when rebuilding ordered indexes during a system or node start, as well as when running ndb_restore --rebuild-indexes. It is supported only when there is more than one fragment for the table per data node (for example, when the MAX_ROWS option has been used with CREATE TABLE).

    Setting this parameter to 0 (the default) disables multi-threaded building of ordered indexes.

    This parameter is supported when using ndbd or ndbmtd.

    You can enable multi-threaded builds during data node initial restarts by setting the TwoPassInitialNodeRestartCopy data node configuration parameter to TRUE.

  • TwoPassInitialNodeRestartCopy

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0booleanfalsetrue, falseN

    Multi-threaded building of ordered indexes can be enabled for initial restarts of data nodes by setting this configuration parameter to TRUE, which enables two-pass copying of data during initial node restarts.

    You must also set BuildIndexThreads to a nonzero value.

  • Numa

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0boolean1...N

    This parameter determines whether Non-Uniform Memory Access (NUMA) is controlled by the operating or by the data node process, whether the data node uses ndbd or ndbmtd. By default, NDB attempts to use an interleaved NUMA memory allocation policy on any data node where the host operating system provides NUMA support.

    Setting Numa = 0 means that the datanode process does not itself attempt to set a policy for memory allocation, and permits this behavior to be determined by the operating system, which may be further guided by the separate numactl tool. That is, Numa = 0 yields the system default behavior, which can be customised by numactl. For many Linux systems, the system default behavior is to allocate socket-local memory to any given process at allocation time. This can be problematic when using ndbmtd; this is because nbdmtd allocates all memory at startup, leading to an imbalance, giving different access speeds for different sockets, especially when locking pages in main memory.

    Setting Numa = 1 means that the data node process uses libnuma to request interleaved memory allocation. (This can also be accomplished manually, on the operating system level, using numactl.) Using interleaved allocation in effect tells the data node process to ignore non-uniform memory access but does not attempt to take any advantage of fast local memory; instead, the data node process tries to avoid imbalances due to slow remote memory. If interleaved allocation is not desired, set Numa to 0 so that the desired behavior can be determined on the operating system level.

    The Numa configuration parameter is supported only on Linux systems where libnuma.so is available.

Multi-Threading Configuration Parameters (ndbmtd).  ndbmtd runs by default as a single-threaded process and must be configured to use multiple threads, using either of two methods, both of which require setting configuration parameters in the config.ini file. The first method is simply to set an appropriate value for the MaxNoOfExecutionThreads configuration parameter. A second method, makes it possible to set up more complex rules for ndbmtd multi-threading using ThreadConfig. The next few paragraphs provide information about these parameters and their use with multi-threaded data nodes.

  • MaxNoOfExecutionThreads

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0integer22 - 72IS

    This parameter directly controls the number of execution threads used by ndbmtd, up to a maximum of 72. Although this parameter is set in [ndbd] or [ndbd default] sections of the config.ini file, it is exclusive to ndbmtd and does not apply to ndbd.

    Setting MaxNoOfExecutionThreads sets the number of threads for each type as determined by a matrix in the file storage/ndb/src/kernel/vm/mt_thr_config.cpp. This table shows these numbers of threads for possible values of MaxNoOfExecutionThreads.

    MaxNoOfExecutionThreads ValueLDM ThreadsTC ThreadsSend ThreadsReceive Threads
    0 .. 31001
    4 .. 62001
    7 .. 84001
    94201
    104211
    114311
    126211
    136311
    146312
    156322
    168312
    178412
    188422
    198522
    2010422
    2110522
    2210523
    2310623
    2412523
    2512623
    2612633
    2712733
    2812734
    2912834
    3012844
    3112944
    3216833
    3316834
    3416844
    3516944
    36161044
    37161045
    38161145
    39161155
    40201044
    41201045
    42201145
    43201155
    44201255
    45201256
    46201356
    47201366
    48241255
    49241256
    50241356
    51241366
    52241466
    53241467
    54241567
    55241577
    56241677
    57241678
    58241778
    59241788
    60241888
    61241889
    62241989
    63241999
    64321677
    65321678
    66321778
    67321788
    68321888
    69321889
    70321989
    71322089
    723220810

    There is always one SUMA (replication) thread.

    The number of LDM threads must not exceed NoOfFragmentLogParts. If this parameter's value is the default (4), this means that you must increase it as well, when setting MaxNoOfExecutionThreads to 16 or greater; that is, you should set NoOfFragmentLogParts to the corresponding number of LDM threads value shown for that value of MaxNoOfExecutionThreads in the preceding table.

    The thread types are described later in this section (see ThreadConfig).

    Setting this parameter outside the permitted range of values causes the management server to abort on startup with the error Error line number: Illegal value value for parameter MaxNoOfExecutionThreads.

    For MaxNoOfExecutionThreads, a value of 0 or 1 is rounded up internally by NDB to 2, so that 2 is considered this parameter's default and minimum value.

    MaxNoOfExecutionThreads is generally intended to be set equal to the number of CPU threads available, and to allocate a number of threads of each type suitable to typical workloads. It does not assign particular threads to specified CPUs. For cases where it is desirable to vary from the settings provided, or to bind threads to CPUs, you should use ThreadConfig instead, which allows you to allocate each thread directly to a desired type, CPU, or both.

    The multi-threaded data node process always spawns, at a minimum, the threads listed here:

    • 1 local query handler (LDM) thread

    • 1 receive thread

    • 1 subscription manager (SUMA or replication) thread

    For a MaxNoOfExecutionThreads value of 8 or less, no TC threads are created, and TC handling is instead performed by the main thread.

    Changing the number of LDM threads always requires a system restart, whether it is changed using this parameter or ThreadConfig. If the cluster's IndexMemory usage is greater than 50%, changing this requires an initial restart of the cluster. (A maximum of 30-35% IndexMemory usage is recommended in such cases.) Otherwise, resource usage and LDM thread allocation cannot be balanced between nodes, which can result in underutilized and overutilized LDM threads, and ultimately data node failures.

  • NoOfFragmentLogParts

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0numeric44, 8, 12, 16, 24, 32IN

    Set the number of log file groups for redo logs belonging to this ndbmtd. The maximum value is 32; the value set must be an even multiple of 4.

    The number of LQH threads used by ndbmtd must not exceed NoOfFragmentLogParts, and this number may increase when increasing MaxNoOfExecutionThreads; see the description of this parameter for more information.

  • ThreadConfig

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0string''...IS

    This parameter is used with ndbmtd to assign threads of different types to different CPUs. Its value is a string whose format has the following syntax:

    ThreadConfig := entry[,entry[,...]]
    entry := type={param[,param[,...]]}
    type := ldm | main | recv | send | rep | io | tc | watchdog
    param := count=number
      | cpubind=cpu_list
      | cpuset=cpu_list
      | spintime=number
      | realtime={0|1}
      | thread_prio={0..10}
      | cpubind_exclusive=cpu_list
      | cpuset_exclusive=cpu_list
    

    The curly braces ({...}) surrounding the list of parameters are required, even if there is only one parameter in the list.

    A param (parameter) specifies any or all of the following information:

    • The number of threads of the given type (count).

    • The set of CPUs to which the threads of the given type are to be nonexclusively bound. This is determined by either one of cpubind or cpuset). cpubind causes each thread to be bound (nonexclusively) to a CPU in the set; cpuset means that each thread is bound (nonexclusively) to the set of CPUs specified.

      On Solaris, you can instead specify a set of CPUs to which the threads of the given type are to be bound exclusively. cpubind_exclusive causes each thread to be bound exclusively to a CPU in the set; cpuset_exclsuive means that each thread is bound exclusively to the set of CPUs specified.

      Only one of cpubind, cpuset, cpubind_exclusive, or cpuset_exclusive can be provided in a single configuration.

    • spintime determines the wait time in microseconds the thread spins before going to sleep.

      The default value for spintime is the value of the SchedulerSpinTimer data node configuration parameter.

      spintime does not apply to I/O threads or watchdog threads and so cannot be set for these thread types.

    • realtime can be set to 0 or 1. If it is set to 1, the threads run with real-time priority. This also means that thread_prio cannot be set.

      The realtime parameter is set by default to the value of the RealtimeScheduler data node configuration parameter.

    • thread_prio is a thread priority level that can be set from 0 to 10, with 10 representing the greatest priority. The default is 5. The precise effects of this parameter are platform-specific, and are described later in this section.

    thread_prio settings and effects by platform.  The implementation of thread_prio differs between Linux/FreeBSD, Solaris, and Windows. In the following list, we discuss its effects on each of these platforms in turn:

    • Linux and FreeBSD: We map thread_prio to a value to be supplied to the nice system call. Since a lower niceness value for a process indicates a higher process priority, increasing thread_prio has the effect of lowering the nice value.

      thread_prio valuenice value
      019
      116
      212
      38
      44
      50
      6-4
      7-8
      8-12
      9-16
      10-20

      Some operating systems may provide for a maximum process niceness level of 20, but this is not supported by all targeted versions; for this reason, we choose 19 as the maximum nice value that can be set.

    • Solaris: Setting thread_prio on Solaris sets the Solaris FX priority, with mappings as shown in the following table:

      thread_prio valueSolaris FX priority
      015
      120
      225
      330
      435
      540
      645
      750
      855
      959
      1060

      A thread_prio setting of 9 is mapped on Solaris to the special FX priority value 59, which means that the operating system also attempts to force the thread to run alone on its own CPU core.

    • Windows: We map thread_prio to a Windows thread priority value passed to the Windows API SetThreadPriority() function. This mapping is shown in the following table:

      thread_prio valueWindows thread priority
      0 - 1THREAD_PRIORITY_LOWEST
      2 - 3THREAD_PRIORITY_BELOW_NORMAL
      4 - 5THREAD_PRIORITY_NORMAL
      6 - 7THREAD_PRIORITY_ABOVE_NORMAL
      8 - 10THREAD_PRIORITY_HIGHEST

    The type attribute represents an NDB thread type. The thread types supported, and the range of permitted count values for each, are provided in the following list:

    • ldm: Local query handler (DBLQH kernel block) that handles data. The more LDM threads that are used, the more highly partitioned the data becomes. Each LDM thread maintains its own sets of data and index partitions, as well as its own redo log. The value set for ldm must be one of the values 1, 2, 4, 6, 8, 12, 16, 24, or 32.

      Important

      Changing the number of LDM threads requires a system restart to be effective and safe for cluster operations. (This is also true when this is done using MaxNoOfExecutionThreads.) If IndexMemory usage is in excess of 50%, an initial restart of the cluster is required; a maximum of 30-35% IndexMemory usage is recommended in such cases. Otherwise, IndexMemory and DataMemory usage as well as the allocation of LDM threads cannot be balanced between nodes, which can ultimately lead to data node failures.

    • tc: Transaction coordinator thread (DBTC kernel block) containing the state of an ongoing transaction. The maximum number of TC threads is 32.

      Optimally, every new transaction can be assigned to a new TC thread. In most cases 1 TC thread per 2 LDM threads is sufficient to guarantee that this can happen. In cases where the number of writes is relatively small when compared to the number of reads, it is possible that only 1 TC thread per 4 LQH threads is required to maintain transaction states. Conversely, in applications that perform a great many updates, it may be necessary for the ratio of TC threads to LDM threads to approach 1 (for example, 3 TC threads to 4 LDM threads).

      Setting tc to 0 causes TC handling to be done by the main thread. In most cases, this is effectively the same as setting it to 1.

      Range: 0 - 32

    • main: Data dictionary and transaction coordinator (DBDIH and DBTC kernel blocks), providing schema management. This is always handled by a single dedicated thread.

      Range: 1 only.

    • recv: Receive thread (CMVMI kernel block). Each receive thread handles one or more sockets for communicating with other nodes in an NDB Cluster , with one socket per node. NDB Cluster supports multiple receive threads; the maximum is 16 such threads.

      Range: 1 - 16

    • send: Send thread (CMVMI kernel block). To increase throughput, it is possible to perform sends from one or more separate, dedicated threads (maximum 8).

      Previously, all threads handled their own sending directly; this can still be made to happen by setting the number of send threads to 0 (this also happens when MaxNoOfExecutionThreads is set less than 10). While doing so can have an adeverse impact on throughput, it can also in some cases provide decreased latency.

      Range: 0 - 16

    • rep: Replication thread (SUMA kernel block). Asynchronous replication operations are always handled by a single, dedicated thread.

      Range: 1 only.

    • io: File system and other miscellaneous operations. These are not demanding tasks, and are always handled as a group by a single, dedicated I/O thread.

      Range: 1 only.

    • watchdog: Settings to this parameter are actually applied to several threads of this type having specific uses. These threads include the SocketServer thread which receives connection setups from other nodes, the SocketClient thread which attempts to set up connections to other nodes, and the thread watchdog thread that checks that threads are progressing.

      Range: 1 only.

Simple examples:

# Example 1.
ThreadConfig=ldm={count=2,cpubind=1,2},main={cpubind=12},rep={cpubind=11}
# Example 2.
Threadconfig=main={cpubind=0},ldm={count=4,cpubind=1,2,5,6},io={cpubind=3}

It is usually desirable when configuring thread usage for a data node host to reserve one or more number of CPUs for operating system and other tasks. Thus, for a host machine with 24 CPUs, you might want to use 20 CPU threads (leaving 4 for other uses), with 8 LDM threads, 4 TC threads (half the number of LDM threads), 3 send threads, 3 receive threads, and 1 thread each for schema management, asynchronous replication, and I/O operations. (This is almost the same distribution of threads used when MaxNoOfExecutionThreads is set equal to 20.) The following ThreadConfig setting performs these assignments, additionally binding all of these threads to specific CPUs:

ThreadConfig=ldm{count=8,cpubind=1,2,3,4,5,6,7,8},main={cpubind=9},io={cpubind=9}, \
rep={cpubind=10},tc{count=4,cpubind=11,12,13,14},recv={count=3,cpubind=15,16,17}, \
send{count=3,cpubind=18,19,20}

It should be possible in most cases to bind the main (schema management) thread and the I/O thread to the same CPU, as we have done in the example just shown.

The following example incorporates groups of CPUs defined using both cpuset and cpubind, as well as use of thread prioritization.

ThreadConfig=ldm={count=4,cpuset=0-3,thread_prio=8,spintime=200}, \
ldm={count=4,cpubind=4-7,thread_prio=8,spintime=200}, \
tc={count=4,cpuset=8-9,thread_prio=6},send={count=2,thread_prio=10,cpubind=10-11}, \
main={count=1,cpubind=10},rep={count=1,cpubind=11}
        

In this case we create two LDM groups; the first uses cpubind and the second uses cpuset. thread_prio and spintime are set to the same values for each group. This means there are eight LDM threads in total. (You should ensure that NoOfFragmentLogParts is also set to 8.) The four TC threads use only two CPUs; it is possible when using cpuset to specify fewer CPUs than threads in the group. (This is not true for cpubind.) The send threads use two threads using cpubind to bind these threads to CPUs 10 and 11. The main and rep threads can reuse these CPUs.

This example shows how ThreadConfig and NoOfFragmentLogParts might be set up for a 24-CPU host with hyperthreading, leaving CPUs 10, 11, 22, and 23 available for operating system functions and interrupts:

NoOfFragmentLogParts=10
ThreadConfig=ldm={count=10,cpubind=0-4,12-16,thread_prio=9,spintime=200}, \
tc={count=4,cpuset=6-7,18-19,thread_prio=8},send={count=1,cpuset=8}, \
recv={count=1,cpuset=20},main={count=1,cpuset=9,21},rep={count=1,cpuset=9,21}, \
io={count=1,cpuset=9,21,thread_prio=8},watchdog={count=1,cpuset=9,21,thread_prio=9}

In order to take advantage of the enhanced stability that the use of ThreadConfig offers, it is necessary to insure that CPUs are isolated, and that they not subject to interrupts, or to being scheduled for other tasks by the operating system. On many Linux systems, you can do this by setting IRQBALANCE_BANNED_CPUS in /etc/sysconfig/irqbalance to 0xFFFFF0, and by using the isolcpus boot option in grub.conf. For specific information, see your operating system or platform documentation.

Disk Data Configuration Parameters.  Configuration parameters affecting Disk Data behavior include the following:

  • DiskPageBufferEntries

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.032K pages101 - 1000N

    This is the number of page entries (page references) to allocate. It is specified as a number of 32K pages in DiskPageBufferMemory. The default is sufficient for most cases but you may need to increase the value of this parameter if you encounter problems with very large transactions on Disk Data tables. Each page entry requires approximately 100 bytes.

  • DiskPageBufferMemory

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0bytes64M4M - 1TN

    This determines the amount of space used for caching pages on disk, and is set in the [ndbd] or [ndbd default] section of the config.ini file. It is measured in bytes. Each page takes up 32 KB. This means that NDB Cluster Disk Data storage always uses N * 32 KB memory where N is some nonnegative integer.

    The default value for this parameter is 64M (2000 pages of 32 KB each).

    You can query the ndbinfo.diskpagebuffer table to help determine whether the value for this parameter should be increased to minimize unnecessary disk seeks. See Section 7.10.19, “The ndbinfo diskpagebuffer Table”, for more information.

  • SharedGlobalMemory

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0bytes128M0 - 64TN

    This parameter determines the amount of memory that is used for log buffers, disk operations (such as page requests and wait queues), and metadata for tablespaces, log file groups, UNDO files, and data files. The shared global memory pool also provides memory used for satisfying the memory requirements of the UNDO_BUFFER_SIZE option used with CREATE LOGFILE GROUP and ALTER LOGFILE GROUP statements, including any default value implied for this options by the setting of the InitialLogFileGroup data node configuration parameter. SharedGlobalMemory can be set in the [ndbd] or [ndbd default] section of the config.ini configuration file, and is measured in bytes.

    The default value is 128M.

  • DiskIOThreadPool

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0threads20 - 4294967039 (0xFFFFFEFF)N

    This parameter determines the number of unbound threads used for Disk Data file access. Before DiskIOThreadPool was introduced, exactly one thread was spawned for each Disk Data file, which could lead to performance issues, particularly when using very large data files. With DiskIOThreadPool, you can—for example—access a single large data file using several threads working in parallel.

    This parameter applies to Disk Data I/O threads only.

    The optimum value for this parameter depends on your hardware and configuration, and includes these factors:

    • Physical distribution of Disk Data files.  You can obtain better performance by placing data files, undo log files, and the data node file system on separate physical disks. If you do this with some or all of these sets of files, then you can set DiskIOThreadPool higher to enable separate threads to handle the files on each disk.

    • Disk performance and types.  The number of threads that can be accommodated for Disk Data file handling is also dependent on the speed and throughput of the disks. Faster disks and higher throughput allow for more disk I/O threads. Our test results indicate that solid-state disk drives can handle many more disk I/O threads than conventional disks, and thus higher values for DiskIOThreadPool.

    The default value for this parameter is 2.

  • Disk Data file system parameters.  The parameters in the following list make it possible to place NDB Cluster Disk Data files in specific directories without the need for using symbolic links.

    • FileSystemPathDD

      Effective VersionType/UnitsDefaultRange/ValuesRestart Type
      NDB 7.5.0filename[see text]...IN

      If this parameter is specified, then NDB Cluster Disk Data data files and undo log files are placed in the indicated directory. This can be overridden for data files, undo log files, or both, by specifying values for FileSystemPathDataFiles, FileSystemPathUndoFiles, or both, as explained for these parameters. It can also be overridden for data files by specifying a path in the ADD DATAFILE clause of a CREATE TABLESPACE or ALTER TABLESPACE statement, and for undo log files by specifying a path in the ADD UNDOFILE clause of a CREATE LOGFILE GROUP or ALTER LOGFILE GROUP statement. If FileSystemPathDD is not specified, then FileSystemPath is used.

      If a FileSystemPathDD directory is specified for a given data node (including the case where the parameter is specified in the [ndbd default] section of the config.ini file), then starting that data node with --initial causes all files in the directory to be deleted.

    • FileSystemPathDataFiles

      Effective VersionType/UnitsDefaultRange/ValuesRestart Type
      NDB 7.5.0filename[see text]...IN

      If this parameter is specified, then NDB Cluster Disk Data data files are placed in the indicated directory. This overrides any value set for FileSystemPathDD. This parameter can be overridden for a given data file by specifying a path in the ADD DATAFILE clause of a CREATE TABLESPACE or ALTER TABLESPACE statement used to create that data file. If FileSystemPathDataFiles is not specified, then FileSystemPathDD is used (or FileSystemPath, if FileSystemPathDD has also not been set).

      If a FileSystemPathDataFiles directory is specified for a given data node (including the case where the parameter is specified in the [ndbd default] section of the config.ini file), then starting that data node with --initial causes all files in the directory to be deleted.

    • FileSystemPathUndoFiles

      Effective VersionType/UnitsDefaultRange/ValuesRestart Type
      NDB 7.5.0filename[see text]...IN

      If this parameter is specified, then NDB Cluster Disk Data undo log files are placed in the indicated directory. This overrides any value set for FileSystemPathDD. This parameter can be overridden for a given data file by specifying a path in the ADD UNDO clause of a CREATE LOGFILE GROUP or ALTER LOGFILE GROUP statement used to create that data file. If FileSystemPathUndoFiles is not specified, then FileSystemPathDD is used (or FileSystemPath, if FileSystemPathDD has also not been set).

      If a FileSystemPathUndoFiles directory is specified for a given data node (including the case where the parameter is specified in the [ndbd default] section of the config.ini file), then starting that data node with --initial causes all files in the directory to be deleted.

    For more information, see Section 7.13.1, “NDB Cluster Disk Data Objects”.

  • Disk Data object creation parameters.  The next two parameters enable you—when starting the cluster for the first time—to cause a Disk Data log file group, tablespace, or both, to be created without the use of SQL statements.

    • InitialLogFileGroup

      Effective VersionType/UnitsDefaultRange/ValuesRestart Type
      NDB 7.5.0string[see text]...S

      This parameter can be used to specify a log file group that is created when performing an initial start of the cluster. InitialLogFileGroup is specified as shown here:

      InitialLogFileGroup = [name=name;] [undo_buffer_size=size;] file-specification-list
      file-specification-list:
          file-specification[; file-specification[; ...]]
      file-specification:
          filename:size
      

      The name of the log file group is optional and defaults to DEFAULT-LG. The undo_buffer_size is also optional; if omitted, it defaults to 64M. Each file-specification corresponds to an undo log file, and at least one must be specified in the file-specification-list. Undo log files are placed according to any values that have been set for FileSystemPath, FileSystemPathDD, and FileSystemPathUndoFiles, just as if they had been created as the result of a CREATE LOGFILE GROUP or ALTER LOGFILE GROUP statement.

      Consider the following:

      InitialLogFileGroup = name=LG1; undo_buffer_size=128M; undo1.log:250M; undo2.log:150M
      

      This is equivalent to the following SQL statements:

      CREATE LOGFILE GROUP LG1
          ADD UNDOFILE 'undo1.log'
          INITIAL_SIZE 250M
          UNDO_BUFFER_SIZE 128M
          ENGINE NDBCLUSTER;
      ALTER LOGFILE GROUP LG1
          ADD UNDOFILE 'undo2.log'
          INITIAL_SIZE 150M
          ENGINE NDBCLUSTER;
      

      This logfile group is created when the data nodes are started with --initial.

      Resources for the initial log file group are added to the global memory pool along with those indicated by the value of SharedGlobalMemory.

      This parameter, if used, should always be set in the [ndbd default] section of the config.ini file. The behavior of an NDB Cluster when different values are set on different data nodes is not defined.

    • InitialTablespace

      Effective VersionType/UnitsDefaultRange/ValuesRestart Type
      NDB 7.5.0string[see text]...S

      This parameter can be used to specify an NDB Cluster Disk Data tablespace that is created when performing an initial start of the cluster. InitialTablespace is specified as shown here:

      InitialTablespace = [name=name;] [extent_size=size;] file-specification-list
      

      The name of the tablespace is optional and defaults to DEFAULT-TS. The extent_size is also optional; it defaults to 1M. The file-specification-list uses the same syntax as shown with the InitialLogfileGroup parameter, the only difference being that each file-specification used with InitialTablespace corresponds to a data file. At least one must be specified in the file-specification-list. Data files are placed according to any values that have been set for FileSystemPath, FileSystemPathDD, and FileSystemPathDataFiles, just as if they had been created as the result of a CREATE TABLESPACE or ALTER TABLESPACE statement.

      For example, consider the following line specifying InitialTablespace in the [ndbd default] section of the config.ini file (as with InitialLogfileGroup, this parameter should always be set in the [ndbd default] section, as the behavior of an NDB Cluster when different values are set on different data nodes is not defined):

      InitialTablespace = name=TS1; extent_size=8M; data1.dat:2G; data2.dat:4G
      

      This is equivalent to the following SQL statements:

      CREATE TABLESPACE TS1
          ADD DATAFILE 'data1.dat'
          EXTENT_SIZE 8M
          INITIAL_SIZE 2G
          ENGINE NDBCLUSTER;
      ALTER TABLESPACE TS1
          ADD DATAFILE 'data2.dat'
          INITIAL_SIZE 4G
          ENGINE NDBCLUSTER;
      

      This tablespace is created when the data nodes are started with --initial, and can be used whenever creating NDB Cluster Disk Data tables thereafter.

Disk Data and GCP Stop errors.  Errors encountered when using Disk Data tables such as Node nodeid killed this node because GCP stop was detected (error 2303) are often referred to as GCP stop errors. Such errors occur when the redo log is not flushed to disk quickly enough; this is usually due to slow disks and insufficient disk throughput.

You can help prevent these errors from occurring by using faster disks, and by placing Disk Data files on a separate disk from the data node file system. Reducing the value of TimeBetweenGlobalCheckpoints tends to decrease the amount of data to be written for each global checkpoint, and so may provide some protection against redo log buffer overflows when trying to write a global checkpoint; however, reducing this value also permits less time in which to write the GCP, so this must be done with caution.

In addition to the considerations given for DiskPageBufferMemory as explained previously, it is also very important that the DiskIOThreadPool configuration parameter be set correctly; having DiskIOThreadPool set too high is very likely to cause GCP stop errors (Bug #37227).

GCP stops can be caused by save or commit timeouts; the TimeBetweenEpochsTimeout data node configuration parameter determines the timeout for commits. However, it is possible to disable both types of timeouts by setting this parameter to 0.

Parameters for configuring send buffer memory allocation.  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. (Previously, the NDB kernel used a fixed-size send buffer for every node in the cluster, which was allocated when the node started and could not be changed while the node was running.) The TotalSendBufferMemory and OverLoadLimit data node configuration parameters permit the setting of limits on this memory allocation. For more information about the use of these parameters (as well as SendBufferMemory), see Section 5.3.13, “Configuring NDB Cluster Send Buffer Parameters”.

See also Section 7.14, “Adding NDB Cluster Data Nodes Online”.

Redo log over-commit handling.  It is possible to control a data node's handling of operations when too much time is taken flushing redo logs to disk. This occurs when a given redo log flush takes longer than RedoOverCommitLimit seconds, more than RedoOverCommitCounter times, causing any pending transactions to be aborted. When this happens, the API node that sent the transaction can handle the operations that should have been committed either by queuing the operations and re-trying them, or by aborting them, as determined by DefaultOperationRedoProblemAction. The data node configuration parameters for setting the timeout and number of times it may be exceeded before the API node takes this action are described in the following list:

  • RedoOverCommitCounter

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0numeric30 - 4294967039 (0xFFFFFEFF)N

    When RedoOverCommitLimit is exceeded when trying to write a given redo log to disk this many times or more, any transactions that were not committed as a result are aborted, and an API node where any of these transactions originated handles the operations making up those transactions according to its value for DefaultOperationRedoProblemAction (by either queuing the operations to be re-tried, or aborting them).

    RedoOverCommitCounter defaults to 3. Set it to 0 to disable the limit.

  • RedoOverCommitLimit

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0seconds200 - 4294967039 (0xFFFFFEFF)N

    This parameter sets an upper limit in seconds for trying to write a given redo log to disk before timing out. The number of times the data node tries to flush this redo log, but takes longer than RedoOverCommitLimit, is kept and compared with RedoOverCommitCounter, and when flushing takes too long more times than the value of that parameter, any transactions that were not committed as a result of the flush timeout are aborted. When this occurs, the API node where any of these transactions originated handles the operations making up those transactions according to its DefaultOperationRedoProblemAction setting (it either queues the operations to be re-tried, or aborts them).

    By default, RedoOverCommitLimit is 20 seconds. Set to 0 to disable checking for redo log flush timeouts.

Controlling restart attempts.  It is possible to exercise finely-grained control over restart attempts by data nodes when they fail to start using the MaxStartFailRetries and StartFailRetryDelay data node configuration parameters.

MaxStartFailRetries limits the total number of retries made before giving up on starting the data node, StartFailRetryDelay sets the number of seconds between retry attempts. These parameters are listed here:

  • StartFailRetryDelay

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned00 - 4294967039 (0xFFFFFEFF)N

    Use this parameter to set the number of seconds between restart attempts by the data node in the event on failure on startup. The default is 0 (no delay).

    Both this parameter and MaxStartFailRetries are ignored unless StopOnError is equal to 0.

  • MaxStartFailRetries

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned30 - 4294967039 (0xFFFFFEFF)N

    Use this parameter to limit the number restart attempts made by the data node in the event that it fails on startup. The default is 3 attempts.

    Both this parameter and StartFailRetryDelay are ignored unless StopOnError is equal to 0.

NDB index statistics parameters.  The parameters in the following list relate to NDB index statistics generation.

  • IndexStatAutoCreate

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0booleanfalsefalse, trueS

    Enable or disable automatic statistics collection when indexes are created. Disabled by default.

  • IndexStatAutoUpdate

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0booleanfalsefalse, trueS

    Enable or disable monitoring of indexes for changes and trigger automatic statistics updates these are detected. The amount and degree of change needed to trigger the updates are determined by the settings for the IndexStatTriggerPct and IndexStatTriggerScale options.

  • IndexStatSaveSize

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0bytes327680 - 4294967039 (0xFFFFFEFF)IN

    Maximum space in bytes allowed for the saved statistics of any given index in the NDB system tables and in the mysqld memory cache. This consumes IndexMemory.

    At least one sample is always produced, regardless of any size limit. This size is scaled by IndexStatSaveScale.

    The size specified by IndexStatSaveSize is scaled by the value of IndexStatTriggerPct for a large index, times 0.01. This is further multiplied by the logarithm to the base 2 of the index size. Setting IndexStatTriggerPct equal to 0 disables the scaling effect.

  • IndexStatSaveScale

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0percentage1000 - 4294967039 (0xFFFFFEFF)IN

    The size specified by IndexStatSaveSize is scaled by the value of IndexStatTriggerPct for a large index, times 0.01. This is further multiplied by the logarithm to the base 2 of the index size. Setting IndexStatTriggerPct equal to 0 disables the scaling effect.

  • IndexStatTriggerPct

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0percentage1000 - 4294967039 (0xFFFFFEFF)IN

    Percentage change in updates that triggers an index statistics update. The value is scaled by IndexStatTriggerScale. You can disable this trigger altogether by setting IndexStatTriggerPct to 0.

  • IndexStatTriggerScale

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0percentage1000 - 4294967039 (0xFFFFFEFF)IN

    Scale IndexStatTriggerPct by this amount times 0.01 for a large index. A value of 0 disables scaling.

  • IndexStatUpdateDelay

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0seconds600 - 4294967039 (0xFFFFFEFF)IN

    Minimum delay in seconds between automatic index statistics updates for a given index. Setting this variable to 0 disables any delay. The default is 60 seconds.

5.3.7 Defining SQL and Other API Nodes in an NDB Cluster

The [mysqld] and [api] sections in the config.ini file define the behavior of the MySQL servers (SQL nodes) and other applications (API nodes) used to access cluster data. None of the parameters shown is required. If no computer or host name is provided, any host can use this SQL or API node.

Generally speaking, a [mysqld] section is used to indicate a MySQL server providing an SQL interface to the cluster, and an [api] section is used for applications other than mysqld processes accessing cluster data, but the two designations are actually synonymous; you can, for instance, list parameters for a MySQL server acting as an SQL node in an [api] section.

Note

For a discussion of MySQL server options for NDB Cluster , see Section 5.3.8.1, “MySQL Server Options for NDB Cluster”; for information about MySQL server system variables relating to NDB Cluster , see Section 5.3.8.2, “NDB Cluster System Variables”.

  • Id

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned[none]1 - 255IS

    The Id is an integer value used to identify the node in all cluster internal messages. The permitted range of values is 1 to 255 inclusive. This value must be unique for each node in the cluster, regardless of the type of node.

    Note

    Data node IDs must be less than 49, regardless of the NDB 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 API nodes (and management nodes) to values greater than 48.

    NodeId is the preferred parameter name to use when identifying API nodes. (Id continues to be supported for backward compatibility, but is now deprecated and generates a warning when used. It is also subject to future removal.)

  • ConnectionMap

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0string[none]...N

    Specifies which data nodes to connect.

  • NodeId

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned[none]1 - 255IS

    The NodeId is an integer value used to identify the node in all cluster internal messages. The permitted range of values is 1 to 255 inclusive. This value must be unique for each node in the cluster, regardless of the type of node.

    Note

    Data node IDs must be less than 49, regardless of the NDB 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 API nodes (and management nodes) to values greater than 48.

    NodeId is the preferred parameter name to use when identifying management nodes. An alias, Id, was used for this purpose in very old versions of NDB Cluster , and continues to be supported for backward compatibility; it is now deprecated and generates a warning when used, and is subject to removal in a future release of NDB Cluster .

  • ExecuteOnComputer

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0name[none]...S

    This refers to the Id set for one of the computers (hosts) defined in a [computer] section of the configuration file.

    Important

    This parameter is deprecated as of NDB 7.5.0, and is subject to removal in a future release. Use the HostName parameter instead.

  • HostName

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0name or IP address[none]...N

    Specifying this parameter defines the hostname of the computer on which the SQL node (API node) is to reside. To specify a hostname, either this parameter or ExecuteOnComputer is required.

    If no HostName or ExecuteOnComputer is specified in a given [mysql] or [api] section of the config.ini file, then an SQL or API node may connect using the corresponding slot from any host which can establish a network connection to the management server host machine. This differs from the default behavior for data nodes, where localhost is assumed for HostName unless otherwise specified.

  • ArbitrationRank

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.00-200 - 2N

    This parameter defines which nodes can act as arbitrators. Both management nodes and SQL nodes can be arbitrators. A value of 0 means that the given node is never used as an arbitrator, a value of 1 gives the node high priority as an arbitrator, and a value of 2 gives it low priority. A normal configuration uses the management server as arbitrator, setting its ArbitrationRank to 1 (the default for management nodes) and those for all SQL nodes to 0 (the default for SQL nodes).

    By setting ArbitrationRank to 0 on all management and SQL nodes, you can disable arbitration completely. You can also control arbitration by overriding this parameter; to do so, set the Arbitration parameter in the [ndbd default] section of the config.ini global configuration file.

  • ArbitrationDelay

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0milliseconds00 - 4294967039 (0xFFFFFEFF)N

    Setting this parameter to any other value than 0 (the default) means that responses by the arbitrator to arbitration requests will be delayed by the stated number of milliseconds. It is usually not necessary to change this value.

  • BatchByteSize

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0bytes16K1024 - 1MN

    For queries that are translated into full table scans or range scans on indexes, it is important for best performance to fetch records in properly sized batches. It is possible to set the proper size both in terms of number of records (BatchSize) and in terms of bytes (BatchByteSize). The actual batch size is limited by both parameters.

    The speed at which queries are performed can vary by more than 40% depending upon how this parameter is set.

    This parameter is measured in bytes. The default value is 16K.

  • BatchSize

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0records2561 - 992N

    This parameter is measured in number of records and is by default set to 256. The maximum size is 992.

  • ExtraSendBufferMemory

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0bytes00 - 4294967039 (0xFFFFFEFF)N

    This parameter specifies the amount of transporter send buffer memory to allocate in addition to any that has been set using TotalSendBufferMemory, SendBufferMemory, or both.

  • HeartbeatThreadPriority

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0string[none]...S

    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).

  • MaxScanBatchSize

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0bytes256K32K - 16MN

    The batch size is the size of each batch sent from each data node. Most scans are performed in parallel to protect the MySQL Server from receiving too much data from many nodes in parallel; this parameter sets a limit to the total batch size over all nodes.

    The default value of this parameter is set to 256KB. Its maximum size is 16MB.

  • TotalSendBufferMemory

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0bytes0256K - 4294967039 (0xFFFFFEFF)N

    This parameter 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 permitted value is 256KB; 0 indicates that the parameter has not been set. For more detailed information, see Section 5.3.13, “Configuring NDB Cluster Send Buffer Parameters”.

  • AutoReconnect

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0booleanfalsetrue, falseN

    This parameter is false by default. This forces disconnected API nodes (including MySQL Servers acting as SQL nodes) to use a new connection to the cluster rather than attempting to re-use an existing one, as re-use of connections can cause problems when using dynamically-allocated node IDs. (Bug #45921)

    Note

    This parameter can be overridden using the NDB API. For more information, see Ndb_cluster_connection::set_auto_reconnect(), and Ndb_cluster_connection::get_auto_reconnect().

  • DefaultOperationRedoProblemAction

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0enumerationQUEUEABORT, QUEUES

    This parameter (along with RedoOverCommitLimit and RedoOverCommitCounter) controls the data node's handling of operations when too much time is taken flushing redo logs to disk. This occurs when a given redo log flush takes longer than RedoOverCommitLimit seconds, more than RedoOverCommitCounter times, causing any pending transactions to be aborted.

    When this happens, the node can respond in either of two ways, according to the value of DefaultOperationRedoProblemAction, listed here:

    • ABORT: Any pending operations from aborted transactions are also aborted.

    • QUEUE: Pending operations from transactions that were aborted are queued up to be re-tried. This the default. Pending operations are still aborted when the redo log runs out of space—that is, when P_TAIL_PROBLEM errors occur.

  • DefaultHashMapSize

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0buckets38400 - 3840N

    The size of the table hash maps used by NDB is configurable using this parameter. DefaultHashMapSize can take any of three possible values (0, 240, 3840). These values and their effects are described in the following table.

    ValueDescription / Effect
    0Use the lowest value set, if any, for this parameter among all data nodes and API nodes in the cluster; if it is not set on any data or API node, use the default value.
    240Original hash map size (used by default prior to NDB 7.2.7.
    3840Larger hash map size as (used by default in NDB 7.2.7 and later

    The original intended use for this parameter was to facilitate upgrades and downgrades to and from older NDB Cluster versions, in which the hash map size differed, due to the fact that this change was not otherwise backward compatible. This is not an issue when upgrading or downgrading from NDB Cluster 7.5.

  • Wan

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0booleanfalsetrue, falseN

    Use WAN TCP setting as default.

  • ConnectBackoffMaxTime

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0integer00 - 4294967039 (0xFFFFFEFF)N

    In an NDB Cluster with many unstarted data nodes, the value of this parameter can be raised to circumvent connection attempts to data nodes which have not yet begun to function in the cluster, as well as moderate high traffic to management nodes. As long as the API node is not connected to any new data nodes, the value of the StartConnectBackoffMaxTime parameter is applied; otherwise, ConnectBackoffMaxTime is used to determine the length of time in milliseconds to wait between connection attempts.

    Time elapsed during node connection attempts is not taken into account when calculating elapsed time for this parameter. The timeout is applied with approximately 100 ms resolution, starting with a 100 ms delay; for each subsequent attempt, the length of this period is doubled until it reaches ConnectBackoffMaxTime milliseconds, up to a maximum of 100000 ms (100s).

    Once the API node is connected to a data node and that node reports (in a heartbeat message) that it has connected to other data nodes, connection attempts to those data nodes are no longer affected by this parameter, and are made every 100 ms thereafter until connected. Once a data node has started, it can take up HeartbeatIntervalDbApi for the API node to be notified that this has occurred.

  • StartConnectBackoffMaxTime

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0integer00 - 4294967039 (0xFFFFFEFF)N

    In an NDB Cluster with many unstarted data nodes, the value of this parameter can be raised to circumvent connection attempts to data nodes which have not yet begun to function in the cluster, as well as moderate high traffic to management nodes. As long as the API node is not connected to any new data nodes, the value of the StartConnectBackoffMaxTime parameter is applied; otherwise, ConnectBackoffMaxTime is used to determine the length of time in milliseconds to wait between connection attempts.

    Time elapsed during node connection attempts is not taken into account when calculating elapsed time for this parameter. The timeout is applied with approximately 100 ms resolution, starting with a 100 ms delay; for each subsequent attempt, the length of this period is doubled until it reaches StartConnectBackoffMaxTime milliseconds, up to a maximum of 100000 ms (100s).

    Once the API node is connected to a data node and that node reports (in a heartbeat message) that it has connected to other data nodes, connection attempts to those data nodes are no longer affected by this parameter, and are made every 100 ms thereafter until connected. Once a data node has started, it can take up HeartbeatIntervalDbApi for the API node to be notified that this has occurred.

API Node Debugging Parameters.  Beginning with NDB 7.5.2, you can use the ApiVerbose configuration parameter to enable debugging output from a given API node. This parameter takes an integer value. 0 is the default, and disables such debugging; 1 enables debugging output to the cluster log; 2 adds DBDICT debugging output as well. (Bug #20638450) See also DUMP 1229.

You can also obtain information from a MySQL server running as an NDB Cluster SQL node using SHOW STATUS in the mysql client, as shown here:

mysql> SHOW STATUS LIKE 'ndb%';
+-----------------------------+---------------+
| Variable_name               | Value         |
+-----------------------------+---------------+
| Ndb_cluster_node_id         | 5             |
| Ndb_config_from_host        | 192.168.0.112 |
| Ndb_config_from_port        | 1186          |
| Ndb_number_of_storage_nodes | 4             |
+-----------------------------+---------------+
4 rows in set (0.02 sec)

For information about the status variables appearing in the output from this statement, see Section 5.3.8.3, “NDB Cluster Status Variables”.

Note

To add new SQL or API nodes to the configuration of a running NDB Cluster , it is necessary to perform a rolling restart of all cluster nodes after adding new [mysqld] or [api] sections to the config.ini file (or files, if you are using more than one management server). This must be done before the new SQL or API nodes can connect to the cluster.

It is not necessary to perform any restart of the cluster if new SQL or API nodes can employ previously unused API slots in the cluster configuration to connect to the cluster.

5.3.8 MySQL Server Options and Variables for NDB Cluster

This section provides information about MySQL server options, server and status variables that are specific to NDB Cluster . For general information on using these, and for other options and variables not specific to NDB Cluster , see The MySQL Server.

For NDB Cluster configuration parameters used in the cluster configuration file (usually named config.ini), see Chapter 5, Configuration of NDB Cluster.

5.3.8.1 MySQL Server Options for NDB Cluster

This section provides descriptions of mysqld server options relating to NDB Cluster . For information about mysqld options not specific to NDB Cluster , and for general information about the use of options with mysqld, see Server Command Options.

For information about command-line options used with other NDB Cluster processes (ndbd, ndb_mgmd, and ndb_mgm), see Section 6.27, “Options Common to NDB Cluster Programs — Options Common to NDB Cluster Programs”. For information about command-line options used with NDB utility programs (such as ndb_desc, ndb_size.pl, and ndb_show_tables), see Chapter 6, NDB Cluster Programs.

  • --ndb-allow-copying-alter-table=[ON|OFF]

    Table 5.10 Type and value information for ndb-allow-copying-alter-table

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb-allow-copying-alter-table

    Yes Yes No
    Yes Both Yes
    NDB 7.5 boolean ON

    DESCRIPTION: Set to OFF to keep ALTER TABLE from using copying operations on NDB tables


    Let ALTER TABLE and other DDL statements use copying operations on NDB tables. Set to OFF to keep this from happening; doing so may improve performance of critical applications.

  • --ndb-batch-size=#

    Table 5.11 Type and value information for ndb-batch-size

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb-batch-size

    Yes Yes No
    Yes Global No
    NDB 7.5 integer 32768 / 0 - 31536000

    DESCRIPTION: Size (in bytes) to use for NDB transaction batches


    This sets the size in bytes that is used for NDB transaction batches.

  • --ndb-cluster-connection-pool=#

    Table 5.12 Type and value information for ndb-cluster-connection-pool

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb-cluster-connection-pool

    Yes Yes Yes
    Yes Global No
    NDB 7.5 integer 1 / 1 - 63

    DESCRIPTION: Number of connections to the cluster used by MySQL


    By setting this option to a value greater than 1 (the default), a mysqld process can use multiple connections to the cluster, effectively mimicking several SQL nodes. Each connection requires its own [api] or [mysqld] section in the cluster configuration (config.ini) file, and counts against the maximum number of API connections supported by the cluster.

    Suppose that you have 2 cluster host computers, each running an SQL node whose mysqld process was started with --ndb-cluster-connection-pool=4; this means that the cluster must have 8 API slots available for these connections (instead of 2). All of these connections are set up when the SQL node connects to the cluster, and are allocated to threads in a round-robin fashion.

    This option is useful only when running mysqld on host machines having multiple CPUs, multiple cores, or both. For best results, the value should be smaller than the total number of cores available on the host machine. Setting it to a value greater than this is likely to degrade performance severely.

    Important

    Because each SQL node using connection pooling occupies multiple API node slots—each slot having its own node ID in the cluster—you must not use a node ID as part of the cluster connection string when starting any mysqld process that employs connection pooling.

    Setting a node ID in the connection string when using the --ndb-cluster-connection-pool option causes node ID allocation errors when the SQL node attempts to connect to the cluster.

  • --ndb-cluster-connection-pool-nodeids=list

    Table 5.13 Type and value information for ndb-cluster-connection-pool-nodeids

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb-cluster-connection-pool-nodeids

    Yes Yes No
    Yes Global No
    NDB 7.5 set /

    DESCRIPTION: Comma-separated list of node IDs for connections to the cluster used by MySQL; the number of nodes in the list must be the same as the value set for --ndb-cluster-connection-pool


    Specifies a comma-separated list of node IDs for connections to the cluster used by an SQL node. The number of nodes in this list must be the same as the value set for the --ndb-cluster-connection-pool option.

    --ndb-cluster-connection-pool-nodeids was added in NDB 7.5.0.

  • --ndb-blob-read-batch-bytes=bytes

    Table 5.14 Type and value information for ndb-blob-read-batch-bytes

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb-blob-read-batch-bytes

    Yes Yes No
    Yes Both Yes
    NDB 7.5 integer 65536 / 0 - 4294967295

    DESCRIPTION: Specifies size in bytes that large BLOB reads should be batched into. 0 = no limit.


    This option can be used to set the size (in bytes) for batching of BLOB data reads in NDB Cluster applications. When this batch size is exceeded by the amount of BLOB data to be read within the current transaction, any pending BLOB read operations are immediately executed.

    The maximum value for this option is 4294967295; the default is 65536. Setting it to 0 has the effect of disabling BLOB read batching.

    Note

    In NDB API applications, you can control BLOB write batching with the setMaxPendingBlobReadBytes() and getMaxPendingBlobReadBytes() methods.

  • --ndb-blob-write-batch-bytes=bytes

    Table 5.15 Type and value information for ndb-blob-write-batch-bytes

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb-blob-write-batch-bytes

    Yes Yes No
    Yes Both Yes
    NDB 7.5 integer 65536 / 0 - 4294967295

    DESCRIPTION: Specifies size in bytes that large BLOB writes should be batched into. 0 = no limit.


    This option can be used to set the size (in bytes) for batching of BLOB data writes in NDB Cluster applications. When this batch size is exceeded by the amount of BLOB data to be written within the current transaction, any pending BLOB write operations are immediately executed.

    The maximum value for this option is 4294967295; the default is 65536. Setting it to 0 has the effect of disabling BLOB write batching.

    Note

    In NDB API applications, you can control BLOB write batching with the setMaxPendingBlobWriteBytes() and getMaxPendingBlobWriteBytes() methods.

  • --ndb-connectstring=connection_string

    Table 5.16 Type and value information for ndb-connectstring

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb-connectstring

    Yes No No
    Yes No
    NDB 7.5 string

    DESCRIPTION: Point to the management server that distributes the cluster configuration


    When using the NDBCLUSTER storage engine, this option specifies the management server that distributes cluster configuration data. See Section 5.3.3, “NDB Cluster Connection Strings”, for syntax.

  • --ndb-default-column-format=[FIXED|DYNAMIC]

    Table 5.17 Type and value information for ndb-default-column-format

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb-default-column-format

    Yes Yes No
    Yes Global Yes
    5.7.11-ndb-7.5.1 enumeration DYNAMIC / FIXED, DYNAMIC
    5.7.16-ndb-7.5.4 enumeration FIXED / FIXED, DYNAMIC

    DESCRIPTION: Use this value (FIXED or DYNAMIC) by default for COLUMN_FORMAT and ROW_FORMAT options when creating or adding columns to a table.


    In NDB 7.5.1 and later, sets the default COLUMN_FORMAT and ROW_FORMAT for new tables (see CREATE TABLE Syntax).

    In NDB 7.5.1, the default for this option was DYNAMIC; in NDB 7.5.4, the default was changed to FIXED to maintain backwards compatibility with older release series (Bug #24487363).

  • --ndb-deferred-constraints=[0|1]

    Table 5.18 Type and value information for ndb-deferred-constraints

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb-deferred-constraints

    Yes Yes No
    Yes Both Yes
    NDB 7.5 integer 0 / 0 - 1

    DESCRIPTION: Specifies that constraint checks on unique indexes (where these are supported) should be deferred until commit time. Not normally needed or used; for testing purposes only.


    Controls whether or not constraint checks on unique indexes are deferred until commit time, where such checks are supported. 0 is the default.

    This option is not normally needed for operation of NDB Cluster or NDB Cluster Replication, and is intended primarily for use in testing.

  • --ndb-distribution=[KEYHASH|LINHASH]

    Table 5.19 Type and value information for ndb-distribution

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb-distribution

    Yes Yes No
    Yes Global Yes
    NDB 7.5 enumeration KEYHASH / LINHASH, KEYHASH

    DESCRIPTION: Default distribution for new tables in NDBCLUSTER (KEYHASH or LINHASH, default is KEYHASH)


    Controls the default distribution method for NDB tables. Can be set to either of KEYHASH (key hashing) or LINHASH (linear hashing). KEYHASH is the default.

  • --ndb-mgmd-host=host[:port]

    Table 5.20 Type and value information for ndb-mgmd-host

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb-mgmd-host

    Yes No No
    Yes No
    NDB 7.5 string localhost:1186

    DESCRIPTION: Set the host (and port, if desired) for connecting to management server


    Can be used to set the host and port number of a single management server for the program to connect to. If the program requires node IDs or references to multiple management servers (or both) in its connection information, use the --ndb-connectstring option instead.

  • --ndbcluster

    Table 5.21 Type and value information for ndbcluster

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndbcluster

    Yes No No
    Yes No
    NDB 7.5 boolean FALSE

    DESCRIPTION: Enable NDB Cluster (if this version of MySQL supports it)

    Disabled by --skip-ndbcluster


    The NDBCLUSTER storage engine is necessary for using NDB Cluster . If a mysqld binary includes support for the NDBCLUSTER storage engine, the engine is disabled by default. Use the --ndbcluster option to enable it. Use --skip-ndbcluster to explicitly disable the engine.

    It is not necessary or desirable to use this option together with --initialize. Beginning with NDB 7.5.4, --ndbcluster is ignored (and the NDB storage engine is not enabled) if --initialize is also used. (Bug #81689, Bug #23518923)

  • --ndb-log-apply-status

    Table 5.22 Type and value information for ndb-log-apply-status

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb-log-apply-status

    Yes Yes No
    Yes Global No
    NDB 7.5 boolean OFF

    DESCRIPTION: Cause a MySQL server acting as a slave to log mysql.ndb_apply_status updates received from its immediate master in its own binary log, using its own server ID. Effective only if the server is started with the --ndbcluster option.


    Causes a slave mysqld to log any updates received from its immediate master to the mysql.ndb_apply_status table in its own binary log using its own server ID rather than the server ID of the master. In a circular or chain replication setting, this allows such updates to propagate to the mysql.ndb_apply_status tables of any MySQL servers configured as slaves of the current mysqld.

    In a chain replication setup, using this option allows downstream (slave) clusters to be aware of their positions relative to all of their upstream contributors (masters).

    In a circular replication setup, this option causes changes to ndb_apply_status tables to complete the entire circuit, eventually propagating back to the originating NDB Cluster . This also allows a cluster acting as a master to see when its changes (epochs) have been applied to the other clusters in the circle.

    This option has no effect unless the MySQL server is started with the --ndbcluster option.

  • --ndb-log-empty-epochs=[ON|OFF]

    Table 5.23 Type and value information for ndb-log-empty-epochs

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb-log-empty-epochs

    Yes Yes No
    Yes Global Yes
    NDB 7.5 boolean OFF

    DESCRIPTION: When enabled, causes epochs in which there were no changes to be written to the ndb_apply_status and ndb_binlog_index tables, even when --log-slave-updates is enabled.


    Causes epochs during which there were no changes to be written to the ndb_apply_status and ndb_binlog_index tables, even when --log-slave-updates is enabled.

    By default this option is disabled. Disabling --ndb-log-empty-epochs causes epoch transactions with no changes not to be written to the binary log, although a row is still written even for an empty epoch in ndb_binlog_index.

    Because --ndb-log-empty-epochs=1 causes the size of the ndb_binlog_index table to increase independently of the size of the binary log, users should be prepared to manage the growth of this table, even if they expect the cluster to be idle a large part of the time.

  • --ndb-log-empty-update=[ON|OFF]

    Table 5.24 Type and value information for ndb-log-empty-update

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb-log-empty-update

    Yes Yes No
    Yes Global Yes
    NDB 7.5 boolean OFF

    DESCRIPTION: When enabled, causes updates that produced no changes to be written to the ndb_apply_status and ndb_binlog_index tables, even when --log-slave-updates is enabled.


    Causes updates that produced no changes to be written to the ndb_apply_status and ndb_binlog_index tables, even when --log-slave-updates is enabled.

    By default this option is disabled (OFF). Disabling --ndb-log-empty-update causes updates with no changes not to be written to the binary log.

  • --ndb-log-exclusive-reads=[0|1]

    Table 5.25 Type and value information for ndb-log-exclusive-reads

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb-log-exclusive-reads

    Yes Yes No
    Yes Both Yes
    NDB 7.5 boolean 0

    DESCRIPTION: Log primary key reads with exclusive locks; allow conflict resolution based on read conflicts.


    Starting the server with this option causes primary key reads to be logged with exclusive locks, which allows for NDB Cluster Replication conflict detection and resolution based on read conflicts. You can also enable and disable these locks at runtime by setting the value of the ndb_log_exclusive_reads system variable to 1 or 0, respectively. 0 (disable locking) is the default.

    For more information, see Read conflict detection and resolution.

  • --ndb-log-orig

    Table 5.26 Type and value information for ndb-log-orig

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb-log-orig

    Yes Yes No
    Yes Global No
    NDB 7.5 boolean OFF

    DESCRIPTION: Log originating server id and epoch in mysql.ndb_binlog_index table.


    Log the originating server ID and epoch in the ndb_binlog_index table.

    Note

    This makes it possible for a given epoch to have multiple rows in ndb_binlog_index, one for each originating epoch.

    For more information, see Section 8.4, “NDB Cluster Replication Schema and Tables”.

  • --ndb-log-transaction-id

    Table 5.27 Type and value information for ndb-log-transaction-id

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb-log-transaction-id

    Yes Yes No
    Yes Global No
    NDB 7.5 boolean OFF

    DESCRIPTION: Write NDB transaction IDs in the binary log. Requires --log-bin-v1-events=OFF.


    Causes a slave mysqld to write the NDB transaction ID in each row of the binary log. Such logging requires the use of the Version 2 event format for the binary log; thus, --log-bin-use-v1-row-events must be set to FALSE in order to use this option.

    This option is not supported in mainline MySQL Server 5.7. It is required to enable NDB Cluster Replication conflict detection and resolution using the NDB$EPOCH_TRANS() function (see NDB$EPOCH_TRANS()).

    The default value is FALSE.

    For more information, see Section 8.11, “NDB Cluster Replication Conflict Resolution”.

  • --ndb-nodeid=#

    Table 5.28 Type and value information for ndb-nodeid

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb-nodeid

    Yes No Yes
    Yes Global No
    5.0.45 integer / 1 - 63
    5.1.5 integer / 1 - 255

    DESCRIPTION: MySQL Cluster node ID for this MySQL server


    Set this MySQL server's node ID in an NDB Cluster .

    The --ndb-nodeid option overrides any node ID set with --ndb-connectstring, regardless of the order in which the two options are used.

    In addition, if --ndb-nodeid is used, then either a matching node ID must be found in a [mysqld] or [api] section of config.ini, or there must be an open [mysqld] or [api] section in the file (that is, a section without a NodeId or Id parameter specified). This is also true if the node ID is specified as part of the connection string.

    Regardless of how the node ID is determined, its is shown as the value of the global status variable Ndb_cluster_node_id in the output of SHOW STATUS, and as cluster_node_id in the connection row of the output of SHOW ENGINE NDBCLUSTER STATUS.

    For more information about node IDs for NDB Cluster SQL nodes, see Section 5.3.7, “Defining SQL and Other API Nodes in an NDB Cluster”.

  • --ndb_optimization_delay=milliseconds

    Table 5.29 Type and value information for ndb_optimization_delay

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_optimization_delay

    No Yes No
    No Global Yes
    NDB 7.5 integer 10 / 0 - 100000

    DESCRIPTION: Sets the number of milliseconds to wait between processing sets of rows by OPTIMIZE TABLE on NDB tables.


    Set the number of milliseconds to wait between sets of rows by OPTIMIZE TABLE statements on NDB tables. The default is 10.

  • --ndb-recv-thread-activation-threshold=threshold

    Table 5.30 Type and value information for ndb-recv-thread-activation-threshold

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb-recv-thread-activation-threshold

    Yes No No
    Yes No
    5.6.10-ndb-7.3.1 integer 8 / 0 (MIN_ACTIVATION_THRESHOLD) - 16 (MAX_ACTIVATION_THRESHOLD)

    DESCRIPTION: Activation threshold when receive thread takes over the polling of the cluster connection (measured in concurrently active threads)


    When this number of concurrently active threads is reached, the receive thread takes over polling of the cluster connection.

  • --ndb-recv-thread-cpu-mask=bitmask

    Table 5.31 Type and value information for ndb-recv-thread-cpu-mask

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb-recv-thread-cpu-mask

    Yes No No
    Yes No
    NDB 7.5 bitmap [empty]

    DESCRIPTION: CPU mask for locking receiver threads to specific CPUs; specified as hexadecimal. See documentation for details.


    Set a CPU mask for locking receiver threads to specific CPUs. This is specified as a hexadecimal bitmask; for example, 0x33 means that one CPU is used per receiver thread. An empty string (no locking of receiver threads) is the default.

  • ndb-transid-mysql-connection-map=state

    Table 5.32 Type and value information for ndb-transid-mysql-connection-map

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb-transid-mysql-connection-map

    Yes No No
    No No
    NDB 7.5 enumeration ON / ON, OFF, FORCE

    DESCRIPTION: Enable or disable the ndb_transid_mysql_connection_map plugin; that is, enable or disable the INFORMATION_SCHEMA table having that name.


    Enables or disables the plugin that handles the ndb_transid_mysql_connection_map table in the INFORMATION_SCHEMA database. Takes one of the values ON, OFF, or FORCE. ON (the default) enables the plugin. OFF disables the plugin, which makes ndb_transid_mysql_connection_map inaccessible. FORCE keeps the MySQL Server from starting if the plugin fails to load and start.

    You can see whether the ndb_transid_mysql_connection_map table plugin is running by checking the output of SHOW PLUGINS.

  • --ndb-wait-connected=seconds

    Table 5.33 Type and value information for ndb-wait-connected

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb-wait-connected

    Yes Yes No
    Yes Global No
    NDB 7.5 integer 0 / 0 - 31536000
    5.1.56-ndb-7.0.27 integer 30 / 0 - 31536000
    NDB 7.5 integer 0 / 0 - 31536000
    5.1.56-ndb-7.1.16 integer 30 / 0 - 31536000

    DESCRIPTION: Time (in seconds) for the MySQL server to wait for connection to cluster management and data nodes before accepting MySQL client connections.


    This option sets the period of time that the MySQL server waits for connections to NDB Cluster management and data nodes to be established before accepting MySQL client connections. The time is specified in seconds. The default value is 30.

  • --ndb-wait-setup=seconds

    Table 5.34 Type and value information for ndb-wait-setup

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb-wait-setup

    Yes Yes No
    Yes Global No
    5.1.39-ndb-6.2.19 integer 15 / 0 - 31536000
    5.1.39-ndb-6.3.28 integer 15 / 0 - 31536000
    5.1.39-ndb-7.0.9 integer 15 / 0 - 31536000
    5.1.56-ndb-7.0.27 integer 30 / 0 - 31536000
    5.1.39-ndb-7.1.0 integer 15 / 0 - 31536000
    5.1.56-ndb-7.1.16 integer 30 / 0 - 31536000

    DESCRIPTION: Time (in seconds) for the MySQL server to wait for NDB engine setup to complete.


    This variable shows the period of time that the MySQL server waits for the NDB storage engine to complete setup before timing out and treating NDB as unavailable. The time is specified in seconds. The default value is 30.

  • --server-id-bits=#

    Table 5.35 Type and value information for server-id-bits

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    server-id-bits

    Yes Yes No
    Yes Global No
    NDB 7.5 integer 32 / 7 - 32

    DESCRIPTION: Sets the number of least significant bits in the server_id actually used for identifying the server, permitting NDB API applications to store application data in the most significant bits. server_id must be less than 2 to the power of this value.


    This option indicates the number of least significant bits within the 32-bit server_id which actually identify the server. Indicating that the server is actually identified by fewer than 32 bits makes it possible for some of the remaining bits to be used for other purposes, such as storing user data generated by applications using the NDB API's Event API within the AnyValue of an OperationOptions structure (NDB Cluster uses the AnyValue to store the server ID).

    When extracting the effective server ID from server_id for purposes such as detection of replication loops, the server ignores the remaining bits. The --server-id-bits option is used to mask out any irrelevant bits of server_id in the IO and SQL threads when deciding whether an event should be ignored based on the server ID.

    This data can be read from the binary log by mysqlbinlog, provided that it is run with its own --server-id-bits option set to 32 (the default).

    The value of server_id must be less than 2 ^ server_id_bits; otherwise, mysqld refuses to start.

    This system variable is supported only by NDB Cluster . It is not supported in the standard MySQL 5.7 Server.

  • --skip-ndbcluster

    Table 5.36 Type and value information for skip-ndbcluster

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    skip-ndbcluster

    Yes No No
    Yes No

    DESCRIPTION: Disable the NDB Cluster storage engine


    Disable the NDBCLUSTER storage engine. This is the default for binaries that were built with NDBCLUSTER storage engine support; the server allocates memory and other resources for this storage engine only if the --ndbcluster option is given explicitly. See Section 5.1, “Quick Test Setup of NDB Cluster”, for an example.

5.3.8.2 NDB Cluster System Variables

This section provides detailed information about MySQL server system variables that are specific to NDB Cluster and the NDB storage engine. For system variables not specific to NDB Cluster , see Server System Variables. For general information on using system variables, see Using System Variables.

  • ndb_autoincrement_prefetch_sz

    Table 5.37 Type and value information for ndb_autoincrement_prefetch_sz

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_autoincrement_prefetch_sz

    Yes Yes No
    Yes Both Yes
    NDB 7.5 integer 32 / 1 - 256
    5.0.56 integer 1 / 1 - 256
    5.1.1 integer 32 / 1 - 256
    5.1.23 integer 1 / 1 - 256
    5.1.16-ndb-6.2.0 integer 32 / 1 - 256
    5.1.23-ndb-6.2.10 integer 1 / 1 - 256
    5.1.19-ndb-6.3.0 integer 32 / 1 - 256
    5.1.23-ndb-6.3.7 integer 1 / 1 - 256
    5.1.41-ndb-6.3.31 integer 1 / 1 - 65536
    5.1.30-ndb-6.4.0 integer 32 / 1 - 256
    5.1.41-ndb-7.0.11 integer 1 / 1 - 65536
    5.5.15-ndb-7.2.1 integer 1 / 1 - 65536

    DESCRIPTION: NDB auto-increment prefetch size


    Determines the probability of gaps in an autoincremented column. Set it to 1 to minimize this. Setting it to a high value for optimization makes inserts faster, but decreases the likelihood that consecutive autoincrement numbers will be used in a batch of inserts. The mininum and default value is 1. The maximum value for ndb_autoincrement_prefetch_sz is 65536.

    This variable affects only the number of AUTO_INCREMENT IDs that are fetched between statements; within a given statement, at least 32 IDs are obtained at a time. The default value is 1.

    Important

    This variable does not affect inserts performed using INSERT ... SELECT.

  • ndb_cache_check_time

    Table 5.38 Type and value information for ndb_cache_check_time

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_cache_check_time

    Yes Yes No
    Yes Global Yes
    NDB 7.5 integer 0 / -

    DESCRIPTION: Number of milliseconds between checks of cluster SQL nodes made by the MySQL query cache


    The number of milliseconds that elapse between checks of NDB Cluster SQL nodes by the MySQL query cache. Setting this to 0 (the default and minimum value) means that the query cache checks for validation on every query.

    The recommended maximum value for this variable is 1000, which means that the check is performed once per second. A larger value means that the check is performed and possibly invalidated due to updates on different SQL nodes less often. It is generally not desirable to set this to a value greater than 2000.

  • ndb_clear_apply_status

    Table 5.39 Type and value information for ndb_clear_apply_status

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_clear_apply_status

    Yes Yes No
    No Global Yes
    NDB 7.5 boolean ON

    DESCRIPTION: Causes RESET SLAVE to clear all rows from the ndb_apply_status table. ON by default.


    By the default, executing RESET SLAVE causes an NDB Cluster replication slave to purge all rows from its ndb_apply_status table. You can disable this by setting ndb_clear_apply_status=OFF.

  • ndb_data_node_neighbour

    Table 5.40 Type and value information for ndb_data_node_neighbour

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_data_node_neighbour

    Yes Yes No
    Yes Global Yes
    5.7.12-ndb-7.5.2 integer 0 / 0 - 255

    DESCRIPTION: Specifies cluster data node "closest" to this MySQL Server, for transaction hinting and fully replicated tables


    Sets the ID of a nearest data node—that is, a preferred nonlocal data node is chosen to execute the transaction, rather than one running on the same host as the SQL or API node. This used to ensure that when a fully replicated table is accessed, we access it on this data node, to ensure that the local copy of the table is always used whenever possible. This can also be used for providing hints for transactions.

    This can improve data access times in the case of a node that is physically closer than and thus has higher network throughput than others on the same host.

    See Setting NDB_TABLE Options in Table Comments, for further information.

    Added in NDB 7.5.2.

    Note

    An equivalent method set_data_node_neighbour() is provided for use in NDB API applications.

  • ndb_default_column_format

    Table 5.41 Type and value information for ndb_default_column_format

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_default_column_format

    Yes Yes No
    Yes Global Yes
    5.7.11-ndb-7.5.1 enumeration DYNAMIC / FIXED, DYNAMIC
    5.7.16-ndb-7.5.4 enumeration FIXED / FIXED, DYNAMIC

    DESCRIPTION: Sets default row format and column format (FIXED or DYNAMIC) used for new NDB tables.


    In NDB 7.5.1 and later, sets the default COLUMN_FORMAT and ROW_FORMAT for new tables (see CREATE TABLE Syntax).

    In NDB 7.5.1, the default for this variable was DYNAMIC; in NDB 7.5.4, the default was changed to FIXED to maintain backwards compatibility with older release series (Bug #24487363).

  • ndb_deferred_constraints

    Table 5.42 Type and value information for ndb_deferred_constraints

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_deferred_constraints

    Yes Yes No
    Yes Both Yes
    NDB 7.5 integer 0 / 0 - 1

    DESCRIPTION: Specifies that constraint checks should be deferred (where these are supported). Not normally needed or used; for testing purposes only.


    Controls whether or not constraint checks are deferred, where these are supported. 0 is the default.

    This variable is not normally needed for operation of NDB Cluster or NDB Cluster Replication, and is intended primarily for use in testing.

  • ndb_distribution

    Table 5.43 Type and value information for ndb_distribution

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_distribution

    Yes Yes No
    Yes Global Yes
    NDB 7.5 enumeration KEYHASH / LINHASH, KEYHASH

    DESCRIPTION: Default distribution for new tables in NDBCLUSTER (KEYHASH or LINHASH, default is KEYHASH)


    Controls the default distribution method for NDB tables. Can be set to either of KEYHASH (key hashing) or LINHASH (linear hashing). KEYHASH is the default.

  • ndb_eventbuffer_free_percent

    Table 5.44 Type and value information for ndb_eventbuffer_free_percent

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_eventbuffer_free_percent

    Yes Yes No
    Yes Global Yes
    NDB 7.5 integer 20 / 1 - 99

    DESCRIPTION: Percentage of free memory that should be available in event buffer before resumption of buffering, after reaching limit set by ndb_eventbuffer_max_alloc.


    Sets the percentage of the maximum memory allocated to the event buffer (ndb_eventbuffer_max_alloc) that should be available in event buffer after reaching the maximum, before starting to buffer again.

  • ndb_eventbuffer_max_alloc

    Table 5.45 Type and value information for ndb_eventbuffer_max_alloc

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_eventbuffer_max_alloc

    Yes Yes No
    Yes Global Yes
    NDB 7.5 integer 0 / 0 - 4294967295

    DESCRIPTION: Maximum memory that can be allocated for buffering events by the NDB API. Defaults to 0 (no limit).


    Sets the maximum amount memory (in bytes) that can be allocated for buffering events by the NDB API. 0 means that no limit is imposed, and is the default.

  • ndb_extra_logging

    Table 5.46 Type and value information for ndb_extra_logging

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_extra_logging

    Yes Yes No
    Yes Global Yes
    NDB 7.5 integer 0 / -
    5.1.19-ndb-6.3.0 integer 1 / -

    DESCRIPTION: Controls logging of MySQL Cluster schema, connection, and data distribution events in the MySQL error log


    This variable enables recording in the MySQL error log of information specific to the NDB storage engine.

    When this variable is set to 0, the only information specific to NDB that is written to the MySQL error log relates to transaction handling. If it set to a value greater than 0 but less than 10, NDB table schema and connection events are also logged, as well as whether or not conflict resolution is in use, and other NDB errors and information. If the value is set to 10 or more, information about NDB internals, such as the progress of data distribution among cluster nodes, is also written to the MySQL error log. The default is 1.

  • ndb_force_send

    Table 5.47 Type and value information for ndb_force_send

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_force_send

    Yes Yes No
    Yes Both Yes
    NDB 7.5 boolean TRUE

    DESCRIPTION: Forces sending of buffers to NDB immediately, without waiting for other threads


    Forces sending of buffers to NDB immediately, without waiting for other threads. Defaults to ON.

  • ndb_fully_replicated

    Table 5.48 Type and value information for ndb_fully_replicated

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_fully_replicated

    Yes Yes No
    Yes Both Yes
    5.7.12-ndb-7-5-2 boolean OFF

    DESCRIPTION: Whether new NDB tables are fully replicated


    Determines whether new NDB tables are fully replicated. This setting can be overridden for an individual table using COMMENT="NDB_TABLE=FULLY_REPLICATED=..." in a CREATE TABLE or ALTER TABLE statement; see Setting NDB_TABLE Options in Table Comments, for syntax and other information.

    Added in NDB 7.5.2.

  • ndb_index_stat_enable

    Table 5.49 Type and value information for ndb_index_stat_enable

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_index_stat_enable

    Yes Yes No
    Yes Both Yes
    NDB 7.5 boolean OFF
    5.5.15-ndb-7.2.1 boolean ON

    DESCRIPTION: Use NDB index statistics in query optimization


    Use NDB index statistics in query optimization. The default is ON.

  • ndb_index_stat_option

    Table 5.50 Type and value information for ndb_index_stat_option

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_index_stat_option

    Yes Yes No
    Yes Both Yes
    NDB 7.5 string loop_enable=1000ms,loop_idle=1000ms,loop_busy=100ms, update_batch=1,read_batch=4,idle_batch=32,check_batch=8, check_delay=10m,delete_batch=8, clean_delay=1m,error_batch=4, error_delay=1m,evict_batch=8,evict_delay=1m,cache_limit=32M, cache_lowpct=90,zero_total=0
    5.1.56-ndb-7.1.17 string loop_checkon=1000ms,loop_idle=1000ms,loop_busy=100ms, update_batch=1,read_batch=4,idle_batch=32,check_batch=32, check_delay=1m,delete_batch=8,clean_delay=0,error_batch=4, error_delay=1m,evict_batch=8,evict_delay=1m,cache_limit=32M, cache_lowpct=90

    DESCRIPTION: Comma-separated list of tunable options for NDB index statistics; the list should contain no spaces


    This variable is used for providing tuning options for NDB index statistics generation. The list consist of comma-separated name-value pairs of option names and values, and this list must not contain any space characters.

    Options not used when setting ndb_index_stat_option are not changed from their default values. For example, you can set ndb_index_stat_option = 'loop_idle=1000ms,cache_limit=32M'.

    Time values can be optionally suffixed with h (hours), m (minutes), or s (seconds). Millisecond values can optionally be specified using ms; millisecond values cannot be specified using h, m, or s.) Integer values can be suffixed with K, M, or G.

    The names of the options that can be set using this variable are shown in the table that follows. The table also provides brief descriptions of the options, their default values, and (where applicable) their minimum and maximum values.

    NameDescriptionDefault/UnitsMinimum/Maximum
    loop_enable 1000 ms0/4G
    loop_idleTime to sleep when idle1000 ms0/4G
    loop_busyTime to sleep when more work is waiting100 ms0/4G
    update_batch 10/4G
    read_batch 41/4G
    idle_batch 321/4G
    check_batch 81/4G
    check_delayHow often to check for new statistics10 m1/4G
    delete_batch 80/4G
    clean_delay 1 m0/4G
    error_batch 41/4G
    error_delay 1 m1/4G
    evict_batch 81/4G
    evict_delayClean LRU cache, from read time1 m0/4G
    cache_limitMaximum amount of memory in bytes used for cached index statistics by this mysqld; clean up the cache when this is exceeded.32 M0/4G
    cache_lowpct 900/100
    zero_totalSetting this to 1 resets all accumulating counters in ndb_index_stat_status to 0. This option value is also reset to 0 when this is done.00/1
  • ndb_join_pushdown

    Table 5.51 Type and value information for ndb_join_pushdown

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_join_pushdown

    No Yes No
    No Both Yes
    5.1.51-ndb-7.2.0 boolean TRUE

    DESCRIPTION: Enables pushing down of joins to data nodes


    This variable controls whether joins on NDB tables are pushed down to the NDB kernel (data nodes). Previously, a join was handled using multiple accesses of NDB by the SQL node; however, when ndb_join_pushdown is enabled, a pushable join is sent in its entirety to the data nodes, where it can be distributed among the data nodes and executed in parallel on multiple copies of the data, with a single, merged result being returned to mysqld. This can reduce greatly the number of round trips between an SQL node and the data nodes required to handle such a join.

    By default, ndb_join_pushdown is enabled.

    Conditions for NDB pushdown joins.  In order for a join to be pushable, it must meet the following conditions:

    1. Only columns can be compared, and all columns to be joined must use exactly the same data type.

      This means that expressions such as t1.a = t2.a + constant cannot be pushed down, and that (for example) a join on an INT column and a BIGINT column also cannot be pushed down.

    2. Queries referencing BLOB or TEXT columns are not supported.

    3. Explicit locking is not supported; however, the NDB storage engine's characteristic implicit row-based locking is enforced.

      This means that a join using FOR UPDATE cannot be pushed down.

    4. In order for a join to be pushed down, child tables in the join must be accessed using one of the ref, eq_ref, or  const access methods, or some combination of these methods.

      Outer joined child tables can only be pushed using eq_ref.

      If the root of the pushed join is an eq_ref or const, only child tables joined by eq_ref can be appended. (A table joined by ref is likely to become the root of another pushed join.)

      If the query optimizer decides on Using join cache for a candidate child table, that table cannot be pushed as a child. However, it may be the root of another set of pushed tables.

    5. Joins referencing tables explicitly partitioned by [LINEAR] HASH, LIST, or RANGE currently cannot be pushed down.

    You can see whether a given join can be pushed down by checking it with EXPLAIN; when the join can be pushed down, you can see references to the pushed join in the Extra column of the output, as shown in this example:

    mysql> EXPLAIN
        ->     SELECT e.first_name, e.last_name, t.title, d.dept_name
        ->         FROM employees e
        ->         JOIN dept_emp de ON e.emp_no=de.emp_no
        ->         JOIN departments d ON d.dept_no=de.dept_no
        ->         JOIN titles t ON e.emp_no=t.emp_no\G
    *************************** 1. row ***************************
               id: 1
      select_type: SIMPLE
            table: d
             type: ALL
    possible_keys: PRIMARY
              key: NULL
          key_len: NULL
              ref: NULL
             rows: 9
            Extra: Parent of 4 pushed join@1
    *************************** 2. row ***************************
               id: 1
      select_type: SIMPLE
            table: de
             type: ref
    possible_keys: PRIMARY,emp_no,dept_no
              key: dept_no
          key_len: 4
              ref: employees.d.dept_no
             rows: 5305
            Extra: Child of 'd' in pushed join@1
    *************************** 3. row ***************************
               id: 1
      select_type: SIMPLE
            table: e
             type: eq_ref
    possible_keys: PRIMARY
              key: PRIMARY
          key_len: 4
              ref: employees.de.emp_no
             rows: 1
            Extra: Child of 'de' in pushed join@1
    *************************** 4. row ***************************
               id: 1
      select_type: SIMPLE
            table: t
             type: ref
    possible_keys: PRIMARY,emp_no
              key: emp_no
          key_len: 4
              ref: employees.de.emp_no
             rows: 19
            Extra: Child of 'e' in pushed join@1
    4 rows in set (0.00 sec)
    
    Note

    If inner joined child tables are joined by ref, and the result is ordered or grouped by a sorted index, this index cannot provide sorted rows, which forces writing to a sorted tempfile.

    Two additional sources of information about pushed join performance are available:

    1. The status variables Ndb_pushed_queries_defined, Ndb_pushed_queries_dropped, Ndb_pushed_queries_executed, and Ndb_pushed_reads.

    2. The counters in the ndbinfo.counters table that belong to the DBSPJ kernel block. See Section 7.10.9, “The ndbinfo counters Table”, for information about these counters. See also The DBSPJ Block, in the NDB Cluster API Developer Guide.

  • ndb_log_apply_status

    Table 5.52 Type and value information for ndb_log_apply_status

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_log_apply_status

    Yes Yes No
    Yes Global No
    NDB 7.5 boolean OFF

    DESCRIPTION: Whether or not a MySQL server acting as a slave logs mysql.ndb_apply_status updates received from its immediate master in its own binary log, using its own server ID.


    A read-only variable which shows whether the server was started with the --ndb-log-apply-status option.

  • ndb_log_bin

    Table 5.53 Type and value information for ndb_log_bin

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_log_bin

    Yes Yes No
    No Both Yes
    NDB 7.5 boolean ON

    DESCRIPTION: Write updates to NDB tables in the binary log. Effective only if binary logging is enabled with --log-bin.


    Causes updates to NDB tables to be written to the binary log. Setting this variable has no effect if binary logging is not already enabled for the server using log_bin. ndb_log_bin defaults to 1 (ON); normally, there is never any need to change this value in a production environment.

  • ndb_log_binlog_index

    Table 5.54 Type and value information for ndb_log_binlog_index

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_log_binlog_index

    Yes Yes No
    No Global Yes
    NDB 7.5 boolean ON

    DESCRIPTION: Insert mapping between epochs and binary log positions into the ndb_binlog_index table. Defaults to ON. Effective only if binary logging is enabled on the server.


    Causes a mapping of epochs to positions in the binary log to be inserted into the ndb_binlog_index table. Setting this variable has no effect if binary logging is not already enabled for the server using log_bin. (In addition, ndb_log_bin must not be disabled.) ndb_log_binlog_index defaults to 1 (ON); normally, there is never any need to change this value in a production environment.

  • ndb_log_empty_epochs

    Table 5.55 Type and value information for ndb_log_empty_epochs

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_log_empty_epochs

    Yes Yes No
    Yes Global Yes
    NDB 7.5 boolean OFF

    DESCRIPTION: When enabled, epochs in which there were no changes are written to the ndb_apply_status and ndb_binlog_index tables, even when log_slave_updates is enabled.


    When this variable is set to 0, epoch transactions with no changes are not written to the binary log, although a row is still written even for an empty epoch in ndb_binlog_index.

  • ndb_log_empty_update

    Table 5.56 Type and value information for ndb_log_empty_update

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_log_empty_update

    Yes Yes No
    Yes Global Yes
    NDB 7.5 boolean OFF

    DESCRIPTION: When enabled, updates which produce no changes are written to the ndb_apply_status and ndb_binlog_index tables, even when log_slave_updates is enabled.


    When this variable is set to ON (1), update transactions with no changes are written to the binary log, even when --log-slave-updates is enabled.

  • ndb_log_exclusive_reads

    Table 5.57 Type and value information for ndb_log_exclusive_reads

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_log_exclusive_reads

    Yes Yes No
    Yes Both Yes
    NDB 7.5 boolean 0

    DESCRIPTION: Log primary key reads with exclusive locks; allow conflict resolution based on read conflicts.


    This variable determines whether primary key reads are logged with exclusive locks, which allows for NDB Cluster Replication conflict detection and resolution based on read conflicts. To enable these locks, set the value of ndb_log_exclusive_reads to 1. 0, which disables such locking, is the default.

    For more information, see Read conflict detection and resolution.

  • ndb_log_orig

    Table 5.58 Type and value information for ndb_log_orig

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_log_orig

    Yes Yes No
    Yes Global No
    NDB 7.5 boolean OFF

    DESCRIPTION: Whether the id and epoch of the originating server are recorded in the mysql.ndb_binlog_index table. Set using the --ndb-log-orig option when starting mysqld.


    Shows whether the originating server ID and epoch are logged in the ndb_binlog_index table. Set using the --ndb-log-orig server option.

  • ndb_log_transaction_id

    Table 5.59 Type and value information for ndb_log_transaction_id

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_log_transaction_id

    No Yes No
    No Global No
    NDB 7.5 boolean OFF

    DESCRIPTION: Whether NDB transaction IDs are written into the binary log. (Read-only.)


    This read-only, Boolean system variable shows whether a slave mysqld writes NDB transaction IDs in the binary log (required to use active-active NDB Cluster Replication with NDB$EPOCH_TRANS() conflict detection). To change the setting, use the --ndb-log-transaction-id option.

    ndb_log_transaction_id is not supported in mainline MySQL Server 5.7.

    For more information, see Section 8.11, “NDB Cluster Replication Conflict Resolution”.

  • ndb_optimized_node_selection

    Table 5.60 Type and value information for ndb_optimized_node_selection

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_optimized_node_selection

    Yes Yes No
    Yes Global No
    NDB 7.5 boolean ON
    5.1.22-ndb-6.3.4 integer 3 / 0 - 3

    DESCRIPTION: Determines how an SQL node chooses a cluster data node to use as transaction coordinator


    There are two forms of optimized node selection, described here:

    1. The SQL node uses promixity to determine the transaction coordinator; that is, the closest data node to the SQL node is chosen as the transaction coordinator. For this purpose, a data node having a shared memory connection with the SQL node is considered to be closest to the SQL node; the next closest (in order of decreasing proximity) are: TCP connection to localhost; SCI connection; TCP connection from a host other than localhost.

    2. The SQL thread uses distribution awareness to select the data node. That is, the data node housing the cluster partition accessed by the first statement of a given transaction is used as the transaction coordinator for the entire transaction. (This is effective only if the first statement of the transaction accesses no more than one cluster partition.)

    This option takes one of the integer values 0, 1, 2, or 3. 3 is the default. These values affect node selection as follows:

    • 0: Node selection is not optimized. Each data node is employed as the transaction coordinator 8 times before the SQL thread proceeds to the next data node.

    • 1: Proximity to the SQL node is used to determine the transaction coordinator.

    • 2: Distribution awareness is used to select the transaction coordinator. However, if the first statement of the transaction accesses more than one cluster partition, the SQL node reverts to the round-robin behavior seen when this option is set to 0.

    • 3: If distribution awareness can be employed to determine the transaction coordinator, then it is used; otherwise proximity is used to select the transaction coordinator. (This is the default behavior.)

    Proximity is determined as follows:

    1. Start with the value set for the Group parameter (default 55).

    2. For an API node sharing the same host with other API nodes, decrement the value by 1. Assuming the default value for Group, the effective value for data nodes on same host as the API node is 54, and for remote data nodes 55.

    3. (NDB 7.5.2 and later:) Setting ndb_data_node_neighbour further decreases the effective Group value by 50, causing this node to be regarded as the nearest node. This is needed only when all data nodes are on hosts other than that hosts the API node and it is desirable to dedicate one of them to the API node. In normal cases, the default adjustment described previously is sufficient.

    Frequent changes in ndb_data_node_neighbour are not advisable, since this changes the state of the cluster connection and thus may disrupt the selection algorithm for new transactions from each thread until it stablilizes.

  • ndb_read_backup

    Table 5.61 Type and value information for ndb_read_backup

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_read_backup

    Yes Yes No
    Yes Global Yes
    5.7.12-ndb-7.5.2 boolean OFF

    DESCRIPTION: Enable read from any replica


    Enable read from any replica for any NDB table subsequently created.

    Added in NDB 7.5.2.

  • ndb_recv_thread_activation_threshold

    Table 5.62 Type and value information for ndb_recv_thread_activation_threshold

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_recv_thread_activation_threshold

    No No No
    No No
    5.6.10-ndb-7.3.1 integer 8 / 0 (MIN_ACTIVATION_THRESHOLD) - 16 (MAX_ACTIVATION_THRESHOLD)

    DESCRIPTION: Activation threshold when receive thread takes over the polling of the cluster connection (measured in concurrently active threads)


    When this number of concurrently active threads is reached, the receive thread takes over polling of the cluster connection.

    This variable is global in scope. It can also be set on startup using the --ndb-recv-thread-activation-threshold option.

  • ndb_recv_thread_cpu_mask

    Table 5.63 Type and value information for ndb_recv_thread_cpu_mask

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_recv_thread_cpu_mask

    No Yes No
    No Global Yes
    NDB 7.5 bitmap [empty]

    DESCRIPTION: CPU mask for locking receiver threads to specific CPUs; specified as hexadecimal. See documentation for details.


    CPU mask for locking receiver threads to specific CPUs. This is specified as a hexadecimal bitmask; for example, 0x33 means that one CPU is used per receiver thread. An empty string is the default; setting ndb_recv_thread_cpu_mask to this value removes any receiver thread locks previously set.

    This variable is global in scope. It can also be set on startup using the --ndb-recv-thread-cpu-mask option.

  • ndb_report_thresh_binlog_epoch_slip

    Table 5.64 Type and value information for ndb_report_thresh_binlog_epoch_slip

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_report_thresh_binlog_epoch_slip

    Yes Yes No
    Yes Global Yes
    NDB 7.5 integer 3 / 0 - 256
    5.7.16-ndb-7.5.4 integer 10 / 0 - 256

    DESCRIPTION: NDB 7.5.4 and later: Threshold for number of epochs completely buffered, but not yet consumed by binlog injector thread which when exceeded generates BUFFERED_EPOCHS_OVER_THRESHOLD event buffer status message; prior to NDB 7.5.4: Threshold for number of epochs to lag behind before reporting binary log status


    In NDB 7.5.4 and later, this represents the threshold for the number of epochs completely buffered in the event buffer, but not yet consumed by the binlog injector thread. When this degree of slippage (lag) is exceeded, an event buffer status message is reported, with BUFFERED_EPOCHS_OVER_THRESHOLD supplied as the reason (see Section 7.7.3, “Event Buffer Reporting in the Cluster Log”). Slip is increased when an epoch is received from data nodes and buffered completely in the event buffer; it is decreased when an epoch is consumed by the binlog injector thread, it is reduced. Empty epochs are buffered and queued, and so included in this calculation only when this is enabled using the Ndb::setEventBufferQueueEmptyEpoch() method from the NDB API.

    Prior to NDB 7.5.4, the value of this vairable served as a threshold for the number of epochs to be behind before reporting binary log status. In these previous releases, a value of 3—the default—means that if the difference between which epoch has been received from the storage nodes and which epoch has been applied to the binary log is 3 or more, a status message is then sent to the cluster log.

  • ndb_report_thresh_binlog_mem_usage

    Table 5.65 Type and value information for ndb_report_thresh_binlog_mem_usage

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_report_thresh_binlog_mem_usage

    Yes Yes No
    Yes Global Yes
    NDB 7.5 integer 10 / 0 - 10

    DESCRIPTION: This is a threshold on the percentage of free memory remaining before reporting binary log status


    This is a threshold on the percentage of free memory remaining before reporting binary log status. For example, a value of 10 (the default) means that if the amount of available memory for receiving binary log data from the data nodes falls below 10%, a status message is sent to the cluster log.

  • slave_allow_batching

    Table 5.66 Type and value information for slave_allow_batching

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    slave_allow_batching

    Yes Yes No
    Yes Global Yes
    NDB 7.5 boolean off

    DESCRIPTION: Turns update batching on and off for a replication slave


    Whether or not batched updates are enabled on NDB Cluster replication slaves.

    Currently, this variable is available for mysqld only as supplied with NDB Cluster or built from the NDB Cluster sources. For more information, see Section 8.6, “Starting NDB Cluster Replication (Single Replication Channel)”.

  • ndb_show_foreign_key_mock_tables

    Table 5.67 Type and value information for ndb_show_foreign_key_mock_tables

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_show_foreign_key_mock_tables

    Yes Yes No
    Yes Global Yes
    NDB 7.5 boolean OFF

    DESCRIPTION: Show the mock tables used to support foreign_key_checks=0.


    Show the mock tables used by NDB to support foreign_key_checks=0. When this is enabled, extra warnings are shown when creating and dropping the tables. The real (internal) name of the table can be seen in the output of SHOW CREATE TABLE.

  • ndb_slave_conflict_role

    Table 5.68 Type and value information for ndb_slave_conflict_role

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_slave_conflict_role

    Yes Yes No
    Yes Global Yes
    NDB 7.5 enumeration NONE / NONE, PRIMARY, SECONDARY, PASS

    DESCRIPTION: Role for slave to play in conflict detection and resolution. Value is one of PRIMARY, SECONDARY, PASS, or NONE (default). Can be changed only when slave SQL thread is stopped. See documentation for further information.


    Determine the role of this SQL node (and NDB Cluster ) in a circular (active-active) replication setup. ndb_slave_conflict_role can take any one of the values PRIMARY, SECONDARY, PASS, or NULL (the default). The slave SQL thread must be stopped before you can change ndb_slave_conflict_role. In addition, it is not possible to change directly between PASS and either of PRIMARY or SECONDARY directly; in such cases, you must ensure that the SQL thread is stopped, then execute SET @@GLOBAL.ndb_slave_conflict_role = 'NONE' first.

    For more information, see Section 8.11, “NDB Cluster Replication Conflict Resolution”.

  • ndb_table_no_logging

    Table 5.69 Type and value information for ndb_table_no_logging

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_table_no_logging

    No Yes No
    No Session Yes
    NDB 7.5 boolean FALSE

    DESCRIPTION: NDB tables created when this setting is enabled are not checkpointed to disk (although table schema files are created). The setting in effect when the table is created with or altered to use NDBCLUSTER persists for the lifetime of the table.


    When this variable is set to ON or 1, it causes NDB tables not to be checkpointed to disk. More specifically, this setting applies to tables which are created or altered using ENGINE NDB when ndb_table_no_logging is enabled, and continues to apply for the lifetime of the table, even if ndb_table_no_logging is later changed. Suppose that A, B, C, and D are tables that we create (and perhaps also alter), and that we also change the setting for ndb_table_no_logging as shown here:

    SET @@ndb_table_no_logging = 1;
    CREATE TABLE A ... ENGINE NDB;
    CREATE TABLE B ... ENGINE MYISAM;
    CREATE TABLE C ... ENGINE MYISAM;
    ALTER TABLE B ENGINE NDB;
    SET @@ndb_table_no_logging = 0;
    CREATE TABLE D ... ENGINE NDB;
    ALTER TABLE C ENGINE NDB;
    SET @@ndb_table_no_logging = 1;
    

    After the previous sequence of events, tables A and B are not checkpointed; A was created with ENGINE NDB and B was altered to use NDB, both while ndb_table_no_logging was enabled. However, tables C and D are logged; C was altered to use NDB and D was created using ENGINE NDB, both while ndb_table_no_logging was disabled. Setting ndb_table_no_logging back to 1 or ON does not cause table C or D to be checkpointed.

    Note

    ndb_table_no_logging has no effect on the creation of NDB table schema files; to suppress these, use ndb_table_temporary instead.

  • ndb_table_temporary

    Table 5.70 Type and value information for ndb_table_temporary

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_table_temporary

    No Yes No
    No Session Yes
    NDB 7.5 boolean FALSE

    DESCRIPTION: NDB tables are not persistent on disk: no schema files are created and the tables are not logged


    When set to ON or 1, this variable causes NDB tables not to be written to disk: This means that no table schema files are created, and that the tables are not logged.

    Note

    Setting this variable currently has no effect. This is a known issue; see Bug #34036.

  • ndb_use_copying_alter_table

    Table 5.71 Type and value information for ndb_use_copying_alter_table

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_use_copying_alter_table

    No Yes No
    No Both No

    DESCRIPTION: Use copying ALTER TABLE operations in MySQL Cluster


    Forces NDB to use copying of tables in the event of problems with online ALTER TABLE operations. The default value is OFF.

  • ndb_use_exact_count

    Table 5.72 Type and value information for ndb_use_exact_count

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_use_exact_count

    No Yes No
    No Both Yes
    NDB 7.5 boolean ON
    5.1.47-ndb-7.1.8 boolean OFF

    DESCRIPTION: Use exact row count when planning queries


    Forces NDB to use a count of records during SELECT COUNT(*) query planning to speed up this type of query. The default value is OFF, which allows for faster queries overall.

  • ndb_use_transactions

    Table 5.73 Type and value information for ndb_use_transactions

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_use_transactions

    Yes Yes No
    Yes Both Yes
    NDB 7.5 boolean ON

    DESCRIPTION: Forces NDB to use a count of records during SELECT COUNT(*) query planning to speed up this type of query


    You can disable NDB transaction support by setting this variable's values to OFF (not recommended). The default is ON.

  • ndb_version

    Table 5.74 Type and value information for ndb_version

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_version

    No Yes No
    No Global No
    NDB 7.5 string

    DESCRIPTION: Shows build and NDB engine version as an integer.


    NDB engine version, as a composite integer.

  • ndb_version_string

    Table 5.75 Type and value information for ndb_version_string

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndb_version_string

    No Yes No
    No Global No
    NDB 7.5 string

    DESCRIPTION: Shows build information including NDB engine version in ndb-x.y.z format.


    NDB engine version in ndb-x.y.z format.

  • server_id_bits

    Table 5.76 Type and value information for server_id_bits

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    server_id_bits

    Yes Yes No
    Yes Global No
    NDB 7.5 integer 32 / 7 - 32

    DESCRIPTION: The effective value of server_id if the server was started with the --server-id-bits option set to a nondefault value.


    The effective value of server_id if the server was started with the --server-id-bits option set to a nondefault value.

    If the value of server_id greater than or equal to 2 to the power of server_id_bits, mysqld refuses to start.

    This system variable is supported only by NDB Cluster . server_id_bits is not supported by the standard MySQL Server.

  • transaction_allow_batching

    Table 5.77 Type and value information for transaction_allow_batching

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    transaction_allow_batching

    No Yes No
    No Session Yes
    NDB 7.5 boolean FALSE

    DESCRIPTION: Allows batching of statements within a transaction. Disable AUTOCOMMIT to use.


    When set to 1 or ON, this variable enables batching of statements within the same transaction. To use this variable, autocommit must first be disabled by setting it to 0 or OFF; otherwise, setting transaction_allow_batching has no effect.

    It is safe to use this variable with transactions that performs writes only, as having it enabled can lead to reads from the before image. You should ensure that any pending transactions are committed (using an explicit COMMIT if desired) before issuing a SELECT.

    Important

    transaction_allow_batching should not be used whenever there is the possibility that the effects of a given statement depend on the outcome of a previous statement within the same transaction.

    This variable is currently supported for NDB Cluster only.

The system variables in the following list all relate to the ndbinfo information database.

  • ndbinfo_database

    Table 5.78 Type and value information for ndbinfo_database

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndbinfo_database

    No Yes No
    No Global No
    NDB 7.5 string ndbinfo

    DESCRIPTION: The name used for the NDB information database; read only.


    Shows the name used for the NDB information database; the default is ndbinfo. This is a read-only variable whose value is determined at compile time; you can set it by starting the server using --ndbinfo-database=name, which sets the value shown for this variable but does not actually change the name used for the NDB information database.

  • ndbinfo_max_bytes

    Table 5.79 Type and value information for ndbinfo_max_bytes

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndbinfo_max_bytes

    Yes Yes No
    No Both Yes
    NDB 7.5 integer 0 / -

    DESCRIPTION: Used for debugging only.


    Used in testing and debugging only.

  • ndbinfo_max_rows

    Table 5.80 Type and value information for ndbinfo_max_rows

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndbinfo_max_rows

    Yes Yes No
    No Both Yes
    NDB 7.5 integer 10 / -

    DESCRIPTION: Used for debugging only.


    Used in testing and debugging only.

  • ndbinfo_offline

    Table 5.81 Type and value information for ndbinfo_offline

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndbinfo_offline

    No Yes No
    No Global Yes
    NDB 7.5 boolean OFF

    DESCRIPTION: Put the ndbinfo database into offline mode, in which no rows are returned from tables or views.


    Place the ndbinfo database into offline mode, in which tables and views can be opened even when they do not actually exist, or when they exist but have different definitions in NDB. No rows are returned from such tables (or views).

  • ndbinfo_show_hidden

    Table 5.82 Type and value information for ndbinfo_show_hidden

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndbinfo_show_hidden

    Yes Yes No
    No Both Yes
    NDB 7.5 boolean OFF

    DESCRIPTION: Whether to show ndbinfo internal base tables in the mysql client. The default is OFF.


    Whether or not the ndbinfo database's underlying internal tables are shown in the mysql client. The default is OFF.

  • ndbinfo_table_prefix

    Table 5.83 Type and value information for ndbinfo_table_prefix

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndbinfo_table_prefix

    Yes Yes No
    No Both Yes
    NDB 7.5 string ndb$

    DESCRIPTION: The prefix to use for naming ndbinfo internal base tables


    The prefix used in naming the ndbinfo database's base tables (normally hidden, unless exposed by setting ndbinfo_show_hidden). This is a read-only variable whose default value is ndb$. You can start the server with the --ndbinfo-table-prefix option, but this merely sets the variable and does not change the actual prefix used to name the hidden base tables; the prefix itself is determined at compile time.

  • ndbinfo_version

    Table 5.84 Type and value information for ndbinfo_version

    Command Line System Variable Status Variable
    Option File Scope Dynamic
    From Version Type Default, Range
    Notes

    ndbinfo_version

    No Yes No
    No Global No
    NDB 7.5 string

    DESCRIPTION: The version of the ndbinfo engine; read only.


    Shows the version of the ndbinfo engine in use; read-only.

5.3.8.3 NDB Cluster Status Variables

This section provides detailed information about MySQL server status variables that relate to NDB Cluster and the NDB storage engine. For status variables not specific to NDB Cluster , and for general information on using status variables, see Server Status Variables.

5.3.9 NDB Cluster TCP/IP Connections

TCP/IP is the default transport mechanism for all connections between nodes in an NDB Cluster . Normally it is not necessary to define TCP/IP connections; NDB Cluster automatically sets up such connections for all data nodes, management nodes, and SQL or API nodes.

To override the default connection parameters, it is necessary to define a connection using one or more [tcp] sections in the config.ini file. Each [tcp] section explicitly defines a TCP/IP connection between two NDB Cluster nodes, and must contain at a minimum the parameters NodeId1 and NodeId2, as well as any connection parameters to override.

It is also possible to change the default values for these parameters by setting them in the [tcp default] section.

Important

Any [tcp] sections in the config.ini file should be listed last, following all other sections in the file. However, this is not required for a [tcp default] section. This requirement is a known issue with the way in which the config.ini file is read by the NDB Cluster management server.

Connection parameters which can be set in [tcp] and [tcp default] sections of the config.ini file are listed here:

  • NodeId1

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0numeric[none]...N

    To identify a connection between two nodes it is necessary to provide their node IDs in the [tcp] section of the configuration file as the values of NodeId1 and NodeId2. These are the same unique Id values for each of these nodes as described in Section 5.3.7, “Defining SQL and Other API Nodes in an NDB Cluster”.

  • NodeId2

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0numeric[none]...N

    To identify a connection between two nodes it is necessary to provide their node IDs in the [tcp] section of the configuration file as the values of NodeId1 and NodeId2. These are the same unique Id values for each of these nodes as described in Section 5.3.7, “Defining SQL and Other API Nodes in an NDB Cluster”.

  • HostName1

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0name or IP address[none]...N

    The HostName1 and HostName2 parameters can be used to specify specific network interfaces to be used for a given TCP connection between two nodes. The values used for these parameters can be host names or IP addresses.

  • HostName2

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0name or IP address[none]...N

    The HostName1 and HostName2 parameters can be used to specify specific network interfaces to be used for a given TCP connection between two nodes. The values used for these parameters can be host names or IP addresses.

  • OverloadLimit

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0bytes00 - 4294967039 (0xFFFFFEFF)N

    When more than this many unsent bytes are in the send buffer, the connection is considered overloaded.

    This parameter can be used to determine the amount of unsent data that must be present in the send buffer before the connection is considered overloaded. See Section 5.3.13, “Configuring NDB Cluster Send Buffer Parameters”, for more information.

  • SendBufferMemory

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned2M256K - 4294967039 (0xFFFFFEFF)N

    TCP transporters use a buffer to store all messages before performing the send call to the operating system. When this buffer reaches 64KB its contents are sent; these are also sent when a round of messages have been executed. To handle temporary overload situations it is also possible to define a bigger send buffer.

    If this parameter is set explicitly, then the memory is not dedicated to each transporter; instead, the value used denotes the hard limit for how much memory (out of the total available memory—that is, TotalSendBufferMemory) that may be used by a single transporter. For more information about configuring dynamic transporter send buffer memory allocation in NDB Cluster , see Section 5.3.13, “Configuring NDB Cluster Send Buffer Parameters”.

    The default size of the send buffer is 2MB, which is the size recommended in most situations. The minimum size is 64 KB; the theoretical maximum is 4 GB.

  • SendSignalId

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0boolean[see text]true, falseN

    To be able to retrace a distributed message datagram, it is necessary to identify each message. When this parameter is set to Y, message IDs are transported over the network. This feature is disabled by default in production builds, and enabled in -debug builds.

  • Checksum

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0booleanfalsetrue, falseN

    This parameter is a boolean parameter (enabled by setting it to Y or 1, disabled by setting it to N or 0). It is disabled by default. When it is enabled, checksums for all messages are calculated before they placed in the send buffer. This feature ensures that messages are not corrupted while waiting in the send buffer, or by the transport mechanism.

  • PortNumber (OBSOLETE)

    This parameter formerly specified the port number to be used for listening for connections from other nodes. It is now deprecated (and removed in NDB Cluster 7.5); use the ServerPort data node configuration parameter for this purpose instead (Bug #77405, Bug #21280456).

  • ReceiveBufferMemory

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0bytes2M16K - 4294967039 (0xFFFFFEFF)N

    Specifies the size of the buffer used when receiving data from the TCP/IP socket.

    The default value of this parameter is 2MB. The minimum possible value is 16KB; the theoretical maximum is 4GB.

  • TCP_RCV_BUF_SIZE

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned00 - 2GN

    Determines the size of the receive buffer set during TCP transporter initialization. The default and minimum value is 0, which allows the operating system or platform to set this value. The default is recommended for most common usage cases.

  • TCP_SND_BUF_SIZE

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned00 - 2GN

    Determines the size of the send buffer set during TCP transporter initialization. The default and minimum value is 0, which allows the operating system or platform to set this value. The default is recommended for most common usage cases.

  • TCP_MAXSEG_SIZE

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned00 - 2GN

    Determines the size of the memory set during TCP transporter initialization. The default is recommended for most common usage cases.

  • 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).

  • Group

    When ndb_optimized_node_selection is enabled, node proximity is used in some cases to select which node to connect to. This parameter can be used to influence proximity by setting it to a lower value, which is interpreted as closer. See the description of the system variable for more information.

5.3.10 NDB Cluster TCP/IP Connections Using Direct Connections

Setting up a cluster using direct connections between data nodes requires specifying explicitly the crossover IP addresses of the data nodes so connected in the [tcp] section of the cluster config.ini file.

In the following example, we envision a cluster with at least four hosts, one each for a management server, an SQL node, and two data nodes. The cluster as a whole resides on the 172.23.72.* subnet of a LAN. In addition to the usual network connections, the two data nodes are connected directly using a standard crossover cable, and communicate with one another directly using IP addresses in the 1.1.0.* address range as shown:

# Management Server
[ndb_mgmd]
Id=1
HostName=172.23.72.20
# SQL Node
[mysqld]
Id=2
HostName=172.23.72.21
# Data Nodes
[ndbd]
Id=3
HostName=172.23.72.22
[ndbd]
Id=4
HostName=172.23.72.23
# TCP/IP Connections
[tcp]
NodeId1=3
NodeId2=4
HostName1=1.1.0.1
HostName2=1.1.0.2

The HostName1 and HostName2 parameters are used only when specifying direct connections.

The use of direct TCP connections between data nodes can improve the cluster's overall efficiency by enabling the data nodes to bypass an Ethernet device such as a switch, hub, or router, thus cutting down on the cluster's latency.

Note

To take the best advantage of direct connections in this fashion with more than two data nodes, you must have a direct connection between each data node and every other data node in the same node group.

5.3.11 NDB Cluster Shared-Memory Connections

NDB Cluster attempts to use the shared memory transporter and configure it automatically where possible. [shm] sections in the config.ini file explicitly define shared-memory connections between nodes in the cluster. When explicitly defining shared memory as the connection method, it is necessary to define at least NodeId1, NodeId2, and ShmKey. All other parameters have default values that should work well in most cases.

Important

SHM functionality is considered experimental only. It is not officially supported in any current NDB Cluster release, and testing results indicate that SHM performance is not appreciably greater than when using TCP/IP for the transporter.

For these reasons, you must determine for yourself or by using our free resources (forums, mailing lists) whether SHM can be made to work correctly in your specific case.

  • NodeId1

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0numeric[none]...N

    To identify a connection between two nodes it is necessary to provide node identifiers for each of them, as NodeId1 and NodeId2.

  • NodeId2

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0numeric[none]...N

    To identify a connection between two nodes it is necessary to provide node identifiers for each of them, as NodeId1 and NodeId2.

  • HostName1

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0name or IP address[none]...N

    The HostName1 and HostName2 parameters can be used to specify specific network interfaces to be used for a given SHM connection between two nodes. The values used for these parameters can be host names or IP addresses.

  • HostName2

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0name or IP address[none]...N

    The HostName1 and HostName2 parameters can be used to specify specific network interfaces to be used for a given SHM connection between two nodes. The values used for these parameters can be host names or IP addresses.

  • OverloadLimit

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0bytes00 - 4294967039 (0xFFFFFEFF)N

    When more than this many unsent bytes are in the send buffer, the connection is considered overloaded.

    This parameter can be used to determine the amount of unsent data that must be present in the send buffer before the connection is considered overloaded. See Section 5.3.13, “Configuring NDB Cluster Send Buffer Parameters”, for more information.

  • ShmKey

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned[none]0 - 4294967039 (0xFFFFFEFF)N

    When setting up shared memory segments, a node ID, expressed as an integer, is used to identify uniquely the shared memory segment to use for the communication. There is no default value.

  • ShmSize

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0bytes1M64K - 4294967039 (0xFFFFFEFF)N

    Each SHM connection has a shared memory segment where messages between nodes are placed by the sender and read by the reader. The size of this segment is defined by ShmSize. The default value is 1MB.

  • SendSignalId

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0booleanfalsetrue, falseN

    To retrace the path of a distributed message, it is necessary to provide each message with a unique identifier. Setting this parameter to Y causes these message IDs to be transported over the network as well. This feature is disabled by default in production builds, and enabled in -debug builds.

  • Checksum

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0booleantruetrue, falseN

    This parameter is a boolean (Y/N) parameter which is disabled by default. When it is enabled, checksums for all messages are calculated before being placed in the send buffer.

    This feature prevents messages from being corrupted while waiting in the send buffer. It also serves as a check against data being corrupted during transport.

  • SigNum

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned[none]0 - 4294967039 (0xFFFFFEFF)N

    When using the shared memory transporter, a process sends an operating system signal to the other process when there is new data available in the shared memory. Should that signal conflict with an existing signal, this parameter can be used to change it. This is a possibility when using SHM due to the fact that different operating systems use different signal numbers.

    The default value of SigNum is 0; therefore, it must be set to avoid errors in the cluster log when using the shared memory transporter. Typically, this parameter is set to 10 in the [shm default] section of the config.ini file.

5.3.12 SCI Transport Connections in NDB Cluster

[sci] sections in the config.ini file explicitly define SCI (Scalable Coherent Interface) connections between cluster nodes. Using SCI transporters in NDB Cluster requires specialized hardware as well as specially-built MySQL binaries; compiling such binaries is not supported using an NDB 7.2 or later distribution.

The following parameters are present in NDB source code as well as the output of ndb_config and other NDB programs, but are nonfunctional in NDB 7.2 and later.

  • NodeId1

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0numeric[none]...N

    To identify a connection between two nodes it is necessary to provide node identifiers for each of them, as NodeId1 and NodeId2.

  • NodeId2

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0numeric[none]...N

    To identify a connection between two nodes it is necessary to provide node identifiers for each of them, as NodeId1 and NodeId2.

  • Host1SciId0

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned[none]0 - 4294967039 (0xFFFFFEFF)N

    This identifies the SCI node ID on the first Cluster node (identified by NodeId1).

  • Host1SciId1

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned00 - 4294967039 (0xFFFFFEFF)N

    It is possible to set up SCI Transporters for failover between two SCI cards which then should use separate networks between the nodes. This identifies the node ID and the second SCI card to be used on the first node.

  • Host2SciId0

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned[none]0 - 4294967039 (0xFFFFFEFF)N

    This identifies the SCI node ID on the second Cluster node (identified by NodeId2).

  • Host2SciId1

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned00 - 4294967039 (0xFFFFFEFF)N

    When using two SCI cards to provide failover, this parameter identifies the second SCI card to be used on the second node.

  • HostName1

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0name or IP address[none]...N

    The HostName1 and HostName2 parameters can be used to specify specific network interfaces to be used for a given SCI connection between two nodes. The values used for these parameters can be host names or IP addresses.

  • HostName2

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0name or IP address[none]...N

    The HostName1 and HostName2 parameters can be used to specify specific network interfaces to be used for a given SCI connection between two nodes. The values used for these parameters can be host names or IP addresses.

  • SharedBufferSize

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned10M64K - 4294967039 (0xFFFFFEFF)N

    Each SCI transporter has a shared memory segment used for communication between the two nodes. Setting the size of this segment to the default value of 1MB should be sufficient for most applications. Using a smaller value can lead to problems when performing many parallel inserts; if the shared buffer is too small, this can also result in a crash of the ndbd process.

  • SendLimit

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0unsigned8K128 - 32KN

    A small buffer in front of the SCI media stores messages before transmitting them over the SCI network. By default, this is set to 8KB. Our benchmarks show that performance is best at 64KB but 16KB reaches within a few percent of this, and there was little if any advantage to increasing it beyond 8KB.

  • SendSignalId

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0booleantruetrue, falseN

    To trace a distributed message it is necessary to identify each message uniquely. When this parameter is set to Y, message IDs are transported over the network. This feature is disabled by default in production builds, and enabled in -debug builds.

  • Checksum

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0booleanfalsetrue, falseN

    This parameter is a boolean value, and is disabled by default. When Checksum is enabled, checksums are calculated for all messages before they are placed in the send buffer. This feature prevents messages from being corrupted while waiting in the send buffer. It also serves as a check against data being corrupted during transport.

  • OverloadLimit

    Effective VersionType/UnitsDefaultRange/ValuesRestart Type
    NDB 7.5.0bytes00 - 4294967039 (0xFFFFFEFF)N

    When more than this many unsent bytes are in the send buffer, the connection is considered overloaded. See Section 5.3.13, “Configuring NDB Cluster Send Buffer Parameters”, for more information.

5.3.13 Configuring NDB Cluster Send Buffer Parameters

The NDB kernel employs a unified send buffer whose memory is allocated dynamically from a pool shared by all transporters. This means that the size of the send buffer can be adjusted as necessary. Configuration of the unified send buffer can accomplished by setting the following parameters:

  • TotalSendBufferMemory.  This parameter can be set for all types of NDB Cluster nodes—that is, it can be set in the [ndbd], [mgm], and [api] (or [mysql]) sections of the config.ini file. It represents the total amount of memory (in bytes) to be allocated by each node for which it is set for use among all configured transporters. If set, its minimum is 256KB; the maximum is 4294967039.

    To be backward-compatible with existing configurations, this parameter takes as its default value the sum of the maximum send buffer sizes of all configured transporters, plus an additional 32KB (one page) per transporter. The maximum depends on the type of transporter, as shown in the following table:

    TransporterMaximum Send Buffer Size (bytes)
    TCPSendBufferMemory (default = 2M)
    SCISendLimit (default = 8K) plus 16K
    SHM20K

    This enables existing configurations to function in close to the same way as they did with NDB Cluster 6.3 and earlier, with the same amount of memory and send buffer space available to each transporter. However, memory that is unused by one transporter is not available to other transporters.

  • OverloadLimit.  This parameter is used in the config.ini file [tcp] section, and denotes the amount of unsent data (in bytes) that must be present in the send buffer before the connection is considered overloaded. When such an overload condition occurs, transactions that affect the overloaded connection fail with NDB API Error 1218 (Send Buffers overloaded in NDB kernel) until the overload status passes. The default value is 0, in which case the effective overload limit is calculated as SendBufferMemory * 0.8 for a given connection. The maximum value for this parameter is 4G.

  • SendBufferMemory.  This value denotes a hard limit for the amount of memory that may be used by a single transporter out of the entire pool specified by TotalSendBufferMemory. However, the sum of SendBufferMemory for all configured transporters may be greater than the TotalSendBufferMemory that is set for a given node. This is a way to save memory when many nodes are in use, as long as the maximum amount of memory is never required by all transporters at the same time.

  • ReservedSendBufferMemory.  Removed in NDB 7.5.2.

    Prior to NDB 7.5.2, this data node parameter was present, but was not actually used (Bug #77404, Bug #21280428).

5.4 Using High-Speed Interconnects with NDB Cluster

Even before design of NDBCLUSTER began in 1996, it was evident that one of the major problems to be encountered in building parallel databases would be communication between the nodes in the network. For this reason, NDBCLUSTER was designed from the very beginning to permit the use of a number of different data transport mechanisms. In this Manual, we use the term transporter for these.

The NDB Cluster codebase provides for four different transporters:

Most users today employ TCP/IP over Ethernet because it is ubiquitous. TCP/IP is also by far the best-tested transporter for use with NDB Cluster.

We are working to make sure that communication with the ndbd process is made in chunks that are as large as possible because this benefits all types of data transmission.