Author: jstephens
Date: 2006-10-03 13:01:19 +0200 (Tue, 03 Oct 2006)
New Revision: 3525
Log:
Minor markup fix to previous commit + reformat.
Modified:
trunk/refman-4.1/mysql-cluster.xml
trunk/refman-5.0/mysql-cluster.xml
trunk/refman-5.1/mysql-cluster.xml
Modified: trunk/refman-4.1/mysql-cluster.xml
===================================================================
--- trunk/refman-4.1/mysql-cluster.xml 2006-10-03 10:55:27 UTC (rev 3524)
+++ trunk/refman-4.1/mysql-cluster.xml 2006-10-03 11:01:19 UTC (rev 3525)
Changed blocks: 11, Lines Added: 307, Lines Deleted: 296; 23893 bytes
@@ -5825,7 +5825,7 @@
written to disk by the backup log and backup data buffers.
</para>
</listitem>
-
+
<listitem>
<indexterm>
<primary><literal>BackupMaxWriteSize</literal></primary>
@@ -5846,33 +5846,38 @@
</listitem>
</itemizedlist>
-
+
<para>
<emphasis role="bold">Important</emphasis>: When specifying
these parameters, the following relationships must hold true.
Otherwise, the data node will be unable to start.
</para>
-
+
<itemizedlist>
+
<listitem>
<para>
<literal>BackupDataBufferSize >= BackupWriteSize +
- 188KB</literal>
+ 188KB</literal>
</para>
</listitem>
+
<listitem>
<para>
- <literal>BackupLogBufferSize >= BackupWriteSize + 16KB</literal>
+ <literal>BackupLogBufferSize >= BackupWriteSize +
+ 16KB</literal>
</para>
</listitem>
+
<listitem>
<para>
- <literal>BackupMaxWriteSize >= BackupWriteSize</literal>
+ <literal>BackupMaxWriteSize >=
+ BackupWriteSize</literal>
</para>
</listitem>
+
</itemizedlist>
-
-
+
</section>
<section id="mysql-cluster-api-definition">
@@ -10111,7 +10116,7 @@
This stage sets up Cluster connections, establishes
inter-node communications, and starts Cluster heartbeats.
</para>
-
+
<para>
<emphasis role="bold">Note</emphasis>: When one or more
nodes hang in Phase 1 while the remaining node or nodes hang
@@ -12914,12 +12919,12 @@
<itemizedlist>
- <listitem>
- <para>
- <command>ndb_config</command>: Retrieves Cluster configuration
- options.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <command>ndb_config</command>: Retrieves Cluster configuration
+ options.
+ </para>
+ </listitem>
<listitem>
<para>
@@ -13129,229 +13134,234 @@
</listitem>
</itemizedlist>
-<section id="mysql-cluster-utilities-ndb-config">
- <title><command>ndb_config</command></title>
+ <section id="mysql-cluster-utilities-ndb-config">
- <para>
- <emphasis role="bold">Description</emphasis>: This tool extracts
- configuration information for data nodes, SQL nodes, and API nodes
- from a cluster management node (and possibly its
- <filename>config.ini</filename> file).
- </para>
+ <title><command>ndb_config</command></title>
- <para>
- <emphasis role="bold">Usage</emphasis>:
- </para>
+ <para>
+ <emphasis role="bold">Description</emphasis>: This tool extracts
+ configuration information for data nodes, SQL nodes, and API
+ nodes from a cluster management node (and possibly its
+ <filename>config.ini</filename> file).
+ </para>
+ <para>
+ <emphasis role="bold">Usage</emphasis>:
+ </para>
+
<programlisting>
ndb_config <replaceable>options</replaceable>
</programlisting>
-
- <para>
- The <replaceable>options</replaceable> available for this utility
- differ somewhat from those used with the other utilities, and so
- are listed in their entireity in the next section, followed by
- some examples.
- </para>
- <para>
- <emphasis role="bold">Options</emphasis>:
- </para>
-
- <itemizedlist>
-
- <listitem>
- <para>
- <option>--usage</option>, <option>--help</option>, or
- <option>-?</option>
- </para>
-
- <para>
- Causes <command>ndb_config</command> to print a list of
- available options, and then exit.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--version</option>, <option>-V</option>
- </para>
-
- <para>
- Causes <command>ndb_config</command> to print a version
- information string, and then exit.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--ndb-connectstring=<replaceable>connect_string</replaceable></option>
- </para>
-
- <para>
- Specifies the <literal>connectstring</literal> to use in
- connecting to the management server. The format for the
- connectstring is the same as described in
- <xref linkend="mysql-cluster-connectstring"/>, and defaults to
- <literal>localhost:1186</literal>.
- </para>
-
- <para>
- <emphasis role="bold">Note</emphasis>: The use of
- <option>-c</option> as a short version for this option is not
- currently supported with <command>ndb_config</command>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--config-file=<replaceable>path-to-file</replaceable></option>
- </para>
-
- <para>
- Gives the path to the management server's configuration file
- (<filename>config.ini</filename>). This may be a relative or
- absolute path. If the management node resides on a different
- host from the one on which <command>ndb_config</command> is
- invoked, then an absolute path must be used.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--query=<replaceable>query-options</replaceable></option>,
- <option>-q</option> <replaceable>query-options</replaceable>
- </para>
-
- <para>
- This is a comma-delimited list of <firstterm>query
+ <para>
+ The <replaceable>options</replaceable> available for this
+ utility differ somewhat from those used with the other
+ utilities, and so are listed in their entireity in the next
+ section, followed by some examples.
+ </para>
+
+ <para>
+ <emphasis role="bold">Options</emphasis>:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <option>--usage</option>, <option>--help</option>, or
+ <option>-?</option>
+ </para>
+
+ <para>
+ Causes <command>ndb_config</command> to print a list of
+ available options, and then exit.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--version</option>, <option>-V</option>
+ </para>
+
+ <para>
+ Causes <command>ndb_config</command> to print a version
+ information string, and then exit.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--ndb-connectstring=<replaceable>connect_string</replaceable></option>
+ </para>
+
+ <para>
+ Specifies the <literal>connectstring</literal> to use in
+ connecting to the management server. The format for the
+ connectstring is the same as described in
+ <xref linkend="mysql-cluster-connectstring"/>, and defaults
+ to <literal>localhost:1186</literal>.
+ </para>
+
+ <para>
+ <emphasis role="bold">Note</emphasis>: The use of
+ <option>-c</option> as a short version for this option is
+ not currently supported with <command>ndb_config</command>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--config-file=<replaceable>path-to-file</replaceable></option>
+ </para>
+
+ <para>
+ Gives the path to the management server's configuration file
+ (<filename>config.ini</filename>). This may be a relative or
+ absolute path. If the management node resides on a different
+ host from the one on which <command>ndb_config</command> is
+ invoked, then an absolute path must be used.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--query=<replaceable>query-options</replaceable></option>,
+ <option>-q</option> <replaceable>query-options</replaceable>
+ </para>
+
+ <para>
+ This is a comma-delimited list of <firstterm>query
options</firstterm> — that is, a list of one or more
- node attributes to be returned. These include
- <literal>id</literal> (node ID), type
- (node type — that is, <literal>ndbd</literal>,
- <literal>mysqld</literal>, or <literal>ndb_mgmd</literal>),
- and any configuration parameters whose values are to be
- obtained.
- </para>
-
- <para>
- For example,
- <option>--query=id,type,indexmemory,datamemory</option> would
- return the node ID, node type, <literal>DataMemory</literal>,
- and <literal>IndexMemory</literal> for each node.
- </para>
-
- <para>
- <emphasis role="bold">Note</emphasis>: 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.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--host=<replaceable>hostname</replaceable></option>
- </para>
-
- <para>
- Specifies the hostname of the node for which configuration
- information is to be obtained.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--id=<replaceable>node_id</replaceable></option>,
- <option>--nodeid=<replaceable>node_id</replaceable></option>
- </para>
-
- <para>
- Used to specify the node ID of the node for which
- configuration information is to be obtained.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--nodes</option>
- </para>
-
- <para>
- (Tells <command>ndb_config</command> to print information from
- parameters defined in <literal>[ndbd]</literal> 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 <literal>[tcp]</literal> and other
- sections of cluster configuration files.)
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--type=<replaceable>node_type</replaceable></option>
- </para>
-
- <para>
- Filters results so that only configuration values applying to
- nodes of the specified <replaceable>node_type</replaceable>
- (<literal>ndbd</literal>, <literal>mysqld</literal>, or
- <literal>ndb_mgmd</literal>) are returned.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--fields=<replaceable>delimiter</replaceable></option>,
- <option>-f</option> <replaceable>delimiter</replaceable>
- </para>
-
- <para>
- Specifies a <replaceable>delimiter</replaceable> string used
- to separate the fields in the result. The default is
- <quote><literal>,</literal></quote> (the comma character).
- </para>
-
- <para>
- <emphasis role="bold">Note</emphasis>: If the
- <replaceable>delimiter</replaceable> contains spaces or
- escapes (such as <literal>\n</literal> for the linefeed
- character), then it must be quoted.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--rows=<replaceable>separator</replaceable></option>,
- <option>-r</option> <replaceable>separator</replaceable>
- </para>
-
- <para>
- Specifies a <replaceable>separator</replaceable> string used
- to separate the rows in the result. The default is a space
- character.
- </para>
-
- <para>
- <emphasis role="bold">Note</emphasis>: If the
- <replaceable>separator</replaceable> contains spaces or
- escapes (such as <literal>\n</literal> for the linefeed
- character), then it must be quoted.
- </para>
- </listitem>
- </itemizedlist>
-
- <para>
- <emphasis role="bold">Examples</emphasis>:
- </para>
-
- <orderedlist>
- <listitem>
- <para>
- To obtain the node ID and type of each node in the cluster:
- </para>
-
+ node attributes to be returned. These include
+ <literal>id</literal> (node ID), type (node type —
+ that is, <literal>ndbd</literal>, <literal>mysqld</literal>,
+ or <literal>ndb_mgmd</literal>), and any configuration
+ parameters whose values are to be obtained.
+ </para>
+
+ <para>
+ For example,
+ <option>--query=id,type,indexmemory,datamemory</option>
+ would return the node ID, node type,
+ <literal>DataMemory</literal>, and
+ <literal>IndexMemory</literal> for each node.
+ </para>
+
+ <para>
+ <emphasis role="bold">Note</emphasis>: 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.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--host=<replaceable>hostname</replaceable></option>
+ </para>
+
+ <para>
+ Specifies the hostname of the node for which configuration
+ information is to be obtained.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--id=<replaceable>node_id</replaceable></option>,
+ <option>--nodeid=<replaceable>node_id</replaceable></option>
+ </para>
+
+ <para>
+ Used to specify the node ID of the node for which
+ configuration information is to be obtained.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--nodes</option>
+ </para>
+
+ <para>
+ (Tells <command>ndb_config</command> to print information
+ from parameters defined in <literal>[ndbd]</literal>
+ 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
+ <literal>[tcp]</literal> and other sections of cluster
+ configuration files.)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--type=<replaceable>node_type</replaceable></option>
+ </para>
+
+ <para>
+ Filters results so that only configuration values applying
+ to nodes of the specified
+ <replaceable>node_type</replaceable>
+ (<literal>ndbd</literal>, <literal>mysqld</literal>, or
+ <literal>ndb_mgmd</literal>) are returned.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--fields=<replaceable>delimiter</replaceable></option>,
+ <option>-f</option> <replaceable>delimiter</replaceable>
+ </para>
+
+ <para>
+ Specifies a <replaceable>delimiter</replaceable> string used
+ to separate the fields in the result. The default is
+ <quote><literal>,</literal></quote> (the comma character).
+ </para>
+
+ <para>
+ <emphasis role="bold">Note</emphasis>: If the
+ <replaceable>delimiter</replaceable> contains spaces or
+ escapes (such as <literal>\n</literal> for the linefeed
+ character), then it must be quoted.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--rows=<replaceable>separator</replaceable></option>,
+ <option>-r</option> <replaceable>separator</replaceable>
+ </para>
+
+ <para>
+ Specifies a <replaceable>separator</replaceable> string used
+ to separate the rows in the result. The default is a space
+ character.
+ </para>
+
+ <para>
+ <emphasis role="bold">Note</emphasis>: If the
+ <replaceable>separator</replaceable> contains spaces or
+ escapes (such as <literal>\n</literal> for the linefeed
+ character), then it must be quoted.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ <emphasis role="bold">Examples</emphasis>:
+ </para>
+
+ <orderedlist>
+
+ <listitem>
+ <para>
+ To obtain the node ID and type of each node in the cluster:
+ </para>
+
<programlisting>
shell> <userinput>./ndb_config --query=id,type --fields=':' --rows='\n'</userinput>
1:ndbd
@@ -13364,38 +13374,39 @@
8:mysqld
9:mysqld
</programlisting>
-
- <para>
- In this example, we used the <option>--fields</option> options
- to separate the ID and type of each node with a colon
- character (<literal>:</literal>), and the
- <option>--rows</option> options to place the values for each
- node on a new line in the output.
- </para>
- </listitem>
-
- <listitem>
- <para>
- To produce a connectstring that can be used by data, SQL, and
- API nodes to connect to the management server:
- </para>
-
+
+ <para>
+ In this example, we used the <option>--fields</option>
+ options to separate the ID and type of each node with a
+ colon character (<literal>:</literal>), and the
+ <option>--rows</option> options to place the values for each
+ node on a new line in the output.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ To produce a connectstring that can be used by data, SQL,
+ and API nodes to connect to the management server:
+ </para>
+
<programlisting>
shell> <userinput>./ndb_config --config-file=usr/local/mysql/cluster-data/config.ini --query=hostname,portnumber --fields=: --rows=, --type=ndb_mgmd</userinput>
192.168.0.179:1186
</programlisting>
- </listitem>
-
- <listitem>
- <para>
- This invocation of <command>ndb_config</command> checks only
- data nodes (using the <option>--type</option> option), and
- shows the values for each node's ID and hostname, and its
- <literal>DataMemory</literal>, <literal>IndexMemory</literal>,
- and <literal>DataDir</literal> parameters:
- </para>
-
+ </listitem>
+
+ <listitem>
+ <para>
+ This invocation of <command>ndb_config</command> checks only
+ data nodes (using the <option>--type</option> option), and
+ shows the values for each node's ID and hostname, and its
+ <literal>DataMemory</literal>,
+ <literal>IndexMemory</literal>, and
+ <literal>DataDir</literal> parameters:
+ </para>
+
<programlisting>
shell> <userinput>./ndb_config --type=ndbd --query=id,host,datamemory,indexmemory,datadir -f ' : ' -r '\n'</userinput>
1 : 192.168.0.193 : 83886080 : 18874368 : /usr/local/mysql/cluster-data
@@ -13403,42 +13414,43 @@
3 : 192.168.0.176 : 83886080 : 18874368 : /usr/local/mysql/cluster-data
4 : 192.168.0.119 : 83886080 : 18874368 : /usr/local/mysql/cluster-data
</programlisting>
-
- <para>
- In this example, we used the short options <option>-f</option>
- and <option>-r</option> for setting the field delimiter and
- row separator, respectively.
- </para>
- </listitem>
-
- <listitem>
- <para>
- To exclude results from any host except one in particular, use
- the <option>--host</option> option:
- </para>
-
+
+ <para>
+ In this example, we used the short options
+ <option>-f</option> and <option>-r</option> for setting the
+ field delimiter and row separator, respectively.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ To exclude results from any host except one in particular,
+ use the <option>--host</option> option:
+ </para>
+
<programlisting>
-shell> ./ndb_config --host=192.168.0.176 -f : -r '\n' -q id,type
+shell> <userinput>./ndb_config --host=192.168.0.176 -f : -r '\n' -q id,type</userinput>
3:ndbd
5:ndb_mgmd
</programlisting>
-
- <para>
- In this example, we also used the short form
- <option>-q</option> to determine the attributes to be queried.
- </para>
-
- <para>
- Similarly, you can limit results to a node with a specific ID
- using the <option>--id</option> or <option>--nodeid</option>
- option.
- </para>
- </listitem>
- </orderedlist>
-
-
- </section>
+ <para>
+ In this example, we also used the short form
+ <option>-q</option> to determine the attributes to be
+ queried.
+ </para>
+
+ <para>
+ Similarly, you can limit results to a node with a specific
+ ID using the <option>--id</option> or
+ <option>--nodeid</option> option.
+ </para>
+ </listitem>
+
+ </orderedlist>
+
+ </section>
+
<section id="mysql-cluster-utilities-ndb-delete-all">
<title><command>ndb_delete_all</command></title>
@@ -15667,7 +15679,7 @@
</para>
<itemizedlist>
-
+
<listitem>
<para>
Temporary tables are not supported.
@@ -16924,7 +16936,7 @@
This Perl script connects to a current MySQL (non-Cluster)
database and creates a report on how much space that database
would require if it used the <literal>NDBCluster</literal>
- storage engine. For more information, see
+ storage engine. For more information, see
<xref linkend="mysql-cluster-utilities-ndb-size"/>.
</para>
@@ -17141,9 +17153,8 @@
<para>
It is possible to create tables using other storage engines
(such as <literal>MyISAM</literal> or
- <literal>InnoDB</literal>)
- on a MySQL server being used for clustering, but these
- non-<literal>NDB</literal> tables will
+ <literal>InnoDB</literal>) on a MySQL server being used for
+ clustering, but these non-<literal>NDB</literal> tables will
<emphasis role="bold">not</emphasis> participate in the
cluster; they are local to the individual MySQL server
instance on which they are created.
@@ -17329,13 +17340,13 @@
</para>
<itemizedlist>
-
+
<listitem>
<para>
- Temporary tables are not supported; a <literal>CREATE TEMPORARY
- TABLE</literal> statement using
+ Temporary tables are not supported; a <literal>CREATE
+ TEMPORARY TABLE</literal> statement using
<literal>ENGINE=NDB</literal> or
- <literal>ENGINE=NDBCLUSTER</literal> fails with an error.
+ <literal>ENGINE=NDBCLUSTER</literal> fails with an error.
</para>
</listitem>
Modified: trunk/refman-5.0/mysql-cluster.xml
===================================================================
--- trunk/refman-5.0/mysql-cluster.xml 2006-10-03 10:55:27 UTC (rev 3524)
+++ trunk/refman-5.0/mysql-cluster.xml 2006-10-03 11:01:19 UTC (rev 3525)
Changed blocks: 10, Lines Added: 305, Lines Deleted: 293; 23560 bytes
@@ -5827,30 +5827,36 @@
</listitem>
</itemizedlist>
-
+
<para>
<emphasis role="bold">Important</emphasis>: When specifying
these parameters, the following relationships must hold true.
Otherwise, the data node will be unable to start.
</para>
-
+
<itemizedlist>
+
<listitem>
<para>
<literal>BackupDataBufferSize >= BackupWriteSize +
- 188KB</literal>
+ 188KB</literal>
</para>
</listitem>
+
<listitem>
<para>
- <literal>BackupLogBufferSize >= BackupWriteSize + 16KB</literal>
+ <literal>BackupLogBufferSize >= BackupWriteSize +
+ 16KB</literal>
</para>
</listitem>
+
<listitem>
<para>
- <literal>BackupMaxWriteSize >= BackupWriteSize</literal>
+ <literal>BackupMaxWriteSize >=
+ BackupWriteSize</literal>
</para>
</listitem>
+
</itemizedlist>
</section>
@@ -10138,7 +10144,7 @@
This stage sets up Cluster connections, establishes
inter-node communications, and starts Cluster heartbeats.
</para>
-
+
<para>
<emphasis role="bold">Note</emphasis>: When one or more
nodes hang in Phase 1 while the remaining node or nodes hang
@@ -12958,12 +12964,12 @@
<itemizedlist>
- <listitem>
- <para>
- <command>ndb_config</command>: Retrieves Cluster configuration
- options.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <command>ndb_config</command>: Retrieves Cluster configuration
+ options.
+ </para>
+ </listitem>
<listitem>
<para>
@@ -13173,229 +13179,234 @@
</listitem>
</itemizedlist>
-<section id="mysql-cluster-utilities-ndb-config">
- <title><command>ndb_config</command></title>
+ <section id="mysql-cluster-utilities-ndb-config">
- <para>
- <emphasis role="bold">Description</emphasis>: This tool extracts
- configuration information for data nodes, SQL nodes, and API nodes
- from a cluster management node (and possibly its
- <filename>config.ini</filename> file).
- </para>
+ <title><command>ndb_config</command></title>
- <para>
- <emphasis role="bold">Usage</emphasis>:
- </para>
+ <para>
+ <emphasis role="bold">Description</emphasis>: This tool extracts
+ configuration information for data nodes, SQL nodes, and API
+ nodes from a cluster management node (and possibly its
+ <filename>config.ini</filename> file).
+ </para>
+ <para>
+ <emphasis role="bold">Usage</emphasis>:
+ </para>
+
<programlisting>
ndb_config <replaceable>options</replaceable>
</programlisting>
-
- <para>
- The <replaceable>options</replaceable> available for this utility
- differ somewhat from those used with the other utilities, and so
- are listed in their entireity in the next section, followed by
- some examples.
- </para>
- <para>
- <emphasis role="bold">Options</emphasis>:
- </para>
-
- <itemizedlist>
-
- <listitem>
- <para>
- <option>--usage</option>, <option>--help</option>, or
- <option>-?</option>
- </para>
-
- <para>
- Causes <command>ndb_config</command> to print a list of
- available options, and then exit.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--version</option>, <option>-V</option>
- </para>
-
- <para>
- Causes <command>ndb_config</command> to print a version
- information string, and then exit.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--ndb-connectstring=<replaceable>connect_string</replaceable></option>
- </para>
-
- <para>
- Specifies the <literal>connectstring</literal> to use in
- connecting to the management server. The format for the
- connectstring is the same as described in
- <xref linkend="mysql-cluster-connectstring"/>, and defaults to
- <literal>localhost:1186</literal>.
- </para>
-
- <para>
- <emphasis role="bold">Note</emphasis>: The use of
- <option>-c</option> as a short version for this option is not
- currently supported with <command>ndb_config</command>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--config-file=<replaceable>path-to-file</replaceable></option>
- </para>
-
- <para>
- Gives the path to the management server's configuration file
- (<filename>config.ini</filename>). This may be a relative or
- absolute path. If the management node resides on a different
- host from the one on which <command>ndb_config</command> is
- invoked, then an absolute path must be used.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--query=<replaceable>query-options</replaceable></option>,
- <option>-q</option> <replaceable>query-options</replaceable>
- </para>
-
- <para>
- This is a comma-delimited list of <firstterm>query
+ <para>
+ The <replaceable>options</replaceable> available for this
+ utility differ somewhat from those used with the other
+ utilities, and so are listed in their entireity in the next
+ section, followed by some examples.
+ </para>
+
+ <para>
+ <emphasis role="bold">Options</emphasis>:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <option>--usage</option>, <option>--help</option>, or
+ <option>-?</option>
+ </para>
+
+ <para>
+ Causes <command>ndb_config</command> to print a list of
+ available options, and then exit.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--version</option>, <option>-V</option>
+ </para>
+
+ <para>
+ Causes <command>ndb_config</command> to print a version
+ information string, and then exit.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--ndb-connectstring=<replaceable>connect_string</replaceable></option>
+ </para>
+
+ <para>
+ Specifies the <literal>connectstring</literal> to use in
+ connecting to the management server. The format for the
+ connectstring is the same as described in
+ <xref linkend="mysql-cluster-connectstring"/>, and defaults
+ to <literal>localhost:1186</literal>.
+ </para>
+
+ <para>
+ <emphasis role="bold">Note</emphasis>: The use of
+ <option>-c</option> as a short version for this option is
+ not currently supported with <command>ndb_config</command>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--config-file=<replaceable>path-to-file</replaceable></option>
+ </para>
+
+ <para>
+ Gives the path to the management server's configuration file
+ (<filename>config.ini</filename>). This may be a relative or
+ absolute path. If the management node resides on a different
+ host from the one on which <command>ndb_config</command> is
+ invoked, then an absolute path must be used.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--query=<replaceable>query-options</replaceable></option>,
+ <option>-q</option> <replaceable>query-options</replaceable>
+ </para>
+
+ <para>
+ This is a comma-delimited list of <firstterm>query
options</firstterm> — that is, a list of one or more
- node attributes to be returned. These include
- <literal>id</literal> (node ID), type
- (node type — that is, <literal>ndbd</literal>,
- <literal>mysqld</literal>, or <literal>ndb_mgmd</literal>),
- and any configuration parameters whose values are to be
- obtained.
- </para>
-
- <para>
- For example,
- <option>--query=id,type,indexmemory,datamemory</option> would
- return the node ID, node type, <literal>DataMemory</literal>,
- and <literal>IndexMemory</literal> for each node.
- </para>
-
- <para>
- <emphasis role="bold">Note</emphasis>: 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.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--host=<replaceable>hostname</replaceable></option>
- </para>
-
- <para>
- Specifies the hostname of the node for which configuration
- information is to be obtained.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--id=<replaceable>node_id</replaceable></option>,
- <option>--nodeid=<replaceable>node_id</replaceable></option>
- </para>
-
- <para>
- Used to specify the node ID of the node for which
- configuration information is to be obtained.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--nodes</option>
- </para>
-
- <para>
- (Tells <command>ndb_config</command> to print information from
- parameters defined in <literal>[ndbd]</literal> 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 <literal>[tcp]</literal> and other
- sections of cluster configuration files.)
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--type=<replaceable>node_type</replaceable></option>
- </para>
-
- <para>
- Filters results so that only configuration values applying to
- nodes of the specified <replaceable>node_type</replaceable>
- (<literal>ndbd</literal>, <literal>mysqld</literal>, or
- <literal>ndb_mgmd</literal>) are returned.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--fields=<replaceable>delimiter</replaceable></option>,
- <option>-f</option> <replaceable>delimiter</replaceable>
- </para>
-
- <para>
- Specifies a <replaceable>delimiter</replaceable> string used
- to separate the fields in the result. The default is
- <quote><literal>,</literal></quote> (the comma character).
- </para>
-
- <para>
- <emphasis role="bold">Note</emphasis>: If the
- <replaceable>delimiter</replaceable> contains spaces or
- escapes (such as <literal>\n</literal> for the linefeed
- character), then it must be quoted.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--rows=<replaceable>separator</replaceable></option>,
- <option>-r</option> <replaceable>separator</replaceable>
- </para>
-
- <para>
- Specifies a <replaceable>separator</replaceable> string used
- to separate the rows in the result. The default is a space
- character.
- </para>
-
- <para>
- <emphasis role="bold">Note</emphasis>: If the
- <replaceable>separator</replaceable> contains spaces or
- escapes (such as <literal>\n</literal> for the linefeed
- character), then it must be quoted.
- </para>
- </listitem>
- </itemizedlist>
-
- <para>
- <emphasis role="bold">Examples</emphasis>:
- </para>
-
- <orderedlist>
- <listitem>
- <para>
- To obtain the node ID and type of each node in the cluster:
- </para>
-
+ node attributes to be returned. These include
+ <literal>id</literal> (node ID), type (node type —
+ that is, <literal>ndbd</literal>, <literal>mysqld</literal>,
+ or <literal>ndb_mgmd</literal>), and any configuration
+ parameters whose values are to be obtained.
+ </para>
+
+ <para>
+ For example,
+ <option>--query=id,type,indexmemory,datamemory</option>
+ would return the node ID, node type,
+ <literal>DataMemory</literal>, and
+ <literal>IndexMemory</literal> for each node.
+ </para>
+
+ <para>
+ <emphasis role="bold">Note</emphasis>: 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.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--host=<replaceable>hostname</replaceable></option>
+ </para>
+
+ <para>
+ Specifies the hostname of the node for which configuration
+ information is to be obtained.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--id=<replaceable>node_id</replaceable></option>,
+ <option>--nodeid=<replaceable>node_id</replaceable></option>
+ </para>
+
+ <para>
+ Used to specify the node ID of the node for which
+ configuration information is to be obtained.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--nodes</option>
+ </para>
+
+ <para>
+ (Tells <command>ndb_config</command> to print information
+ from parameters defined in <literal>[ndbd]</literal>
+ 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
+ <literal>[tcp]</literal> and other sections of cluster
+ configuration files.)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--type=<replaceable>node_type</replaceable></option>
+ </para>
+
+ <para>
+ Filters results so that only configuration values applying
+ to nodes of the specified
+ <replaceable>node_type</replaceable>
+ (<literal>ndbd</literal>, <literal>mysqld</literal>, or
+ <literal>ndb_mgmd</literal>) are returned.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--fields=<replaceable>delimiter</replaceable></option>,
+ <option>-f</option> <replaceable>delimiter</replaceable>
+ </para>
+
+ <para>
+ Specifies a <replaceable>delimiter</replaceable> string used
+ to separate the fields in the result. The default is
+ <quote><literal>,</literal></quote> (the comma character).
+ </para>
+
+ <para>
+ <emphasis role="bold">Note</emphasis>: If the
+ <replaceable>delimiter</replaceable> contains spaces or
+ escapes (such as <literal>\n</literal> for the linefeed
+ character), then it must be quoted.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--rows=<replaceable>separator</replaceable></option>,
+ <option>-r</option> <replaceable>separator</replaceable>
+ </para>
+
+ <para>
+ Specifies a <replaceable>separator</replaceable> string used
+ to separate the rows in the result. The default is a space
+ character.
+ </para>
+
+ <para>
+ <emphasis role="bold">Note</emphasis>: If the
+ <replaceable>separator</replaceable> contains spaces or
+ escapes (such as <literal>\n</literal> for the linefeed
+ character), then it must be quoted.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ <emphasis role="bold">Examples</emphasis>:
+ </para>
+
+ <orderedlist>
+
+ <listitem>
+ <para>
+ To obtain the node ID and type of each node in the cluster:
+ </para>
+
<programlisting>
shell> <userinput>./ndb_config --query=id,type --fields=':' --rows='\n'</userinput>
1:ndbd
@@ -13408,38 +13419,39 @@
8:mysqld
9:mysqld
</programlisting>
-
- <para>
- In this example, we used the <option>--fields</option> options
- to separate the ID and type of each node with a colon
- character (<literal>:</literal>), and the
- <option>--rows</option> options to place the values for each
- node on a new line in the output.
- </para>
- </listitem>
-
- <listitem>
- <para>
- To produce a connectstring that can be used by data, SQL, and
- API nodes to connect to the management server:
- </para>
-
+
+ <para>
+ In this example, we used the <option>--fields</option>
+ options to separate the ID and type of each node with a
+ colon character (<literal>:</literal>), and the
+ <option>--rows</option> options to place the values for each
+ node on a new line in the output.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ To produce a connectstring that can be used by data, SQL,
+ and API nodes to connect to the management server:
+ </para>
+
<programlisting>
shell> <userinput>./ndb_config --config-file=usr/local/mysql/cluster-data/config.ini --query=hostname,portnumber --fields=: --rows=, --type=ndb_mgmd</userinput>
192.168.0.179:1186
</programlisting>
- </listitem>
-
- <listitem>
- <para>
- This invocation of <command>ndb_config</command> checks only
- data nodes (using the <option>--type</option> option), and
- shows the values for each node's ID and hostname, and its
- <literal>DataMemory</literal>, <literal>IndexMemory</literal>,
- and <literal>DataDir</literal> parameters:
- </para>
-
+ </listitem>
+
+ <listitem>
+ <para>
+ This invocation of <command>ndb_config</command> checks only
+ data nodes (using the <option>--type</option> option), and
+ shows the values for each node's ID and hostname, and its
+ <literal>DataMemory</literal>,
+ <literal>IndexMemory</literal>, and
+ <literal>DataDir</literal> parameters:
+ </para>
+
<programlisting>
shell> <userinput>./ndb_config --type=ndbd --query=id,host,datamemory,indexmemory,datadir -f ' : ' -r '\n'</userinput>
1 : 192.168.0.193 : 83886080 : 18874368 : /usr/local/mysql/cluster-data
@@ -13447,42 +13459,43 @@
3 : 192.168.0.176 : 83886080 : 18874368 : /usr/local/mysql/cluster-data
4 : 192.168.0.119 : 83886080 : 18874368 : /usr/local/mysql/cluster-data
</programlisting>
-
- <para>
- In this example, we used the short options <option>-f</option>
- and <option>-r</option> for setting the field delimiter and
- row separator, respectively.
- </para>
- </listitem>
-
- <listitem>
- <para>
- To exclude results from any host except one in particular, use
- the <option>--host</option> option:
- </para>
-
+
+ <para>
+ In this example, we used the short options
+ <option>-f</option> and <option>-r</option> for setting the
+ field delimiter and row separator, respectively.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ To exclude results from any host except one in particular,
+ use the <option>--host</option> option:
+ </para>
+
<programlisting>
-shell> ./ndb_config --host=192.168.0.176 -f : -r '\n' -q id,type
+shell> <userinput>./ndb_config --host=192.168.0.176 -f : -r '\n' -q id,type</userinput>
3:ndbd
5:ndb_mgmd
</programlisting>
-
- <para>
- In this example, we also used the short form
- <option>-q</option> to determine the attributes to be queried.
- </para>
-
- <para>
- Similarly, you can limit results to a node with a specific ID
- using the <option>--id</option> or <option>--nodeid</option>
- option.
- </para>
- </listitem>
- </orderedlist>
-
-
- </section>
+ <para>
+ In this example, we also used the short form
+ <option>-q</option> to determine the attributes to be
+ queried.
+ </para>
+
+ <para>
+ Similarly, you can limit results to a node with a specific
+ ID using the <option>--id</option> or
+ <option>--nodeid</option> option.
+ </para>
+ </listitem>
+
+ </orderedlist>
+
+ </section>
+
<section id="mysql-cluster-utilities-ndb-delete-all">
<title><command>ndb_delete_all</command></title>
@@ -15717,7 +15730,7 @@
</para>
<itemizedlist>
-
+
<listitem>
<para>
Temporary tables are not supported.
@@ -17282,7 +17295,7 @@
This Perl script connects to a current MySQL (non-Cluster)
database and creates a report on how much space that database
would require if it used the <literal>NDBCluster</literal>
- storage engine. For more information, see
+ storage engine. For more information, see
<xref linkend="mysql-cluster-utilities-ndb-size"/>.
</para>
@@ -17499,9 +17512,8 @@
<para>
It is possible to create tables using other storage engines
(such as <literal>MyISAM</literal> or
- <literal>InnoDB</literal>)
- on a MySQL server being used for clustering, but these
- non-<literal>NDB</literal> tables will
+ <literal>InnoDB</literal>) on a MySQL server being used for
+ clustering, but these non-<literal>NDB</literal> tables will
<emphasis role="bold">not</emphasis> participate in the
cluster; they are local to the individual MySQL server
instance on which they are created.
@@ -17692,13 +17704,13 @@
</para>
<itemizedlist>
-
+
<listitem>
<para>
- Temporary tables are not supported; a <literal>CREATE TEMPORARY
- TABLE</literal> statement using
+ Temporary tables are not supported; a <literal>CREATE
+ TEMPORARY TABLE</literal> statement using
<literal>ENGINE=NDB</literal> or
- <literal>ENGINE=NDBCLUSTER</literal> fails with an error.
+ <literal>ENGINE=NDBCLUSTER</literal> fails with an error.
</para>
</listitem>
Modified: trunk/refman-5.1/mysql-cluster.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster.xml 2006-10-03 10:55:27 UTC (rev 3524)
+++ trunk/refman-5.1/mysql-cluster.xml 2006-10-03 11:01:19 UTC (rev 3525)
Changed blocks: 10, Lines Added: 308, Lines Deleted: 298; 24256 bytes
@@ -5724,31 +5724,36 @@
</listitem>
</itemizedlist>
-
-
+
<para>
<emphasis role="bold">Important</emphasis>: When specifying
these parameters, the following relationships must hold true.
Otherwise, the data node will be unable to start.
</para>
-
+
<itemizedlist>
+
<listitem>
<para>
<literal>BackupDataBufferSize >= BackupWriteSize +
- 188KB</literal>
+ 188KB</literal>
</para>
</listitem>
+
<listitem>
<para>
- <literal>BackupLogBufferSize >= BackupWriteSize + 16KB</literal>
+ <literal>BackupLogBufferSize >= BackupWriteSize +
+ 16KB</literal>
</para>
</listitem>
+
<listitem>
<para>
- <literal>BackupMaxWriteSize >= BackupWriteSize</literal>
+ <literal>BackupMaxWriteSize >=
+ BackupWriteSize</literal>
</para>
</listitem>
+
</itemizedlist>
</section>
@@ -10041,7 +10046,7 @@
This stage sets up Cluster connections, establishes
inter-node communications, and starts Cluster heartbeats.
</para>
-
+
<para>
<emphasis role="bold">Note</emphasis>: When one or more
nodes hang in Phase 1 while the remaining node or nodes hang
@@ -12885,16 +12890,16 @@
</para>
<itemizedlist>
-
- <listitem>
- <para>
- <command>ndb_config</command>: Retrieves Cluster configuration
- option values.
- </para>
- </listitem>
<listitem>
<para>
+ <command>ndb_config</command>: Retrieves Cluster configuration
+ option values.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
<command>ndb_delete_all</command>: Deletes all rows from a
given table.
</para>
@@ -13101,230 +13106,234 @@
</listitem>
</itemizedlist>
-
- <section id="mysql-cluster-utilities-ndb-config">
- <title><command>ndb_config</command></title>
+ <section id="mysql-cluster-utilities-ndb-config">
- <para>
- <emphasis role="bold">Description</emphasis>: This tool extracts
- configuration information for data nodes, SQL nodes, and API nodes
- from a cluster management node (and possibly its
- <filename>config.ini</filename> file).
- </para>
+ <title><command>ndb_config</command></title>
- <para>
- <emphasis role="bold">Usage</emphasis>:
- </para>
+ <para>
+ <emphasis role="bold">Description</emphasis>: This tool extracts
+ configuration information for data nodes, SQL nodes, and API
+ nodes from a cluster management node (and possibly its
+ <filename>config.ini</filename> file).
+ </para>
+ <para>
+ <emphasis role="bold">Usage</emphasis>:
+ </para>
+
<programlisting>
ndb_config <replaceable>options</replaceable>
</programlisting>
-
- <para>
- The <replaceable>options</replaceable> available for this utility
- differ somewhat from those used with the other utilities, and so
- are listed in their entireity in the next section, followed by
- some examples.
- </para>
- <para>
- <emphasis role="bold">Options</emphasis>:
- </para>
-
- <itemizedlist>
-
- <listitem>
- <para>
- <option>--usage</option>, <option>--help</option>, or
- <option>-?</option>
- </para>
-
- <para>
- Causes <command>ndb_config</command> to print a list of
- available options, and then exit.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--version</option>, <option>-V</option>
- </para>
-
- <para>
- Causes <command>ndb_config</command> to print a version
- information string, and then exit.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--ndb-connectstring=<replaceable>connect_string</replaceable></option>
- </para>
-
- <para>
- Specifies the <literal>connectstring</literal> to use in
- connecting to the management server. The format for the
- connectstring is the same as described in
- <xref linkend="mysql-cluster-connectstring"/>, and defaults to
- <literal>localhost:1186</literal>.
- </para>
-
- <para>
- <emphasis role="bold">Note</emphasis>: The use of
- <option>-c</option> as a short version for this option is not
- currently supported with <command>ndb_config</command>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--config-file=<replaceable>path-to-file</replaceable></option>
- </para>
-
- <para>
- Gives the path to the management server's configuration file
- (<filename>config.ini</filename>). This may be a relative or
- absolute path. If the management node resides on a different
- host from the one on which <command>ndb_config</command> is
- invoked, then an absolute path must be used.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--query=<replaceable>query-options</replaceable></option>,
- <option>-q</option> <replaceable>query-options</replaceable>
- </para>
-
- <para>
- This is a comma-delimited list of <firstterm>query
+ <para>
+ The <replaceable>options</replaceable> available for this
+ utility differ somewhat from those used with the other
+ utilities, and so are listed in their entireity in the next
+ section, followed by some examples.
+ </para>
+
+ <para>
+ <emphasis role="bold">Options</emphasis>:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <option>--usage</option>, <option>--help</option>, or
+ <option>-?</option>
+ </para>
+
+ <para>
+ Causes <command>ndb_config</command> to print a list of
+ available options, and then exit.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--version</option>, <option>-V</option>
+ </para>
+
+ <para>
+ Causes <command>ndb_config</command> to print a version
+ information string, and then exit.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--ndb-connectstring=<replaceable>connect_string</replaceable></option>
+ </para>
+
+ <para>
+ Specifies the <literal>connectstring</literal> to use in
+ connecting to the management server. The format for the
+ connectstring is the same as described in
+ <xref linkend="mysql-cluster-connectstring"/>, and defaults
+ to <literal>localhost:1186</literal>.
+ </para>
+
+ <para>
+ <emphasis role="bold">Note</emphasis>: The use of
+ <option>-c</option> as a short version for this option is
+ not currently supported with <command>ndb_config</command>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--config-file=<replaceable>path-to-file</replaceable></option>
+ </para>
+
+ <para>
+ Gives the path to the management server's configuration file
+ (<filename>config.ini</filename>). This may be a relative or
+ absolute path. If the management node resides on a different
+ host from the one on which <command>ndb_config</command> is
+ invoked, then an absolute path must be used.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--query=<replaceable>query-options</replaceable></option>,
+ <option>-q</option> <replaceable>query-options</replaceable>
+ </para>
+
+ <para>
+ This is a comma-delimited list of <firstterm>query
options</firstterm> — that is, a list of one or more
- node attributes to be returned. These include
- <literal>id</literal> (node ID), type
- (node type — that is, <literal>ndbd</literal>,
- <literal>mysqld</literal>, or <literal>ndb_mgmd</literal>),
- and any configuration parameters whose values are to be
- obtained.
- </para>
-
- <para>
- For example,
- <option>--query=id,type,indexmemory,datamemory</option> would
- return the node ID, node type, <literal>DataMemory</literal>,
- and <literal>IndexMemory</literal> for each node.
- </para>
-
- <para>
- <emphasis role="bold">Note</emphasis>: 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.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--host=<replaceable>hostname</replaceable></option>
- </para>
-
- <para>
- Specifies the hostname of the node for which configuration
- information is to be obtained.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--id=<replaceable>node_id</replaceable></option>,
- <option>--nodeid=<replaceable>node_id</replaceable></option>
- </para>
-
- <para>
- Used to specify the node ID of the node for which
- configuration information is to be obtained.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--nodes</option>
- </para>
-
- <para>
- (Tells <command>ndb_config</command> to print information from
- parameters defined in <literal>[ndbd]</literal> 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 <literal>[tcp]</literal> and other
- sections of cluster configuration files.)
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--type=<replaceable>node_type</replaceable></option>
- </para>
-
- <para>
- Filters results so that only configuration values applying to
- nodes of the specified <replaceable>node_type</replaceable>
- (<literal>ndbd</literal>, <literal>mysqld</literal>, or
- <literal>ndb_mgmd</literal>) are returned.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--fields=<replaceable>delimiter</replaceable></option>,
- <option>-f</option> <replaceable>delimiter</replaceable>
- </para>
-
- <para>
- Specifies a <replaceable>delimiter</replaceable> string used
- to separate the fields in the result. The default is
- <quote><literal>,</literal></quote> (the comma character).
- </para>
-
- <para>
- <emphasis role="bold">Note</emphasis>: If the
- <replaceable>delimiter</replaceable> contains spaces or
- escapes (such as <literal>\n</literal> for the linefeed
- character), then it must be quoted.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <option>--rows=<replaceable>separator</replaceable></option>,
- <option>-r</option> <replaceable>separator</replaceable>
- </para>
-
- <para>
- Specifies a <replaceable>separator</replaceable> string used
- to separate the rows in the result. The default is a space
- character.
- </para>
-
- <para>
- <emphasis role="bold">Note</emphasis>: If the
- <replaceable>separator</replaceable> contains spaces or
- escapes (such as <literal>\n</literal> for the linefeed
- character), then it must be quoted.
- </para>
- </listitem>
- </itemizedlist>
-
- <para>
- <emphasis role="bold">Examples</emphasis>:
- </para>
-
- <orderedlist>
- <listitem>
- <para>
- To obtain the node ID and type of each node in the cluster:
- </para>
-
+ node attributes to be returned. These include
+ <literal>id</literal> (node ID), type (node type —
+ that is, <literal>ndbd</literal>, <literal>mysqld</literal>,
+ or <literal>ndb_mgmd</literal>), and any configuration
+ parameters whose values are to be obtained.
+ </para>
+
+ <para>
+ For example,
+ <option>--query=id,type,indexmemory,datamemory</option>
+ would return the node ID, node type,
+ <literal>DataMemory</literal>, and
+ <literal>IndexMemory</literal> for each node.
+ </para>
+
+ <para>
+ <emphasis role="bold">Note</emphasis>: 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.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--host=<replaceable>hostname</replaceable></option>
+ </para>
+
+ <para>
+ Specifies the hostname of the node for which configuration
+ information is to be obtained.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--id=<replaceable>node_id</replaceable></option>,
+ <option>--nodeid=<replaceable>node_id</replaceable></option>
+ </para>
+
+ <para>
+ Used to specify the node ID of the node for which
+ configuration information is to be obtained.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--nodes</option>
+ </para>
+
+ <para>
+ (Tells <command>ndb_config</command> to print information
+ from parameters defined in <literal>[ndbd]</literal>
+ 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
+ <literal>[tcp]</literal> and other sections of cluster
+ configuration files.)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--type=<replaceable>node_type</replaceable></option>
+ </para>
+
+ <para>
+ Filters results so that only configuration values applying
+ to nodes of the specified
+ <replaceable>node_type</replaceable>
+ (<literal>ndbd</literal>, <literal>mysqld</literal>, or
+ <literal>ndb_mgmd</literal>) are returned.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--fields=<replaceable>delimiter</replaceable></option>,
+ <option>-f</option> <replaceable>delimiter</replaceable>
+ </para>
+
+ <para>
+ Specifies a <replaceable>delimiter</replaceable> string used
+ to separate the fields in the result. The default is
+ <quote><literal>,</literal></quote> (the comma character).
+ </para>
+
+ <para>
+ <emphasis role="bold">Note</emphasis>: If the
+ <replaceable>delimiter</replaceable> contains spaces or
+ escapes (such as <literal>\n</literal> for the linefeed
+ character), then it must be quoted.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--rows=<replaceable>separator</replaceable></option>,
+ <option>-r</option> <replaceable>separator</replaceable>
+ </para>
+
+ <para>
+ Specifies a <replaceable>separator</replaceable> string used
+ to separate the rows in the result. The default is a space
+ character.
+ </para>
+
+ <para>
+ <emphasis role="bold">Note</emphasis>: If the
+ <replaceable>separator</replaceable> contains spaces or
+ escapes (such as <literal>\n</literal> for the linefeed
+ character), then it must be quoted.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ <emphasis role="bold">Examples</emphasis>:
+ </para>
+
+ <orderedlist>
+
+ <listitem>
+ <para>
+ To obtain the node ID and type of each node in the cluster:
+ </para>
+
<programlisting>
shell> <userinput>./ndb_config --query=id,type --fields=':' --rows='\n'</userinput>
1:ndbd
@@ -13337,38 +13346,39 @@
8:mysqld
9:mysqld
</programlisting>
-
- <para>
- In this example, we used the <option>--fields</option> options
- to separate the ID and type of each node with a colon
- character (<literal>:</literal>), and the
- <option>--rows</option> options to place the values for each
- node on a new line in the output.
- </para>
- </listitem>
-
- <listitem>
- <para>
- To produce a connectstring that can be used by data, SQL, and
- API nodes to connect to the management server:
- </para>
-
+
+ <para>
+ In this example, we used the <option>--fields</option>
+ options to separate the ID and type of each node with a
+ colon character (<literal>:</literal>), and the
+ <option>--rows</option> options to place the values for each
+ node on a new line in the output.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ To produce a connectstring that can be used by data, SQL,
+ and API nodes to connect to the management server:
+ </para>
+
<programlisting>
shell> <userinput>./ndb_config --config-file=usr/local/mysql/cluster-data/config.ini --query=hostname,portnumber --fields=: --rows=, --type=ndb_mgmd</userinput>
192.168.0.179:1186
</programlisting>
- </listitem>
-
- <listitem>
- <para>
- This invocation of <command>ndb_config</command> checks only
- data nodes (using the <option>--type</option> option), and
- shows the values for each node's ID and hostname, and its
- <literal>DataMemory</literal>, <literal>IndexMemory</literal>,
- and <literal>DataDir</literal> parameters:
- </para>
-
+ </listitem>
+
+ <listitem>
+ <para>
+ This invocation of <command>ndb_config</command> checks only
+ data nodes (using the <option>--type</option> option), and
+ shows the values for each node's ID and hostname, and its
+ <literal>DataMemory</literal>,
+ <literal>IndexMemory</literal>, and
+ <literal>DataDir</literal> parameters:
+ </para>
+
<programlisting>
shell> <userinput>./ndb_config --type=ndbd --query=id,host,datamemory,indexmemory,datadir -f ' : ' -r '\n'</userinput>
1 : 192.168.0.193 : 83886080 : 18874368 : /usr/local/mysql/cluster-data
@@ -13376,42 +13386,43 @@
3 : 192.168.0.176 : 83886080 : 18874368 : /usr/local/mysql/cluster-data
4 : 192.168.0.119 : 83886080 : 18874368 : /usr/local/mysql/cluster-data
</programlisting>
-
- <para>
- In this example, we used the short options <option>-f</option>
- and <option>-r</option> for setting the field delimiter and
- row separator, respectively.
- </para>
- </listitem>
-
- <listitem>
- <para>
- To exclude results from any host except one in particular, use
- the <option>--host</option> option:
- </para>
-
+
+ <para>
+ In this example, we used the short options
+ <option>-f</option> and <option>-r</option> for setting the
+ field delimiter and row separator, respectively.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ To exclude results from any host except one in particular,
+ use the <option>--host</option> option:
+ </para>
+
<programlisting>
-shell> ./ndb_config --host=192.168.0.176 -f : -r '\n' -q id,type
+shell> <userinput>./ndb_config --host=192.168.0.176 -f : -r '\n' -q id,type</userinput>
3:ndbd
5:ndb_mgmd
</programlisting>
-
- <para>
- In this example, we also used the short form
- <option>-q</option> to determine the attributes to be queried.
- </para>
-
- <para>
- Similarly, you can limit results to a node with a specific ID
- using the <option>--id</option> or <option>--nodeid</option>
- option.
- </para>
- </listitem>
- </orderedlist>
-
-
- </section>
+ <para>
+ In this example, we also used the short form
+ <option>-q</option> to determine the attributes to be
+ queried.
+ </para>
+
+ <para>
+ Similarly, you can limit results to a node with a specific
+ ID using the <option>--id</option> or
+ <option>--nodeid</option> option.
+ </para>
+ </listitem>
+
+ </orderedlist>
+
+ </section>
+
<section id="mysql-cluster-utilities-ndb-delete-all">
<title><command>ndb_delete_all</command></title>
@@ -18081,7 +18092,7 @@
</para>
<itemizedlist>
-
+
<listitem>
<para>
Temporary tables are not supported.
@@ -19692,7 +19703,7 @@
This Perl script connects to a current MySQL (non-Cluster)
database and creates a report on how much space that database
would require if it used the <literal>NDBCluster</literal>
- storage engine. For more information, see
+ storage engine. For more information, see
<xref linkend="mysql-cluster-utilities-ndb-size"/>.
</para>
@@ -19910,9 +19921,8 @@
<para>
It is possible to create tables using other storage engines
(such as <literal>MyISAM</literal> or
- <literal>InnoDB</literal>)
- on a MySQL server being used for clustering, but these
- non-<literal>NDB</literal> tables will
+ <literal>InnoDB</literal>) on a MySQL server being used for
+ clustering, but these non-<literal>NDB</literal> tables will
<emphasis role="bold">not</emphasis> participate in the
cluster; they are local to the individual MySQL server
instance on which they are created.
@@ -20091,23 +20101,23 @@
</para>
<itemizedlist>
-
+
<listitem>
<para>
- Temporary tables are not supported; a <literal>CREATE TEMPORARY
- TABLE</literal> statement using
+ Temporary tables are not supported; a <literal>CREATE
+ TEMPORARY TABLE</literal> statement using
<literal>ENGINE=NDB</literal> or
- <literal>ENGINE=NDBCLUSTER</literal> fails with an error.
+ <literal>ENGINE=NDBCLUSTER</literal> fails with an error.
</para>
</listitem>
-
+
<listitem>
<para>
The only types of user-defined partitioning supported for
<literal>NDB</literal> tables are <literal>KEY</literal>
and <literal>LINEAR KEY</literal>. (Beginning with MySQL
5.1.12, attempting to create an <literal>NDB</literal>
- table using any other partitioning type fails with an
+ table using any other partitioning type fails with an
error.)
</para>
</listitem>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r3525 - in trunk: refman-4.1 refman-5.0 refman-5.1 | jon | 3 Oct |
