ndb_config

SYNOPSIS
       ndb_config options

DESCRIPTION
       This tool extracts configuration information for data nodes, SQL nodes,
       and API nodes from a cluster management node (and possibly its
       config.ini file).

       Usage:

          ndb_config options

       The options available for this utility differ somewhat from those used
       with the other utilities, and so are listed in their entirety in the
       next section, followed by some examples.

       Options:

       o  --usage, --help, or -?

          +--------------------+--------+
          |Command Line Format | --help |
          +--------------------+--------+
          Causes ndb_config to print a list of available options, and then
          exit.

       o  --version, -V

          +--------------------+----+
          |Command Line Format | -V |
          +--------------------+----+
          Causes ndb_config to print a version information string, and then
          exit.

       o  --ndb-connectstring=connect_string

          +--------------------+--------------------------+
          |Command Line Format | --ndb-connectstring=name |
          +--------------------+--------------------------+
          |Value Set           | [nested table]*          |
          +--------------------+--------------------------+

       *[nested table]
       +--------+----------------+
       |Type    | string         |
       +--------+----------------+
       |Default | localhost:1186 |
       +--------+----------------+
       Specifies the connectstring to use in connecting to the management
       server. The format for the connectstring is the same as described in
       Section 17.3.4.2, "The MySQL Cluster Connectstring", and defaults to
       localhost:1186.

          +--------------------+-----------------+
          |Command Line Format | --query=string  |
          +--------------------+-----------------+
          |Value Set           | [nested table]* |
          +--------------------+-----------------+

       *[nested table]
       +--------+--------+
       |Type    | string |
       +--------+--------+
       |Default |        |
       +--------+--------+
       This is a comma-delimited list of query options -- that is, a list of
       one or more node attributes to be returned. These include id (node ID),
       type (node type -- that is, ndbd, mysqld, or ndb_mgmd), and any
       configuration parameters whose values are to be obtained.

       For example, --query=id,type,indexmemory,datamemory would return the
       node ID, node type, DataMemory, and IndexMemory for each node.

       Note
       If a given parameter is not applicable to a certain type of node, than
       an empty string is returned for the corresponding value. See the
       examples later in this section for more information.

       o  --host=hostname

          +--------------------+-----------------+
          |Command Line Format | --host=name     |
          +--------------------+-----------------+
          |Value Set           | [nested table]* |
          +--------------------+-----------------+

       *[nested table]
       +--------+--------+
       |Type    | string |
       +--------+--------+
       |Default |        |
       +--------+--------+
       Specifies the host name of the node for which configuration information
       is to be obtained.

       o  --id=node_id, --nodeid=node_id

          +--------------------+-----------------+
          |Command Line Format | --ndb-nodeid=#  |
          +--------------------+-----------------+
          |Value Set           | [nested table]* |
          +--------------------+-----------------+

       *[nested table]
       +--------+---------+
       |Type    | numeric |
       +--------+---------+

       *[nested table]
       +--------+---------+
       |Type    | boolean |
       +--------+---------+
       |Default | FALSE   |
       +--------+---------+
       (Tells ndb_config to print information from parameters defined in
       [ndbd] sections only. Currently, using this option has no affect, since
       these are the only values checked, but it may become possible in future
       to query parameters set in [tcp] and other sections of cluster
       configuration files.)

       o  --type=node_type

          +--------------------+-----------------+
          |Command Line Format | --type=name     |
          +--------------------+-----------------+
          |Value Set           | [nested table]* |
          +--------------------+-----------------+

       *[nested table]
       +-------------+------------------------+
       |Type         | enumeration            |
       +-------------+------------------------+
       |Default      |                        |
       +-------------+------------------------+
       |Valid Values | ndbd, mysqld, ndb_mgmd |
       +-------------+------------------------+
       Filters results so that only configuration values applying to nodes of
       the specified node_type (ndbd, mysqld, or ndb_mgmd) are returned.

       o  --fields=delimiter, -f delimiter

          +--------------------+-----------------+
          |Command Line Format | --fields=string |
          +--------------------+-----------------+
          |Value Set           | [nested table]* |
          +--------------------+-----------------+

       *[nested table]
       +--------+--------+
       |Type    | string |
       +--------+--------+
       |Default |        |
       +--------+--------+
       Specifies a delimiter string used to separate the fields in the result.
       The default is "," (the comma character).

       Note
       If the delimiter contains spaces or escapes (such as \n for the
       linefeed character), then it must be quoted.

       o  --rows=separator, -r separator
       |Default |        |
       +--------+--------+
       Specifies a separator string used to separate the rows in the result.
       The default is a space character.

       Note
       If the separator contains spaces or escapes (such as \n for the
       linefeed character), then it must be quoted.


       Examples:

       1. To obtain the node ID and type of each node in the cluster:

          shell> ./ndb_config --query=id,type --fields=':' --rows='\n'
          1:ndbd
          2:ndbd
          3:ndbd
          4:ndbd
          5:ndb_mgmd
          6:mysqld
          7:mysqld
          8:mysqld
          9:mysqld
       In this example, we used the --fields options to separate the ID and
       type of each node with a colon character (:), and the --rows options to
       place the values for each node on a new line in the output.

       2. To produce a connectstring that can be used by data, SQL, and API
          nodes to connect to the management server:

          shell> ./ndb_config --config-file=usr/local/mysql/cluster-data/config.ini --query=hostname,portnumber --fields=: --rows=, --type=ndb_mgmd
          192.168.0.179:1186

       3. This invocation of ndb_config checks only data nodes (using the
          --type option), and shows the values for each node's ID and host
          name, and its DataMemory, IndexMemory, and DataDir parameters:

          shell> ./ndb_config --type=ndbd --query=id,host,datamemory,indexmemory,datadir -f ' : ' -r '\n'
          1 : 192.168.0.193 : 83886080 : 18874368 : /usr/local/mysql/cluster-data
          2 : 192.168.0.112 : 83886080 : 18874368 : /usr/local/mysql/cluster-data
          3 : 192.168.0.176 : 83886080 : 18874368 : /usr/local/mysql/cluster-data
          4 : 192.168.0.119 : 83886080 : 18874368 : /usr/local/mysql/cluster-data
       In this example, we used the short options -f and -r for setting the
       field delimiter and row separator, respectively.

       4. To exclude results from any host except one in particular, use the
          --host option:

          shell> ./ndb_config --host=192.168.0.176 -f : -r '\n' -q id,type
          3:ndbd
          5:ndb_mgmd
       In this example, we also used the short form -q to determine the
       attributes to be queried.
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
       General Public License for more details.

       You should have received a copy of the GNU General Public License along
       with the program; if not, write to the Free Software Foundation, Inc.,
       51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see
       http://www.gnu.org/licenses/.

SEE ALSO
       For more information, please refer to the MySQL Reference Manual, which
       may already be installed locally and which is also available online at
       http://dev.mysql.com/doc/.

AUTHOR
       Sun Microsystems, Inc. (http://www.mysql.com/).



MySQL 5.0                         05/29/2009                     NDB_CONFIG(1)