Skip navigation links
MySQL 5.1 Reference Manual :: 17 MySQL Cluster NDB 6.X/7.X :: 17.4 MySQL Cluster Programs :: 17.4.23 Options Common to MySQL Cluster Programs
17.5 Management of MySQL Cluster »
Section Navigation      [Toggle]

17.4.23. Options Common to MySQL Cluster Programs

All MySQL Cluster programs (except for mysqld) take the options described in this section. Users of earlier MySQL Cluster versions should note that some of these options have been changed to make them consistent with one another as well as with mysqld. You can use the --help option with any MySQL Cluster program to view a list of the options which it supports.

The options in the following table are common to all MySQL Cluster executables.

Table 17.17. Common MySQL Cluster Command Line Options

Format Description Introduction Deprecated Removed
--character-sets-dir=name Directory where character sets are      
--ndb-connectstring=name Set connect string for connecting to ndb_mgmd. Syntax: [nodeid=<id>;][host=]<hostname>[:<port>]. Overrides specifying entries in NDB_CONNECTSTRING and my.cnf      
--core-file Write core on errors (defaults to TRUE in debug builds)      
--debug=options Enable output from debug calls. Can be used only for versions compiled with debugging enabled      
--execute=name Execute command and exit      
--help Display help message and exit      
--ndb-mgmd-host=name Set host and port for connecting to ndb_mgmd. Syntax: <hostname>[:<port>]. Overrides specifying entries in NDB_CONNECTSTRING and my.cnf      
--ndb-nodeid=# Set node id for this node      
--ndb-optimized-node-selection Select nodes for transactions in a more optimal way      
--ndb-shm Allow optimizing using shared memory connections when available (EXPERIMENTAL ONLY)      
-V Output version information and exit      

For options specific to individual MySQL Cluster programs, see Section 17.4, “MySQL Cluster Programs”.

See Section 17.3.4.2, “mysqld Command Options for MySQL Cluster”, for mysqld options relating to MySQL 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=name
      Permitted Values
    Type filename
    Default

    Tells the program where to find character set information.

  • --connect-string=connect_string, -c connect_string

    Command-Line Format --ndb-connectstring=name
      Permitted Values
    Type string
    Default localhost:1186

    connect_string sets the connectstring to the management server as a command option. 

    shell> ndbd --connect-string="nodeid=2;host=ndb_mgmd.mysql.com:1186"

    For more information, see Section 17.3.2.3, “The MySQL Cluster Connectstring”.

  • --core-file

    Command-Line Format --core-file
      Permitted Values
    Type boolean
    Default FALSE

    Write a core file if the program dies. The name and location of the core file are system-dependent. (For MySQL 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 MySQL 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 Values
    Type string
    Default d:t:O,/tmp/ndb_restore.trace

    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.

  • --execute=command, -e command

    Command-Line Format --execute=name

    Can be used to send a command to a Cluster executable from the system shell. For example, either of the following: 

    shell> ndb_mgm -e "SHOW"

    or 

    shell> ndb_mgm --execute="SHOW"

    is equivalent to 

    ndb_mgm> SHOW

    This is analogous to how the --execute or -e option works with the mysql command-line client. See Section 4.2.3.1, “Using Options on the Command Line”.

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

    Can be used to set the host and port number of the management server to connect to.

  • --ndb-nodeid=#

    Command-Line Format --ndb-nodeid=#
      Permitted Values
    Type numeric
    Default 0

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

  • --ndb-optimized-node-selection

    Command-Line Format --ndb-optimized-node-selection
      Permitted Values
    Type boolean
    Default TRUE

    Optimize selection of nodes for transactions. Enabled by default.

  • --version, -V

    Command-Line Format -V

    Prints the MySQL Cluster version number of the executable. The version number is relevant because not all versions can be used together, and the MySQL 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 MySQL Cluster. (See Section 17.2.6.1, “Performing a Rolling Restart of a MySQL Cluster”).