Author: paul
Date: 2007-02-28 22:24:31 +0100 (Wed, 28 Feb 2007)
New Revision: 5118
Log:
r20702@polar: paul | 2007-02-28 14:55:55 -0600
Convert ndb_select_all section to use manpage markup.
Modified:
trunk/refman-4.1/mysql-cluster.xml
trunk/refman-5.0/mysql-cluster.xml
trunk/refman-5.1/mysql-cluster.xml
Property changes on: trunk
___________________________________________________________________
Name: svk:merge
- 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:20701
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:16997
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:14593
+ 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:20702
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:16997
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:14593
Modified: trunk/refman-4.1/mysql-cluster.xml
===================================================================
--- trunk/refman-4.1/mysql-cluster.xml 2007-02-28 21:24:17 UTC (rev 5117)
+++ trunk/refman-4.1/mysql-cluster.xml 2007-02-28 21:24:31 UTC (rev 5118)
Changed blocks: 5, Lines Added: 189, Lines Deleted: 153; 14156 bytes
@@ -14566,200 +14566,231 @@
</section>
- <section id="mysql-cluster-utilities-ndb-select-all">
+ <section id="fake-id-for-ndb-select-all-manpage-section-wrapper">
- <title><command>ndb_select_all</command></title>
+ <title>fake title for ndb_select_all manpage section wrapper</title>
- <indexterm>
- <primary><command>ndb_select_all</command></primary>
- </indexterm>
+ <refentry id="mysql-cluster-utilities-ndb-select-all">
- <para>
- <emphasis role="bold">Description</emphasis>: Prints all rows
- from an <literal>NDB</literal> table to
- <literal>stdout</literal>.
- </para>
+ <indexterm>
+ <primary>ndb_select_all</primary>
+ </indexterm>
- <para>
- <emphasis role="bold">Usage</emphasis>:
- </para>
+ <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>
-<programlisting>
-ndb_select_all -c <replaceable>connect_string</replaceable> <replaceable>tbl_name</replaceable> -d <replaceable>db_name</replaceable> [> <replaceable>file_name</replaceable>]
-</programlisting>
+ <refnamediv>
+ <refname>ndb_select_all</refname>
+
+ <refpurpose>print rows from NDB table</refpurpose>
+ </refnamediv>
- <para>
- <emphasis role="bold">Additional Options</emphasis>:
- </para>
+ <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>
- <itemizedlist>
+ <refsection id="ndb-select-all-description">
- <listitem>
+ <title>Description</title>
+
<para>
- <option>-l <replaceable>lock_type</replaceable></option>,
- <option>--lock=<replaceable>lock_type</replaceable></option>
+ <command>ndb_select_all</command> prints all rows from an
+ <literal>NDB</literal> table to <literal>stdout</literal>.
</para>
<para>
- Employs a lock when reading the table. Possible values for
- <replaceable>lock_type</replaceable> are:
+ <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>
+
<itemizedlist>
<listitem>
<para>
- <literal>0</literal>: Read lock
+ <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>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>0</literal>: Read lock
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>1</literal>: Read lock with hold
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>2</literal>: Exclusive read lock
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ There is no default value for this option.
+ </para>
</listitem>
<listitem>
<para>
- <literal>1</literal>: Read lock with hold
+ <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>
<listitem>
<para>
- <literal>2</literal>: Exclusive read lock
+ <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>
- </itemizedlist>
+ <listitem>
+ <para>
+ <option>--header=FALSE</option>
+ </para>
- <para>
- There is no default value for this option.
- </para>
- </listitem>
+ <para>
+ Excludes column headers from the output.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <option>-o <replaceable>index_name</replaceable></option>,
- <option>--order=<replaceable>index_name</replaceable></option>
- </para>
+ <listitem>
+ <para>
+ <option>--useHexFormat</option> <option>-x</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>
+ 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>
- <option>-z</option>, <option>--descending</option>
- </para>
+ <listitem>
+ <para>
+ <option>--delimiter=<replaceable>character</replaceable></option>,
+ <option>-D <replaceable>character</replaceable></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>
+ Causes the <replaceable>character</replaceable> to be
+ used as a column delimiter. Only table data columns are
+ separated by this delimiter.
+ </para>
- <listitem>
- <para>
- <option>--header=FALSE</option>
- </para>
+ <para>
+ The default delimiter is the tab character.
+ </para>
+ </listitem>
- <para>
- Excludes column headers from the output.
- </para>
- </listitem>
+ <listitem>
+ <remark role="todo">
+ [js] Add more info and link to cluster filesystem
+ documentation when that appears in the Manual.
+ </remark>
- <listitem>
- <para>
- <option>-x</option>, <option>--useHexFormat</option>
- </para>
+ <para>
+ <option>--rowid</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>
+ <para>
+ Adds a <literal>ROWID</literal> column providing
+ information about the fragments in which rows are
+ stored.
+ </para>
+ </listitem>
- <para>
- <option>-D <replaceable>character</replaceable></option>,
- <option>--delimiter=<replaceable>character</replaceable></option>
- </para>
+ <listitem>
+ <para>
+ <option>--gci</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>
+ 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>
- The default delimiter is the tab character.
- </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] Add more info and link to cluster filesystem
- documentation when that appears in the Manual.
- </remark>
+ <para>
+ <option>--tupscan</option> <option>-t</option>
+ </para>
- <para>
- <option>--rowid</option>
- </para>
+ <para>
+ Scan the table in the order of the tuples.
+ </para>
+ </listitem>
- <para>
- Adds a <literal>ROWID</literal> column providing information
- about the fragments in which rows are stored.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <option>--nodata</option>
+ </para>
- <listitem>
- <para>
- <option>--gci</option>
- </para>
+ <para>
+ Causes any table data to be omitted.
+ </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>
+ </itemizedlist>
- <listitem>
- <remark role="todo">
- [js] Need to provide a better explanation of this, or a link
- to one.
- </remark>
-
<para>
- <option>-t</option>, <option>--tupscan</option>
+ <emphasis role="bold">Sample Output</emphasis>:
</para>
<para>
- Scan the table in the order of the tuples.
+ Output from a MySQL <literal>SELECT</literal> statement:
</para>
- </listitem>
- <listitem>
- <para>
- <option>--nodata</option>
- </para>
-
- <para>
- Causes any table data to be omitted.
- </para>
- </listitem>
-
- </itemizedlist>
-
- <para>
- <emphasis role="bold">Sample Output</emphasis>:
- </para>
-
- <para>
- Output from a MySQL <literal>SELECT</literal> statement:
- </para>
-
<programlisting>
mysql> <userinput>SELECT * FROM ctest1.fish;</userinput>
+----+-----------+
@@ -14775,10 +14806,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>
@@ -14794,12 +14825,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 (
@@ -14818,10 +14850,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</userinput>
@@ -14835,6 +14867,10 @@
NDBT_ProgramExit: 0 - OK
</programlisting>
+ </refsection>
+
+ </refentry>
+
</section>
<section id="mysql-cluster-utilities-ndb-select-count">
Modified: trunk/refman-5.0/mysql-cluster.xml
===================================================================
--- trunk/refman-5.0/mysql-cluster.xml 2007-02-28 21:24:17 UTC (rev 5117)
+++ trunk/refman-5.0/mysql-cluster.xml 2007-02-28 21:24:31 UTC (rev 5118)
Changed blocks: 5, Lines Added: 189, Lines Deleted: 153; 14156 bytes
@@ -14679,200 +14679,231 @@
</section>
- <section id="mysql-cluster-utilities-ndb-select-all">
+ <section id="fake-id-for-ndb-select-all-manpage-section-wrapper">
- <title><command>ndb_select_all</command></title>
+ <title>fake title for ndb_select_all manpage section wrapper</title>
- <indexterm>
- <primary><command>ndb_select_all</command></primary>
- </indexterm>
+ <refentry id="mysql-cluster-utilities-ndb-select-all">
- <para>
- <emphasis role="bold">Description</emphasis>: Prints all rows
- from an <literal>NDB</literal> table to
- <literal>stdout</literal>.
- </para>
+ <indexterm>
+ <primary>ndb_select_all</primary>
+ </indexterm>
- <para>
- <emphasis role="bold">Usage</emphasis>:
- </para>
+ <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>
-<programlisting>
-ndb_select_all -c <replaceable>connect_string</replaceable> <replaceable>tbl_name</replaceable> -d <replaceable>db_name</replaceable> [> <replaceable>file_name</replaceable>]
-</programlisting>
+ <refnamediv>
+ <refname>ndb_select_all</refname>
+
+ <refpurpose>print rows from NDB table</refpurpose>
+ </refnamediv>
- <para>
- <emphasis role="bold">Additional Options</emphasis>:
- </para>
+ <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>
- <itemizedlist>
+ <refsection id="ndb-select-all-description">
- <listitem>
+ <title>Description</title>
+
<para>
- <option>-l <replaceable>lock_type</replaceable></option>,
- <option>--lock=<replaceable>lock_type</replaceable></option>
+ <command>ndb_select_all</command> prints all rows from an
+ <literal>NDB</literal> table to <literal>stdout</literal>.
</para>
<para>
- Employs a lock when reading the table. Possible values for
- <replaceable>lock_type</replaceable> are:
+ <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>
+
<itemizedlist>
<listitem>
<para>
- <literal>0</literal>: Read lock
+ <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>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>0</literal>: Read lock
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>1</literal>: Read lock with hold
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>2</literal>: Exclusive read lock
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ There is no default value for this option.
+ </para>
</listitem>
<listitem>
<para>
- <literal>1</literal>: Read lock with hold
+ <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>
<listitem>
<para>
- <literal>2</literal>: Exclusive read lock
+ <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>
- </itemizedlist>
+ <listitem>
+ <para>
+ <option>--header=FALSE</option>
+ </para>
- <para>
- There is no default value for this option.
- </para>
- </listitem>
+ <para>
+ Excludes column headers from the output.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <option>-o <replaceable>index_name</replaceable></option>,
- <option>--order=<replaceable>index_name</replaceable></option>
- </para>
+ <listitem>
+ <para>
+ <option>--useHexFormat</option> <option>-x</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>
+ 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>
- <option>-z</option>, <option>--descending</option>
- </para>
+ <listitem>
+ <para>
+ <option>--delimiter=<replaceable>character</replaceable></option>,
+ <option>-D <replaceable>character</replaceable></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>
+ Causes the <replaceable>character</replaceable> to be
+ used as a column delimiter. Only table data columns are
+ separated by this delimiter.
+ </para>
- <listitem>
- <para>
- <option>--header=FALSE</option>
- </para>
+ <para>
+ The default delimiter is the tab character.
+ </para>
+ </listitem>
- <para>
- Excludes column headers from the output.
- </para>
- </listitem>
+ <listitem>
+ <remark role="todo">
+ [js] Add more info and link to cluster filesystem
+ documentation when that appears in the Manual.
+ </remark>
- <listitem>
- <para>
- <option>-x</option>, <option>--useHexFormat</option>
- </para>
+ <para>
+ <option>--rowid</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>
+ <para>
+ Adds a <literal>ROWID</literal> column providing
+ information about the fragments in which rows are
+ stored.
+ </para>
+ </listitem>
- <para>
- <option>-D <replaceable>character</replaceable></option>,
- <option>--delimiter=<replaceable>character</replaceable></option>
- </para>
+ <listitem>
+ <para>
+ <option>--gci</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>
+ 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>
- The default delimiter is the tab character.
- </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] Add more info and link to cluster filesystem
- documentation when that appears in the Manual.
- </remark>
+ <para>
+ <option>--tupscan</option> <option>-t</option>
+ </para>
- <para>
- <option>--rowid</option>
- </para>
+ <para>
+ Scan the table in the order of the tuples.
+ </para>
+ </listitem>
- <para>
- Adds a <literal>ROWID</literal> column providing information
- about the fragments in which rows are stored.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <option>--nodata</option>
+ </para>
- <listitem>
- <para>
- <option>--gci</option>
- </para>
+ <para>
+ Causes any table data to be omitted.
+ </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>
+ </itemizedlist>
- <listitem>
- <remark role="todo">
- [js] Need to provide a better explanation of this, or a link
- to one.
- </remark>
-
<para>
- <option>-t</option>, <option>--tupscan</option>
+ <emphasis role="bold">Sample Output</emphasis>:
</para>
<para>
- Scan the table in the order of the tuples.
+ Output from a MySQL <literal>SELECT</literal> statement:
</para>
- </listitem>
- <listitem>
- <para>
- <option>--nodata</option>
- </para>
-
- <para>
- Causes any table data to be omitted.
- </para>
- </listitem>
-
- </itemizedlist>
-
- <para>
- <emphasis role="bold">Sample Output</emphasis>:
- </para>
-
- <para>
- Output from a MySQL <literal>SELECT</literal> statement:
- </para>
-
<programlisting>
mysql> <userinput>SELECT * FROM ctest1.fish;</userinput>
+----+-----------+
@@ -14888,10 +14919,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>
@@ -14907,12 +14938,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 (
@@ -14931,10 +14963,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</userinput>
@@ -14948,6 +14980,10 @@
NDBT_ProgramExit: 0 - OK
</programlisting>
+ </refsection>
+
+ </refentry>
+
</section>
<section id="mysql-cluster-utilities-ndb-select-count">
Modified: trunk/refman-5.1/mysql-cluster.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster.xml 2007-02-28 21:24:17 UTC (rev 5117)
+++ trunk/refman-5.1/mysql-cluster.xml 2007-02-28 21:24:31 UTC (rev 5118)
Changed blocks: 5, Lines Added: 298, Lines Deleted: 175; 17944 bytes
@@ -14753,222 +14753,340 @@
</section>
- <section id="mysql-cluster-utilities-ndb-select-all">
+ <section id="fake-id-for-ndb-select-all-manpage-section-wrapper">
- <title><command>ndb_select_all</command></title>
+ <title>fake title for ndb_select_all manpage section wrapper</title>
- <indexterm>
- <primary><command>ndb_select_all</command></primary>
- </indexterm>
+ <refentry id="mysql-cluster-utilities-ndb-select-all">
- <para>
- <emphasis role="bold">Description</emphasis>: Prints all rows
- from an <literal>NDB</literal> table to
- <literal>stdout</literal>.
- </para>
+ <indexterm>
+ <primary>ndb_select_all</primary>
+ </indexterm>
- <para>
- <emphasis role="bold">Usage</emphasis>:
- </para>
+ <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>
-<programlisting>
-ndb_select_all -c <replaceable>connect_string</replaceable> <replaceable>tbl_name</replaceable> -d <replaceable>db_name</replaceable> [> <replaceable>file_name</replaceable>]
-</programlisting>
+ <refnamediv>
+ <refname>ndb_select_all</refname>
+
+ <refpurpose>print rows from NDB table</refpurpose>
+ </refnamediv>
- <para>
- <emphasis role="bold">Additional Options</emphasis>:
- </para>
+ <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>
- <itemizedlist>
+ <refsection id="ndb-select-all-description">
- <listitem>
+ <title>Description</title>
+
<para>
- <option>-l <replaceable>lock_type</replaceable></option>,
- <option>--lock=<replaceable>lock_type</replaceable></option>
+ <command>ndb_select_all</command> prints all rows from an
+ <literal>NDB</literal> table to <literal>stdout</literal>.
</para>
<para>
- Employs a lock when reading the table. Possible values for
- <replaceable>lock_type</replaceable> are:
+ <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>
+
<itemizedlist>
<listitem>
<para>
- <literal>0</literal>: Read lock
+<indexterm>
+<primary>ndb_select_all</primary>
+<secondary>lock option</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>
+
+ <para>
+ Employs a lock when reading the table. Possible values
+ for <replaceable>lock_type</replaceable> are:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>0</literal>: Read lock
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>1</literal>: Read lock with hold
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>2</literal>: Exclusive read lock
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ There is no default value for this option.
+ </para>
</listitem>
<listitem>
<para>
- <literal>1</literal>: Read lock with hold
+<indexterm>
+<primary>ndb_select_all</primary>
+<secondary>order option</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>
+
+ <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>
- <literal>2</literal>: Exclusive read lock
+<indexterm>
+<primary>ndb_select_all</primary>
+<secondary>descending option</secondary>
+</indexterm>
+<indexterm>
+<primary>descending option</primary>
+<secondary>ndb_select_all</secondary>
+</indexterm>
+ <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>
- </itemizedlist>
+ <listitem>
+ <para>
+<indexterm>
+<primary>ndb_select_all</primary>
+<secondary>header option</secondary>
+</indexterm>
+<indexterm>
+<primary>header option</primary>
+<secondary>ndb_select_all</secondary>
+</indexterm>
+ <option>--header=FALSE</option>
+ </para>
- <para>
- There is no default value for this option.
- </para>
- </listitem>
+ <para>
+ Excludes column headers from the output.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <option>-o <replaceable>index_name</replaceable></option>,
- <option>--order=<replaceable>index_name</replaceable></option>
- </para>
+ <listitem>
+ <para>
+<indexterm>
+<primary>ndb_select_all</primary>
+<secondary>useHexFormat option</secondary>
+</indexterm>
+<indexterm>
+<primary>useHexFormat option</primary>
+<secondary>ndb_select_all</secondary>
+</indexterm>
+ <option>--useHexFormat</option> <option>-x</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>
+ 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>
- <option>-z</option>, <option>--descending</option>
- </para>
+ <listitem>
+ <para>
+<indexterm>
+<primary>ndb_select_all</primary>
+<secondary>delimiter option</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>
- <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>
+ Causes the <replaceable>character</replaceable> to be
+ used as a column delimiter. Only table data columns are
+ separated by this delimiter.
+ </para>
- <listitem>
- <para>
- <option>--header=FALSE</option>
- </para>
+ <para>
+ The default delimiter is the tab character.
+ </para>
+ </listitem>
- <para>
- Excludes column headers from the output.
- </para>
- </listitem>
+ <listitem>
+ <remark role="todo">
+ [js] Remove this parameter from the 4.1 and 5.0
+ versions, since it applies only to Disk Data tables.
+ </remark>
- <listitem>
- <para>
- <option>-x</option>, <option>--useHexFormat</option>
- </para>
+ <remark role="todo">
+ [js] Add more info and link to cluster filesystem
+ documentation when that appears in the Manual.
+ </remark>
- <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>
+ <para>
+<indexterm>
+<primary>ndb_select_all</primary>
+<secondary>disk option</secondary>
+</indexterm>
+<indexterm>
+<primary>disk option</primary>
+<secondary>ndb_select_all</secondary>
+</indexterm>
+ <option>--disk</option>
+ </para>
- <para>
- <option>-D <replaceable>character</replaceable></option>,
- <option>--delimiter=<replaceable>character</replaceable></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>
- Causes the <replaceable>character</replaceable> to be used
- as a column delimiter. Only table data columns are separated
- by this delimiter.
- </para>
+ <listitem>
+ <remark role="todo">
+ [js] Add more info and link to cluster filesystem
+ documentation when that appears in the Manual.
+ </remark>
- <para>
- The default delimiter is the tab character.
- </para>
- </listitem>
+ <para>
+<indexterm>
+<primary>ndb_select_all</primary>
+<secondary>rowid option</secondary>
+</indexterm>
+<indexterm>
+<primary>rowid option</primary>
+<secondary>ndb_select_all</secondary>
+</indexterm>
+ <option>--rowid</option>
+ </para>
- <listitem>
- <remark role="todo">
- [js] Remove this parameter from the 4.1 and 5.0 versions,
- since it applies only to Disk Data tables.
- </remark>
+ <para>
+ Adds a <literal>ROWID</literal> column providing
+ information about the fragments in which rows are
+ stored.
+ </para>
+ </listitem>
- <remark role="todo">
- [js] Add more info and link to cluster filesystem
- documentation when that appears in the Manual.
- </remark>
+ <listitem>
+ <para>
+<indexterm>
+<primary>ndb_select_all</primary>
+<secondary>gci option</secondary>
+</indexterm>
+<indexterm>
+<primary>gci option</primary>
+<secondary>ndb_select_all</secondary>
+</indexterm>
+ <option>--gci</option>
+ </para>
- <para>
- <option>--disk</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 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] Need to provide a better explanation of this, or a
+ link one.
+ </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>tupscan option</secondary>
+</indexterm>
+<indexterm>
+<primary>tupscan option</primary>
+<secondary>ndb_select_all</secondary>
+</indexterm>
+ <option>--tupscan</option> <option>-t</option>
+ </para>
- <para>
- <option>--rowid</option>
- </para>
+ <para>
+ Scan the table in the order of the tuples.
+ </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>nodata option</secondary>
+</indexterm>
+<indexterm>
+<primary>nodata option</primary>
+<secondary>ndb_select_all</secondary>
+</indexterm>
+ <option>--nodata</option>
+ </para>
- <listitem>
- <para>
- <option>--gci</option>
- </para>
+ <para>
+ Causes any table data to be omitted.
+ </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>
+ </itemizedlist>
- <listitem>
- <remark role="todo">
- [js] Need to provide a better explanation of this, or a link
- one.
- </remark>
-
<para>
- <option>-t</option>, <option>--tupscan</option>
+ <emphasis role="bold">Sample Output</emphasis>:
</para>
<para>
- Scan the table in the order of the tuples.
+ Output from a MySQL <literal>SELECT</literal> statement:
</para>
- </listitem>
- <listitem>
- <para>
- <option>--nodata</option>
- </para>
-
- <para>
- Causes any table data to be omitted.
- </para>
- </listitem>
-
- </itemizedlist>
-
- <para>
- <emphasis role="bold">Sample Output</emphasis>:
- </para>
-
- <para>
- Output from a MySQL <literal>SELECT</literal> statement:
- </para>
-
<programlisting>
mysql> <userinput>SELECT * FROM ctest1.fish;</userinput>
+----+-----------+
@@ -14984,10 +15102,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>
@@ -15003,17 +15121,18 @@
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>
- <remark role="todo">
- [js] Remove references to Disk Data from this example for the
- 4.1 and 5.0 versions.
- </remark>
+ <remark role="todo">
+ [js] Remove references to Disk Data from this example for
+ the 4.1 and 5.0 versions.
+ </remark>
<programlisting>
CREATE TABLE dogs (
@@ -15033,10 +15152,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>
@@ -15050,6 +15169,10 @@
NDBT_ProgramExit: 0 - OK
</programlisting>
+ </refsection>
+
+ </refentry>
+
</section>
<section id="mysql-cluster-utilities-ndb-select-count">
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r5118 - in trunk: . refman-4.1 refman-5.0 refman-5.1 | paul | 28 Feb |
