Documentation Home
MySQL NDB Cluster 6.1-7.1


5.3.8.1 MySQL Server Options for MySQL Cluster

This section provides descriptions of mysqld server options relating to MySQL Cluster. For information about mysqld options not specific to MySQL 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 MySQL Cluster processes (ndbd, ndb_mgmd, and ndb_mgm), see Section 6.26, “Options Common to MySQL Cluster Programs — Options Common to MySQL 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, MySQL Cluster Programs.

  • --ndb-batch-size=#

    Table 5.10 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
    MySQL 5.1 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-blob-read-batch-bytes=bytes

    Table 5.11 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
    MySQL 5.1 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 MySQL 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.

    This option was introduced in MySQL Cluster NDB 7.0.21 and MySQL Cluster NDB 7.1.10.

  • --ndb-blob-write-batch-bytes=bytes

    Table 5.12 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
    MySQL 5.1 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 MySQL 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.

    This option was introduced in MySQL Cluster NDB 7.0.21 and MySQL Cluster NDB 7.1.10.

  • --ndb-cluster-connection-pool=#

    Table 5.13 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
    MySQL 5.1 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.

    This option was introduced in MySQL Cluster NDB 6.2.2. Beginning with MySQL Cluster NDB 6.2.16 and MySQL Cluster NDB 6.3.13, the value used for this option is available as a system variable (Bug #35573).

    Prior to MySQL Cluster NDB 7.0.23 and MySQL Cluster NDB 7.1.12, there was also a status variable corresponding to this option; however, the status variable was removed as redundant as of these versions. (Bug #60119)

  • --ndb-connectstring=connection_string

    Table 5.14 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
    MySQL 5.1 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, “MySQL Cluster Connection Strings”, for syntax.

  • --ndb-deferred-constraints=[0|1]

    Table 5.15 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
    MySQL 5.1 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 MySQL Cluster or MySQL Cluster Replication, and is intended primarily for use in testing.

    This option was added in MySQL Cluster NDB 7.0.28 and MySQL Cluster NDB 7.1.14.

  • --ndb-distribution=[KEYHASH|LINHASH]

    Table 5.16 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
    MySQL 5.1 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.17 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
    MySQL 5.1 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.18 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
    MySQL 5.1 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 MySQL 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.

  • --ndb-log-apply-status

    Table 5.19 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
    MySQL 5.1 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 MySQL 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 was added in MySQL Cluster NDB 7.0.21 and MySQL Cluster NDB 7.1.10. It has no effect unless the MySQL server is started with the --ndbcluster option.

  • --ndb-log-empty-epochs=[0|1]

    Table 5.20 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
    MySQL 5.1 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 (Bug #49559, Bug #11757505).

    Because --ndb-log-empty-epochs=1 causes the size of 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.

    This option was introduced in MySQL Cluster NDB 6.3.21 and MySQL Cluster NDB 6.4.1. Prior to MySQL Cluster NDB 6.3.33, MySQL Cluster NDB 7.0.14, and MySQL Cluster NDB 7.1.3, setting --ndb-log-empty-epochs=0 also caused no row to be written in ndb_binlog_index for an empty epoch.

  • --ndb-log-orig

    Table 5.21 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
    MySQL 5.1 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 that 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, “MySQL Cluster Replication Schema and Tables”.

  • --ndb-log-transaction-id

    Table 5.22 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
    MySQL 5.1 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 available beginning with MySQL Cluster NDB 7.1.16 (and is not supported in mainline MySQL Server 5.1). It is required to enable MySQL Cluster Replication conflict detection and resolution using the NDB$EPOCH_TRANS() function introduced in the same MySQL Cluster release.

    The default value is FALSE.

    For more information, see Section 8.11, “MySQL Cluster Replication Conflict Resolution”.

  • --ndb-nodeid=#

    Table 5.23 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 a MySQL Cluster.

    Prior to MySQL Cluster NDB 7.0.15 and MySQL Cluster NDB 7.1.4, this option can be used instead of specifying the node ID as part of the connection string or in the config.ini file, or permitting the cluster to determine an arbitrary node ID. If you use this option, then --ndb-nodeid must be specified before --ndb-connectstring. If --ndb-nodeid is used and a node ID is specified in the connection string, then the MySQL server cannot connect to the cluster.

    Beginning with MySQL Cluster NDB 7.0.15 and MySQL Cluster NDB 7.1.4, 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 (regardless of the MySQL Cluster version), 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 MySQL Cluster SQL nodes, see Section 5.3.7, “Defining SQL and Other API Nodes in a MySQL Cluster”.

  • --ndb_optimization_delay=milliseconds

    Table 5.24 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
    MySQL 5.1 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-transid-mysql-connection-map=state

    Table 5.25 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
    MySQL 5.1 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.

    This option was added in MySQL Cluster NDB 7.1.17.

  • --ndb-wait-connected=seconds

    Table 5.26 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
    MySQL 5.1 integer 0 / 0 - 31536000
    5.1.56-ndb-7.1.16, 5.1.56-ndb-7.0.27 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 MySQL Cluster management and data nodes to be established before accepting MySQL client connections. The time is specified in seconds.

    Prior to MySQL Cluster NDB 7.0.27 and MySQL Cluster NDB 7.1.16, there existed a hard-coded 30-second timeout (which was removed in these versions), and the default value for this option was 0. Starting with these releases, the default value is 30, and user-supplied values are handled correctly. (Bug #12543299)

  • --ndb-wait-setup=seconds

    Table 5.27 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
    MySQL 5.1 integer 15 / 0 - 31536000
    5.1.56-ndb-7.0.27, 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.

    Prior to MySQL Cluster NDB 7.0.27 and MySQL Cluster NDB 7.1.16, the default value for this option was 15. In these and later releases, the default value is 30. (Bug #12543299)

  • --server-id-bits=#

    Table 5.28 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
    MySQL 5.1 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 (MySQL 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 was added in MySQL Cluster NDB 7.0.17 and MySQL Cluster NDB 7.1.6; it is supported only in these and later releases of MySQL Cluster. It is not supported by the standard MySQL Server.

  • --skip-ndbcluster

    Table 5.29 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 MySQL Cluster”, for an example.