C.5 MySQL Server Option and Variable Reference for MySQL Cluster

Table C.9  MySQL Server Options and Variables for MySQL Cluster: MySQL Cluster NDB 7.3

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

Handler_discover

No No Yes
No Both No

DESCRIPTION: Number of times that tables have been discovered

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_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_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_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_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_meta_request_count_slave

No No Yes
No Global No

DESCRIPTION: Number of times thread has been blocked waiting for a metadata-based signal 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_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_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_bytes_sent_count_session

No No Yes
No Session No

DESCRIPTION: Amount of data (in bytes) sent to the data nodes in this client session.

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_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_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_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_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_trans_start_count

No No Yes
No Global No

DESCRIPTION: Number of transactions started 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_commit_count

No No Yes
No Global No

DESCRIPTION: Number of transactions committed 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_abort_count

No No Yes
No Global No

DESCRIPTION: Number of transactions aborted 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_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_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_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_uk_op_count_session

No No Yes
No Session No

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

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_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_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_table_scan_count_slave

No No Yes
No Global No

DESCRIPTION: Number of table scans that have been started, including scans of internal tables, 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_range_scan_count_session

No No Yes
No Session No

DESCRIPTION: Number of range scans that have been started 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_range_scan_count

No No Yes
No Global No

DESCRIPTION: Number of range scans that have been started 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_pruned_scan_count_slave

No No Yes
No Global No

DESCRIPTION: Number of scans that have been pruned to a single partition 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_scan_batch_count_session

No No Yes
No Session No

DESCRIPTION: Number of batches of rows received 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_scan_batch_count

No No Yes
No Global No

DESCRIPTION: Number of batches of rows received 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_read_row_count_slave

No No Yes
No Global No

DESCRIPTION: Total number of rows that have been read 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_trans_local_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_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_local_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_event_data_count_injector

No No Yes
No Global No

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

Ndb_api_event_data_count

No No Yes
No Global No

DESCRIPTION: Number of row change events received by this MySQL Server (SQL node).

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 binlog injector thread.

Ndb_api_event_nondata_count

No No Yes
No Global No

DESCRIPTION: Number of events received, other than row change events, by this MySQL Server (SQL node).

Ndb_api_event_bytes_count_injector

No No Yes
No Global No

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

Ndb_api_event_bytes_count

No No Yes
No Global No

DESCRIPTION: Number of bytes of events received by this MySQL Server (SQL node).

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_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_fn_epoch

No No Yes
No Global No

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

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_trans_row_conflict_count

No No Yes
No Global No

DESCRIPTION: Number of rows found to be in conflict by a transactional conflict function

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_conflict_trans_reject_count

No No Yes
No Global No

DESCRIPTION: Number of transactions rejected after being found in conflict by a transactional conflict function.

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_conflict_commit_count

No No Yes
No Global No

DESCRIPTION: Number of epoch transactions committed after requiring transactional conflict handling.

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_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_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_autoincrement_prefetch_sz

Yes Yes No
Yes Both Yes

DESCRIPTION: NDB auto-increment prefetch size

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_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-cluster-connection-pool

Yes Yes Yes
Yes Global No

DESCRIPTION: Number of connections to the cluster used by MySQL

ndb_join_pushdown

No Yes No
No Global No

DESCRIPTION: Enables pushing down of joins to data nodes

Ndb_execute_count

No No Yes
No Global No

DESCRIPTION: Provides the number of round trips to the NDB kernel made by operations

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_pruned_scan_count

No No Yes
No Global No

DESCRIPTION: Number of scans executed by NDB since the cluster was last started where partition pruning could be used

ndb-connectstring

Yes No No
Yes No

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

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_use_exact_count

No Yes No
No Both Yes

DESCRIPTION: Use exact row count when planning queries

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_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-orig

Yes Yes No
Yes Global No

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

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

Yes Yes No
Yes Global No

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

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-log-update-as-write

Yes Yes No
Yes Global Yes

DESCRIPTION: Toggles logging of updates on the master between updates (OFF) and writes (ON)

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_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-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_pushed_reads

No No Yes
No Global No

DESCRIPTION: Number of reads executed on the data nodes by pushed-down joins

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_dropped

No No Yes
No Global No

DESCRIPTION: Number of joins that API nodes have tried to push down, but failed

Ndb_pushed_queries_executed

No No Yes
No Global No

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

ndb-nodeid

Yes No Yes
Yes Global No

DESCRIPTION: MySQL Cluster node ID for this MySQL server

ndb-mgmd-host

Yes No No
Yes No

DESCRIPTION: Set the host (and port, if desired) for connecting to management 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_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

Yes No No
Yes No

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

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

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.

have_ndbcluster

No Yes No
No Global No

DESCRIPTION: Whether mysqld supports NDB Cluster tables (set by --ndbcluster option)

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_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_distribution

Yes Yes No
Yes Global Yes

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

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_index_stat_cache_entries

Yes No No
Yes No

DESCRIPTION: Sets the granularity of the statistics by determining the number of starting and ending keys

ndb_index_stat_enable

Yes No No
Yes No

DESCRIPTION: Use NDB index statistics in query optimization

ndb_index_stat_option

Yes No No
Yes No

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

ndb_index_stat_update_freq

Yes No No
Yes No

DESCRIPTION: How often to query data nodes instead of the statistics cache

ndb_optimized_node_selection

Yes No No
Yes No

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

ndb_report_thresh_binlog_epoch_slip

Yes No No
Yes No

DESCRIPTION: This is a threshold on the number of epochs to be behind before reporting binlog status

ndb_report_thresh_binlog_mem_usage

Yes No No
Yes No

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

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

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

Com_show_ndb_status

No No Yes
No Both No

DESCRIPTION: Count of SHOW NDB STATUS statements