Documentation Home
MySQL 5.6 Reference Manual
Related Documentation Download this Manual
PDF (US Ltr) - 31.4Mb
PDF (A4) - 31.5Mb
PDF (RPM) - 30.6Mb
EPUB - 7.8Mb
HTML Download (TGZ) - 7.6Mb
HTML Download (Zip) - 7.6Mb
HTML Download (RPM) - 6.5Mb
Eclipse Doc Plugin (TGZ) - 8.3Mb
Eclipse Doc Plugin (Zip) - 10.2Mb
Man Pages (TGZ) - 185.3Kb
Man Pages (Zip) - 298.0Kb
Info (Gzip) - 2.9Mb
Info (Zip) - 2.9Mb
Excerpts from this Manual

MySQL 5.6 Reference Manual  /  ...  /  Options Common to NDB Cluster Programs — Options Common to NDB Cluster Programs

18.4.28 Options Common to NDB Cluster Programs — Options Common to NDB Cluster Programs

All NDB Cluster programs accept the options described in this section, with the following exceptions:


Users of earlier NDB Cluster versions should note that some of these options have been changed to make them consistent with one another, and also with mysqld. You can use the --help option with any NDB Cluster program—with the exception of ndb_print_backup_file, ndb_print_schema_file, and ndb_print_sys_file—to view a list of the options which the program supports.

The options in the following table are common to all NDB Cluster executables (except those noted previously in this section).

Table 18.102 This table describes command-line options common to all MySQL Cluster programs

Format Description Added or Removed




Display help message and exit

All MySQL 5.6 based releases


Directory where character sets are installed

All MySQL 5.6 based releases


Set the number of times to retry a connection before giving up

ADDED: NDB 7.4.9


Time to wait between attempts to contact a management server, in seconds

ADDED: NDB 7.4.9


Write core on errors (defaults to TRUE in debug builds)

All MySQL 5.6 based releases


Enable output from debug calls. Can be used only for versions compiled with debugging enabled

All MySQL 5.6 based releases




Set connection string for connecting to ndb_mgmd. Syntax: [nodeid=<id>;][host=]<hostname>[:<port>]. Overrides entries specified in NDB_CONNECTSTRING or my.cnf.

All MySQL 5.6 based releases


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

All MySQL 5.6 based releases


Set node id for this node

All MySQL 5.6 based releases


Select nodes for transactions in a more optimal way

All MySQL 5.6 based releases



Output version information and exit

All MySQL 5.6 based releases

For options specific to individual NDB Cluster programs, see Section 18.4, “NDB Cluster Programs”.

See Section, “MySQL Server Options for NDB Cluster”, for mysqld options relating to NDB Cluster.

  • --help, --usage, -?

    Command-Line Format--help

    Prints a short list with descriptions of the available command options.

  • --character-sets-dir=name

    Command-Line Format--character-sets-dir=dir_name
    Permitted ValuesTypedirectory name

    Tells the program where to find character set information.

  • --ndb-connectstring=connection_string, --connect-string=connection_string, -c connection_string

    Command-Line Format--ndb-connectstring=connectstring
    Permitted ValuesTypestring

    This option takes an NDB Cluster connection string that specifies the management server for the application to connect to, as shown here:

    shell> ndbd --ndb-connectstring="nodeid=2;"

    For more information, see Section, “NDB Cluster Connection Strings”.

  • --connect-retries=#

    Command-Line Format--connect-retries=#
    Permitted Values (>= 5.6.28-ndb-7.4.9)Typenumeric
    Min Value0
    Max Value4294967295

    This option specifies the number of times following the first attempt to retry a connection before giving up (the client always tries the connection at least once). The length of time to wait per attempt is set using --connect-retry-delay.


    When used with ndb_mgm, this option has 3 as its default. See Section 18.4.5, “ndb_mgm — The NDB Cluster Management Client”, for more information.

    This option was added in NDB 7.4.9.

  • --connect-retry-delay=#

    Command-Line Format--connect-retry-delay=#
    Permitted Values (>= 5.6.28-ndb-7.4.9)Typenumeric
    Min Value0
    Max Value4294967295

    This option specifies the length of time to wait per attempt a connection before giving up. The number of times to try connecting is set by --connect-retries.

    This option was added in NDB 7.4.9.

  • --core-file

    Command-Line Format--core-file
    Permitted ValuesTypeboolean

    Write a core file if the program dies. The name and location of the core file are system-dependent. (For NDB Cluster programs nodes running on Linux, the default location is the program's working directory—for a data node, this is the node's DataDir.) For some systems, there may be restrictions or limitations; for example, it might be necessary to execute ulimit -c unlimited before starting the server. Consult your system documentation for detailed information.

    If NDB Cluster was built using the --debug option for configure, then --core-file is enabled by default. For regular builds, --core-file is disabled by default.

  • --debug[=options]

    Command-Line Format--debug=options
    Permitted ValuesTypestring

    This option can be used only for versions compiled with debugging enabled. It is used to enable output from debug calls in the same manner as for the mysqld process.

  • --ndb-mgmd-host=host[:port]

    Command-Line Format--ndb-mgmd-host=host[:port]
    Permitted ValuesTypestring

    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.

  • --ndb-nodeid=#

    Command-Line Format--ndb-nodeid=#
    Permitted ValuesTypenumeric

    Sets this node's NDB Cluster node ID. The range of permitted values depends on the node's type (data, management, or API) and the NDB Cluster software version. See Section, “Limits and Differences of NDB Cluster from Standard MySQL Limits”, for more information.

  • --ndb-optimized-node-selection

    Command-Line Format--ndb-optimized-node-selection
    Permitted ValuesTypeboolean

    Optimize selection of nodes for transactions. Enabled by default.

  • --version, -V

    Command-Line Format--version

    Prints the NDB Cluster version number of the executable. The version number is relevant because not all versions can be used together, and the NDB Cluster startup process verifies that the versions of the binaries being used can co-exist in the same cluster. This is also important when performing an online (rolling) software upgrade or downgrade of NDB Cluster.

    See Section 18.5.5, “Performing a Rolling Restart of an NDB Cluster”), for more information.

User Comments
Sign Up Login You must be logged in to post a comment.