Author: mcbrown
Date: 2007-09-24 17:49:12 +0200 (Mon, 24 Sep 2007)
New Revision: 7911
Log:
Fixing some bad URL issues/reformat
Modified:
trunk/refman-5.1/mysql-cluster-multi-computer.xml
trunk/refman-5.1/mysql-cluster-process-management.xml
trunk/refman-5.1/mysql-cluster-utilities.xml
trunk/refman-5.1/mysql-cluster.xml
Modified: trunk/refman-5.1/mysql-cluster-multi-computer.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster-multi-computer.xml 2007-09-24 12:44:33 UTC (rev 7910)
+++ trunk/refman-5.1/mysql-cluster-multi-computer.xml 2007-09-24 15:49:12 UTC (rev 7911)
Changed blocks: 3, Lines Added: 5, Lines Deleted: 5; 1589 bytes
@@ -310,7 +310,7 @@
yourself merely to be able to use Cluster. In this How-To, we
assume that you are using the server binary appropriate to your
operating system, available via the MySQL software downloads page
- at <ulink url=""/>.
+ at <ulink url="&base-url-downloads;"/>.
</para>
<para>
@@ -418,8 +418,8 @@
MySQL's binaries, the first step in the installation process for
each cluster host is to download the file
<filename>mysql-max-¤t-version;-pc-linux-gnu-i686.tar.gz</filename>
- from the <ulink url="">MySQL downloads area</ulink>. We assume
- that you have placed it in each machine's
+ from the <ulink url="&base-url-downloads;">MySQL downloads
+ area</ulink>. We assume that you have placed it in each machine's
<filename>/var/tmp</filename> directory. (If you do require a
custom binary, see <xref linkend="installing-source-tree"/>.)
</para>
@@ -1081,8 +1081,8 @@
<note>
<para>
The <literal>world</literal> database can be downloaded from
- <ulink url=""/>, where it can be found listed under
- <quote>Examples</quote>.
+ <ulink url="&base-url-docs;"/>, where it can be found listed
+ under <quote>Examples</quote>.
</para>
</note>
Modified: trunk/refman-5.1/mysql-cluster-process-management.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster-process-management.xml 2007-09-24 12:44:33 UTC (rev 7910)
+++ trunk/refman-5.1/mysql-cluster-process-management.xml 2007-09-24 15:49:12 UTC (rev 7911)
Changed blocks: 1, Lines Added: 2, Lines Deleted: 2; 930 bytes
@@ -99,8 +99,8 @@
To be used with MySQL Cluster, <command>mysqld</command> needs to
be built with support for the <literal>NDB Cluster</literal>
storage engine, as it is in the precompiled binaries available
- from <ulink url=""/>. If you build MySQL from source, you must
- invoke <command>configure</command> with the
+ from <ulink url="&base-url-downloads;"/>. If you build MySQL from
+ source, you must invoke <command>configure</command> with the
<option>--with-ndbcluster</option> option to enable <literal>NDB
Cluster</literal> storage engine support.
</para>
Modified: trunk/refman-5.1/mysql-cluster-utilities.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster-utilities.xml 2007-09-24 12:44:33 UTC (rev 7910)
+++ trunk/refman-5.1/mysql-cluster-utilities.xml 2007-09-24 15:49:12 UTC (rev 7911)
Changed blocks: 17, Lines Added: 2204, Lines Deleted: 2221; 185467 bytes
@@ -5,219 +5,217 @@
<!ENTITY % all.entities SYSTEM "all-entities.ent">
%all.entities;
]>
-
<section id="mysql-cluster-utilities">
- <title>Cluster Utility Programs</title>
+ <title>Cluster Utility Programs</title>
- <indexterm>
- <primary>MySQL Cluster utilities</primary>
- </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster utilities</primary>
+ </indexterm>
- <indexterm>
- <primary><command>ndb_config</command></primary>
- </indexterm>
+ <indexterm>
+ <primary><command>ndb_config</command></primary>
+ </indexterm>
- <indexterm>
- <primary><command>ndb_cpcd</command></primary>
- </indexterm>
+ <indexterm>
+ <primary><command>ndb_cpcd</command></primary>
+ </indexterm>
- <indexterm>
- <primary><command>ndb_delete_all</command></primary>
- </indexterm>
+ <indexterm>
+ <primary><command>ndb_delete_all</command></primary>
+ </indexterm>
- <indexterm>
- <primary><command>ndb_desc</command></primary>
- </indexterm>
+ <indexterm>
+ <primary><command>ndb_desc</command></primary>
+ </indexterm>
- <indexterm>
- <primary><command>ndb_drop_index</command></primary>
- </indexterm>
+ <indexterm>
+ <primary><command>ndb_drop_index</command></primary>
+ </indexterm>
- <indexterm>
- <primary><command>ndb_drop_table</command></primary>
- </indexterm>
+ <indexterm>
+ <primary><command>ndb_drop_table</command></primary>
+ </indexterm>
- <indexterm>
- <primary><command>ndb_error_reporter</command></primary>
- </indexterm>
+ <indexterm>
+ <primary><command>ndb_error_reporter</command></primary>
+ </indexterm>
- <indexterm>
- <primary><command>ndb_print_backup_file</command></primary>
- </indexterm>
+ <indexterm>
+ <primary><command>ndb_print_backup_file</command></primary>
+ </indexterm>
- <indexterm>
- <primary><command>ndb_print_schema_file</command></primary>
- </indexterm>
+ <indexterm>
+ <primary><command>ndb_print_schema_file</command></primary>
+ </indexterm>
- <indexterm>
- <primary><command>ndb_print_sys_file</command></primary>
- </indexterm>
+ <indexterm>
+ <primary><command>ndb_print_sys_file</command></primary>
+ </indexterm>
- <indexterm>
- <primary><command>ndb_select_all</command></primary>
- </indexterm>
+ <indexterm>
+ <primary><command>ndb_select_all</command></primary>
+ </indexterm>
- <indexterm>
- <primary><command>ndb_select_count</command></primary>
- </indexterm>
+ <indexterm>
+ <primary><command>ndb_select_count</command></primary>
+ </indexterm>
- <indexterm>
- <primary><command>ndb_show_tables</command></primary>
- </indexterm>
+ <indexterm>
+ <primary><command>ndb_show_tables</command></primary>
+ </indexterm>
- <indexterm>
- <primary><command>ndb_size.pl</command></primary>
- </indexterm>
+ <indexterm>
+ <primary><command>ndb_size.pl</command></primary>
+ </indexterm>
- <indexterm>
- <primary><command>ndb_waiter</command></primary>
- </indexterm>
+ <indexterm>
+ <primary><command>ndb_waiter</command></primary>
+ </indexterm>
- <para>
- This section discusses the MySQL Cluster utility programs that can
- be found in the <filename>mysql/bin</filename> directory. Each of
- these — except for <filename>ndb_size.pl</filename> and
- <command>ndb_error_reporter</command> — is a standalone
- binary that can be used from a system shell, and that does not
- need to connect to a MySQL server (nor even requires that a MySQL
- server be connected to the cluster).
- </para>
+ <para>
+ This section discusses the MySQL Cluster utility programs that can
+ be found in the <filename>mysql/bin</filename> directory. Each of
+ these — except for <filename>ndb_size.pl</filename> and
+ <command>ndb_error_reporter</command> — is a standalone binary
+ that can be used from a system shell, and that does not need to
+ connect to a MySQL server (nor even requires that a MySQL server be
+ connected to the cluster).
+ </para>
- <para>
- These utilities can also serve as examples for writing your own
- applications using the <literal>NDB</literal> API. The source code
- for most of these programs may be found in the
- <filename>storage/ndb/tools</filename> directory of the MySQL
- ¤t-series; tree (see <xref linkend="installing-source"/>).
- The <literal>NDB</literal> API is not covered in this manual;
- please refer to the
- <ulink url="/ndbapi/en/"><literal>NDB</literal> API
- Guide</ulink> for information about this API.
- </para>
+ <para>
+ These utilities can also serve as examples for writing your own
+ applications using the <literal>NDB</literal> API. The source code
+ for most of these programs may be found in the
+ <filename>storage/ndb/tools</filename> directory of the MySQL
+ ¤t-series; tree (see <xref linkend="installing-source"/>). The
+ <literal>NDB</literal> API is not covered in this manual; please
+ refer to the <ulink url="/ndbapi/en/"><literal>NDB</literal> API
+ Guide</ulink> for information about this API.
+ </para>
- <para>
- All of the <literal>NDB</literal> utilities are listed here with
- brief descriptions:
- </para>
+ <para>
+ All of the <literal>NDB</literal> utilities are listed here with
+ brief descriptions:
+ </para>
- <itemizedlist>
+ <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_cpcd</command>: Used in testing and debugging
- MySQL Cluster.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <command>ndb_cpcd</command>: Used in testing and debugging MySQL
+ Cluster.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <command>ndb_delete_all</command>: Deletes all rows from a
- given table.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <command>ndb_delete_all</command>: Deletes all rows from a given
+ table.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <command>ndb_desc</command>: Lists all properties of an
- <literal>NDB</literal> table.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <command>ndb_desc</command>: Lists all properties of an
+ <literal>NDB</literal> table.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <command>ndb_drop_index</command>: Drops the specified index
- from an <literal>NDB</literal> table.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <command>ndb_drop_index</command>: Drops the specified index
+ from an <literal>NDB</literal> table.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <command>ndb_drop_table</command>: Drops an
- <literal>NDB</literal> table.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <command>ndb_drop_table</command>: Drops an
+ <literal>NDB</literal> table.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <command>ndb_error_reporter</command>: Can be used to gather
- information useful for diagnosing problems with the cluster.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <command>ndb_error_reporter</command>: Can be used to gather
+ information useful for diagnosing problems with the cluster.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <command>ndb_mgm</command>: This is the MySQL Cluster
- management client, which is discussed in
- <xref linkend="mysql-cluster-mgm-client-commands"/>.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <command>ndb_mgm</command>: This is the MySQL Cluster management
+ client, which is discussed in
+ <xref linkend="mysql-cluster-mgm-client-commands"/>.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <command>ndb_print_backup_file</command>: Prints diagnostic
- information obtained from cluster backup files.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <command>ndb_print_backup_file</command>: Prints diagnostic
+ information obtained from cluster backup files.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <command>ndb_print_schema_file</command>: Prints diagnostic
- information obtained from cluster schema files.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <command>ndb_print_schema_file</command>: Prints diagnostic
+ information obtained from cluster schema files.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <command>ndb_print_sys_file</command>: Prints diagnostic
- information obtained from cluster system files.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <command>ndb_print_sys_file</command>: Prints diagnostic
+ information obtained from cluster system files.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <command>ndb_restore</command>: This utility is used to
- restore a cluster from backup. See
- <xref linkend="mysql-cluster-restore"/>, for more information.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <command>ndb_restore</command>: This utility is used to restore
+ a cluster from backup. See
+ <xref linkend="mysql-cluster-restore"/>, for more information.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <command>ndb_select_all</command>: Prints all rows from an
- <literal>NDB</literal> table.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <command>ndb_select_all</command>: Prints all rows from an
+ <literal>NDB</literal> table.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <command>ndb_select_count</command>: Gets the number of rows
- in one or more <literal>NDB</literal> tables.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <command>ndb_select_count</command>: Gets the number of rows in
+ one or more <literal>NDB</literal> tables.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <command>ndb_show_tables</command>: Shows all
- <literal>NDB</literal> tables anywhere in the cluster.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <command>ndb_show_tables</command>: Shows all
+ <literal>NDB</literal> tables anywhere in the cluster.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <command>ndb_size.pl</command>: Examines all the tables in a
- given non-Cluster database and calculates the amount of
- storage each would require if it were converted to use the
- <literal>NDB</literal> storage engine.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <command>ndb_size.pl</command>: Examines all the tables in a
+ given non-Cluster database and calculates the amount of storage
+ each would require if it were converted to use the
+ <literal>NDB</literal> storage engine.
+ </para>
+ </listitem>
<!--
<listitem>
@@ -227,536 +225,532 @@
</listitem>
-->
- <listitem>
- <para>
- <command>ndb_waiter</command>: Reports on the status of
- cluster data nodes in a manner similar to that of the
- management client command <literal>ALL STATUS</literal>.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <command>ndb_waiter</command>: Reports on the status of cluster
+ data nodes in a manner similar to that of the management client
+ command <literal>ALL STATUS</literal>.
+ </para>
+ </listitem>
- <listitem>
+ <listitem>
&mccge-warning-begin;
<para>
- <command>ndbd_redo_log_reader</command>: Reads a redo log
- file, checking it for errors, printing it in a human-readable
- format, or both.
+ <command>ndbd_redo_log_reader</command>: Reads a redo log file,
+ checking it for errors, printing it in a human-readable format,
+ or both.
+ </para>
+
+ <note>
+ <para>
+ An alpha version of this utility was made available in MySQL
+ 5.1.15-ndb-6.1.3. Currently, it should be considered
+ experimental.
</para>
+ </note>
- <note>
- <para>
- An alpha version of this utility was made available in MySQL
- 5.1.15-ndb-6.1.3. Currently, it should be considered
- experimental.
- </para>
- </note>
-
&mccge-warning-end-cluster;
</listitem>
- </itemizedlist>
+ </itemizedlist>
- <para>
- Most of these utilities need to connect to a Cluster management
- server in order to function. The exceptions are
- <filename>ndb_size.pl</filename> (see below), and the following
- utilities which access a cluster data node filesystem and so need
- to be run on a data node host:
- </para>
+ <para>
+ Most of these utilities need to connect to a Cluster management
+ server in order to function. The exceptions are
+ <filename>ndb_size.pl</filename> (see below), and the following
+ utilities which access a cluster data node filesystem and so need to
+ be run on a data node host:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <command>ndb_print_backup_file</command>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <command>ndb_print_backup_file</command>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <command>ndb_print_schema_file</command>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <command>ndb_print_schema_file</command>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <command>ndb_print_sys_file</command>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <command>ndb_print_sys_file</command>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <command>ndbd_redo_log_reader</command>
- (<emphasis>&mccge-series; only</emphasis>)
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <command>ndbd_redo_log_reader</command>
+ (<emphasis>&mccge-series; only</emphasis>)
+ </para>
+ </listitem>
- </itemizedlist>
+ </itemizedlist>
- <para>
- <filename>ndb_size.pl</filename> is a Perl script which is also
- intended to be used from the shell; however it is a MySQL
- application and must be able to connect to a MySQL server. See
- <xref linkend="mysql-cluster-utilities-ndb-size"/>, for additional
- requirements for using this script.
- </para>
+ <para>
+ <filename>ndb_size.pl</filename> is a Perl script which is also
+ intended to be used from the shell; however it is a MySQL
+ application and must be able to connect to a MySQL server. See
+ <xref linkend="mysql-cluster-utilities-ndb-size"/>, for additional
+ requirements for using this script.
+ </para>
- <para>
- <command>ndb_error_reporter</command> is also a Perl script. It is
- used to gather cluster data node and management node logs together
- into a tarball to submit along with a bug report. It can use
- <command>ssh</command> or <command>scp</command> to access the
- node filesystems remotely.
- </para>
+ <para>
+ <command>ndb_error_reporter</command> is also a Perl script. It is
+ used to gather cluster data node and management node logs together
+ into a tarball to submit along with a bug report. It can use
+ <command>ssh</command> or <command>scp</command> to access the node
+ filesystems remotely.
+ </para>
- <para>
- Additional information about each of these utilities (except for
- <command>ndb_mgm</command> and <command>ndb_restore</command>) can
- be found in the sections that follow.
- </para>
+ <para>
+ Additional information about each of these utilities (except for
+ <command>ndb_mgm</command> and <command>ndb_restore</command>) can
+ be found in the sections that follow.
+ </para>
- <note>
- <para>
- All of these utilities (except for
- <command>ndb_size.pl</command> and
- <command>ndb_config</command>) can use the options discussed in
- <xref linkend="mysql-cluster-command-options"/>. Additional
- options specific to each utility program are discussed in the
- individual program listings.
- </para>
- </note>
-
+ <note>
<para>
- The order in which these options are used is generally not
- important. For example, all of these commands produce exactly the
- same output:
+ All of these utilities (except for <command>ndb_size.pl</command>
+ and <command>ndb_config</command>) can use the options discussed
+ in <xref linkend="mysql-cluster-command-options"/>. Additional
+ options specific to each utility program are discussed in the
+ individual program listings.
</para>
+ </note>
- <itemizedlist>
+ <para>
+ The order in which these options are used is generally not
+ important. For example, all of these commands produce exactly the
+ same output:
+ </para>
- <listitem>
- <para>
- <literal>ndb_desc -c localhost fish -d test</literal>
- </para>
- </listitem>
+ <itemizedlist>
- <listitem>
- <para>
- <literal>ndb_desc fish -c localhost -d test</literal>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>ndb_desc -c localhost fish -d test</literal>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>ndb_desc -d test fish -c localhost</literal>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>ndb_desc fish -c localhost -d test</literal>
+ </para>
+ </listitem>
- </itemizedlist>
+ <listitem>
+ <para>
+ <literal>ndb_desc -d test fish -c localhost</literal>
+ </para>
+ </listitem>
- <section id="fake-id-for-ndb-config-manpage-section-wrapper">
+ </itemizedlist>
- <title>fake title for ndb_config manpage section wrapper</title>
+ <section id="fake-id-for-ndb-config-manpage-section-wrapper">
- <refentry id="mysql-cluster-utilities-ndb-config">
+ <title>fake title for ndb_config manpage section wrapper</title>
- <indexterm>
- <primary>ndb_config</primary>
- </indexterm>
+ <refentry id="mysql-cluster-utilities-ndb-config">
- <refmeta>
- <refentrytitle><command>ndb_config</command></refentrytitle>
-
- <manvolnum>1</manvolnum>
- <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
- <refmiscinfo class="source">MySQL</refmiscinfo>
- <refmiscinfo class="version">¤t-series;</refmiscinfo>
- <refmiscinfo class="refman">Extract NDB Configuration Information</refmiscinfo>
- </refmeta>
+ <indexterm>
+ <primary>ndb_config</primary>
+ </indexterm>
- <refnamediv>
- <refname>ndb_config</refname>
-
- <refpurpose>extract NDB configuration information</refpurpose>
- </refnamediv>
+ <refmeta>
+ <refentrytitle><command>ndb_config</command></refentrytitle>
+
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
+ <refmiscinfo class="source">MySQL</refmiscinfo>
+ <refmiscinfo class="version">¤t-series;</refmiscinfo>
+ <refmiscinfo class="refman">Extract NDB Configuration Information</refmiscinfo>
+ </refmeta>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ndb_config <replaceable>options</replaceable></command>
- </cmdsynopsis>
- </refsynopsisdiv>
+ <refnamediv>
+ <refname>ndb_config</refname>
+
+ <refpurpose>extract NDB configuration information</refpurpose>
+ </refnamediv>
- <refsection id="ndb-config-description">
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ndb_config <replaceable>options</replaceable></command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
- <title>Description</title>
+ <refsection id="ndb-config-description">
- <para>
- 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>Description</title>
- <para>
- <emphasis role="bold">Usage</emphasis>:
- </para>
+ <para>
+ 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 entirety in the next
- section, followed by some examples.
- </para>
+ <para>
+ The <replaceable>options</replaceable> 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.
+ </para>
- <para>
- <emphasis role="bold">Options</emphasis>:
- </para>
+ <para>
+ <emphasis role="bold">Options</emphasis>:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <indexterm>
- <primary>ndb_config</primary>
- <secondary>usage option</secondary>
- </indexterm>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_config</primary>
+ <secondary>usage option</secondary>
+ </indexterm>
- <indexterm>
- <primary>usage option</primary>
- <secondary>ndb_config</secondary>
- </indexterm>
+ <indexterm>
+ <primary>usage option</primary>
+ <secondary>ndb_config</secondary>
+ </indexterm>
- <option>--usage</option>, <option>--help</option>, or
- <option>-?</option>
- </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>
+ <para>
+ Causes <command>ndb_config</command> to print a list of
+ available options, and then exit.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <indexterm>
- <primary>ndb_config</primary>
- <secondary>version option</secondary>
- </indexterm>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_config</primary>
+ <secondary>version option</secondary>
+ </indexterm>
- <indexterm>
- <primary>version option</primary>
- <secondary>ndb_config</secondary>
- </indexterm>
+ <indexterm>
+ <primary>version option</primary>
+ <secondary>ndb_config</secondary>
+ </indexterm>
- <option>--version</option>, <option>-V</option>
- </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>
+ <para>
+ Causes <command>ndb_config</command> to print a version
+ information string, and then exit.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <indexterm>
- <primary>ndb_config</primary>
- <secondary>ndb-connectstring option</secondary>
- </indexterm>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_config</primary>
+ <secondary>ndb-connectstring option</secondary>
+ </indexterm>
- <indexterm>
- <primary>ndb-connectstring option</primary>
- <secondary>ndb_config</secondary>
- </indexterm>
+ <indexterm>
+ <primary>ndb-connectstring option</primary>
+ <secondary>ndb_config</secondary>
+ </indexterm>
- <option>--ndb-connectstring=<replaceable>connect_string</replaceable></option>
- </para>
+ <option>--ndb-connectstring=<replaceable>connect_string</replaceable></option>
+ </para>
- <para>
- Specifies the connectstring 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>
+ Specifies the connectstring 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>
- The use of <option>-c</option> as a short version for
- this option is supported for
- <command>ndb_config</command> beginning with MySQL
- 5.1.12.
- </para>
- </listitem>
+ <para>
+ The use of <option>-c</option> as a short version for this
+ option is supported for <command>ndb_config</command>
+ beginning with MySQL 5.1.12.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <indexterm>
- <primary>ndb_config</primary>
- <secondary>config-file option</secondary>
- </indexterm>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_config</primary>
+ <secondary>config-file option</secondary>
+ </indexterm>
- <indexterm>
- <primary>config-file option</primary>
- <secondary>ndb_config</secondary>
- </indexterm>
+ <indexterm>
+ <primary>config-file option</primary>
+ <secondary>ndb_config</secondary>
+ </indexterm>
- <option>--config-file=<replaceable>path-to-file</replaceable></option>
- </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>
+ <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>
- <indexterm>
- <primary>ndb_config</primary>
- <secondary>query option</secondary>
- </indexterm>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_config</primary>
+ <secondary>query option</secondary>
+ </indexterm>
- <indexterm>
- <primary>query option</primary>
- <secondary>ndb_config</secondary>
- </indexterm>
+ <indexterm>
+ <primary>query option</primary>
+ <secondary>ndb_config</secondary>
+ </indexterm>
- <option>--query=<replaceable>query-options</replaceable></option>,
- <option>-q</option>
- <replaceable>query-options</replaceable>
- </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>
+ 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,
+ <para>
+ For example,
- <indexterm>
- <primary>ndb_config</primary>
- <secondary>query option</secondary>
- </indexterm>
+ <indexterm>
+ <primary>ndb_config</primary>
+ <secondary>query option</secondary>
+ </indexterm>
- <indexterm>
- <primary>query option</primary>
- <secondary>ndb_config</secondary>
- </indexterm>
+ <indexterm>
+ <primary>query option</primary>
+ <secondary>ndb_config</secondary>
+ </indexterm>
- <option>--query=id,type,indexmemory,datamemory</option>
- would return the node ID, node type,
- <literal>DataMemory</literal>, and
- <literal>IndexMemory</literal> for each node.
+ <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>
+
+ <note>
+ <para>
+ 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>
+ </note>
+ </listitem>
- <note>
- <para>
- 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>
- </note>
- </listitem>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_config</primary>
+ <secondary>host option</secondary>
+ </indexterm>
- <listitem>
- <para>
- <indexterm>
- <primary>ndb_config</primary>
- <secondary>host option</secondary>
- </indexterm>
+ <indexterm>
+ <primary>host option</primary>
+ <secondary>ndb_config</secondary>
+ </indexterm>
- <indexterm>
- <primary>host option</primary>
- <secondary>ndb_config</secondary>
- </indexterm>
+ <option>--host=<replaceable>hostname</replaceable></option>
+ </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>
- <para>
- Specifies the hostname of the node for which
- configuration information is to be obtained.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_config</primary>
+ <secondary>id option</secondary>
+ </indexterm>
- <listitem>
- <para>
- <indexterm>
- <primary>ndb_config</primary>
- <secondary>id option</secondary>
- </indexterm>
+ <indexterm>
+ <primary>id option</primary>
+ <secondary>ndb_config</secondary>
+ </indexterm>
- <indexterm>
- <primary>id option</primary>
- <secondary>ndb_config</secondary>
- </indexterm>
+ <option>--id=<replaceable>node_id</replaceable></option>,
- <option>--id=<replaceable>node_id</replaceable></option>,
+ <indexterm>
+ <primary>ndb_config</primary>
+ <secondary>nodeid option</secondary>
+ </indexterm>
- <indexterm>
- <primary>ndb_config</primary>
- <secondary>nodeid option</secondary>
- </indexterm>
+ <indexterm>
+ <primary>nodeid option</primary>
+ <secondary>ndb_config</secondary>
+ </indexterm>
- <indexterm>
- <primary>nodeid option</primary>
- <secondary>ndb_config</secondary>
- </indexterm>
+ <option>--nodeid=<replaceable>node_id</replaceable></option>
+ </para>
- <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>
- <para>
- Used to specify the node ID of the node for which
- configuration information is to be obtained.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_config</primary>
+ <secondary>nodes option</secondary>
+ </indexterm>
- <listitem>
- <para>
- <indexterm>
- <primary>ndb_config</primary>
- <secondary>nodes option</secondary>
- </indexterm>
+ <indexterm>
+ <primary>nodes option</primary>
+ <secondary>ndb_config</secondary>
+ </indexterm>
- <indexterm>
- <primary>nodes option</primary>
- <secondary>ndb_config</secondary>
- </indexterm>
+ <option>--nodes</option>
+ </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>
- <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>
+ <indexterm>
+ <primary>ndb_config</primary>
+ <secondary>type option</secondary>
+ </indexterm>
- <listitem>
- <para>
- <indexterm>
- <primary>ndb_config</primary>
- <secondary>type option</secondary>
- </indexterm>
+ <indexterm>
+ <primary>type option</primary>
+ <secondary>ndb_config</secondary>
+ </indexterm>
- <indexterm>
- <primary>type option</primary>
- <secondary>ndb_config</secondary>
- </indexterm>
+ <option>--type=<replaceable>node_type</replaceable></option>
+ </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>
- <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>
+ <indexterm>
+ <primary>ndb_config</primary>
+ <secondary>fields option</secondary>
+ </indexterm>
- <listitem>
- <para>
- <indexterm>
- <primary>ndb_config</primary>
- <secondary>fields option</secondary>
- </indexterm>
+ <indexterm>
+ <primary>fields option</primary>
+ <secondary>ndb_config</secondary>
+ </indexterm>
- <indexterm>
- <primary>fields option</primary>
- <secondary>ndb_config</secondary>
- </indexterm>
+ <option>--fields=<replaceable>delimiter</replaceable></option>,
+ <option>-f</option> <replaceable>delimiter</replaceable>
+ </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>
+ <note>
<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).
+ If the <replaceable>delimiter</replaceable> contains
+ spaces or escapes (such as <literal>\n</literal> for the
+ linefeed character), then it must be quoted.
</para>
+ </note>
+ </listitem>
- <note>
- <para>
- If the <replaceable>delimiter</replaceable> contains
- spaces or escapes (such as <literal>\n</literal> for
- the linefeed character), then it must be quoted.
- </para>
- </note>
- </listitem>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_config</primary>
+ <secondary>rows option</secondary>
+ </indexterm>
- <listitem>
- <para>
- <indexterm>
- <primary>ndb_config</primary>
- <secondary>rows option</secondary>
- </indexterm>
+ <indexterm>
+ <primary>rows option</primary>
+ <secondary>ndb_config</secondary>
+ </indexterm>
- <indexterm>
- <primary>rows option</primary>
- <secondary>ndb_config</secondary>
- </indexterm>
+ <option>--rows=<replaceable>separator</replaceable></option>,
+ <option>-r</option> <replaceable>separator</replaceable>
+ </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>
+ <note>
<para>
- Specifies a <replaceable>separator</replaceable> string
- used to separate the rows in the result. The default is
- a space character.
+ If the <replaceable>separator</replaceable> contains
+ spaces or escapes (such as <literal>\n</literal> for the
+ linefeed character), then it must be quoted.
</para>
+ </note>
+ </listitem>
- <note>
- <para>
- If the <replaceable>separator</replaceable> contains
- spaces or escapes (such as <literal>\n</literal> for
- the linefeed character), then it must be quoted.
- </para>
- </note>
- </listitem>
+ </itemizedlist>
- </itemizedlist>
+ <para>
+ <emphasis role="bold">Examples</emphasis>:
+ </para>
- <para>
- <emphasis role="bold">Examples</emphasis>:
- </para>
+ <orderedlist>
- <orderedlist>
+ <listitem>
+ <para>
+ To obtain the node ID and type of each node in the
+ cluster:
+ </para>
- <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
@@ -770,37 +764,37 @@
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>
+ <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>
+ <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>
- <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>
+ <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>
@@ -810,18 +804,18 @@
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>
+ <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>
+ <listitem>
+ <para>
+ To exclude results from any host except one in particular,
+ use the <option>--host</option> option:
+ </para>
<programlisting>
shell> <userinput>./ndb_config --host=192.168.0.176 -f : -r '\n' -q id,type</userinput>
@@ -829,257 +823,255 @@
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>
+ 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>
+ <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>
+ </orderedlist>
- </refsection>
+ </refsection>
- </refentry>
+ </refentry>
- </section>
+ </section>
- <section id="fake-id-for-ndb-cpcd-manpage-section-wrapper">
+ <section id="fake-id-for-ndb-cpcd-manpage-section-wrapper">
- <title>fake title for ndb_cpcd manpage section wrapper</title>
+ <title>fake title for ndb_cpcd manpage section wrapper</title>
- <refentry id="mysql-cluster-utilities-ndb-cpcd">
+ <refentry id="mysql-cluster-utilities-ndb-cpcd">
- <indexterm>
- <primary>ndb_cpcd</primary>
- </indexterm>
+ <indexterm>
+ <primary>ndb_cpcd</primary>
+ </indexterm>
- <refmeta>
- <refentrytitle><command>ndb_cpcd</command></refentrytitle>
-
- <manvolnum>1</manvolnum>
- <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
- <refmiscinfo class="source">MySQL</refmiscinfo>
- <refmiscinfo class="version">¤t-series;</refmiscinfo>
- <refmiscinfo class="refman">Automate Testing for NDB Development</refmiscinfo>
- </refmeta>
+ <refmeta>
+ <refentrytitle><command>ndb_cpcd</command></refentrytitle>
+
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
+ <refmiscinfo class="source">MySQL</refmiscinfo>
+ <refmiscinfo class="version">¤t-series;</refmiscinfo>
+ <refmiscinfo class="refman">Automate Testing for NDB Development</refmiscinfo>
+ </refmeta>
- <refnamediv>
- <refname>ndb_cpcd</refname>
-
- <refpurpose>automate testing of NDB (development use only)</refpurpose>
- </refnamediv>
+ <refnamediv>
+ <refname>ndb_cpcd</refname>
+
+ <refpurpose>automate testing of NDB (development use only)</refpurpose>
+ </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ndb_cpcd <replaceable>options</replaceable></command>
- </cmdsynopsis>
- </refsynopsisdiv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ndb_cpcd <replaceable>options</replaceable></command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
- <refsection id="ndb-cpcd-description">
+ <refsection id="ndb-cpcd-description">
- <title>Description</title>
+ <title>Description</title>
- <para>
- This utility is found in the <filename>libexec</filename>
- directory. It is part of an internal automated test
- framework used in testing and bedugging MySQL Cluster.
- Because it can control processes on remote systems, it is
- not advisable to use <command>ndb_cpcd</command> in a
- production cluster.
- </para>
+ <para>
+ This utility is found in the <filename>libexec</filename>
+ directory. It is part of an internal automated test framework
+ used in testing and bedugging MySQL Cluster. Because it can
+ control processes on remote systems, it is not advisable to
+ use <command>ndb_cpcd</command> in a production cluster.
+ </para>
- <remark role="TODO">
- [js] Update following para with xref when info is added to
- Internals Manual.
- </remark>
+ <remark role="TODO">
+ [js] Update following para with xref when info is added to
+ Internals Manual.
+ </remark>
- <para>
- Because some users may be interested in employing the
- Cluster testing framework for their own development or
- testing purposes, we intend to make details of this
- application's usage available in the near future as part of
- the MySQL Internals Manual.
- </para>
+ <para>
+ Because some users may be interested in employing the Cluster
+ testing framework for their own development or testing
+ purposes, we intend to make details of this application's
+ usage available in the near future as part of the MySQL
+ Internals Manual.
+ </para>
- <para>
- The source files for <command>ndb_cpcd</command> may be
- found in the directory
- <filename>storage/ndb/src/cw/cpcd</filename>, in the MySQL
- ¤t-series; source tree.
- </para>
+ <para>
+ The source files for <command>ndb_cpcd</command> may be found
+ in the directory <filename>storage/ndb/src/cw/cpcd</filename>,
+ in the MySQL ¤t-series; source tree.
+ </para>
- </refsection>
+ </refsection>
- </refentry>
+ </refentry>
- </section>
+ </section>
- <section id="fake-id-for-ndb-delete-all-manpage-section-wrapper">
+ <section id="fake-id-for-ndb-delete-all-manpage-section-wrapper">
- <title>fake title for ndb_delete_all manpage section wrapper</title>
+ <title>fake title for ndb_delete_all manpage section wrapper</title>
- <refentry id="mysql-cluster-utilities-ndb-delete-all">
+ <refentry id="mysql-cluster-utilities-ndb-delete-all">
- <indexterm>
- <primary>ndb_delete_all</primary>
- </indexterm>
+ <indexterm>
+ <primary>ndb_delete_all</primary>
+ </indexterm>
- <refmeta>
- <refentrytitle><command>ndb_delete_all</command></refentrytitle>
-
- <manvolnum>1</manvolnum>
- <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
- <refmiscinfo class="source">MySQL</refmiscinfo>
- <refmiscinfo class="version">¤t-series;</refmiscinfo>
- <refmiscinfo class="refman">Delete All Rows from NDB Table</refmiscinfo>
- </refmeta>
+ <refmeta>
+ <refentrytitle><command>ndb_delete_all</command></refentrytitle>
+
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
+ <refmiscinfo class="source">MySQL</refmiscinfo>
+ <refmiscinfo class="version">¤t-series;</refmiscinfo>
+ <refmiscinfo class="refman">Delete All Rows from NDB Table</refmiscinfo>
+ </refmeta>
- <refnamediv>
- <refname>ndb_delete_all</refname>
-
- <refpurpose>delete all rows from NDB table</refpurpose>
- </refnamediv>
+ <refnamediv>
+ <refname>ndb_delete_all</refname>
+
+ <refpurpose>delete all rows from NDB table</refpurpose>
+ </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ndb_delete_all <replaceable>options</replaceable></command>
- </cmdsynopsis>
- </refsynopsisdiv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ndb_delete_all <replaceable>options</replaceable></command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
- <refsection id="ndb-delete-all-description">
+ <refsection id="ndb-delete-all-description">
- <title>Description</title>
+ <title>Description</title>
- <para>
- <command>ndb_delete_all</command> deletes all rows from the
- given <literal>NDB</literal> table. In some cases, this can
- be much faster than <literal>DELETE</literal> or even
- <literal>TRUNCATE</literal>.
- </para>
+ <para>
+ <command>ndb_delete_all</command> deletes all rows from the
+ given <literal>NDB</literal> table. In some cases, this can be
+ much faster than <literal>DELETE</literal> or even
+ <literal>TRUNCATE</literal>.
+ </para>
- <para>
- <emphasis role="bold">Usage</emphasis>:
- </para>
+ <para>
+ <emphasis role="bold">Usage</emphasis>:
+ </para>
<programlisting>
ndb_delete_all -c <replaceable>connect_string</replaceable> <replaceable>tbl_name</replaceable> -d <replaceable>db_name</replaceable>
</programlisting>
- <para>
- This deletes all rows from the table named
- <replaceable>tbl_name</replaceable> in the database named
- <replaceable>db_name</replaceable>. It is exactly equivalent
- to executing <literal>TRUNCATE
- <replaceable>db_name</replaceable>.<replaceable>tbl_name</replaceable></literal>
- in MySQL.
- </para>
+ <para>
+ This deletes all rows from the table named
+ <replaceable>tbl_name</replaceable> in the database named
+ <replaceable>db_name</replaceable>. It is exactly equivalent
+ to executing <literal>TRUNCATE
+ <replaceable>db_name</replaceable>.<replaceable>tbl_name</replaceable></literal>
+ in MySQL.
+ </para>
- <para>
- <emphasis role="bold">Additional Options</emphasis>:
- </para>
+ <para>
+ <emphasis role="bold">Additional Options</emphasis>:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <indexterm>
- <primary>ndb_delete_all</primary>
- <secondary>transactional option</secondary>
- </indexterm>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_delete_all</primary>
+ <secondary>transactional option</secondary>
+ </indexterm>
- <indexterm>
- <primary>transactional option</primary>
- <secondary>ndb_delete_all</secondary>
- </indexterm>
+ <indexterm>
+ <primary>transactional option</primary>
+ <secondary>ndb_delete_all</secondary>
+ </indexterm>
- <option>--transactional</option>, <option>-t</option>
- </para>
+ <option>--transactional</option>, <option>-t</option>
+ </para>
+ <para>
+ Use of this option causes the delete operation to be
+ performed as a single transaction.
+ </para>
+
+ <warning>
<para>
- Use of this option causes the delete operation to be
- performed as a single transaction.
+ With very large tables, using this option may cause the
+ number of operations available to the cluster to be
+ exceeded.
</para>
+ </warning>
+ </listitem>
- <warning>
- <para>
- With very large tables, using this option may cause
- the number of operations available to the cluster to
- be exceeded.
- </para>
- </warning>
- </listitem>
+ </itemizedlist>
- </itemizedlist>
+ </refsection>
- </refsection>
+ </refentry>
- </refentry>
+ </section>
- </section>
+ <section id="fake-id-for-ndb-desc-manpage-section-wrapper">
- <section id="fake-id-for-ndb-desc-manpage-section-wrapper">
+ <title>fake title for ndb_desc manpage section wrapper</title>
- <title>fake title for ndb_desc manpage section wrapper</title>
+ <refentry id="mysql-cluster-utilities-ndb-desc">
- <refentry id="mysql-cluster-utilities-ndb-desc">
+ <indexterm>
+ <primary>ndb_desc</primary>
+ </indexterm>
- <indexterm>
- <primary>ndb_desc</primary>
- </indexterm>
+ <refmeta>
+ <refentrytitle><command>ndb_desc</command></refentrytitle>
+
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
+ <refmiscinfo class="source">MySQL</refmiscinfo>
+ <refmiscinfo class="version">¤t-series;</refmiscinfo>
+ <refmiscinfo class="refman">Describe NDB Tables</refmiscinfo>
+ </refmeta>
- <refmeta>
- <refentrytitle><command>ndb_desc</command></refentrytitle>
-
- <manvolnum>1</manvolnum>
- <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
- <refmiscinfo class="source">MySQL</refmiscinfo>
- <refmiscinfo class="version">¤t-series;</refmiscinfo>
- <refmiscinfo class="refman">Describe NDB Tables</refmiscinfo>
- </refmeta>
+ <refnamediv>
+ <refname>ndb_desc</refname>
+
+ <refpurpose>describe NDB tables</refpurpose>
+ </refnamediv>
- <refnamediv>
- <refname>ndb_desc</refname>
-
- <refpurpose>describe NDB tables</refpurpose>
- </refnamediv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ndb_desc <replaceable>options</replaceable></command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ndb_desc <replaceable>options</replaceable></command>
- </cmdsynopsis>
- </refsynopsisdiv>
+ <refsection id="ndb-desc-description">
- <refsection id="ndb-desc-description">
+ <title>Description</title>
- <title>Description</title>
+ <para>
+ <command>ndb_desc</command> provides a detailed description of
+ one or more <literal>NDB</literal> tables.
+ </para>
- <para>
- <command>ndb_desc</command> provides a detailed description
- of one or more <literal>NDB</literal> tables.
- </para>
+ <para>
+ <emphasis role="bold">Usage</emphasis>:
+ </para>
- <para>
- <emphasis role="bold">Usage</emphasis>:
- </para>
-
<programlisting>
ndb_desc -c <replaceable>connect_string</replaceable> <replaceable>tbl_name</replaceable> -d <replaceable>db_name</replaceable>
</programlisting>
- <para>
- <emphasis role="bold">Sample Output</emphasis>:
- </para>
+ <para>
+ <emphasis role="bold">Sample Output</emphasis>:
+ </para>
- <para>
- MySQL table creation and population statements:
- </para>
+ <para>
+ MySQL table creation and population statements:
+ </para>
<programlisting>
USE test;
@@ -1097,9 +1089,9 @@
('','manta ray'), ('','grouper'), ('','puffer');
</programlisting>
- <para>
- Output from <command>ndb_desc</command>:
- </para>
+ <para>
+ Output from <command>ndb_desc</command>:
+ </para>
<programlisting>
shell> <userinput>./ndb_desc -c localhost fish -d test -p</userinput>
@@ -1135,125 +1127,125 @@
NDBT_ProgramExit: 0 - OK
</programlisting>
- <para>
- <emphasis role="bold">Additional Options</emphasis>:
- </para>
+ <para>
+ <emphasis role="bold">Additional Options</emphasis>:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <indexterm>
- <primary>ndb_desc</primary>
- <secondary>extra-partition-info option</secondary>
- </indexterm>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_desc</primary>
+ <secondary>extra-partition-info option</secondary>
+ </indexterm>
- <indexterm>
- <primary>extra-partition-info option</primary>
- <secondary>ndb_desc</secondary>
- </indexterm>
+ <indexterm>
+ <primary>extra-partition-info option</primary>
+ <secondary>ndb_desc</secondary>
+ </indexterm>
- <option>--extra-partition-info</option>,
- <option>-p</option>
- </para>
+ <option>--extra-partition-info</option>,
+ <option>-p</option>
+ </para>
- <para>
- Prints additional information about the table's
- partitions.
- </para>
- </listitem>
+ <para>
+ Prints additional information about the table's
+ partitions.
+ </para>
+ </listitem>
- <listitem>
- <para>
- Information about multiple tables can be obtained in a
- single invocation of <command>ndb_desc</command> by
- using their names, separated by spaces. All of the
- tables must be in the same database.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ Information about multiple tables can be obtained in a
+ single invocation of <command>ndb_desc</command> by using
+ their names, separated by spaces. All of the tables must
+ be in the same database.
+ </para>
+ </listitem>
- </itemizedlist>
+ </itemizedlist>
- </refsection>
+ </refsection>
- </refentry>
+ </refentry>
- </section>
+ </section>
- <section id="fake-id-for-ndb-drop-index-manpage-section-wrapper">
+ <section id="fake-id-for-ndb-drop-index-manpage-section-wrapper">
- <title>fake title for ndb_drop_index manpage section wrapper</title>
+ <title>fake title for ndb_drop_index manpage section wrapper</title>
- <refentry id="mysql-cluster-utilities-ndb-drop-index">
+ <refentry id="mysql-cluster-utilities-ndb-drop-index">
- <indexterm>
- <primary>ndb_drop_index</primary>
- </indexterm>
+ <indexterm>
+ <primary>ndb_drop_index</primary>
+ </indexterm>
- <refmeta>
- <refentrytitle><command>ndb_drop_index</command></refentrytitle>
-
- <manvolnum>1</manvolnum>
- <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
- <refmiscinfo class="source">MySQL</refmiscinfo>
- <refmiscinfo class="version">¤t-series;</refmiscinfo>
- <refmiscinfo class="refman">Drop Index from NDB Table</refmiscinfo>
- </refmeta>
+ <refmeta>
+ <refentrytitle><command>ndb_drop_index</command></refentrytitle>
+
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
+ <refmiscinfo class="source">MySQL</refmiscinfo>
+ <refmiscinfo class="version">¤t-series;</refmiscinfo>
+ <refmiscinfo class="refman">Drop Index from NDB Table</refmiscinfo>
+ </refmeta>
- <refnamediv>
- <refname>ndb_drop_index</refname>
-
- <refpurpose>drop index from NDB table</refpurpose>
- </refnamediv>
+ <refnamediv>
+ <refname>ndb_drop_index</refname>
+
+ <refpurpose>drop index from NDB table</refpurpose>
+ </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ndb_drop_index <replaceable>options</replaceable></command>
- </cmdsynopsis>
- </refsynopsisdiv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ndb_drop_index <replaceable>options</replaceable></command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
- <refsection id="ndb-drop-index-description">
+ <refsection id="ndb-drop-index-description">
- <title>Description</title>
+ <title>Description</title>
- <para>
- <command>ndb_drop_index</command> drops the specified index
- from an <literal>NDB</literal> table. <emphasis>It is
- recommended that you use this utility only as an example for
- writing NDB API applications</emphasis> — see the
- Warning later in this section for details.
- </para>
+ <para>
+ <command>ndb_drop_index</command> drops the specified index
+ from an <literal>NDB</literal> table. <emphasis>It is
+ recommended that you use this utility only as an example for
+ writing NDB API applications</emphasis> — see the
+ Warning later in this section for details.
+ </para>
- <para>
- <emphasis role="bold">Usage</emphasis>:
- </para>
+ <para>
+ <emphasis role="bold">Usage</emphasis>:
+ </para>
<programlisting>
ndb_drop_index -c <replaceable>connect_string</replaceable> <replaceable>table_name</replaceable> <replaceable>index</replaceable> -d <replaceable>db_name</replaceable>
</programlisting>
- <para>
- The statement shown above drops the index named
- <replaceable>index</replaceable> from the
- <replaceable>table</replaceable> in the
- <replaceable>database</replaceable>.
- </para>
+ <para>
+ The statement shown above drops the index named
+ <replaceable>index</replaceable> from the
+ <replaceable>table</replaceable> in the
+ <replaceable>database</replaceable>.
+ </para>
+ <para>
+ <emphasis role="bold">Additional Options</emphasis>: None that
+ are specific to this application.
+ </para>
+
+ <warning>
<para>
- <emphasis role="bold">Additional Options</emphasis>: None
- that are specific to this application.
+ <emphasis>Operations performed on Cluster table indexes
+ using the NDB API are not visible to MySQL and make the
+ table unusable by a MySQL server</emphasis>. If you use this
+ program to drop an index, then try to access the table from
+ an SQL node, an error results, as shown here:
</para>
+ </warning>
- <warning>
- <para>
- <emphasis>Operations performed on Cluster table indexes
- using the NDB API are not visible to MySQL and make the
- table unusable by a MySQL server</emphasis>. If you use
- this program to drop an index, then try to access the
- table from an SQL node, an error results, as shown here:
- </para>
- </warning>
-
<programlisting>
shell> <userinput>./ndb_drop_index -c localhost dogs ix -d ctest1</userinput>
Dropping index dogs/idx...OK
@@ -1287,554 +1279,551 @@
<errortext>ERROR 1296 (HY000): Got error 4243 'Index not found' from NDBCLUSTER</errortext>
</programlisting>
- <para>
- In such a case, your <emphasis>only</emphasis> option for
- making the table available to MySQL again is to drop the
- table and re-create it. You can use either the SQL
- statement<literal>DROP TABLE</literal> or the
- <command>ndb_drop_table</command> utility (see
- <xref linkend="mysql-cluster-utilities-ndb-drop-table"/>) to
- drop the table.
- </para>
+ <para>
+ In such a case, your <emphasis>only</emphasis> option for
+ making the table available to MySQL again is to drop the table
+ and re-create it. You can use either the SQL
+ statement<literal>DROP TABLE</literal> or the
+ <command>ndb_drop_table</command> utility (see
+ <xref linkend="mysql-cluster-utilities-ndb-drop-table"/>) to
+ drop the table.
+ </para>
- </refsection>
+ </refsection>
- </refentry>
+ </refentry>
- </section>
+ </section>
- <section id="fake-id-for-ndb-drop-table-manpage-section-wrapper">
+ <section id="fake-id-for-ndb-drop-table-manpage-section-wrapper">
- <title>fake title for ndb_drop_table manpage section wrapper</title>
+ <title>fake title for ndb_drop_table manpage section wrapper</title>
- <refentry id="mysql-cluster-utilities-ndb-drop-table">
+ <refentry id="mysql-cluster-utilities-ndb-drop-table">
- <indexterm>
- <primary>ndb_drop_table</primary>
- </indexterm>
+ <indexterm>
+ <primary>ndb_drop_table</primary>
+ </indexterm>
- <refmeta>
- <refentrytitle><command>ndb_drop_table</command></refentrytitle>
-
- <manvolnum>1</manvolnum>
- <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
- <refmiscinfo class="source">MySQL</refmiscinfo>
- <refmiscinfo class="version">¤t-series;</refmiscinfo>
- <refmiscinfo class="refman">Drop NDB Table</refmiscinfo>
- </refmeta>
+ <refmeta>
+ <refentrytitle><command>ndb_drop_table</command></refentrytitle>
+
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
+ <refmiscinfo class="source">MySQL</refmiscinfo>
+ <refmiscinfo class="version">¤t-series;</refmiscinfo>
+ <refmiscinfo class="refman">Drop NDB Table</refmiscinfo>
+ </refmeta>
- <refnamediv>
- <refname>ndb_drop_table</refname>
-
- <refpurpose>drop NDB table</refpurpose>
- </refnamediv>
+ <refnamediv>
+ <refname>ndb_drop_table</refname>
+
+ <refpurpose>drop NDB table</refpurpose>
+ </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ndb_drop_table <replaceable>options</replaceable></command>
- </cmdsynopsis>
- </refsynopsisdiv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ndb_drop_table <replaceable>options</replaceable></command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
- <refsection id="ndb-drop-table-description">
+ <refsection id="ndb-drop-table-description">
- <title>Description</title>
+ <title>Description</title>
- <para>
- <command>ndb_drop_table</command> drops the specified
- <literal>NDB</literal> table. (If you try to use this on a
- table created with a storage engine other than NDB, it fails
- with the error <errortext>723: No such table
- exists</errortext>.) This operation is extremely fast
- — in some cases, it can be an order of magnitude
- faster than using <literal>DROP TABLE</literal> on an
- <literal>NDB</literal> table from MySQL.
- </para>
+ <para>
+ <command>ndb_drop_table</command> drops the specified
+ <literal>NDB</literal> table. (If you try to use this on a
+ table created with a storage engine other than NDB, it fails
+ with the error <errortext>723: No such table
+ exists</errortext>.) This operation is extremely fast —
+ in some cases, it can be an order of magnitude faster than
+ using <literal>DROP TABLE</literal> on an
+ <literal>NDB</literal> table from MySQL.
+ </para>
- <para>
- <emphasis role="bold">Usage</emphasis>:
- </para>
+ <para>
+ <emphasis role="bold">Usage</emphasis>:
+ </para>
<programlisting>
ndb_drop_table -c <replaceable>connect_string</replaceable> <replaceable>tbl_name</replaceable> -d <replaceable>db_name</replaceable>
</programlisting>
- <para>
- <emphasis role="bold">Additional Options</emphasis>: None.
- </para>
+ <para>
+ <emphasis role="bold">Additional Options</emphasis>: None.
+ </para>
- </refsection>
+ </refsection>
- </refentry>
+ </refentry>
- </section>
+ </section>
- <section id="fake-id-for-ndb-error-reporter-manpage-section-wrapper">
+ <section id="fake-id-for-ndb-error-reporter-manpage-section-wrapper">
- <title>fake title for ndb_error_reporter manpage section wrapper</title>
+ <title>fake title for ndb_error_reporter manpage section wrapper</title>
- <refentry id="mysql-cluster-utilities-ndb-error-reporter">
+ <refentry id="mysql-cluster-utilities-ndb-error-reporter">
- <indexterm>
- <primary>ndb_error_reporter</primary>
- </indexterm>
+ <indexterm>
+ <primary>ndb_error_reporter</primary>
+ </indexterm>
- <indexterm>
- <primary>bugs</primary>
- <secondary>MySQL Cluster</secondary>
- <tertiary>reporting</tertiary>
- </indexterm>
+ <indexterm>
+ <primary>bugs</primary>
+ <secondary>MySQL Cluster</secondary>
+ <tertiary>reporting</tertiary>
+ </indexterm>
- <refmeta>
- <refentrytitle><command>ndb_error_reporter</command></refentrytitle>
-
- <manvolnum>1</manvolnum>
- <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
- <refmiscinfo class="source">MySQL</refmiscinfo>
- <refmiscinfo class="version">¤t-series;</refmiscinfo>
- <refmiscinfo class="refman">NDB Error-Reporting Utility</refmiscinfo>
- </refmeta>
+ <refmeta>
+ <refentrytitle><command>ndb_error_reporter</command></refentrytitle>
+
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
+ <refmiscinfo class="source">MySQL</refmiscinfo>
+ <refmiscinfo class="version">¤t-series;</refmiscinfo>
+ <refmiscinfo class="refman">NDB Error-Reporting Utility</refmiscinfo>
+ </refmeta>
- <refnamediv>
- <refname>ndb_error_reporter</refname>
-
- <refpurpose>NDB error-reporting utility</refpurpose>
- </refnamediv>
+ <refnamediv>
+ <refname>ndb_error_reporter</refname>
+
+ <refpurpose>NDB error-reporting utility</refpurpose>
+ </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ndb_error_reporter <replaceable>options</replaceable></command>
- </cmdsynopsis>
- </refsynopsisdiv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ndb_error_reporter <replaceable>options</replaceable></command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
- <refsection id="ndb-error-reporter-description">
+ <refsection id="ndb-error-reporter-description">
- <title>Description</title>
+ <title>Description</title>
- <para>
- <command>ndb_error_reporter</command> creates an archive
- from data node and management node log files that can be
- used to help diagnose bugs or other problems with a cluster.
- <emphasis>It is highly recommended that you make use of this
- utility when filing reports of bugs in MySQL
- Cluster</emphasis>.
- </para>
+ <para>
+ <command>ndb_error_reporter</command> creates an archive from
+ data node and management node log files that can be used to
+ help diagnose bugs or other problems with a cluster.
+ <emphasis>It is highly recommended that you make use of this
+ utility when filing reports of bugs in MySQL
+ Cluster</emphasis>.
+ </para>
- <para>
- <emphasis role="bold">Usage</emphasis>:
- </para>
+ <para>
+ <emphasis role="bold">Usage</emphasis>:
+ </para>
<programlisting>
ndb_error_reporter <replaceable>path/to/config-file</replaceable> [<replaceable>username</replaceable>] [--fs]
</programlisting>
- <para>
- This utility is intended for use on a management node host,
- and requires the path to the management host configuration
- file (<filename>config.ini</filename>). Optionally, you can
- supply the name of a user that is able to access the
- cluster's data nodes via SSH, in order to copy the data node
- log files. ndb_error_reporter then includes all of these
- files in archive that is created in the same directory in
- which it is run. The archive is named
- <filename>ndb_error_report_<replaceable>YYYYMMDDHHMMSS</replaceable>.tar.bz2</filename>,
- where <replaceable>YYYYMMDDHHMMSS</replaceable> is a
- datetime string.
- </para>
+ <para>
+ This utility is intended for use on a management node host,
+ and requires the path to the management host configuration
+ file (<filename>config.ini</filename>). Optionally, you can
+ supply the name of a user that is able to access the cluster's
+ data nodes via SSH, in order to copy the data node log files.
+ ndb_error_reporter then includes all of these files in archive
+ that is created in the same directory in which it is run. The
+ archive is named
+ <filename>ndb_error_report_<replaceable>YYYYMMDDHHMMSS</replaceable>.tar.bz2</filename>,
+ where <replaceable>YYYYMMDDHHMMSS</replaceable> is a datetime
+ string.
+ </para>
- <para>
- If the <option>--fs</option> is used, then the data node
- filesystems are also copied to the management host and
- included in the archive that is produced by this script. As
- data node filesystems can be extremely large even after
- being compressed, we ask that you please do
- <emphasis>not</emphasis> send archives created using this
- option to MySQL AB unless you are specifically requested to
- do so.
- </para>
+ <para>
+ If the <option>--fs</option> is used, then the data node
+ filesystems are also copied to the management host and
+ included in the archive that is produced by this script. As
+ data node filesystems can be extremely large even after being
+ compressed, we ask that you please do <emphasis>not</emphasis>
+ send archives created using this option to MySQL AB unless you
+ are specifically requested to do so.
+ </para>
- </refsection>
+ </refsection>
- </refentry>
+ </refentry>
- </section>
+ </section>
- <section id="fake-id-for-ndb-print-backup-file-manpage-section-wrapper">
+ <section id="fake-id-for-ndb-print-backup-file-manpage-section-wrapper">
- <title>fake title for ndb_print_backup_file manpage section wrapper</title>
+ <title>fake title for ndb_print_backup_file manpage section wrapper</title>
- <refentry id="mysql-cluster-utilities-ndb-print-backup-file">
+ <refentry id="mysql-cluster-utilities-ndb-print-backup-file">
- <indexterm>
- <primary>ndb_print_backup_file</primary>
- </indexterm>
+ <indexterm>
+ <primary>ndb_print_backup_file</primary>
+ </indexterm>
- <refmeta>
- <refentrytitle><command>ndb_print_backup_file</command></refentrytitle>
-
- <manvolnum>1</manvolnum>
- <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
- <refmiscinfo class="source">MySQL</refmiscinfo>
- <refmiscinfo class="version">¤t-series;</refmiscinfo>
- <refmiscinfo class="refman">Print NDB Backup File Contents</refmiscinfo>
- </refmeta>
+ <refmeta>
+ <refentrytitle><command>ndb_print_backup_file</command></refentrytitle>
+
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
+ <refmiscinfo class="source">MySQL</refmiscinfo>
+ <refmiscinfo class="version">¤t-series;</refmiscinfo>
+ <refmiscinfo class="refman">Print NDB Backup File Contents</refmiscinfo>
+ </refmeta>
- <refnamediv>
- <refname>ndb_print_backup_file</refname>
-
- <refpurpose>print NDB backup file contents</refpurpose>
- </refnamediv>
+ <refnamediv>
+ <refname>ndb_print_backup_file</refname>
+
+ <refpurpose>print NDB backup file contents</refpurpose>
+ </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ndb_print_backup_file <replaceable>file_name</replaceable></command>
- </cmdsynopsis>
- </refsynopsisdiv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ndb_print_backup_file <replaceable>file_name</replaceable></command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
- <refsection id="ndb-print-backup-file-description">
+ <refsection id="ndb-print-backup-file-description">
- <title>Description</title>
+ <title>Description</title>
- <para>
- <command>ndb_print_backup_file</command> obtains diagnostic
- information from a cluster backup file.
- </para>
+ <para>
+ <command>ndb_print_backup_file</command> obtains diagnostic
+ information from a cluster backup file.
+ </para>
- <para>
- <emphasis role="bold">Usage</emphasis>:
- </para>
+ <para>
+ <emphasis role="bold">Usage</emphasis>:
+ </para>
<programlisting>
ndb_print_backup_file <replaceable>file_name</replaceable>
</programlisting>
- <para>
- <replaceable>file_name</replaceable> is the name of a
- cluster backup file. This can be any of the files
- (<filename>.Data</filename>, <filename>.ctl</filename>, or
- <filename>.log</filename> file) found in a cluster backup
- directory. These files are found in the data node's backup
- directory under the subdirectory
- <filename>BACKUP-<replaceable>#</replaceable></filename>,
- where <replaceable>#</replaceable> is the sequence number
- for the backup. For more information about cluster backup
- files and their contents, see
- <xref linkend="mysql-cluster-backup-concepts"/>.
- </para>
+ <para>
+ <replaceable>file_name</replaceable> is the name of a cluster
+ backup file. This can be any of the files
+ (<filename>.Data</filename>, <filename>.ctl</filename>, or
+ <filename>.log</filename> file) found in a cluster backup
+ directory. These files are found in the data node's backup
+ directory under the subdirectory
+ <filename>BACKUP-<replaceable>#</replaceable></filename>,
+ where <replaceable>#</replaceable> is the sequence number for
+ the backup. For more information about cluster backup files
+ and their contents, see
+ <xref linkend="mysql-cluster-backup-concepts"/>.
+ </para>
- <para>
- Like <command>ndb_print_schema_file</command> and
- <command>ndb_print_sys_file</command> (and unlike most of
- the other <literal>NDB</literal> utilities that are intended
- to be run on a management server host or to connect to a
- management server) <command>ndb_print_backup_file</command>
- must be run on a cluster data node, since it accesses the
- data node filesystem directly. Because it does not make use
- of the management server, this utility can be used when the
- management server is not running, and even when the cluster
- has been completely shut down.
- </para>
+ <para>
+ Like <command>ndb_print_schema_file</command> and
+ <command>ndb_print_sys_file</command> (and unlike most of the
+ other <literal>NDB</literal> utilities that are intended to be
+ run on a management server host or to connect to a management
+ server) <command>ndb_print_backup_file</command> must be run
+ on a cluster data node, since it accesses the data node
+ filesystem directly. Because it does not make use of the
+ management server, this utility can be used when the
+ management server is not running, and even when the cluster
+ has been completely shut down.
+ </para>
- <remark role="todo">
- [js] Add sample output with explanation.
- </remark>
+ <remark role="todo">
+ [js] Add sample output with explanation.
+ </remark>
- <para>
- <emphasis role="bold">Additional Options</emphasis>: None.
- </para>
+ <para>
+ <emphasis role="bold">Additional Options</emphasis>: None.
+ </para>
- </refsection>
+ </refsection>
- </refentry>
+ </refentry>
- </section>
+ </section>
- <section id="fake-id-for-ndb-print-schema-file-manpage-section-wrapper">
+ <section id="fake-id-for-ndb-print-schema-file-manpage-section-wrapper">
- <title>fake title for ndb_print_schema_file manpage section wrapper</title>
+ <title>fake title for ndb_print_schema_file manpage section wrapper</title>
- <refentry id="mysql-cluster-utilities-ndb-print-schema-file">
+ <refentry id="mysql-cluster-utilities-ndb-print-schema-file">
- <indexterm>
- <primary>ndb_print_schema_file</primary>
- </indexterm>
+ <indexterm>
+ <primary>ndb_print_schema_file</primary>
+ </indexterm>
- <refmeta>
- <refentrytitle><command>ndb_print_schema_file</command></refentrytitle>
-
- <manvolnum>1</manvolnum>
- <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
- <refmiscinfo class="source">MySQL</refmiscinfo>
- <refmiscinfo class="version">¤t-series;</refmiscinfo>
- <refmiscinfo class="refman">Print NDB Schema File Contents</refmiscinfo>
- </refmeta>
+ <refmeta>
+ <refentrytitle><command>ndb_print_schema_file</command></refentrytitle>
+
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
+ <refmiscinfo class="source">MySQL</refmiscinfo>
+ <refmiscinfo class="version">¤t-series;</refmiscinfo>
+ <refmiscinfo class="refman">Print NDB Schema File Contents</refmiscinfo>
+ </refmeta>
- <refnamediv>
- <refname>ndb_print_schema_file</refname>
-
- <refpurpose>print NDB schema file contents</refpurpose>
- </refnamediv>
+ <refnamediv>
+ <refname>ndb_print_schema_file</refname>
+
+ <refpurpose>print NDB schema file contents</refpurpose>
+ </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ndb_print_schema_file <replaceable>file_name</replaceable></command>
- </cmdsynopsis>
- </refsynopsisdiv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ndb_print_schema_file <replaceable>file_name</replaceable></command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
- <refsection id="ndb-print-schema-file-description">
+ <refsection id="ndb-print-schema-file-description">
- <title>Description</title>
+ <title>Description</title>
- <para>
- <command>ndb_print_schema_file</command> obtains diagnostic
- information from a cluster schema file.
- </para>
+ <para>
+ <command>ndb_print_schema_file</command> obtains diagnostic
+ information from a cluster schema file.
+ </para>
- <para>
- <emphasis role="bold">Usage</emphasis>:
- </para>
+ <para>
+ <emphasis role="bold">Usage</emphasis>:
+ </para>
<programlisting>
ndb_print_schema_file <replaceable>file_name</replaceable>
</programlisting>
- <remark role="todo">
- [js] Add link to discussion of cluster filesystem when that
- has been added to the Manual.
- </remark>
+ <remark role="todo">
+ [js] Add link to discussion of cluster filesystem when that
+ has been added to the Manual.
+ </remark>
- <para>
- <replaceable>file_name</replaceable> is the name of a
- cluster schema file.
- </para>
+ <para>
+ <replaceable>file_name</replaceable> is the name of a cluster
+ schema file.
+ </para>
- <para>
- Like <command>ndb_print_backup_file</command> and
- <command>ndb_print_sys_file</command> (and unlike most of
- the other <literal>NDB</literal> utilities that are intended
- to be run on a management server host or to connect to a
- management server) <command>ndb_schema_backup_file</command>
- must be run on a cluster data node, since it accesses the
- data node filesystem directly. Because it does not make use
- of the management server, this utility can be used when the
- management server is not running, and even when the cluster
- has been completely shut down.
- </para>
+ <para>
+ Like <command>ndb_print_backup_file</command> and
+ <command>ndb_print_sys_file</command> (and unlike most of the
+ other <literal>NDB</literal> utilities that are intended to be
+ run on a management server host or to connect to a management
+ server) <command>ndb_schema_backup_file</command> must be run
+ on a cluster data node, since it accesses the data node
+ filesystem directly. Because it does not make use of the
+ management server, this utility can be used when the
+ management server is not running, and even when the cluster
+ has been completely shut down.
+ </para>
- <remark role="todo">
- [js] Add sample output with explanation.
- </remark>
+ <remark role="todo">
+ [js] Add sample output with explanation.
+ </remark>
- <para>
- <emphasis role="bold">Additional Options</emphasis>: None.
- </para>
+ <para>
+ <emphasis role="bold">Additional Options</emphasis>: None.
+ </para>
- </refsection>
+ </refsection>
- </refentry>
+ </refentry>
- </section>
+ </section>
- <section id="fake-id-for-ndb-print-sys-file-manpage-section-wrapper">
+ <section id="fake-id-for-ndb-print-sys-file-manpage-section-wrapper">
- <title>fake title for ndb_print_sys_file manpage section wrapper</title>
+ <title>fake title for ndb_print_sys_file manpage section wrapper</title>
- <refentry id="mysql-cluster-utilities-ndb-print-sys-file">
+ <refentry id="mysql-cluster-utilities-ndb-print-sys-file">
- <indexterm>
- <primary>ndb_print_sys_file</primary>
- </indexterm>
+ <indexterm>
+ <primary>ndb_print_sys_file</primary>
+ </indexterm>
- <refmeta>
- <refentrytitle><command>ndb_print_sys_file</command></refentrytitle>
-
- <manvolnum>1</manvolnum>
- <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
- <refmiscinfo class="source">MySQL</refmiscinfo>
- <refmiscinfo class="version">¤t-series;</refmiscinfo>
- <refmiscinfo class="refman">Print NDB System File Contents</refmiscinfo>
- </refmeta>
+ <refmeta>
+ <refentrytitle><command>ndb_print_sys_file</command></refentrytitle>
+
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
+ <refmiscinfo class="source">MySQL</refmiscinfo>
+ <refmiscinfo class="version">¤t-series;</refmiscinfo>
+ <refmiscinfo class="refman">Print NDB System File Contents</refmiscinfo>
+ </refmeta>
- <refnamediv>
- <refname>ndb_print_sys_file</refname>
-
- <refpurpose>print NDB system file contents</refpurpose>
- </refnamediv>
+ <refnamediv>
+ <refname>ndb_print_sys_file</refname>
+
+ <refpurpose>print NDB system file contents</refpurpose>
+ </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ndb_print_sys_file <replaceable>file_name</replaceable></command>
- </cmdsynopsis>
- </refsynopsisdiv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ndb_print_sys_file <replaceable>file_name</replaceable></command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
- <refsection id="ndb-print-sys-file-description">
+ <refsection id="ndb-print-sys-file-description">
- <title>Description</title>
+ <title>Description</title>
- <para>
- <command>ndb_print_sys_file</command> obtains diagnostic
- information from a cluster system file.
- </para>
+ <para>
+ <command>ndb_print_sys_file</command> obtains diagnostic
+ information from a cluster system file.
+ </para>
- <para>
- <emphasis role="bold">Usage</emphasis>:
- </para>
+ <para>
+ <emphasis role="bold">Usage</emphasis>:
+ </para>
<programlisting>
ndb_print_sys_file <replaceable>file_name</replaceable>
</programlisting>
- <remark role="todo">
- [js] Add link to discussion of cluster filesystem when that
- has been added to the Manual.
- </remark>
+ <remark role="todo">
+ [js] Add link to discussion of cluster filesystem when that
+ has been added to the Manual.
+ </remark>
- <para>
- <replaceable>file_name</replaceable> is the name of a
- cluster system file (sysfile). Cluster system files are
- located in a data node's data directory
- (<literal>DataDir</literal>); the path under this directory
- to system files matches the pattern
- <filename>ndb_<replaceable>#</replaceable>_fs/D<replaceable>#</replaceable>/DBDIH/P<replaceable>#</replaceable>.sysfile</filename>.
- In each case, the <replaceable>#</replaceable> represents a
- number (not necessarily the same number).
- </para>
+ <para>
+ <replaceable>file_name</replaceable> is the name of a cluster
+ system file (sysfile). Cluster system files are located in a
+ data node's data directory (<literal>DataDir</literal>); the
+ path under this directory to system files matches the pattern
+ <filename>ndb_<replaceable>#</replaceable>_fs/D<replaceable>#</replaceable>/DBDIH/P<replaceable>#</replaceable>.sysfile</filename>.
+ In each case, the <replaceable>#</replaceable> represents a
+ number (not necessarily the same number).
+ </para>
- <para>
- Like <command>ndb_print_backup_file</command> and
- <command>ndb_print_schema_file</command> (and unlike most of
- the other <literal>NDB</literal> utilities that are intended
- to be run on a management server host or to connect to a
- management server) <command>ndb_print_backup_file</command>
- must be run on a cluster data node, since it accesses the
- data node filesystem directly. Because it does not make use
- of the management server, this utility can be used when the
- management server is not running, and even when the cluster
- has been completely shut down.
- </para>
+ <para>
+ Like <command>ndb_print_backup_file</command> and
+ <command>ndb_print_schema_file</command> (and unlike most of
+ the other <literal>NDB</literal> utilities that are intended
+ to be run on a management server host or to connect to a
+ management server) <command>ndb_print_backup_file</command>
+ must be run on a cluster data node, since it accesses the data
+ node filesystem directly. Because it does not make use of the
+ management server, this utility can be used when the
+ management server is not running, and even when the cluster
+ has been completely shut down.
+ </para>
- <remark role="todo">
- [js] Add sample output with explanation.
- </remark>
+ <remark role="todo">
+ [js] Add sample output with explanation.
+ </remark>
- <para>
- <emphasis role="bold">Additional Options</emphasis>: None.
- </para>
+ <para>
+ <emphasis role="bold">Additional Options</emphasis>: None.
+ </para>
- </refsection>
+ </refsection>
- </refentry>
+ </refentry>
- </section>
+ </section>
- <section id="fake-id-for-ndb-redo-log-reader-manpage-section-wrapper">
+ <section id="fake-id-for-ndb-redo-log-reader-manpage-section-wrapper">
- <title>fake title for ndb_redo_log_reader manpage</title>
+ <title>fake title for ndb_redo_log_reader manpage</title>
- <refentry id="mysql-cluster-utilities-ndbd-redo-log-reader">
+ <refentry id="mysql-cluster-utilities-ndbd-redo-log-reader">
- <indexterm>
- <primary>ndb_redo_log_reader</primary>
- </indexterm>
+ <indexterm>
+ <primary>ndb_redo_log_reader</primary>
+ </indexterm>
- <refmeta>
- <refentrytitle><command>ndbd_redo_log_reader</command></refentrytitle>
-
- <manvolnum>1</manvolnum>
- <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
- <refmiscinfo class="source">MySQL</refmiscinfo>
- <refmiscinfo class="version">&mccge-series;</refmiscinfo>
- <refmiscinfo class="refman">Check and Print Content of Cluster Redo Log</refmiscinfo>
- </refmeta>
+ <refmeta>
+ <refentrytitle><command>ndbd_redo_log_reader</command></refentrytitle>
+
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
+ <refmiscinfo class="source">MySQL</refmiscinfo>
+ <refmiscinfo class="version">&mccge-series;</refmiscinfo>
+ <refmiscinfo class="refman">Check and Print Content of Cluster Redo Log</refmiscinfo>
+ </refmeta>
- <refnamediv>
- <refname>ndbd_redo_log_reader</refname>
-
- <refpurpose>check and print content of cluster redo log</refpurpose>
- </refnamediv>
+ <refnamediv>
+ <refname>ndbd_redo_log_reader</refname>
+
+ <refpurpose>check and print content of cluster redo log</refpurpose>
+ </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ndbd_redo_log_reader <replaceable>file_name</replaceable> [<replaceable>options</replaceable>]</command>
- </cmdsynopsis>
- </refsynopsisdiv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ndbd_redo_log_reader <replaceable>file_name</replaceable> [<replaceable>options</replaceable>]</command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
- <refsection id="ndb-redo-log-reader">
+ <refsection id="ndb-redo-log-reader">
- <title>Description</title>
+ <title>Description</title>
&mccge-warning-section;
<para>
- Reads a redo log file, checking it for errors, printing its
- contents in a human-readable format, or both.
- <command>ndbd_redo_log_reader</command> is intended for use
- primarily by MySQL developers and support personnel in
- debugging and diagnosing problems.
- </para>
+ Reads a redo log file, checking it for errors, printing its
+ contents in a human-readable format, or both.
+ <command>ndbd_redo_log_reader</command> is intended for use
+ primarily by MySQL developers and support personnel in
+ debugging and diagnosing problems.
+ </para>
- <para>
- This utility was made available as part of the default
- builds of &mccge-series; beginning with MySQL
- 5.1.15-ndb-6.1.3. It remains under development, and its
- syntax and behavior are subject to change in future
- releases. For this reason, it should be considered
- experimental at this time.
- </para>
+ <para>
+ This utility was made available as part of the default builds
+ of &mccge-series; beginning with MySQL 5.1.15-ndb-6.1.3. It
+ remains under development, and its syntax and behavior are
+ subject to change in future releases. For this reason, it
+ should be considered experimental at this time.
+ </para>
- <para>
- The C++ source files for
- <command>ndbd_redo_log_reader</command> can be found in the
- directory
- <filename>/storage/ndb/src/kernel/blocks/dblqh/redoLogReader</filename>.
- </para>
+ <para>
+ The C++ source files for
+ <command>ndbd_redo_log_reader</command> can be found in the
+ directory
+ <filename>/storage/ndb/src/kernel/blocks/dblqh/redoLogReader</filename>.
+ </para>
- <para>
- <emphasis role="bold">Usage</emphasis>:
- </para>
+ <para>
+ <emphasis role="bold">Usage</emphasis>:
+ </para>
<programlisting>
ndbd_redo_log_reader <replaceable>file_name</replaceable> [<replaceable>options</replaceable>]
</programlisting>
- <remark role="todo">
- [js] Add link to discussion of cluster filesystem when that
- has been added to the Internals Manual.
- </remark>
+ <remark role="todo">
+ [js] Add link to discussion of cluster filesystem when that
+ has been added to the Internals Manual.
+ </remark>
- <para>
- <replaceable>file_name</replaceable> is the name of a
- cluster REDO log file. REDO log files are located in the
- numbered directories under the data node's data directory
- (<literal>DataDir</literal>); the path under this directory
- to the REDO log files matches the pattern
- <filename>ndb_<replaceable>#</replaceable>_fs/D<replaceable>#</replaceable>/LCP/<replaceable>#</replaceable>/T<replaceable>#</replaceable>F<replaceable>#</replaceable>.Data</filename>.
- In each case, the <replaceable>#</replaceable> represents a
- number (not necessarily the same number).
- </para>
+ <para>
+ <replaceable>file_name</replaceable> is the name of a cluster
+ REDO log file. REDO log files are located in the numbered
+ directories under the data node's data directory
+ (<literal>DataDir</literal>); the path under this directory to
+ the REDO log files matches the pattern
+ <filename>ndb_<replaceable>#</replaceable>_fs/D<replaceable>#</replaceable>/LCP/<replaceable>#</replaceable>/T<replaceable>#</replaceable>F<replaceable>#</replaceable>.Data</filename>.
+ In each case, the <replaceable>#</replaceable> represents a
+ number (not necessarily the same number).
+ </para>
- <para>
- <emphasis role="bold">Additional Options</emphasis>:
- </para>
+ <para>
+ <emphasis role="bold">Additional Options</emphasis>:
+ </para>
- <para>
- The name of the file to be read may be followed by one or
- more of the options listed here:
+ <para>
+ The name of the file to be read may be followed by one or more
+ of the options listed here:
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <option>-noprint</option>: Do not print the contents
- of the log file.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <option>-noprint</option>: Do not print the contents of
+ the log file.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <option>-nocheck</option>: Do not check the log filre
- for errors.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <option>-nocheck</option>: Do not check the log filre
+ for errors.
+ </para>
+ </listitem>
<!--
Following options commented out until they actually do something.
@@ -1894,383 +1883,381 @@
</listitem>
-->
- </itemizedlist>
- </para>
+ </itemizedlist>
+ </para>
- <para>
- Like <command>ndb_print_backup_file</command> and
- <command>ndb_print_schema_file</command> (and unlike most of
- the <literal>NDB</literal> utilities that are intended to be
- run on a management server host or to connect to a
- management server) <command>ndbd_redo_log_reader</command>
- must be run on a cluster data node, since it accesses the
- data node filesystem directly. Because it does not make use
- of the management server, this utility can be used when the
- management server is not running, and even when the cluster
- has been completely shut down.
- </para>
+ <para>
+ Like <command>ndb_print_backup_file</command> and
+ <command>ndb_print_schema_file</command> (and unlike most of
+ the <literal>NDB</literal> utilities that are intended to be
+ run on a management server host or to connect to a management
+ server) <command>ndbd_redo_log_reader</command> must be run on
+ a cluster data node, since it accesses the data node
+ filesystem directly. Because it does not make use of the
+ management server, this utility can be used when the
+ management server is not running, and even when the cluster
+ has been completely shut down.
+ </para>
- <remark role="todo">
- [js] Add sample output with explanation.
- </remark>
+ <remark role="todo">
+ [js] Add sample output with explanation.
+ </remark>
- </refsection>
+ </refsection>
- </refentry>
+ </refentry>
- </section>
+ </section>
- <section id="fake-id-for-ndb-select-all-manpage-section-wrapper">
+ <section id="fake-id-for-ndb-select-all-manpage-section-wrapper">
- <title>fake title for ndb_select_all manpage section wrapper</title>
+ <title>fake title for ndb_select_all manpage section wrapper</title>
- <refentry id="mysql-cluster-utilities-ndb-select-all">
+ <refentry id="mysql-cluster-utilities-ndb-select-all">
- <indexterm>
- <primary>ndb_select_all</primary>
- </indexterm>
+ <indexterm>
+ <primary>ndb_select_all</primary>
+ </indexterm>
- <refmeta>
- <refentrytitle><command>ndb_select_all</command></refentrytitle>
-
- <manvolnum>1</manvolnum>
- <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
- <refmiscinfo class="source">MySQL</refmiscinfo>
- <refmiscinfo class="version">¤t-series;</refmiscinfo>
- <refmiscinfo class="refman">Print Rows from NDB Table</refmiscinfo>
- </refmeta>
+ <refmeta>
+ <refentrytitle><command>ndb_select_all</command></refentrytitle>
+
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
+ <refmiscinfo class="source">MySQL</refmiscinfo>
+ <refmiscinfo class="version">¤t-series;</refmiscinfo>
+ <refmiscinfo class="refman">Print Rows from NDB Table</refmiscinfo>
+ </refmeta>
- <refnamediv>
- <refname>ndb_select_all</refname>
-
- <refpurpose>print rows from NDB table</refpurpose>
- </refnamediv>
+ <refnamediv>
+ <refname>ndb_select_all</refname>
+
+ <refpurpose>print rows from NDB table</refpurpose>
+ </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ndb_select_all -c <replaceable>connect_string</replaceable> <replaceable>tbl_name</replaceable> -d <replaceable>db_name</replaceable> [> <replaceable>file_name</replaceable>]</command>
- </cmdsynopsis>
- </refsynopsisdiv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ndb_select_all -c <replaceable>connect_string</replaceable> <replaceable>tbl_name</replaceable> -d <replaceable>db_name</replaceable> [> <replaceable>file_name</replaceable>]</command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
- <refsection id="ndb-select-all-description">
+ <refsection id="ndb-select-all-description">
- <title>Description</title>
+ <title>Description</title>
- <para>
- <command>ndb_select_all</command> prints all rows from an
- <literal>NDB</literal> table to <literal>stdout</literal>.
- </para>
+ <para>
+ <command>ndb_select_all</command> prints all rows from an
+ <literal>NDB</literal> table to <literal>stdout</literal>.
+ </para>
- <para>
- <emphasis role="bold">Usage</emphasis>:
- </para>
+ <para>
+ <emphasis role="bold">Usage</emphasis>:
+ </para>
<programlisting>
ndb_select_all -c <replaceable>connect_string</replaceable> <replaceable>tbl_name</replaceable> -d <replaceable>db_name</replaceable> [> <replaceable>file_name</replaceable>]
</programlisting>
- <para>
- <emphasis role="bold">Additional Options</emphasis>:
- </para>
+ <para>
+ <emphasis role="bold">Additional Options</emphasis>:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <indexterm>
- <primary>ndb_select_all</primary>
- <secondary>lock option</secondary>
- </indexterm>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_select_all</primary>
+ <secondary>lock option</secondary>
+ </indexterm>
- <indexterm>
- <primary>lock option</primary>
- <secondary>ndb_select_all</secondary>
- </indexterm>
+ <indexterm>
+ <primary>lock option</primary>
+ <secondary>ndb_select_all</secondary>
+ </indexterm>
- <option>--lock=<replaceable>lock_type</replaceable></option>,
- <option>-l <replaceable>lock_type</replaceable></option>
- </para>
+ <option>--lock=<replaceable>lock_type</replaceable></option>,
+ <option>-l <replaceable>lock_type</replaceable></option>
+ </para>
- <para>
- Employs a lock when reading the table. Possible values
- for <replaceable>lock_type</replaceable> are:
- </para>
+ <para>
+ Employs a lock when reading the table. Possible values for
+ <replaceable>lock_type</replaceable> are:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <literal>0</literal>: Read lock
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>0</literal>: Read lock
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>1</literal>: Read lock with hold
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>1</literal>: Read lock with hold
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>2</literal>: Exclusive read lock
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>2</literal>: Exclusive read lock
+ </para>
+ </listitem>
- </itemizedlist>
+ </itemizedlist>
- <para>
- There is no default value for this option.
- </para>
- </listitem>
+ <para>
+ There is no default value for this option.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <indexterm>
- <primary>ndb_select_all</primary>
- <secondary>order option</secondary>
- </indexterm>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_select_all</primary>
+ <secondary>order option</secondary>
+ </indexterm>
- <indexterm>
- <primary>order option</primary>
- <secondary>ndb_select_all</secondary>
- </indexterm>
+ <indexterm>
+ <primary>order option</primary>
+ <secondary>ndb_select_all</secondary>
+ </indexterm>
- <option>--order=<replaceable>index_name</replaceable></option>,
- <option>-o
- <replaceable>index_name</replaceable></option>
- </para>
+ <option>--order=<replaceable>index_name</replaceable></option>,
+ <option>-o <replaceable>index_name</replaceable></option>
+ </para>
- <para>
- Orders the output according to the index named
- <replaceable>index_name</replaceable>. Note that this is
- the name of an index, not of a column, and that the
- index must have been explicitly named when created.
- </para>
- </listitem>
+ <para>
+ Orders the output according to the index named
+ <replaceable>index_name</replaceable>. Note that this is
+ the name of an index, not of a column, and that the index
+ must have been explicitly named when created.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <indexterm>
- <primary>ndb_select_all</primary>
- <secondary>descending option</secondary>
- </indexterm>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_select_all</primary>
+ <secondary>descending option</secondary>
+ </indexterm>
- <indexterm>
- <primary>descending option</primary>
- <secondary>ndb_select_all</secondary>
- </indexterm>
+ <indexterm>
+ <primary>descending option</primary>
+ <secondary>ndb_select_all</secondary>
+ </indexterm>
- <option>--descending</option>, <option>-z</option>
- </para>
+ <option>--descending</option>, <option>-z</option>
+ </para>
- <para>
- Sorts the output in descending order. This option can be
- used only in conjunction with the <option>-o</option>
- (<option>--order</option>) option.
- </para>
- </listitem>
+ <para>
+ Sorts the output in descending order. This option can be
+ used only in conjunction with the <option>-o</option>
+ (<option>--order</option>) option.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <indexterm>
- <primary>ndb_select_all</primary>
- <secondary>header option</secondary>
- </indexterm>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_select_all</primary>
+ <secondary>header option</secondary>
+ </indexterm>
- <indexterm>
- <primary>header option</primary>
- <secondary>ndb_select_all</secondary>
- </indexterm>
+ <indexterm>
+ <primary>header option</primary>
+ <secondary>ndb_select_all</secondary>
+ </indexterm>
- <option>--header=FALSE</option>
- </para>
+ <option>--header=FALSE</option>
+ </para>
- <para>
- Excludes column headers from the output.
- </para>
- </listitem>
+ <para>
+ Excludes column headers from the output.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <indexterm>
- <primary>ndb_select_all</primary>
- <secondary>useHexFormat option</secondary>
- </indexterm>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_select_all</primary>
+ <secondary>useHexFormat option</secondary>
+ </indexterm>
- <indexterm>
- <primary>useHexFormat option</primary>
- <secondary>ndb_select_all</secondary>
- </indexterm>
+ <indexterm>
+ <primary>useHexFormat option</primary>
+ <secondary>ndb_select_all</secondary>
+ </indexterm>
- <option>--useHexFormat</option> <option>-x</option>
- </para>
+ <option>--useHexFormat</option> <option>-x</option>
+ </para>
- <para>
- Causes all numeric values to be displayed in hexadecimal
- format. This does not affect the output of numerals
- contained in strings or datetime values.
- </para>
- </listitem>
+ <para>
+ Causes all numeric values to be displayed in hexadecimal
+ format. This does not affect the output of numerals
+ contained in strings or datetime values.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <indexterm>
- <primary>ndb_select_all</primary>
- <secondary>delimiter option</secondary>
- </indexterm>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_select_all</primary>
+ <secondary>delimiter option</secondary>
+ </indexterm>
- <indexterm>
- <primary>delimiter option</primary>
- <secondary>ndb_select_all</secondary>
- </indexterm>
+ <indexterm>
+ <primary>delimiter option</primary>
+ <secondary>ndb_select_all</secondary>
+ </indexterm>
- <option>--delimiter=<replaceable>character</replaceable></option>,
- <option>-D <replaceable>character</replaceable></option>
- </para>
+ <option>--delimiter=<replaceable>character</replaceable></option>,
+ <option>-D <replaceable>character</replaceable></option>
+ </para>
- <para>
- Causes the <replaceable>character</replaceable> to be
- used as a column delimiter. Only table data columns are
- separated by this delimiter.
- </para>
+ <para>
+ Causes the <replaceable>character</replaceable> to be used
+ as a column delimiter. Only table data columns are
+ separated by this delimiter.
+ </para>
- <para>
- The default delimiter is the tab character.
- </para>
- </listitem>
+ <para>
+ The default delimiter is the tab character.
+ </para>
+ </listitem>
- <listitem>
- <remark role="todo">
- [js] Add more info and link to cluster filesystem
- documentation when that appears in the Manual.
- </remark>
+ <listitem>
+ <remark role="todo">
+ [js] Add more info and link to cluster filesystem
+ documentation when that appears in the Manual.
+ </remark>
- <para>
- <indexterm>
- <primary>ndb_select_all</primary>
- <secondary>disk option</secondary>
- </indexterm>
+ <para>
+ <indexterm>
+ <primary>ndb_select_all</primary>
+ <secondary>disk option</secondary>
+ </indexterm>
- <indexterm>
- <primary>disk option</primary>
- <secondary>ndb_select_all</secondary>
- </indexterm>
+ <indexterm>
+ <primary>disk option</primary>
+ <secondary>ndb_select_all</secondary>
+ </indexterm>
- <option>--disk</option>
- </para>
+ <option>--disk</option>
+ </para>
- <para>
- Adds a disk reference column to the output. The column
- is non-empty only for Disk Data tables having
- non-indexed columns.
- </para>
- </listitem>
+ <para>
+ Adds a disk reference column to the output. The column is
+ non-empty only for Disk Data tables having non-indexed
+ columns.
+ </para>
+ </listitem>
- <listitem>
- <remark role="todo">
- [js] Add more info and link to cluster filesystem
- documentation when that appears in the Manual.
- </remark>
+ <listitem>
+ <remark role="todo">
+ [js] Add more info and link to cluster filesystem
+ documentation when that appears in the Manual.
+ </remark>
- <para>
- <indexterm>
- <primary>ndb_select_all</primary>
- <secondary>rowid option</secondary>
- </indexterm>
+ <para>
+ <indexterm>
+ <primary>ndb_select_all</primary>
+ <secondary>rowid option</secondary>
+ </indexterm>
- <indexterm>
- <primary>rowid option</primary>
- <secondary>ndb_select_all</secondary>
- </indexterm>
+ <indexterm>
+ <primary>rowid option</primary>
+ <secondary>ndb_select_all</secondary>
+ </indexterm>
- <option>--rowid</option>
- </para>
+ <option>--rowid</option>
+ </para>
- <para>
- Adds a <literal>ROWID</literal> column providing
- information about the fragments in which rows are
- stored.
- </para>
- </listitem>
+ <para>
+ Adds a <literal>ROWID</literal> column providing
+ information about the fragments in which rows are stored.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <indexterm>
- <primary>ndb_select_all</primary>
- <secondary>gci option</secondary>
- </indexterm>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_select_all</primary>
+ <secondary>gci option</secondary>
+ </indexterm>
- <indexterm>
- <primary>gci option</primary>
- <secondary>ndb_select_all</secondary>
- </indexterm>
+ <indexterm>
+ <primary>gci option</primary>
+ <secondary>ndb_select_all</secondary>
+ </indexterm>
- <option>--gci</option>
- </para>
+ <option>--gci</option>
+ </para>
- <para>
- Adds a column to the output showing the global
- checkpoint at which each row was last updated. See
- <xref linkend="mysql-cluster-glossary"/>, and
- <xref linkend="mysql-cluster-log-events"/>, for more
- information about checkpoints.
- </para>
- </listitem>
+ <para>
+ Adds a column to the output showing the global checkpoint
+ at which each row was last updated. See
+ <xref linkend="mysql-cluster-glossary"/>, and
+ <xref linkend="mysql-cluster-log-events"/>, for more
+ information about checkpoints.
+ </para>
+ </listitem>
- <listitem>
- <remark role="todo">
- [js] Need to provide a better explanation of this, or a
- link to one.
- </remark>
+ <listitem>
+ <remark role="todo">
+ [js] Need to provide a better explanation of this, or a
+ link to one.
+ </remark>
- <para>
- <indexterm>
- <primary>ndb_select_all</primary>
- <secondary>tupscan option</secondary>
- </indexterm>
+ <para>
+ <indexterm>
+ <primary>ndb_select_all</primary>
+ <secondary>tupscan option</secondary>
+ </indexterm>
- <indexterm>
- <primary>tupscan option</primary>
- <secondary>ndb_select_all</secondary>
- </indexterm>
+ <indexterm>
+ <primary>tupscan option</primary>
+ <secondary>ndb_select_all</secondary>
+ </indexterm>
- <option>--tupscan</option>, <option>-t</option>
- </para>
+ <option>--tupscan</option>, <option>-t</option>
+ </para>
- <para>
- Scan the table in the order of the tuples.
- </para>
- </listitem>
+ <para>
+ Scan the table in the order of the tuples.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <indexterm>
- <primary>ndb_select_all</primary>
- <secondary>nodata option</secondary>
- </indexterm>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_select_all</primary>
+ <secondary>nodata option</secondary>
+ </indexterm>
- <indexterm>
- <primary>nodata option</primary>
- <secondary>ndb_select_all</secondary>
- </indexterm>
+ <indexterm>
+ <primary>nodata option</primary>
+ <secondary>ndb_select_all</secondary>
+ </indexterm>
- <option>--nodata</option>
- </para>
+ <option>--nodata</option>
+ </para>
- <para>
- Causes any table data to be omitted.
- </para>
- </listitem>
+ <para>
+ Causes any table data to be omitted.
+ </para>
+ </listitem>
- </itemizedlist>
+ </itemizedlist>
- <para>
- <emphasis role="bold">Sample Output</emphasis>:
- </para>
+ <para>
+ <emphasis role="bold">Sample Output</emphasis>:
+ </para>
- <para>
- Output from a MySQL <literal>SELECT</literal> statement:
- </para>
+ <para>
+ Output from a MySQL <literal>SELECT</literal> statement:
+ </para>
<programlisting>
mysql> <userinput>SELECT * FROM ctest1.fish;</userinput>
@@ -2287,10 +2274,10 @@
6 rows in set (0.04 sec)
</programlisting>
- <para>
- Output from the equivalent invocation of
- <command>ndb_select_all</command>:
- </para>
+ <para>
+ Output from the equivalent invocation of
+ <command>ndb_select_all</command>:
+ </para>
<programlisting>
shell> <userinput>./ndb_select_all -c localhost fish -d ctest1</userinput>
@@ -2306,13 +2293,13 @@
NDBT_ProgramExit: 0 - OK
</programlisting>
- <para>
- Note that all string values are enclosed by square brackets
- (<quote><literal>[</literal>...<literal>]</literal></quote>)
- in the output of <command>ndb_select_all</command>. For a
- further example, consider the table created and populated as
- shown here:
- </para>
+ <para>
+ Note that all string values are enclosed by square brackets
+ (<quote><literal>[</literal>...<literal>]</literal></quote>)
+ in the output of <command>ndb_select_all</command>. For a
+ further example, consider the table created and populated as
+ shown here:
+ </para>
<programlisting>
CREATE TABLE dogs (
@@ -2332,10 +2319,10 @@
('', 'Rosscoe', 'Mutt');
</programlisting>
- <para>
- This demonstrates the use of several additional
- <command>ndb_select_all</command> options:
- </para>
+ <para>
+ This demonstrates the use of several additional
+ <command>ndb_select_all</command> options:
+ </para>
<programlisting>
shell> <userinput>./ndb_select_all -d ctest1 dogs -o ix -z --gci --disk</userinput>
@@ -2349,76 +2336,76 @@
NDBT_ProgramExit: 0 - OK
</programlisting>
- </refsection>
+ </refsection>
- </refentry>
+ </refentry>
- </section>
+ </section>
- <section id="fake-id-for-ndb-select-count-manpage-section-wrapper">
+ <section id="fake-id-for-ndb-select-count-manpage-section-wrapper">
- <title>fake title for ndb_select_count manpage section wrapper</title>
+ <title>fake title for ndb_select_count manpage section wrapper</title>
- <refentry id="mysql-cluster-utilities-ndb-select-count">
+ <refentry id="mysql-cluster-utilities-ndb-select-count">
- <indexterm>
- <primary>ndb_select_count</primary>
- </indexterm>
+ <indexterm>
+ <primary>ndb_select_count</primary>
+ </indexterm>
- <refmeta>
- <refentrytitle><command>ndb_select_count</command></refentrytitle>
-
- <manvolnum>1</manvolnum>
- <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
- <refmiscinfo class="source">MySQL</refmiscinfo>
- <refmiscinfo class="version">¤t-series;</refmiscinfo>
- <refmiscinfo class="refman">Print Row Counts for NDB Tables</refmiscinfo>
- </refmeta>
+ <refmeta>
+ <refentrytitle><command>ndb_select_count</command></refentrytitle>
+
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
+ <refmiscinfo class="source">MySQL</refmiscinfo>
+ <refmiscinfo class="version">¤t-series;</refmiscinfo>
+ <refmiscinfo class="refman">Print Row Counts for NDB Tables</refmiscinfo>
+ </refmeta>
- <refnamediv>
- <refname>ndb_select_count</refname>
-
- <refpurpose>print row counts for NDB tables</refpurpose>
- </refnamediv>
+ <refnamediv>
+ <refname>ndb_select_count</refname>
+
+ <refpurpose>print row counts for NDB tables</refpurpose>
+ </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ndb_select_count [-c <replaceable>connect_string</replaceable>] -d<replaceable>db_name</replaceable> <replaceable>tbl_name</replaceable>[, <replaceable>tbl_name2</replaceable>[, ...]]</command>
- </cmdsynopsis>
- </refsynopsisdiv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ndb_select_count [-c <replaceable>connect_string</replaceable>] -d<replaceable>db_name</replaceable> <replaceable>tbl_name</replaceable>[, <replaceable>tbl_name2</replaceable>[, ...]]</command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
- <refsection id="ndb-select-count-description">
+ <refsection id="ndb-select-count-description">
- <title>Description</title>
+ <title>Description</title>
- <para>
- <command>ndb_select_count</command> prints the number of
- rows in one or more <literal>NDB</literal> tables. With a
- single table, the result is equivalent to that obtained by
- using the MySQL statement <literal>SELECT COUNT(*) FROM
- <replaceable>tbl_name</replaceable></literal>.
- </para>
+ <para>
+ <command>ndb_select_count</command> prints the number of rows
+ in one or more <literal>NDB</literal> tables. With a single
+ table, the result is equivalent to that obtained by using the
+ MySQL statement <literal>SELECT COUNT(*) FROM
+ <replaceable>tbl_name</replaceable></literal>.
+ </para>
- <para>
- <emphasis role="bold">Usage</emphasis>:
- </para>
+ <para>
+ <emphasis role="bold">Usage</emphasis>:
+ </para>
<programlisting>
ndb_select_count [-c <replaceable>connect_string</replaceable>] -d<replaceable>db_name</replaceable> <replaceable>tbl_name</replaceable>[, <replaceable>tbl_name2</replaceable>[, ...]]
</programlisting>
- <para>
- <emphasis role="bold">Additional Options</emphasis>: None
- that are specific to this application. However, you can
- obtain row counts from multiple tables in the same database
- by listing the table names separated by spaces when invoking
- this command, as shown under <emphasis role="bold">Sample
- Output</emphasis>.
- </para>
+ <para>
+ <emphasis role="bold">Additional Options</emphasis>: None that
+ are specific to this application. However, you can obtain row
+ counts from multiple tables in the same database by listing
+ the table names separated by spaces when invoking this
+ command, as shown under <emphasis role="bold">Sample
+ Output</emphasis>.
+ </para>
- <para>
- <emphasis role="bold">Sample Output</emphasis>:
- </para>
+ <para>
+ <emphasis role="bold">Sample Output</emphasis>:
+ </para>
<programlisting>
shell> <userinput>./ndb_select_count -c localhost -d ctest1 fish dogs</userinput>
@@ -2428,442 +2415,437 @@
NDBT_ProgramExit: 0 - OK
</programlisting>
- </refsection>
+ </refsection>
- </refentry>
+ </refentry>
- </section>
+ </section>
- <section id="fake-id-for-ndb-show-tables-manpage-section-wrapper">
+ <section id="fake-id-for-ndb-show-tables-manpage-section-wrapper">
- <title>fake title for ndb_show_tables manpage section wrapper</title>
+ <title>fake title for ndb_show_tables manpage section wrapper</title>
- <refentry id="mysql-cluster-utilities-ndb-show-tables">
+ <refentry id="mysql-cluster-utilities-ndb-show-tables">
- <indexterm>
- <primary>ndb_show_tables</primary>
- </indexterm>
+ <indexterm>
+ <primary>ndb_show_tables</primary>
+ </indexterm>
- <refmeta>
- <refentrytitle><command>ndb_show_tables</command></refentrytitle>
-
- <manvolnum>1</manvolnum>
- <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
- <refmiscinfo class="source">MySQL</refmiscinfo>
- <refmiscinfo class="version">¤t-series;</refmiscinfo>
- <refmiscinfo class="refman">Display List of NDB Tables</refmiscinfo>
- </refmeta>
+ <refmeta>
+ <refentrytitle><command>ndb_show_tables</command></refentrytitle>
+
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
+ <refmiscinfo class="source">MySQL</refmiscinfo>
+ <refmiscinfo class="version">¤t-series;</refmiscinfo>
+ <refmiscinfo class="refman">Display List of NDB Tables</refmiscinfo>
+ </refmeta>
- <refnamediv>
- <refname>ndb_show_tables</refname>
-
- <refpurpose>display list of NDB tables</refpurpose>
- </refnamediv>
+ <refnamediv>
+ <refname>ndb_show_tables</refname>
+
+ <refpurpose>display list of NDB tables</refpurpose>
+ </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ndb_show_tables [<replaceable>options</replaceable>]</command>
- </cmdsynopsis>
- </refsynopsisdiv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ndb_show_tables [<replaceable>options</replaceable>]</command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
- <refsection id="ndb-show-tables-description">
+ <refsection id="ndb-show-tables-description">
- <title>Description</title>
+ <title>Description</title>
- <para>
- <command>ndb_show_tables</command> displays a list of all
- <literal>NDB</literal> database objects in the cluster. By
- default, this includes not only both user-created tables and
- <literal>NDB</literal> system tables, but
- <literal>NDB</literal>-specific indexes, internal triggers,
- and Cluster Disk Data objects as well.
- </para>
+ <para>
+ <command>ndb_show_tables</command> displays a list of all
+ <literal>NDB</literal> database objects in the cluster. By
+ default, this includes not only both user-created tables and
+ <literal>NDB</literal> system tables, but
+ <literal>NDB</literal>-specific indexes, internal triggers,
+ and Cluster Disk Data objects as well.
+ </para>
- <para>
- <emphasis role="bold">Usage</emphasis>:
- </para>
+ <para>
+ <emphasis role="bold">Usage</emphasis>:
+ </para>
<programlisting>
ndb_show_tables [-c <replaceable>connect_string</replaceable>]
</programlisting>
- <para>
- <emphasis role="bold">Additional Options</emphasis>:
- </para>
+ <para>
+ <emphasis role="bold">Additional Options</emphasis>:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <indexterm>
- <primary>ndb_show_tables</primary>
- <secondary>loops option</secondary>
- </indexterm>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_show_tables</primary>
+ <secondary>loops option</secondary>
+ </indexterm>
- <indexterm>
- <primary>loops option</primary>
- <secondary>ndb_show_tables</secondary>
- </indexterm>
+ <indexterm>
+ <primary>loops option</primary>
+ <secondary>ndb_show_tables</secondary>
+ </indexterm>
- <option>--loops</option>, <option>-l</option>
- </para>
+ <option>--loops</option>, <option>-l</option>
+ </para>
- <para>
- Specifies the number of times the utility should
- execute. This is 1 when this option is not specified,
- but if you do use the option, you must supply an integer
- argument for it.
- </para>
- </listitem>
+ <para>
+ Specifies the number of times the utility should execute.
+ This is 1 when this option is not specified, but if you do
+ use the option, you must supply an integer argument for
+ it.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <indexterm>
- <primary>ndb_show_tables</primary>
- <secondary>parsable option</secondary>
- </indexterm>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_show_tables</primary>
+ <secondary>parsable option</secondary>
+ </indexterm>
- <indexterm>
- <primary>parsable option</primary>
- <secondary>ndb_show_tables</secondary>
- </indexterm>
+ <indexterm>
+ <primary>parsable option</primary>
+ <secondary>ndb_show_tables</secondary>
+ </indexterm>
- <option>--parsable</option>, <option>-p</option>
- </para>
+ <option>--parsable</option>, <option>-p</option>
+ </para>
- <para>
- Using this option causes the output to be in a format
- suitable for use with <literal>LOAD DATA
- INFILE</literal>.
- </para>
- </listitem>
+ <para>
+ Using this option causes the output to be in a format
+ suitable for use with <literal>LOAD DATA INFILE</literal>.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <indexterm>
- <primary>ndb_show_tables</primary>
- <secondary>type option</secondary>
- </indexterm>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_show_tables</primary>
+ <secondary>type option</secondary>
+ </indexterm>
- <indexterm>
- <primary>type option</primary>
- <secondary>ndb_show_tables</secondary>
- </indexterm>
+ <indexterm>
+ <primary>type option</primary>
+ <secondary>ndb_show_tables</secondary>
+ </indexterm>
- <option>--type</option>, <option>-t</option>
- </para>
+ <option>--type</option>, <option>-t</option>
+ </para>
- <para>
- Can be used to restrict the output to one type of
- object, specified by an integer type code as shown here:
- </para>
+ <para>
+ Can be used to restrict the output to one type of object,
+ specified by an integer type code as shown here:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <emphasis role="bold">1</emphasis>: System table
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">1</emphasis>: System table
+ </para>
+ </listitem>
- <listitem>
- <para>
- <emphasis role="bold">2</emphasis>: User-created
- table
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">2</emphasis>: User-created table
+ </para>
+ </listitem>
- <listitem>
- <para>
- <emphasis role="bold">3</emphasis>: Unique hash
- index
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">3</emphasis>: Unique hash index
+ </para>
+ </listitem>
- </itemizedlist>
+ </itemizedlist>
- <para>
- Any other value causes all <literal>NDB</literal>
- database objects to be listed (the default).
- </para>
- </listitem>
+ <para>
+ Any other value causes all <literal>NDB</literal> database
+ objects to be listed (the default).
+ </para>
+ </listitem>
- <listitem>
- <para>
- <indexterm>
- <primary>ndb_show_tables</primary>
- <secondary>unqualified option</secondary>
- </indexterm>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_show_tables</primary>
+ <secondary>unqualified option</secondary>
+ </indexterm>
- <indexterm>
- <primary>unqualified option</primary>
- <secondary>ndb_show_tables</secondary>
- </indexterm>
+ <indexterm>
+ <primary>unqualified option</primary>
+ <secondary>ndb_show_tables</secondary>
+ </indexterm>
- <option>--unqualified</option>, <option>-u</option>
- </para>
+ <option>--unqualified</option>, <option>-u</option>
+ </para>
- <para>
- If specified, this causes unqualified object names to be
- displayed.
- </para>
- </listitem>
-
- </itemizedlist>
-
- <note>
<para>
- Only user-created Cluster tables may be accessed from
- MySQL; system tables such as <literal>SYSTAB_0</literal>
- are not visible to <command>mysqld</command>. However, you
- can examine the contents of system tables using
- <literal>NDB</literal> API applications such as
- <command>ndb_select_all</command> (see
- <xref linkend="mysql-cluster-utilities-ndb-select-all"/>).
+ If specified, this causes unqualified object names to be
+ displayed.
</para>
- </note>
+ </listitem>
- </refsection>
+ </itemizedlist>
- </refentry>
+ <note>
+ <para>
+ Only user-created Cluster tables may be accessed from MySQL;
+ system tables such as <literal>SYSTAB_0</literal> are not
+ visible to <command>mysqld</command>. However, you can
+ examine the contents of system tables using
+ <literal>NDB</literal> API applications such as
+ <command>ndb_select_all</command> (see
+ <xref linkend="mysql-cluster-utilities-ndb-select-all"/>).
+ </para>
+ </note>
- </section>
+ </refsection>
- <section id="fake-id-for-ndb-size-manpage-section-wrapper">
+ </refentry>
- <title>fake title for ndb_size.pl manpage section wrapper</title>
+ </section>
- <refentry id="mysql-cluster-utilities-ndb-size">
+ <section id="fake-id-for-ndb-size-manpage-section-wrapper">
- <indexterm>
- <primary>ndb_size.pl</primary>
- </indexterm>
+ <title>fake title for ndb_size.pl manpage section wrapper</title>
- <refmeta>
- <refentrytitle><command>ndb_size.pl</command></refentrytitle>
-
- <manvolnum>1</manvolnum>
- <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
- <refmiscinfo class="source">MySQL</refmiscinfo>
- <refmiscinfo class="version">¤t-series;</refmiscinfo>
- <refmiscinfo class="refman">NDBCluster Size Requirement Estimator</refmiscinfo>
- </refmeta>
+ <refentry id="mysql-cluster-utilities-ndb-size">
- <refnamediv>
- <refname>ndb_size.pl</refname>
-
- <refpurpose>NDBCluster Size Requirement Estimator</refpurpose>
- </refnamediv>
+ <indexterm>
+ <primary>ndb_size.pl</primary>
+ </indexterm>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ndb_size.pl <replaceable>arguments</replaceable></command>
- </cmdsynopsis>
- </refsynopsisdiv>
+ <refmeta>
+ <refentrytitle><command>ndb_size.pl</command></refentrytitle>
+
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
+ <refmiscinfo class="source">MySQL</refmiscinfo>
+ <refmiscinfo class="version">¤t-series;</refmiscinfo>
+ <refmiscinfo class="refman">NDBCluster Size Requirement Estimator</refmiscinfo>
+ </refmeta>
- <refsection id="ndb-size-description">
+ <refnamediv>
+ <refname>ndb_size.pl</refname>
+
+ <refpurpose>NDBCluster Size Requirement Estimator</refpurpose>
+ </refnamediv>
- <title>Description</title>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ndb_size.pl <replaceable>arguments</replaceable></command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
- <para>
- This is a Perl script that can be used to estimate the
- amount of space that would be required by a MySQL database
- if it were converted to use the
- <literal>NDBCluster</literal> storage engine. Unlike the
- other utilities discussed in this section, it does not
- require access to a MySQL Cluster (in fact, there is no
- reason for it to do so). However, it does need to access the
- MySQL server on which the database to be tested resides.
- </para>
+ <refsection id="ndb-size-description">
- <para>
- <emphasis role="bold">Requirements</emphasis>:
- </para>
+ <title>Description</title>
- <itemizedlist>
+ <para>
+ This is a Perl script that can be used to estimate the amount
+ of space that would be required by a MySQL database if it were
+ converted to use the <literal>NDBCluster</literal> storage
+ engine. Unlike the other utilities discussed in this section,
+ it does not require access to a MySQL Cluster (in fact, there
+ is no reason for it to do so). However, it does need to access
+ the MySQL server on which the database to be tested resides.
+ </para>
- <listitem>
- <para>
- A running MySQL server. The server instance does not
- have to provide support for MySQL Cluster.
- </para>
- </listitem>
+ <para>
+ <emphasis role="bold">Requirements</emphasis>:
+ </para>
- <listitem>
- <para>
- A working installation of Perl.
- </para>
- </listitem>
+ <itemizedlist>
- <listitem>
- <para>
- The <literal>DBI</literal> module, which can be obtained
- from CPAN if it is not already part of your Perl
- installation. (Many Linux and other operating system
- distributions provide their own packages for this
- library.)
- </para>
+ <listitem>
+ <para>
+ A running MySQL server. The server instance does not have
+ to provide support for MySQL Cluster.
+ </para>
+ </listitem>
- <note>
- <para>
- Previous to MySQL 5.1.18,
- <command>ndb_size.pl</command> also required the
- <literal>HTML::Template</literal> module.
- </para>
- </note>
- </listitem>
+ <listitem>
+ <para>
+ A working installation of Perl.
+ </para>
+ </listitem>
- <listitem>
- <para>
- The <filename>ndb_size.tmpl</filename> template file,
- which you should be able to find in the
- <filename>share/mysql</filename> directory of your MySQL
- installation. This file should be copied or moved into
- the same directory as <filename>ndb_size.pl</filename>
- — if it is not there already — before
- running the script.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ The <literal>DBI</literal> module, which can be obtained
+ from CPAN if it is not already part of your Perl
+ installation. (Many Linux and other operating system
+ distributions provide their own packages for this
+ library.)
+ </para>
- <listitem>
+ <note>
<para>
- A MySQL user account having the necessary privileges. If
- you do not wish to use an existing account, then
- creating one using <literal>GRANT USAGE ON
- <replaceable>db_name</replaceable>.*</literal> —
- where <replaceable>db_name</replaceable> is the name of
- the database to be examined — is sufficient for
- this purpose.
+ Previous to MySQL 5.1.18, <command>ndb_size.pl</command>
+ also required the <literal>HTML::Template</literal>
+ module.
</para>
- </listitem>
+ </note>
+ </listitem>
- </itemizedlist>
+ <listitem>
+ <para>
+ The <filename>ndb_size.tmpl</filename> template file,
+ which you should be able to find in the
+ <filename>share/mysql</filename> directory of your MySQL
+ installation. This file should be copied or moved into the
+ same directory as <filename>ndb_size.pl</filename> —
+ if it is not there already — before running the
+ script.
+ </para>
+ </listitem>
- <para>
- <filename>ndb_size.pl</filename> and
- <filename>ndb_size.tmpl</filename> can also be found in the
- MySQL sources in <filename>storage/ndb/tools</filename>. If
- these files are not present in your MySQL installation, you
- can obtain them from the
- <ulink url="http://forge.mysql.com/projects/view.php?id=88">MySQLForge
- project page</ulink>.
- </para>
+ <listitem>
+ <para>
+ A MySQL user account having the necessary privileges. If
+ you do not wish to use an existing account, then creating
+ one using <literal>GRANT USAGE ON
+ <replaceable>db_name</replaceable>.*</literal> —
+ where <replaceable>db_name</replaceable> is the name of
+ the database to be examined — is sufficient for this
+ purpose.
+ </para>
+ </listitem>
- <para>
- <emphasis role="bold">Usage</emphasis>:
- </para>
+ </itemizedlist>
+ <para>
+ <filename>ndb_size.pl</filename> and
+ <filename>ndb_size.tmpl</filename> can also be found in the
+ MySQL sources in <filename>storage/ndb/tools</filename>. If
+ these files are not present in your MySQL installation, you
+ can obtain them from the
+ <ulink url="http://forge.mysql.com/projects/view.php?id=88">MySQLForge
+ project page</ulink>.
+ </para>
+
+ <para>
+ <emphasis role="bold">Usage</emphasis>:
+ </para>
+
<programlisting>
perl ndb_size.pl <replaceable>db_name</replaceable> <replaceable>hostname</replaceable> <replaceable>username</replaceable> <replaceable>password</replaceable> > <replaceable>file_name</replaceable>.html
</programlisting>
- <para>
- The command shown connects to the MySQL server at
- <replaceable>hostname</replaceable> using the account of the
- user <replaceable>username</replaceable> having the password
- <replaceable>password</replaceable>, analyses all of the
- tables in database <replaceable>db_name</replaceable>, and
- generates a report in HTML format which is directed to the
- file
- <filename><replaceable>file_name</replaceable>.html</filename>.
- (Without the redirection, the output is sent to
- <literal>stdout</literal>.) This figure shows partial sample
- output as viewed in a Web browser:
- </para>
+ <para>
+ The command shown connects to the MySQL server at
+ <replaceable>hostname</replaceable> using the account of the
+ user <replaceable>username</replaceable> having the password
+ <replaceable>password</replaceable>, analyses all of the
+ tables in database <replaceable>db_name</replaceable>, and
+ generates a report in HTML format which is directed to the
+ file
+ <filename><replaceable>file_name</replaceable>.html</filename>.
+ (Without the redirection, the output is sent to
+ <literal>stdout</literal>.) This figure shows partial sample
+ output as viewed in a Web browser:
+ </para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/ndb-size-pl-1.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase lang="en">Partial sample output from
- <command>ndb_size.pl</command> as viewed in a Web
- browser.</phrase>
- </textobject>
- </mediaobject>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/ndb-size-pl-1.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Partial sample output from
+ <command>ndb_size.pl</command> as viewed in a Web
+ browser.</phrase>
+ </textobject>
+ </mediaobject>
- <para>
- The output from this script includes:
+ <para>
+ The output from this script includes:
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- Minimum values for the <literal>DataMemory</literal>,
- <literal>IndexMemory</literal>,
- <literal>MaxNoOfTables</literal>,
- <literal>MaxNoOfAttributes</literal>,
- <literal>MaxNoOfOrderedIndexes</literal>,
- <literal>MaxNoOfUniqueHashIndexes</literal>, and
- <literal>MaxNoOfTriggers</literal> configuration
- parameters required to accommodate the tables
- analysed.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ Minimum values for the <literal>DataMemory</literal>,
+ <literal>IndexMemory</literal>,
+ <literal>MaxNoOfTables</literal>,
+ <literal>MaxNoOfAttributes</literal>,
+ <literal>MaxNoOfOrderedIndexes</literal>,
+ <literal>MaxNoOfUniqueHashIndexes</literal>, and
+ <literal>MaxNoOfTriggers</literal> configuration
+ parameters required to accommodate the tables analysed.
+ </para>
+ </listitem>
- <listitem>
- <para>
- Memory requirements for all of the tables, attributes,
- ordered indexes, and unique hash indexes defined in
- the database.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ Memory requirements for all of the tables, attributes,
+ ordered indexes, and unique hash indexes defined in the
+ database.
+ </para>
+ </listitem>
- <listitem>
- <para>
- The <literal>IndexMemory</literal> and
- <literal>DataMemory</literal> required per table and
- table row.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ The <literal>IndexMemory</literal> and
+ <literal>DataMemory</literal> required per table and
+ table row.
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ </itemizedlist>
+ </para>
- <para>
- Beginning with MySQL 5.1.23
- (<emphasis>&mccge-current;</emphasis>: 5.1.22-ndb-6.2.5),
- the behavior of this utility and its available options have
- changed. (Bug #28683, Bug #28253)
- </para>
+ <para>
+ Beginning with MySQL 5.1.23
+ (<emphasis>&mccge-current;</emphasis>: 5.1.22-ndb-6.2.5), the
+ behavior of this utility and its available options have
+ changed. (Bug #28683, Bug #28253)
+ </para>
- <para>
- Typical usage is shown here:
+ <para>
+ Typical usage is shown here:
<programlisting>
ndb_size.pl [--database=<replaceable>db_name</replaceable>|ALL] [--hostname=<replaceable>host</replaceable>[:<replaceable>port</replaceable>]] [--socket=<replaceable>socket</replaceable>] [--user=<replaceable>user</replaceable>] [--password=<replaceable>password</replaceable>] [--help|-h] [--format=(html|text)] [--loadqueries=<replaceable>file</replaceable>] [--savequeries=<replaceable>file</replaceable>]
</programlisting>
- <important>
- <para>
- <command>ndb_size.pl</command> now takes named options,
- each of which is optional.
- </para>
- </important>
- </para>
+ <important>
+ <para>
+ <command>ndb_size.pl</command> now takes named options,
+ each of which is optional.
+ </para>
+ </important>
+ </para>
- <para>
- By default, this utility attempts to analyze all databases
- on the server. You can specify a single database using the
- <option>--database</option> option; the default behavior can
- be made explicit by using <literal>ALL</literal> for the
- name of the database. You can also exclude one or more
- databases by using the <option>--excludedbs</option> with a
- comma-separated list of the names of the databases to be
- skipped. Similarly, you can cause specific tables to be
- skipped by listing their names, separated by commas,
- following the optional <option>--excludetables</option>
- option. A hostname (and possibly a port as well) can be
- specified using <option>--hostname</option>; the default is
- <literal>localhost:3306</literal>. If necessary, you can
- specify a socket; the default is
- <filename>/var/lib/mysql.sock</filename>. A MySQL username
- and password can be specified the corresponding options
- shown. It also possible to control the format of the output
- using the <option>--format</option> option; this can take
- either of the values <literal>html</literal> or
- <literal>text</literal>, with <literal>text</literal> being
- the default. An example of the text output is shown here:
+ <para>
+ By default, this utility attempts to analyze all databases on
+ the server. You can specify a single database using the
+ <option>--database</option> option; the default behavior can
+ be made explicit by using <literal>ALL</literal> for the name
+ of the database. You can also exclude one or more databases by
+ using the <option>--excludedbs</option> with a comma-separated
+ list of the names of the databases to be skipped. Similarly,
+ you can cause specific tables to be skipped by listing their
+ names, separated by commas, following the optional
+ <option>--excludetables</option> option. A hostname (and
+ possibly a port as well) can be specified using
+ <option>--hostname</option>; the default is
+ <literal>localhost:3306</literal>. If necessary, you can
+ specify a socket; the default is
+ <filename>/var/lib/mysql.sock</filename>. A MySQL username and
+ password can be specified the corresponding options shown. It
+ also possible to control the format of the output using the
+ <option>--format</option> option; this can take either of the
+ values <literal>html</literal> or <literal>text</literal>,
+ with <literal>text</literal> being the default. An example of
+ the text output is shown here:
<programlisting>
shell> <userinput>ndb_size.pl --database=test --socket=/tmp/mysql.sock</userinput>
@@ -2931,23 +2913,23 @@
NoOfAttributes 1000 3 3 3
NoOfTriggers 768 5 5 5
</programlisting>
- </para>
+ </para>
- <para>
- For debugging purposes, the Perl arrays containing the
- queries run by this script can be read from the file
- specified using can be saved to a file using
- <option>--savequeries</option>; a file containing such
- arrays to be read in during script execution can be
- specified using <option>--loadqueries</option>. Neither of
- these options has a default value.
- </para>
+ <para>
+ For debugging purposes, the Perl arrays containing the queries
+ run by this script can be read from the file specified using
+ can be saved to a file using <option>--savequeries</option>; a
+ file containing such arrays to be read in during script
+ execution can be specified using
+ <option>--loadqueries</option>. Neither of these options has a
+ default value.
+ </para>
- </refsection>
+ </refsection>
- </refentry>
+ </refentry>
- </section>
+ </section>
<!--
<section id="mysql-cluster-utilities-ndb-test-platform">
@@ -2974,218 +2956,218 @@
-->
- <section id="fake-id-for-ndb-waiter-manpage-section-wrapper">
+ <section id="fake-id-for-ndb-waiter-manpage-section-wrapper">
- <title>fake title for ndb_waiter manpage section wrapper</title>
+ <title>fake title for ndb_waiter manpage section wrapper</title>
- <refentry id="mysql-cluster-utilities-ndb-waiter">
+ <refentry id="mysql-cluster-utilities-ndb-waiter">
- <indexterm>
- <primary>ndb_waiter</primary>
- </indexterm>
+ <indexterm>
+ <primary>ndb_waiter</primary>
+ </indexterm>
- <refmeta>
- <refentrytitle><command>ndb_waiter</command></refentrytitle>
-
- <manvolnum>1</manvolnum>
- <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
- <refmiscinfo class="source">MySQL</refmiscinfo>
- <refmiscinfo class="version">¤t-series;</refmiscinfo>
- <refmiscinfo class="refman">Wait for Cluster to Reach a Given Status</refmiscinfo>
- </refmeta>
+ <refmeta>
+ <refentrytitle><command>ndb_waiter</command></refentrytitle>
+
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
+ <refmiscinfo class="source">MySQL</refmiscinfo>
+ <refmiscinfo class="version">¤t-series;</refmiscinfo>
+ <refmiscinfo class="refman">Wait for Cluster to Reach a Given Status</refmiscinfo>
+ </refmeta>
- <refnamediv>
- <refname>ndb_waiter</refname>
-
- <refpurpose>wait for cluster to reach a given status</refpurpose>
- </refnamediv>
+ <refnamediv>
+ <refname>ndb_waiter</refname>
+
+ <refpurpose>wait for cluster to reach a given status</refpurpose>
+ </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ndb_waiter <replaceable>options</replaceable></command>
- </cmdsynopsis>
- </refsynopsisdiv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ndb_waiter <replaceable>options</replaceable></command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
- <refsection id="ndb-waiter-description">
+ <refsection id="ndb-waiter-description">
- <title>Description</title>
+ <title>Description</title>
- <para>
- <command>ndb_waiter</command> repeatedly (each 100
- milliseconds) prints out the status of all cluster data
- nodes until either the cluster reaches a given status or the
- <option>--timeout</option> limit is exceeded, then exits. By
- default, it waits for the cluster to achieve
- <literal>STARTED</literal> status, in which all nodes have
- started and connected to the cluster. This can be overridden
- using the <option>--no-contact</option> and
- <option>--not-started</option> options (see
- <link linkend="mysql-cluster-utilities-ndb-waiter-additional-options">Additional
- Options</link>).
- </para>
+ <para>
+ <command>ndb_waiter</command> repeatedly (each 100
+ milliseconds) prints out the status of all cluster data nodes
+ until either the cluster reaches a given status or the
+ <option>--timeout</option> limit is exceeded, then exits. By
+ default, it waits for the cluster to achieve
+ <literal>STARTED</literal> status, in which all nodes have
+ started and connected to the cluster. This can be overridden
+ using the <option>--no-contact</option> and
+ <option>--not-started</option> options (see
+ <link linkend="mysql-cluster-utilities-ndb-waiter-additional-options">Additional
+ Options</link>).
+ </para>
- <para>
- The node states reported by this utility are as follows:
- </para>
+ <para>
+ The node states reported by this utility are as follows:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <literal>NO_CONTACT</literal>: The node cannot be
- contacted.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>NO_CONTACT</literal>: The node cannot be
+ contacted.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>UNKNOWN</literal>: The node can be contacted,
- but its status is not yet known. Usually, this means
- that the node has received a <literal>START</literal> or
- <literal>RESTART</literal> command from the management
- server, but has not yet acted on it.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>UNKNOWN</literal>: The node can be contacted, but
+ its status is not yet known. Usually, this means that the
+ node has received a <literal>START</literal> or
+ <literal>RESTART</literal> command from the management
+ server, but has not yet acted on it.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>NOT_STARTED</literal>: The node has stopped,
- but remains in contact with the cluster. This is seen
- when restarting the node using the management client's
- <literal>RESTART</literal> command.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>NOT_STARTED</literal>: The node has stopped, but
+ remains in contact with the cluster. This is seen when
+ restarting the node using the management client's
+ <literal>RESTART</literal> command.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>STARTING</literal>: The node's
- <command>ndbd</command> process has started, but the
- node has not yet joined the cluster.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>STARTING</literal>: The node's
+ <command>ndbd</command> process has started, but the node
+ has not yet joined the cluster.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>STARTED</literal>: The node is operational, and
- has joined the cluster.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>STARTED</literal>: The node is operational, and
+ has joined the cluster.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>SHUTTING_DOWN</literal>: The node is shutting
- down.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>SHUTTING_DOWN</literal>: The node is shutting
+ down.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>SINGLE USER MODE</literal>: This is shown for
- all cluster data nodes when the cluster is in single
- user mode.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>SINGLE USER MODE</literal>: This is shown for all
+ cluster data nodes when the cluster is in single user
+ mode.
+ </para>
+ </listitem>
- </itemizedlist>
+ </itemizedlist>
- <para>
- <emphasis role="bold">Usage</emphasis>:
- </para>
+ <para>
+ <emphasis role="bold">Usage</emphasis>:
+ </para>
<programlisting>
ndb_waiter [-c <replaceable>connect_string</replaceable>]
</programlisting>
- <para id="mysql-cluster-utilities-ndb-waiter-additional-options">
- <emphasis role="bold">Additional Options</emphasis>:
- </para>
+ <para id="mysql-cluster-utilities-ndb-waiter-additional-options">
+ <emphasis role="bold">Additional Options</emphasis>:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <indexterm>
- <primary>ndb_waiter</primary>
- <secondary>no-contact option</secondary>
- </indexterm>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_waiter</primary>
+ <secondary>no-contact option</secondary>
+ </indexterm>
- <indexterm>
- <primary>no-contact option</primary>
- <secondary>ndb_waiter</secondary>
- </indexterm>
+ <indexterm>
+ <primary>no-contact option</primary>
+ <secondary>ndb_waiter</secondary>
+ </indexterm>
- <option>--no-contact</option>, <option>-n</option>
- </para>
+ <option>--no-contact</option>, <option>-n</option>
+ </para>
- <para>
- Instead of waiting for the <literal>STARTED</literal>
- state, <command>ndb_waiter</command> continues running
- until the cluster reaches <literal>NO_CONTACT</literal>
- status before exiting.
- </para>
- </listitem>
+ <para>
+ Instead of waiting for the <literal>STARTED</literal>
+ state, <command>ndb_waiter</command> continues running
+ until the cluster reaches <literal>NO_CONTACT</literal>
+ status before exiting.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <indexterm>
- <primary>ndb_waiter</primary>
- <secondary>not-started option</secondary>
- </indexterm>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_waiter</primary>
+ <secondary>not-started option</secondary>
+ </indexterm>
- <indexterm>
- <primary>not-started option</primary>
- <secondary>ndb_waiter</secondary>
- </indexterm>
+ <indexterm>
+ <primary>not-started option</primary>
+ <secondary>ndb_waiter</secondary>
+ </indexterm>
- <option>--not-started</option>
- </para>
+ <option>--not-started</option>
+ </para>
- <para>
- Instead of waiting for the <literal>STARTED</literal>
- state, <command>ndb_waiter</command> continues running
- until the cluster reaches <literal>NOT_STARTED</literal>
- status before exiting.
- </para>
- </listitem>
+ <para>
+ Instead of waiting for the <literal>STARTED</literal>
+ state, <command>ndb_waiter</command> continues running
+ until the cluster reaches <literal>NOT_STARTED</literal>
+ status before exiting.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <indexterm>
- <primary>ndb_waiter</primary>
- <secondary>timeout option</secondary>
- </indexterm>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_waiter</primary>
+ <secondary>timeout option</secondary>
+ </indexterm>
- <indexterm>
- <primary>timeout option</primary>
- <secondary>ndb_waiter</secondary>
- </indexterm>
+ <indexterm>
+ <primary>timeout option</primary>
+ <secondary>ndb_waiter</secondary>
+ </indexterm>
- <option>--timeout=<replaceable>seconds</replaceable></option>,
- <option>-t <replaceable>seconds</replaceable></option>
- </para>
+ <option>--timeout=<replaceable>seconds</replaceable></option>,
+ <option>-t <replaceable>seconds</replaceable></option>
+ </para>
- <para>
- Time to wait. The program exits if the desired state is
- not achieved within this number of seconds. The default
- is 120 seconds (1200 reporting cycles).
- </para>
- </listitem>
+ <para>
+ Time to wait. The program exits if the desired state is
+ not achieved within this number of seconds. The default is
+ 120 seconds (1200 reporting cycles).
+ </para>
+ </listitem>
- </itemizedlist>
+ </itemizedlist>
- <formalpara>
+ <formalpara>
- <title>Sample Output</title>
+ <title>Sample Output</title>
- <para>
- Shown here is the output from
- <command>ndb_waiter</command> when run against a 4-node
- cluster in which two nodes have been shut down and then
- started again manually. Duplicate reports (indicated by
- <quote><literal>...</literal></quote>) are omitted.
- </para>
+ <para>
+ Shown here is the output from <command>ndb_waiter</command>
+ when run against a 4-node cluster in which two nodes have
+ been shut down and then started again manually. Duplicate
+ reports (indicated by <quote><literal>...</literal></quote>)
+ are omitted.
+ </para>
- </formalpara>
+ </formalpara>
<programlisting>
shell> <userinput>./ndb_waiter -c localhost</userinput>
@@ -3248,19 +3230,20 @@
NDBT_ProgramExit: 0 - OK
</programlisting>
- <note>
- <para>
- If no connectstring is specified, then
- <command>ndb_waiter</command> tries to connect to a
- management on <literal>localhost</literal>, and reports
- <literal>Connecting to mgmsrv at (null)</literal>.
- </para>
- </note>
+ <note>
+ <para>
+ If no connectstring is specified, then
+ <command>ndb_waiter</command> tries to connect to a
+ management on <literal>localhost</literal>, and reports
+ <literal>Connecting to mgmsrv at (null)</literal>.
+ </para>
+ </note>
- </refsection>
+ </refsection>
- </refentry>
+ </refentry>
- </section>
+ </section>
- </section>
\ No newline at end of file
+</section>
+
Modified: trunk/refman-5.1/mysql-cluster.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster.xml 2007-09-24 12:44:33 UTC (rev 7910)
+++ trunk/refman-5.1/mysql-cluster.xml 2007-09-24 15:49:12 UTC (rev 7911)
Changed blocks: 1, Lines Added: 2, Lines Deleted: 1; 520 bytes
@@ -116,7 +116,8 @@
<listitem>
<para>
- The MySQL Cluster Forum: <ulink url="&base-url-forum-list;?25"/>.
+ The MySQL Cluster Forum:
+ <ulink url="&base-url-forum-list;?25"/>.
</para>
</listitem>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r7911 - trunk/refman-5.1 | mcbrown | 24 Sep |
