Author: paul
Date: 2007-03-02 22:17:52 +0100 (Fri, 02 Mar 2007)
New Revision: 5156
Log:
r20857@polar: paul | 2007-03-02 15:03:39 -0600
Convert ndb_restore 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:20856
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:20857
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-03-02 21:17:28 UTC (rev 5155)
+++ trunk/refman-4.1/mysql-cluster.xml 2007-03-02 21:17:52 UTC (rev 5156)
Changed blocks: 1, Lines Added: 342, Lines Deleted: 303; 31813 bytes
@@ -12558,341 +12558,380 @@
</section>
- <section id="mysql-cluster-restore">
+ <section id="fake-id-for-ndb-restore-manpage-section-wrapper">
- <title>How to Restore a Cluster Backup</title>
+ <title>fake title for ndb_restore manpage section wrapper</title>
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>backups</secondary>
- </indexterm>
+ <refentry id="mysql-cluster-restore">
- <indexterm>
- <primary>backups</primary>
- <secondary>in MySQL Cluster</secondary>
- </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>backups</secondary>
+ </indexterm>
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>restoring backups</secondary>
- </indexterm>
+ <indexterm>
+ <primary>backups</primary>
+ <secondary>in MySQL Cluster</secondary>
+ </indexterm>
- <indexterm>
- <primary>restoring backups</primary>
- <secondary>in MySQL Cluster</secondary>
- </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>restoring backups</secondary>
+ </indexterm>
- <indexterm>
- <primary><command>ndb_restore</command></primary>
- </indexterm>
+ <indexterm>
+ <primary>restoring backups</primary>
+ <secondary>in MySQL Cluster</secondary>
+ </indexterm>
- <para>
- The cluster restoration program is implemented as a separate
- command-line utility <command>ndb_restore</command>, which can
- normally be found in the MySQL <filename>bin</filename>
- directory. This program reads the files created as a result of
- the backup and inserts the stored information into the database.
- </para>
+ <indexterm>
+ <primary>ndb_restore</primary>
+ </indexterm>
- <para>
- <command>ndb_restore</command> must be executed once for each of
- the backup files that were created by the <literal>START
- BACKUP</literal> command used to create the backup (see
- <xref linkend="mysql-cluster-backup-using-management-client"/>).
- This is equal to the number of data nodes in the cluster at the
- time that the backup was created.
- </para>
+ <refmeta>
+ <refentrytitle><command>ndb_restore</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">Restore a Cluster Backup</refmiscinfo>
+ </refmeta>
- <indexterm>
- <primary>single user mode (MySQL Cluster)</primary>
- <secondary>and <command>ndb_restore</command></secondary>
- </indexterm>
+ <refnamediv>
+ <refname>ndb_restore</refname>
+
+ <refpurpose>restore a Cluster backup</refpurpose>
+ </refnamediv>
- <para>
- <emphasis role="bold">Note</emphasis>: Before using
- <command>ndb_restore</command>, it is recommended that the
- cluster be running in single user mode, unless you are restoring
- multiple data nodes in parallel. See
- <xref linkend="mysql-cluster-single-user-mode"/>, for more
- information about single user mode.
- </para>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ndb_restore <replaceable>options</replaceable></command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
- <para>
- Typical options for this utility are shown here:
- </para>
+ <refsection id="ndb-restore-description">
+ <title>Description</title>
+
+ <para>
+ The cluster restoration program is implemented as a separate
+ command-line utility <command>ndb_restore</command>, which
+ can normally be found in the MySQL <filename>bin</filename>
+ directory. This program reads the files created as a result
+ of the backup and inserts the stored information into the
+ database.
+ </para>
+
+ <para>
+ <command>ndb_restore</command> must be executed once for
+ each of the backup files that were created by the
+ <literal>START BACKUP</literal> command used to create the
+ backup (see
+ <xref linkend="mysql-cluster-backup-using-management-client"/>).
+ This is equal to the number of data nodes in the cluster at
+ the time that the backup was created.
+ </para>
+
+ <indexterm>
+ <primary>single user mode (MySQL Cluster)</primary>
+ <secondary>and <command>ndb_restore</command></secondary>
+ </indexterm>
+
+ <para>
+ <emphasis role="bold">Note</emphasis>: Before using
+ <command>ndb_restore</command>, it is recommended that the
+ cluster be running in single user mode, unless you are
+ restoring multiple data nodes in parallel. See
+ <xref linkend="mysql-cluster-single-user-mode"/>, for more
+ information about single user mode.
+ </para>
+
+ <para>
+ Typical options for this utility are shown here:
+ </para>
+
<programlisting>
ndb_restore [-c <replaceable>connectstring</replaceable>] -n <replaceable>node_id</replaceable> [-m] -b <replaceable>backup_id</replaceable> -r <replaceable>/path/to/backup/files</replaceable>
</programlisting>
- <para>
- The <option>-c</option> option is used to specify a
- connectstring which tells <literal>ndb_restore</literal> where
- to locate the cluster management server. (See
- <xref linkend="mysql-cluster-connectstring"/>, for information
- on connectstrings.) If this option is not used, then
- <command>ndb_restore</command> attempts to connect to a
- management server on <literal>localhost:1186</literal>. This
- utility acts as a cluster API node, and so requires a free
- connection <quote>slot</quote> to connect to the cluster
- management server. This means that there must be at least one
- <literal>[API]</literal> or <literal>[MYSQLD]</literal> section
- that can be used by it in the cluster
- <filename>config.ini</filename> file. It is a good idea to keep
- at least one empty <literal>[API]</literal> or
- <literal>[MYSQLD]</literal> section in
- <filename>config.ini</filename> that is not being used for a
- MySQL server or other application for this reason (see
- <xref linkend="mysql-cluster-api-definition"/>).
- </para>
+ <para>
+ The <option>-c</option> option is used to specify a
+ connectstring which tells <literal>ndb_restore</literal>
+ where to locate the cluster management server. (See
+ <xref linkend="mysql-cluster-connectstring"/>, for
+ information on connectstrings.) If this option is not used,
+ then <command>ndb_restore</command> attempts to connect to a
+ management server on <literal>localhost:1186</literal>. This
+ utility acts as a cluster API node, and so requires a free
+ connection <quote>slot</quote> to connect to the cluster
+ management server. This means that there must be at least
+ one <literal>[API]</literal> or <literal>[MYSQLD]</literal>
+ section that can be used by it in the cluster
+ <filename>config.ini</filename> file. It is a good idea to
+ keep at least one empty <literal>[API]</literal> or
+ <literal>[MYSQLD]</literal> section in
+ <filename>config.ini</filename> that is not being used for a
+ MySQL server or other application for this reason (see
+ <xref linkend="mysql-cluster-api-definition"/>).
+ </para>
- <para>
- You can verify that <command>ndb_restore</command> is connected
- to the cluster by using the <command>SHOW</command> command in
- the <command>ndb_mgm</command> management client. You can also
- accomplish this from a system shell, as shown here:
- </para>
+ <para>
+ You can verify that <command>ndb_restore</command> is
+ connected to the cluster by using the
+ <command>SHOW</command> command in the
+ <command>ndb_mgm</command> management client. You can also
+ accomplish this from a system shell, as shown here:
+ </para>
<programlisting>
shell> <userinput>ndb_mgm -e "SHOW"</userinput>
</programlisting>
- <para>
- <option>-n</option> is used to specify the node ID of the data
- node on which the backups were taken.
- </para>
+ <para>
+ <option>-n</option> is used to specify the node ID of the
+ data node on which the backups were taken.
+ </para>
- <para>
- The first time you run the <command>ndb_restore</command>
- restoration program, you also need to restore the metadata. In
- other words, you must re-create the database tables — this
- can be done by running it with the <option>-m</option> option.
- Note that the cluster should have an empty database when
- starting to restore a backup. (In other words, you should start
- <command>ndbd</command> with <option>--initial</option> prior to
- performing the restore.)
- </para>
+ <para>
+ The first time you run the <command>ndb_restore</command>
+ restoration program, you also need to restore the metadata.
+ In other words, you must re-create the database tables
+ — this can be done by running it with the
+ <option>-m</option> option. Note that the cluster should
+ have an empty database when starting to restore a backup.
+ (In other words, you should start <command>ndbd</command>
+ with <option>--initial</option> prior to performing the
+ restore.)
+ </para>
- <para>
- The <option>-b</option> option is used to specify the ID or
- sequence number of the backup, and is the same number shown by
- the management client in the <literal>Backup
- <replaceable>backup_id</replaceable> completed</literal> message
- displayed upon completion of a backup. (See
- <xref linkend="mysql-cluster-backup-using-management-client"/>.)
- </para>
+ <para>
+ The <option>-b</option> option is used to specify the ID or
+ sequence number of the backup, and is the same number shown
+ by the management client in the <literal>Backup
+ <replaceable>backup_id</replaceable> completed</literal>
+ message displayed upon completion of a backup. (See
+ <xref linkend="mysql-cluster-backup-using-management-client"/>.)
+ </para>
- <para>
- The <option>-r</option> option is required, and is used to tell
- <literal>ndb_restore</literal> the directory where it can find
- the backup files. <emphasis role="bold">Important</emphasis>:
- When restoring cluster backups, you must be sure to restore all
- data nodes from backups having the same backup ID.
- </para>
+ <para>
+ The <option>-r</option> option is required, and is used to
+ tell <literal>ndb_restore</literal> the directory where it
+ can find the backup files.
+ <emphasis role="bold">Important</emphasis>: When restoring
+ cluster backups, you must be sure to restore all data nodes
+ from backups having the same backup ID.
+ </para>
- <para>
- It is possible to restore a backup to a database with a
- different configuration than it was created from. For example,
- suppose that a backup with backup ID <literal>12</literal>,
- created in a cluster with two database nodes having the node IDs
- <literal>2</literal> and <literal>3</literal>, is to be restored
- to a cluster with four nodes. Then
- <command>ndb_restore</command> must be run twice — once
- for each database node in the cluster where the backup was
- taken. However, <command>ndb_restore</command> cannot always
- restore backups made from a cluster running one version of MySQL
- to a cluster running a different MySQL version. See
- <xref linkend="mysql-cluster-upgrade-downgrade-compatibility"/>,
- for more information.
- </para>
+ <para>
+ It is possible to restore a backup to a database with a
+ different configuration than it was created from. For
+ example, suppose that a backup with backup ID
+ <literal>12</literal>, created in a cluster with two
+ database nodes having the node IDs <literal>2</literal> and
+ <literal>3</literal>, is to be restored to a cluster with
+ four nodes. Then <command>ndb_restore</command> must be run
+ twice — once for each database node in the cluster
+ where the backup was taken. However,
+ <command>ndb_restore</command> cannot always restore backups
+ made from a cluster running one version of MySQL to a
+ cluster running a different MySQL version. See
+ <xref linkend="mysql-cluster-upgrade-downgrade-compatibility"/>,
+ for more information.
+ </para>
- <para>
- <emphasis role="bold">Note</emphasis>: For more rapid
- restoration, the data may be restored in parallel, provided that
- there is a sufficient number of cluster connections available.
- That is, when restoring to multiple nodes in parallel, you must
- have an <literal>[API]</literal> or <literal>[MYSQLD]</literal>
- section in the cluster <filename>config.ini</filename> file
- available for each concurrent <command>ndb_restore</command>
- process. However, the data files must always be applied before
- the logs.
- </para>
+ <para>
+ <emphasis role="bold">Note</emphasis>: For more rapid
+ restoration, the data may be restored in parallel, provided
+ that there is a sufficient number of cluster connections
+ available. That is, when restoring to multiple nodes in
+ parallel, you must have an <literal>[API]</literal> or
+ <literal>[MYSQLD]</literal> section in the cluster
+ <filename>config.ini</filename> file available for each
+ concurrent <command>ndb_restore</command> process. However,
+ the data files must always be applied before the logs.
+ </para>
- <para>
- A complete listing of options available for this program is
- shown in the following table:
- </para>
+ <para>
+ A complete listing of options available for this program is
+ shown in the following table:
+ </para>
- <informaltable>
- <tgroup cols="4">
- <colspec colwidth="25*"/>
- <colspec colwidth="15*"/>
- <colspec colwidth="40*"/>
- <colspec colwidth="20*"/>
- <tbody>
- <row>
- <entry><emphasis role="bold">Long Form</emphasis></entry>
- <entry><emphasis role="bold">Short Form</emphasis></entry>
- <entry><emphasis role="bold">Description</emphasis></entry>
- <entry><emphasis role="bold">Default Value</emphasis></entry>
- </row>
- <row>
- <entry><option>--backup-id</option></entry>
- <entry><option>-b</option></entry>
- <entry>Backup sequence ID</entry>
- <entry><literal>0</literal></entry>
- </row>
- <row>
- <entry><option>--backup_path</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Path to backup files</entry>
- <entry><filename>./</filename></entry>
- </row>
- <row>
- <entry><option>--character-sets-dir</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Specify the directory where character set information can be found</entry>
- <entry><emphasis>None</emphasis></entry>
- </row>
- <row>
- <entry><option>--connect</option>, <option>--connectstring</option>, or
- <option>--ndb-connectstring</option></entry>
- <entry><option>-c</option> or <option>-C</option></entry>
- <entry>Set the connectstring in
- <literal>[nodeid=<replaceable>node_id;][host=]</replaceable><replaceable>host</replaceable>[:<replaceable>port</replaceable>]</literal>
- format</entry>
- <entry><emphasis>None</emphasis></entry>
- </row>
- <row>
- <entry><option>--core-file</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Write a core file in the event of an error</entry>
- <entry><literal>TRUE</literal></entry>
- </row>
- <row>
- <entry><option>--debug</option></entry>
- <entry><option>-#</option></entry>
- <entry>Output debug log</entry>
- <entry><literal>d:t:O,<filename>/tmp/ndb_restore.trace</filename></literal></entry>
- </row>
- <row>
- <entry><option>--help</option> or <option>--usage</option></entry>
- <entry><option>-?</option></entry>
- <entry>Display help message with available options and current values, then
- exit</entry>
- <entry>[N/A]</entry>
- </row>
- <row>
- <entry><option>--ndb-mgmd-host</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Set the host and port in
- <literal><replaceable>host</replaceable>[:<replaceable>port</replaceable>]</literal>
- format for the management server to connect to; this is
- the same as <option>--connect</option>,
- <option>--connectstring</option>, or
- <option>--ndb-connectstring</option>, but without a way
- to specify the <literal>nodeid</literal></entry>
- <entry><emphasis>None</emphasis></entry>
- </row>
- <row>
- <entry><option>--ndb-nodegroup-map</option></entry>
- <entry><option>-z</option></entry>
- <entry>Specifies a nodegroup map — <emphasis>Syntax</emphasis>: list of
- (<replaceable>source_nodegroup</replaceable>,
- <replaceable>destination_nodegroup</replaceable>)</entry>
- <entry><emphasis>None</emphasis></entry>
- </row>
- <row>
- <entry><option>--ndb-nodeid</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Specify a node ID for the <command>ndb_restore</command> process</entry>
- <entry><literal>0</literal></entry>
- </row>
- <row>
- <entry><option>--ndb-optimized-node-selection</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Optimize selection of nodes for transactions</entry>
- <entry><literal>TRUE</literal></entry>
- </row>
- <row>
- <entry><option>--ndb-shm</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Use shared memory connections when available</entry>
- <entry><literal>FALSE</literal></entry>
- </row>
- <row>
- <entry><option>--nodeid</option></entry>
- <entry><option>-n</option></entry>
- <entry>Use backup files from node with the specified ID</entry>
- <entry><literal>0</literal></entry>
- </row>
- <row>
- <entry><option>--parallelism</option></entry>
- <entry><option>-p</option></entry>
- <entry>Set from 1 to 1024 parallel transactions to be used during the
- restoration process</entry>
- <entry><literal>128</literal></entry>
- </row>
- <row>
- <entry><option>--print</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Print data and log to <literal>stdout</literal></entry>
- <entry><literal>FALSE</literal></entry>
- </row>
- <row>
- <entry><option>--print_data</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Print data to <literal>stdout</literal></entry>
- <entry><literal>FALSE</literal></entry>
- </row>
- <row>
- <entry><option>--print_log</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Print log to <literal>stdout</literal></entry>
- <entry><literal>FALSE</literal></entry>
- </row>
- <row>
- <entry><option>--print_meta</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Print metadata to <literal>stdout</literal></entry>
- <entry><literal>FALSE</literal></entry>
- </row>
- <row>
- <entry><option>--restore_data</option></entry>
- <entry><option>-r</option></entry>
- <entry>Restore data and logs</entry>
- <entry><literal>FALSE</literal></entry>
- </row>
- <row>
- <entry><option>--restore_meta</option></entry>
- <entry><option>-m</option></entry>
- <entry>Restore table metadata</entry>
- <entry><literal>FALSE</literal></entry>
- </row>
- <row>
- <entry><option>--version</option></entry>
- <entry><option>-V</option></entry>
- <entry>Output version information and exit</entry>
- <entry>[N/A]</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
+ <informaltable>
+ <tgroup cols="4">
+ <colspec colwidth="25*"/>
+ <colspec colwidth="15*"/>
+ <colspec colwidth="40*"/>
+ <colspec colwidth="20*"/>
+ <tbody>
+ <row>
+ <entry><emphasis role="bold">Long Form</emphasis></entry>
+ <entry><emphasis role="bold">Short Form</emphasis></entry>
+ <entry><emphasis role="bold">Description</emphasis></entry>
+ <entry><emphasis role="bold">Default Value</emphasis></entry>
+ </row>
+ <row>
+ <entry><option>--backup-id</option></entry>
+ <entry><option>-b</option></entry>
+ <entry>Backup sequence ID</entry>
+ <entry><literal>0</literal></entry>
+ </row>
+ <row>
+ <entry><option>--backup_path</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Path to backup files</entry>
+ <entry><filename>./</filename></entry>
+ </row>
+ <row>
+ <entry><option>--character-sets-dir</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Specify the directory where character set information can be found</entry>
+ <entry><emphasis>None</emphasis></entry>
+ </row>
+ <row>
+ <entry><option>--connect</option>, <option>--connectstring</option>, or
+ <option>--ndb-connectstring</option></entry>
+ <entry><option>-c</option> or <option>-C</option></entry>
+ <entry>Set the connectstring in
+ <literal>[nodeid=<replaceable>node_id;][host=]</replaceable><replaceable>host</replaceable>[:<replaceable>port</replaceable>]</literal>
+ format</entry>
+ <entry><emphasis>None</emphasis></entry>
+ </row>
+ <row>
+ <entry><option>--core-file</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Write a core file in the event of an error</entry>
+ <entry><literal>TRUE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--debug</option></entry>
+ <entry><option>-#</option></entry>
+ <entry>Output debug log</entry>
+ <entry><literal>d:t:O,<filename>/tmp/ndb_restore.trace</filename></literal></entry>
+ </row>
+ <row>
+ <entry><option>--help</option> or <option>--usage</option></entry>
+ <entry><option>-?</option></entry>
+ <entry>Display help message with available options and current values, then
+ exit</entry>
+ <entry>[N/A]</entry>
+ </row>
+ <row>
+ <entry><option>--ndb-mgmd-host</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Set the host and port in
+ <literal><replaceable>host</replaceable>[:<replaceable>port</replaceable>]</literal>
+ format for the management server to connect to; this
+ is the same as <option>--connect</option>,
+ <option>--connectstring</option>, or
+ <option>--ndb-connectstring</option>, but without a
+ way to specify the <literal>nodeid</literal></entry>
+ <entry><emphasis>None</emphasis></entry>
+ </row>
+ <row>
+ <entry><option>--ndb-nodegroup-map</option></entry>
+ <entry><option>-z</option></entry>
+ <entry>Specifies a nodegroup map — <emphasis>Syntax</emphasis>: list of
+ (<replaceable>source_nodegroup</replaceable>,
+ <replaceable>destination_nodegroup</replaceable>)</entry>
+ <entry><emphasis>None</emphasis></entry>
+ </row>
+ <row>
+ <entry><option>--ndb-nodeid</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Specify a node ID for the <command>ndb_restore</command> process</entry>
+ <entry><literal>0</literal></entry>
+ </row>
+ <row>
+ <entry><option>--ndb-optimized-node-selection</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Optimize selection of nodes for transactions</entry>
+ <entry><literal>TRUE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--ndb-shm</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Use shared memory connections when available</entry>
+ <entry><literal>FALSE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--nodeid</option></entry>
+ <entry><option>-n</option></entry>
+ <entry>Use backup files from node with the specified ID</entry>
+ <entry><literal>0</literal></entry>
+ </row>
+ <row>
+ <entry><option>--parallelism</option></entry>
+ <entry><option>-p</option></entry>
+ <entry>Set from 1 to 1024 parallel transactions to be used during the
+ restoration process</entry>
+ <entry><literal>128</literal></entry>
+ </row>
+ <row>
+ <entry><option>--print</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Print data and log to <literal>stdout</literal></entry>
+ <entry><literal>FALSE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--print_data</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Print data to <literal>stdout</literal></entry>
+ <entry><literal>FALSE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--print_log</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Print log to <literal>stdout</literal></entry>
+ <entry><literal>FALSE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--print_meta</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Print metadata to <literal>stdout</literal></entry>
+ <entry><literal>FALSE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--restore_data</option></entry>
+ <entry><option>-r</option></entry>
+ <entry>Restore data and logs</entry>
+ <entry><literal>FALSE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--restore_meta</option></entry>
+ <entry><option>-m</option></entry>
+ <entry>Restore table metadata</entry>
+ <entry><literal>FALSE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--version</option></entry>
+ <entry><option>-V</option></entry>
+ <entry>Output version information and exit</entry>
+ <entry>[N/A]</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
- <indexterm>
- <primary><command>ndb_restore</command></primary>
- <secondary>errors</secondary>
- </indexterm>
+ <indexterm>
+ <primary><command>ndb_restore</command></primary>
+ <secondary>errors</secondary>
+ </indexterm>
- <para>
- <emphasis role="bold">Note</emphasis>:
- <command>ndb_restore</command> reports both temporary and
- permanent errors. In the case of temporary errors, it may able
- to recover from them. Beginning with MySQL 4.1.22, it reports
- <literal>Restore successful, but encountered temporary error,
- please look at configuration</literal> in such cases.
- </para>
+ <para>
+ <emphasis role="bold">Note</emphasis>:
+ <command>ndb_restore</command> reports both temporary and
+ permanent errors. In the case of temporary errors, it may
+ able to recover from them. Beginning with MySQL 4.1.22, it
+ reports <literal>Restore successful, but encountered
+ temporary error, please look at configuration</literal> in
+ such cases.
+ </para>
+ </refsection>
+
+ </refentry>
+
</section>
<section id="mysql-cluster-backup-configuration">
Modified: trunk/refman-5.0/mysql-cluster.xml
===================================================================
--- trunk/refman-5.0/mysql-cluster.xml 2007-03-02 21:17:28 UTC (rev 5155)
+++ trunk/refman-5.0/mysql-cluster.xml 2007-03-02 21:17:52 UTC (rev 5156)
Changed blocks: 1, Lines Added: 342, Lines Deleted: 303; 31813 bytes
@@ -12671,341 +12671,380 @@
</section>
- <section id="mysql-cluster-restore">
+ <section id="fake-id-for-ndb-restore-manpage-section-wrapper">
- <title>How to Restore a Cluster Backup</title>
+ <title>fake title for ndb_restore manpage section wrapper</title>
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>backups</secondary>
- </indexterm>
+ <refentry id="mysql-cluster-restore">
- <indexterm>
- <primary>backups</primary>
- <secondary>in MySQL Cluster</secondary>
- </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>backups</secondary>
+ </indexterm>
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>restoring backups</secondary>
- </indexterm>
+ <indexterm>
+ <primary>backups</primary>
+ <secondary>in MySQL Cluster</secondary>
+ </indexterm>
- <indexterm>
- <primary>restoring backups</primary>
- <secondary>in MySQL Cluster</secondary>
- </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>restoring backups</secondary>
+ </indexterm>
- <indexterm>
- <primary><command>ndb_restore</command></primary>
- </indexterm>
+ <indexterm>
+ <primary>restoring backups</primary>
+ <secondary>in MySQL Cluster</secondary>
+ </indexterm>
- <para>
- The cluster restoration program is implemented as a separate
- command-line utility <command>ndb_restore</command>, which can
- normally be found in the MySQL <filename>bin</filename>
- directory. This program reads the files created as a result of
- the backup and inserts the stored information into the database.
- </para>
+ <indexterm>
+ <primary>ndb_restore</primary>
+ </indexterm>
- <para>
- <command>ndb_restore</command> must be executed once for each of
- the backup files that were created by the <literal>START
- BACKUP</literal> command used to create the backup (see
- <xref linkend="mysql-cluster-backup-using-management-client"/>).
- This is equal to the number of data nodes in the cluster at the
- time that the backup was created.
- </para>
+ <refmeta>
+ <refentrytitle><command>ndb_restore</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">Restore a Cluster Backup</refmiscinfo>
+ </refmeta>
- <indexterm>
- <primary>single user mode (MySQL Cluster)</primary>
- <secondary>and <command>ndb_restore</command></secondary>
- </indexterm>
+ <refnamediv>
+ <refname>ndb_restore</refname>
+
+ <refpurpose>restore a Cluster backup</refpurpose>
+ </refnamediv>
- <para>
- <emphasis role="bold">Note</emphasis>: Before using
- <command>ndb_restore</command>, it is recommended that the
- cluster be running in single user mode, unless you are restoring
- multiple data nodes in parallel. See
- <xref linkend="mysql-cluster-single-user-mode"/>, for more
- information about single user mode.
- </para>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ndb_restore <replaceable>options</replaceable></command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
- <para>
- Typical options for this utility are shown here:
- </para>
+ <refsection id="ndb-restore-description">
+ <title>Description</title>
+
+ <para>
+ The cluster restoration program is implemented as a separate
+ command-line utility <command>ndb_restore</command>, which
+ can normally be found in the MySQL <filename>bin</filename>
+ directory. This program reads the files created as a result
+ of the backup and inserts the stored information into the
+ database.
+ </para>
+
+ <para>
+ <command>ndb_restore</command> must be executed once for
+ each of the backup files that were created by the
+ <literal>START BACKUP</literal> command used to create the
+ backup (see
+ <xref linkend="mysql-cluster-backup-using-management-client"/>).
+ This is equal to the number of data nodes in the cluster at
+ the time that the backup was created.
+ </para>
+
+ <indexterm>
+ <primary>single user mode (MySQL Cluster)</primary>
+ <secondary>and <command>ndb_restore</command></secondary>
+ </indexterm>
+
+ <para>
+ <emphasis role="bold">Note</emphasis>: Before using
+ <command>ndb_restore</command>, it is recommended that the
+ cluster be running in single user mode, unless you are
+ restoring multiple data nodes in parallel. See
+ <xref linkend="mysql-cluster-single-user-mode"/>, for more
+ information about single user mode.
+ </para>
+
+ <para>
+ Typical options for this utility are shown here:
+ </para>
+
<programlisting>
ndb_restore [-c <replaceable>connectstring</replaceable>] -n <replaceable>node_id</replaceable> [-m] -b <replaceable>backup_id</replaceable> -r <replaceable>/path/to/backup/files</replaceable>
</programlisting>
- <para>
- The <option>-c</option> option is used to specify a
- connectstring which tells <literal>ndb_restore</literal> where
- to locate the cluster management server. (See
- <xref linkend="mysql-cluster-connectstring"/>, for information
- on connectstrings.) If this option is not used, then
- <command>ndb_restore</command> attempts to connect to a
- management server on <literal>localhost:1186</literal>. This
- utility acts as a cluster API node, and so requires a free
- connection <quote>slot</quote> to connect to the cluster
- management server. This means that there must be at least one
- <literal>[API]</literal> or <literal>[MYSQLD]</literal> section
- that can be used by it in the cluster
- <filename>config.ini</filename> file. It is a good idea to keep
- at least one empty <literal>[API]</literal> or
- <literal>[MYSQLD]</literal> section in
- <filename>config.ini</filename> that is not being used for a
- MySQL server or other application for this reason (see
- <xref linkend="mysql-cluster-api-definition"/>).
- </para>
+ <para>
+ The <option>-c</option> option is used to specify a
+ connectstring which tells <literal>ndb_restore</literal>
+ where to locate the cluster management server. (See
+ <xref linkend="mysql-cluster-connectstring"/>, for
+ information on connectstrings.) If this option is not used,
+ then <command>ndb_restore</command> attempts to connect to a
+ management server on <literal>localhost:1186</literal>. This
+ utility acts as a cluster API node, and so requires a free
+ connection <quote>slot</quote> to connect to the cluster
+ management server. This means that there must be at least
+ one <literal>[API]</literal> or <literal>[MYSQLD]</literal>
+ section that can be used by it in the cluster
+ <filename>config.ini</filename> file. It is a good idea to
+ keep at least one empty <literal>[API]</literal> or
+ <literal>[MYSQLD]</literal> section in
+ <filename>config.ini</filename> that is not being used for a
+ MySQL server or other application for this reason (see
+ <xref linkend="mysql-cluster-api-definition"/>).
+ </para>
- <para>
- You can verify that <command>ndb_restore</command> is connected
- to the cluster by using the <command>SHOW</command> command in
- the <command>ndb_mgm</command> management client. You can also
- accomplish this from a system shell, as shown here:
- </para>
+ <para>
+ You can verify that <command>ndb_restore</command> is
+ connected to the cluster by using the
+ <command>SHOW</command> command in the
+ <command>ndb_mgm</command> management client. You can also
+ accomplish this from a system shell, as shown here:
+ </para>
<programlisting>
shell> <userinput>ndb_mgm -e "SHOW"</userinput>
</programlisting>
- <para>
- <option>-n</option> is used to specify the node ID of the data
- node on which the backups were taken.
- </para>
+ <para>
+ <option>-n</option> is used to specify the node ID of the
+ data node on which the backups were taken.
+ </para>
- <para>
- The first time you run the <command>ndb_restore</command>
- restoration program, you also need to restore the metadata. In
- other words, you must re-create the database tables — this
- can be done by running it with the <option>-m</option> option.
- Note that the cluster should have an empty database when
- starting to restore a backup. (In other words, you should start
- <command>ndbd</command> with <option>--initial</option> prior to
- performing the restore.)
- </para>
+ <para>
+ The first time you run the <command>ndb_restore</command>
+ restoration program, you also need to restore the metadata.
+ In other words, you must re-create the database tables
+ — this can be done by running it with the
+ <option>-m</option> option. Note that the cluster should
+ have an empty database when starting to restore a backup.
+ (In other words, you should start <command>ndbd</command>
+ with <option>--initial</option> prior to performing the
+ restore.)
+ </para>
- <para>
- The <option>-b</option> option is used to specify the ID or
- sequence number of the backup, and is the same number shown by
- the management client in the <literal>Backup
- <replaceable>backup_id</replaceable> completed</literal> message
- displayed upon completion of a backup. (See
- <xref linkend="mysql-cluster-backup-using-management-client"/>.)
- </para>
+ <para>
+ The <option>-b</option> option is used to specify the ID or
+ sequence number of the backup, and is the same number shown
+ by the management client in the <literal>Backup
+ <replaceable>backup_id</replaceable> completed</literal>
+ message displayed upon completion of a backup. (See
+ <xref linkend="mysql-cluster-backup-using-management-client"/>.)
+ </para>
- <para>
- The <option>-r</option> option is required, and is used to tell
- <literal>ndb_restore</literal> the directory where it can find
- the backup files. <emphasis role="bold">Important</emphasis>:
- When restoring cluster backups, you must be sure to restore all
- data nodes from backups having the same backup ID.
- </para>
+ <para>
+ The <option>-r</option> option is required, and is used to
+ tell <literal>ndb_restore</literal> the directory where it
+ can find the backup files.
+ <emphasis role="bold">Important</emphasis>: When restoring
+ cluster backups, you must be sure to restore all data nodes
+ from backups having the same backup ID.
+ </para>
- <para>
- It is possible to restore a backup to a database with a
- different configuration than it was created from. For example,
- suppose that a backup with backup ID <literal>12</literal>,
- created in a cluster with two database nodes having the node IDs
- <literal>2</literal> and <literal>3</literal>, is to be restored
- to a cluster with four nodes. Then
- <command>ndb_restore</command> must be run twice — once
- for each database node in the cluster where the backup was
- taken. However, <command>ndb_restore</command> cannot always
- restore backups made from a cluster running one version of MySQL
- to a cluster running a different MySQL version. See
- <xref linkend="mysql-cluster-upgrade-downgrade-compatibility"/>,
- for more information.
- </para>
+ <para>
+ It is possible to restore a backup to a database with a
+ different configuration than it was created from. For
+ example, suppose that a backup with backup ID
+ <literal>12</literal>, created in a cluster with two
+ database nodes having the node IDs <literal>2</literal> and
+ <literal>3</literal>, is to be restored to a cluster with
+ four nodes. Then <command>ndb_restore</command> must be run
+ twice — once for each database node in the cluster
+ where the backup was taken. However,
+ <command>ndb_restore</command> cannot always restore backups
+ made from a cluster running one version of MySQL to a
+ cluster running a different MySQL version. See
+ <xref linkend="mysql-cluster-upgrade-downgrade-compatibility"/>,
+ for more information.
+ </para>
- <para>
- <emphasis role="bold">Note</emphasis>: For more rapid
- restoration, the data may be restored in parallel, provided that
- there is a sufficient number of cluster connections available.
- That is, when restoring to multiple nodes in parallel, you must
- have an <literal>[API]</literal> or <literal>[MYSQLD]</literal>
- section in the cluster <filename>config.ini</filename> file
- available for each concurrent <command>ndb_restore</command>
- process. However, the data files must always be applied before
- the logs.
- </para>
+ <para>
+ <emphasis role="bold">Note</emphasis>: For more rapid
+ restoration, the data may be restored in parallel, provided
+ that there is a sufficient number of cluster connections
+ available. That is, when restoring to multiple nodes in
+ parallel, you must have an <literal>[API]</literal> or
+ <literal>[MYSQLD]</literal> section in the cluster
+ <filename>config.ini</filename> file available for each
+ concurrent <command>ndb_restore</command> process. However,
+ the data files must always be applied before the logs.
+ </para>
- <para>
- A complete listing of options available for this program is
- shown in the following table:
- </para>
+ <para>
+ A complete listing of options available for this program is
+ shown in the following table:
+ </para>
- <informaltable>
- <tgroup cols="4">
- <colspec colwidth="25*"/>
- <colspec colwidth="15*"/>
- <colspec colwidth="40*"/>
- <colspec colwidth="20*"/>
- <tbody>
- <row>
- <entry><emphasis role="bold">Long Form</emphasis></entry>
- <entry><emphasis role="bold">Short Form</emphasis></entry>
- <entry><emphasis role="bold">Description</emphasis></entry>
- <entry><emphasis role="bold">Default Value</emphasis></entry>
- </row>
- <row>
- <entry><option>--backup-id</option></entry>
- <entry><option>-b</option></entry>
- <entry>Backup sequence ID</entry>
- <entry><literal>0</literal></entry>
- </row>
- <row>
- <entry><option>--backup_path</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Path to backup files</entry>
- <entry><filename>./</filename></entry>
- </row>
- <row>
- <entry><option>--character-sets-dir</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Specify the directory where character set information can be found</entry>
- <entry><emphasis>None</emphasis></entry>
- </row>
- <row>
- <entry><option>--connect</option>, <option>--connectstring</option>, or
- <option>--ndb-connectstring</option></entry>
- <entry><option>-c</option> or <option>-C</option></entry>
- <entry>Set the connectstring in
- <literal>[nodeid=<replaceable>node_id;][host=]</replaceable><replaceable>host</replaceable>[:<replaceable>port</replaceable>]</literal>
- format</entry>
- <entry><emphasis>None</emphasis></entry>
- </row>
- <row>
- <entry><option>--core-file</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Write a core file in the event of an error</entry>
- <entry><literal>TRUE</literal></entry>
- </row>
- <row>
- <entry><option>--debug</option></entry>
- <entry><option>-#</option></entry>
- <entry>Output debug log</entry>
- <entry><literal>d:t:O,<filename>/tmp/ndb_restore.trace</filename></literal></entry>
- </row>
- <row>
- <entry><option>--help</option> or <option>--usage</option></entry>
- <entry><option>-?</option></entry>
- <entry>Display help message with available options and current values, then
- exit</entry>
- <entry>[N/A]</entry>
- </row>
- <row>
- <entry><option>--ndb-mgmd-host</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Set the host and port in
- <literal><replaceable>host</replaceable>[:<replaceable>port</replaceable>]</literal>
- format for the management server to connect to; this is
- the same as <option>--connect</option>,
- <option>--connectstring</option>, or
- <option>--ndb-connectstring</option>, but without a way
- to specify the <literal>nodeid</literal></entry>
- <entry><emphasis>None</emphasis></entry>
- </row>
- <row>
- <entry><option>--ndb-nodegroup-map</option></entry>
- <entry><option>-z</option></entry>
- <entry>Specifies a nodegroup map — <emphasis>Syntax</emphasis>: list of
- (<replaceable>source_nodegroup</replaceable>,
- <replaceable>destination_nodegroup</replaceable>)</entry>
- <entry><emphasis>None</emphasis></entry>
- </row>
- <row>
- <entry><option>--ndb-nodeid</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Specify a node ID for the <command>ndb_restore</command> process</entry>
- <entry><literal>0</literal></entry>
- </row>
- <row>
- <entry><option>--ndb-optimized-node-selection</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Optimize selection of nodes for transactions</entry>
- <entry><literal>TRUE</literal></entry>
- </row>
- <row>
- <entry><option>--ndb-shm</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Use shared memory connections when available</entry>
- <entry><literal>FALSE</literal></entry>
- </row>
- <row>
- <entry><option>--nodeid</option></entry>
- <entry><option>-n</option></entry>
- <entry>Use backup files from node with the specified ID</entry>
- <entry><literal>0</literal></entry>
- </row>
- <row>
- <entry><option>--parallelism</option></entry>
- <entry><option>-p</option></entry>
- <entry>Set from 1 to 1024 parallel transactions to be used during the
- restoration process</entry>
- <entry><literal>128</literal></entry>
- </row>
- <row>
- <entry><option>--print</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Print data and log to <literal>stdout</literal></entry>
- <entry><literal>FALSE</literal></entry>
- </row>
- <row>
- <entry><option>--print_data</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Print data to <literal>stdout</literal></entry>
- <entry><literal>FALSE</literal></entry>
- </row>
- <row>
- <entry><option>--print_log</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Print log to <literal>stdout</literal></entry>
- <entry><literal>FALSE</literal></entry>
- </row>
- <row>
- <entry><option>--print_meta</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Print metadata to <literal>stdout</literal></entry>
- <entry><literal>FALSE</literal></entry>
- </row>
- <row>
- <entry><option>--restore_data</option></entry>
- <entry><option>-r</option></entry>
- <entry>Restore data and logs</entry>
- <entry><literal>FALSE</literal></entry>
- </row>
- <row>
- <entry><option>--restore_meta</option></entry>
- <entry><option>-m</option></entry>
- <entry>Restore table metadata</entry>
- <entry><literal>FALSE</literal></entry>
- </row>
- <row>
- <entry><option>--version</option></entry>
- <entry><option>-V</option></entry>
- <entry>Output version information and exit</entry>
- <entry>[N/A]</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
+ <informaltable>
+ <tgroup cols="4">
+ <colspec colwidth="25*"/>
+ <colspec colwidth="15*"/>
+ <colspec colwidth="40*"/>
+ <colspec colwidth="20*"/>
+ <tbody>
+ <row>
+ <entry><emphasis role="bold">Long Form</emphasis></entry>
+ <entry><emphasis role="bold">Short Form</emphasis></entry>
+ <entry><emphasis role="bold">Description</emphasis></entry>
+ <entry><emphasis role="bold">Default Value</emphasis></entry>
+ </row>
+ <row>
+ <entry><option>--backup-id</option></entry>
+ <entry><option>-b</option></entry>
+ <entry>Backup sequence ID</entry>
+ <entry><literal>0</literal></entry>
+ </row>
+ <row>
+ <entry><option>--backup_path</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Path to backup files</entry>
+ <entry><filename>./</filename></entry>
+ </row>
+ <row>
+ <entry><option>--character-sets-dir</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Specify the directory where character set information can be found</entry>
+ <entry><emphasis>None</emphasis></entry>
+ </row>
+ <row>
+ <entry><option>--connect</option>, <option>--connectstring</option>, or
+ <option>--ndb-connectstring</option></entry>
+ <entry><option>-c</option> or <option>-C</option></entry>
+ <entry>Set the connectstring in
+ <literal>[nodeid=<replaceable>node_id;][host=]</replaceable><replaceable>host</replaceable>[:<replaceable>port</replaceable>]</literal>
+ format</entry>
+ <entry><emphasis>None</emphasis></entry>
+ </row>
+ <row>
+ <entry><option>--core-file</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Write a core file in the event of an error</entry>
+ <entry><literal>TRUE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--debug</option></entry>
+ <entry><option>-#</option></entry>
+ <entry>Output debug log</entry>
+ <entry><literal>d:t:O,<filename>/tmp/ndb_restore.trace</filename></literal></entry>
+ </row>
+ <row>
+ <entry><option>--help</option> or <option>--usage</option></entry>
+ <entry><option>-?</option></entry>
+ <entry>Display help message with available options and current values, then
+ exit</entry>
+ <entry>[N/A]</entry>
+ </row>
+ <row>
+ <entry><option>--ndb-mgmd-host</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Set the host and port in
+ <literal><replaceable>host</replaceable>[:<replaceable>port</replaceable>]</literal>
+ format for the management server to connect to; this
+ is the same as <option>--connect</option>,
+ <option>--connectstring</option>, or
+ <option>--ndb-connectstring</option>, but without a
+ way to specify the <literal>nodeid</literal></entry>
+ <entry><emphasis>None</emphasis></entry>
+ </row>
+ <row>
+ <entry><option>--ndb-nodegroup-map</option></entry>
+ <entry><option>-z</option></entry>
+ <entry>Specifies a nodegroup map — <emphasis>Syntax</emphasis>: list of
+ (<replaceable>source_nodegroup</replaceable>,
+ <replaceable>destination_nodegroup</replaceable>)</entry>
+ <entry><emphasis>None</emphasis></entry>
+ </row>
+ <row>
+ <entry><option>--ndb-nodeid</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Specify a node ID for the <command>ndb_restore</command> process</entry>
+ <entry><literal>0</literal></entry>
+ </row>
+ <row>
+ <entry><option>--ndb-optimized-node-selection</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Optimize selection of nodes for transactions</entry>
+ <entry><literal>TRUE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--ndb-shm</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Use shared memory connections when available</entry>
+ <entry><literal>FALSE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--nodeid</option></entry>
+ <entry><option>-n</option></entry>
+ <entry>Use backup files from node with the specified ID</entry>
+ <entry><literal>0</literal></entry>
+ </row>
+ <row>
+ <entry><option>--parallelism</option></entry>
+ <entry><option>-p</option></entry>
+ <entry>Set from 1 to 1024 parallel transactions to be used during the
+ restoration process</entry>
+ <entry><literal>128</literal></entry>
+ </row>
+ <row>
+ <entry><option>--print</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Print data and log to <literal>stdout</literal></entry>
+ <entry><literal>FALSE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--print_data</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Print data to <literal>stdout</literal></entry>
+ <entry><literal>FALSE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--print_log</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Print log to <literal>stdout</literal></entry>
+ <entry><literal>FALSE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--print_meta</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Print metadata to <literal>stdout</literal></entry>
+ <entry><literal>FALSE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--restore_data</option></entry>
+ <entry><option>-r</option></entry>
+ <entry>Restore data and logs</entry>
+ <entry><literal>FALSE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--restore_meta</option></entry>
+ <entry><option>-m</option></entry>
+ <entry>Restore table metadata</entry>
+ <entry><literal>FALSE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--version</option></entry>
+ <entry><option>-V</option></entry>
+ <entry>Output version information and exit</entry>
+ <entry>[N/A]</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
- <indexterm>
- <primary><command>ndb_restore</command></primary>
- <secondary>errors</secondary>
- </indexterm>
+ <indexterm>
+ <primary><command>ndb_restore</command></primary>
+ <secondary>errors</secondary>
+ </indexterm>
- <para>
- <emphasis role="bold">Note</emphasis>:
- <command>ndb_restore</command> reports both temporary and
- permanent errors. In the case of temporary errors, it may able
- to recover from them. Beginning with MySQL 5.0.29, it reports
- <literal>Restore successful, but encountered temporary error,
- please look at configuration</literal> in such cases.
- </para>
+ <para>
+ <emphasis role="bold">Note</emphasis>:
+ <command>ndb_restore</command> reports both temporary and
+ permanent errors. In the case of temporary errors, it may
+ able to recover from them. Beginning with MySQL 5.0.29, it
+ reports <literal>Restore successful, but encountered
+ temporary error, please look at configuration</literal> in
+ such cases.
+ </para>
+ </refsection>
+
+ </refentry>
+
</section>
<section id="mysql-cluster-backup-configuration">
Modified: trunk/refman-5.1/mysql-cluster.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster.xml 2007-03-02 21:17:28 UTC (rev 5155)
+++ trunk/refman-5.1/mysql-cluster.xml 2007-03-02 21:17:52 UTC (rev 5156)
Changed blocks: 1, Lines Added: 368, Lines Deleted: 330; 34829 bytes
@@ -12714,368 +12714,406 @@
</section>
- <section id="mysql-cluster-restore">
+ <section id="fake-id-for-ndb-restore-manpage-section-wrapper">
- <title>How to Restore a Cluster Backup</title>
+ <title>fake title for ndb_restore manpage section wrapper</title>
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>backups</secondary>
- </indexterm>
+ <refentry id="mysql-cluster-restore">
- <indexterm>
- <primary>backups</primary>
- <secondary>in MySQL Cluster</secondary>
- </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>backups</secondary>
+ </indexterm>
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>restoring backups</secondary>
- </indexterm>
+ <indexterm>
+ <primary>backups</primary>
+ <secondary>in MySQL Cluster</secondary>
+ </indexterm>
- <indexterm>
- <primary>restoring backups</primary>
- <secondary>in MySQL Cluster</secondary>
- </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>restoring backups</secondary>
+ </indexterm>
- <indexterm>
- <primary><command>ndb_restore</command></primary>
- </indexterm>
+ <indexterm>
+ <primary>restoring backups</primary>
+ <secondary>in MySQL Cluster</secondary>
+ </indexterm>
- <para>
- The cluster restoration program is implemented as a separate
- command-line utility <command>ndb_restore</command>, which can
- normally be found in the MySQL <filename>bin</filename>
- directory. This program reads the files created as a result of
- the backup and inserts the stored information into the database.
- </para>
+ <indexterm>
+ <primary>ndb_restore</primary>
+ </indexterm>
- <para>
- <command>ndb_restore</command> must be executed once for each of
- the backup files that were created by the <literal>START
- BACKUP</literal> command used to create the backup (see
- <xref linkend="mysql-cluster-backup-using-management-client"/>).
- This is equal to the number of data nodes in the cluster at the
- time that the backup was created.
- </para>
+ <refmeta>
+ <refentrytitle><command>ndb_restore</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">Restore a Cluster Backup</refmiscinfo>
+ </refmeta>
- <indexterm>
- <primary>single user mode (MySQL Cluster)</primary>
- <secondary>and <command>ndb_restore</command></secondary>
- </indexterm>
+ <refnamediv>
+ <refname>ndb_restore</refname>
+
+ <refpurpose>restore a Cluster backup</refpurpose>
+ </refnamediv>
- <para>
- <emphasis role="bold">Note</emphasis>: Before using
- <command>ndb_restore</command>, it is recommended that the
- cluster be running in single user mode, unless you are restoring
- multiple data nodes in parallel. See
- <xref linkend="mysql-cluster-single-user-mode"/>, for more
- information about single user mode.
- </para>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ndb_restore <replaceable>options</replaceable></command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
- <para>
- Typical options for this utility are shown here:
- </para>
+ <refsection id="ndb-restore-description">
+ <title>Description</title>
+
+ <para>
+ The cluster restoration program is implemented as a separate
+ command-line utility <command>ndb_restore</command>, which
+ can normally be found in the MySQL <filename>bin</filename>
+ directory. This program reads the files created as a result
+ of the backup and inserts the stored information into the
+ database.
+ </para>
+
+ <para>
+ <command>ndb_restore</command> must be executed once for
+ each of the backup files that were created by the
+ <literal>START BACKUP</literal> command used to create the
+ backup (see
+ <xref linkend="mysql-cluster-backup-using-management-client"/>).
+ This is equal to the number of data nodes in the cluster at
+ the time that the backup was created.
+ </para>
+
+ <indexterm>
+ <primary>single user mode (MySQL Cluster)</primary>
+ <secondary>and <command>ndb_restore</command></secondary>
+ </indexterm>
+
+ <para>
+ <emphasis role="bold">Note</emphasis>: Before using
+ <command>ndb_restore</command>, it is recommended that the
+ cluster be running in single user mode, unless you are
+ restoring multiple data nodes in parallel. See
+ <xref linkend="mysql-cluster-single-user-mode"/>, for more
+ information about single user mode.
+ </para>
+
+ <para>
+ Typical options for this utility are shown here:
+ </para>
+
<programlisting>
ndb_restore [-c <replaceable>connectstring</replaceable>] -n <replaceable>node_id</replaceable> [-m] -b <replaceable>backup_id</replaceable> -r <replaceable>/path/to/backup/files</replaceable>
</programlisting>
- <para>
- The <option>-c</option> option is used to specify a
- connectstring which tells <literal>ndb_restore</literal> where
- to locate the cluster management server. (See
- <xref linkend="mysql-cluster-connectstring"/>, for information
- on connectstrings.) If this option is not used, then
- <command>ndb_restore</command> attempts to connect to a
- management server on <literal>localhost:1186</literal>. This
- utility acts as a cluster API node, and so requires a free
- connection <quote>slot</quote> to connect to the cluster
- management server. This means that there must be at least one
- <literal>[API]</literal> or <literal>[MYSQLD]</literal> section
- that can be used by it in the cluster
- <filename>config.ini</filename> file. It is a good idea to keep
- at least one empty <literal>[API]</literal> or
- <literal>[MYSQLD]</literal> section in
- <filename>config.ini</filename> that is not being used for a
- MySQL server or other application for this reason (see
- <xref linkend="mysql-cluster-api-definition"/>).
- </para>
+ <para>
+ The <option>-c</option> option is used to specify a
+ connectstring which tells <literal>ndb_restore</literal>
+ where to locate the cluster management server. (See
+ <xref linkend="mysql-cluster-connectstring"/>, for
+ information on connectstrings.) If this option is not used,
+ then <command>ndb_restore</command> attempts to connect to a
+ management server on <literal>localhost:1186</literal>. This
+ utility acts as a cluster API node, and so requires a free
+ connection <quote>slot</quote> to connect to the cluster
+ management server. This means that there must be at least
+ one <literal>[API]</literal> or <literal>[MYSQLD]</literal>
+ section that can be used by it in the cluster
+ <filename>config.ini</filename> file. It is a good idea to
+ keep at least one empty <literal>[API]</literal> or
+ <literal>[MYSQLD]</literal> section in
+ <filename>config.ini</filename> that is not being used for a
+ MySQL server or other application for this reason (see
+ <xref linkend="mysql-cluster-api-definition"/>).
+ </para>
- <para>
- You can verify that <command>ndb_restore</command> is connected
- to the cluster by using the <command>SHOW</command> command in
- the <command>ndb_mgm</command> management client. You can also
- accomplish this from a system shell, as shown here:
- </para>
+ <para>
+ You can verify that <command>ndb_restore</command> is
+ connected to the cluster by using the
+ <command>SHOW</command> command in the
+ <command>ndb_mgm</command> management client. You can also
+ accomplish this from a system shell, as shown here:
+ </para>
<programlisting>
shell> <userinput>ndb_mgm -e "SHOW"</userinput>
</programlisting>
- <para>
- <option>-n</option> is used to specify the node ID of the data
- node on which the backups were taken.
- </para>
+ <para>
+ <option>-n</option> is used to specify the node ID of the
+ data node on which the backups were taken.
+ </para>
- <para>
- The first time you run the <command>ndb_restore</command>
- restoration program, you also need to restore the metadata. In
- other words, you must re-create the database tables — this
- can be done by running it with the <option>-m</option> option.
- Note that the cluster should have an empty database when
- starting to restore a backup. (In other words, you should start
- <command>ndbd</command> with <option>--initial</option> prior to
- performing the restore. You should also remove manually any Disk
- Data files present in the data node's
- <literal>DataDir</literal>.)
- </para>
+ <para>
+ The first time you run the <command>ndb_restore</command>
+ restoration program, you also need to restore the metadata.
+ In other words, you must re-create the database tables
+ — this can be done by running it with the
+ <option>-m</option> option. Note that the cluster should
+ have an empty database when starting to restore a backup.
+ (In other words, you should start <command>ndbd</command>
+ with <option>--initial</option> prior to performing the
+ restore. You should also remove manually any Disk Data files
+ present in the data node's <literal>DataDir</literal>.)
+ </para>
- <para>
- The <option>-b</option> option is used to specify the ID or
- sequence number of the backup, and is the same number shown by
- the management client in the <literal>Backup
- <replaceable>backup_id</replaceable> completed</literal> message
- displayed upon completion of a backup. (See
- <xref linkend="mysql-cluster-backup-using-management-client"/>.)
- </para>
+ <para>
+ The <option>-b</option> option is used to specify the ID or
+ sequence number of the backup, and is the same number shown
+ by the management client in the <literal>Backup
+ <replaceable>backup_id</replaceable> completed</literal>
+ message displayed upon completion of a backup. (See
+ <xref linkend="mysql-cluster-backup-using-management-client"/>.)
+ </para>
- <para>
- The <option>-r</option> option is required, and is used to tell
- <literal>ndb_restore</literal> the directory where it can find
- the backup files. <emphasis role="bold">Important</emphasis>:
- When restoring cluster backups, you must be sure to restore all
- data nodes from backups having the same backup ID.
- </para>
+ <para>
+ The <option>-r</option> option is required, and is used to
+ tell <literal>ndb_restore</literal> the directory where it
+ can find the backup files.
+ <emphasis role="bold">Important</emphasis>: When restoring
+ cluster backups, you must be sure to restore all data nodes
+ from backups having the same backup ID.
+ </para>
- <para>
- It is possible to restore a backup to a database with a
- different configuration than it was created from. For example,
- suppose that a backup with backup ID <literal>12</literal>,
- created in a cluster with two database nodes having the node IDs
- <literal>2</literal> and <literal>3</literal>, is to be restored
- to a cluster with four nodes. Then
- <command>ndb_restore</command> must be run twice — once
- for each database node in the cluster where the backup was
- taken. However, <command>ndb_restore</command> cannot always
- restore backups made from a cluster running one version of MySQL
- to a cluster running a different MySQL version. See
- <xref linkend="mysql-cluster-upgrade-downgrade-compatibility"/>,
- for more information.
- </para>
+ <para>
+ It is possible to restore a backup to a database with a
+ different configuration than it was created from. For
+ example, suppose that a backup with backup ID
+ <literal>12</literal>, created in a cluster with two
+ database nodes having the node IDs <literal>2</literal> and
+ <literal>3</literal>, is to be restored to a cluster with
+ four nodes. Then <command>ndb_restore</command> must be run
+ twice — once for each database node in the cluster
+ where the backup was taken. However,
+ <command>ndb_restore</command> cannot always restore backups
+ made from a cluster running one version of MySQL to a
+ cluster running a different MySQL version. See
+ <xref linkend="mysql-cluster-upgrade-downgrade-compatibility"/>,
+ for more information.
+ </para>
- <para>
- <emphasis role="bold">Note</emphasis>: For more rapid
- restoration, the data may be restored in parallel, provided that
- there is a sufficient number of cluster connections available.
- That is, when restoring to multiple nodes in parallel, you must
- have an <literal>[API]</literal> or <literal>[MYSQLD]</literal>
- section in the cluster <filename>config.ini</filename> file
- available for each concurrent <command>ndb_restore</command>
- process. However, the data files must always be applied before
- the logs.
- </para>
+ <para>
+ <emphasis role="bold">Note</emphasis>: For more rapid
+ restoration, the data may be restored in parallel, provided
+ that there is a sufficient number of cluster connections
+ available. That is, when restoring to multiple nodes in
+ parallel, you must have an <literal>[API]</literal> or
+ <literal>[MYSQLD]</literal> section in the cluster
+ <filename>config.ini</filename> file available for each
+ concurrent <command>ndb_restore</command> process. However,
+ the data files must always be applied before the logs.
+ </para>
- <para>
- A complete listing of options available for this program is
- shown in the following table:
- </para>
+ <para>
+ A complete listing of options available for this program is
+ shown in the following table:
+ </para>
- <informaltable>
- <tgroup cols="4">
- <colspec colwidth="25*"/>
- <colspec colwidth="15*"/>
- <colspec colwidth="40*"/>
- <colspec colwidth="20*"/>
- <tbody>
- <row>
- <entry><emphasis role="bold">Long Form</emphasis></entry>
- <entry><emphasis role="bold">Short Form</emphasis></entry>
- <entry><emphasis role="bold">Description</emphasis></entry>
- <entry><emphasis role="bold">Default Value</emphasis></entry>
- </row>
- <row>
- <entry><option>--backup-id</option></entry>
- <entry><option>-b</option></entry>
- <entry>Backup sequence ID</entry>
- <entry><literal>0</literal></entry>
- </row>
- <row>
- <entry><option>--backup_path</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Path to backup files</entry>
- <entry><filename>./</filename></entry>
- </row>
- <row>
- <entry><option>--character-sets-dir</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Specify the directory where character set information can be found</entry>
- <entry><emphasis>None</emphasis></entry>
- </row>
- <row>
- <entry><option>--connect</option>, <option>--connectstring</option>, or
- <option>--ndb-connectstring</option></entry>
- <entry><option>-c</option> or <option>-C</option></entry>
- <entry>Set the connectstring in
- <literal>[nodeid=<replaceable>node_id;][host=]</replaceable><replaceable>host</replaceable>[:<replaceable>port</replaceable>]</literal>
- format</entry>
- <entry><emphasis>None</emphasis></entry>
- </row>
- <row>
- <entry><option>--core-file</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Write a core file in the event of an error</entry>
- <entry><literal>TRUE</literal></entry>
- </row>
- <row>
- <entry><option>--debug</option></entry>
- <entry><option>-#</option></entry>
- <entry>Output debug log</entry>
- <entry><literal>d:t:O,<filename>/tmp/ndb_restore.trace</filename></literal></entry>
- </row>
- <row>
- <entry><option>--dont_ignore_systab_0</option></entry>
- <entry><option>-f</option></entry>
- <entry>Do not ignore system table during restore —
- <emphasis>EXPERIMENTAL; not for production
- use</emphasis></entry>
- <entry><literal>FALSE</literal></entry>
- </row>
- <row>
- <entry><option>--help</option> or <option>--usage</option></entry>
- <entry><option>-?</option></entry>
- <entry>Display help message with available options and current values, then
- exit</entry>
- <entry>[N/A]</entry>
- </row>
- <row>
- <entry><option>--ndb-mgmd-host</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Set the host and port in
- <literal><replaceable>host</replaceable>[:<replaceable>port</replaceable>]</literal>
- format for the management server to connect to; this is
- the same as <option>--connect</option>,
- <option>--connectstring</option>, or
- <option>--ndb-connectstring</option>, but without a way
- to specify the <literal>nodeid</literal></entry>
- <entry><emphasis>None</emphasis></entry>
- </row>
- <row>
- <entry><option>--ndb-nodegroup-map</option></entry>
- <entry><option>-z</option></entry>
- <entry>Specifies a nodegroup map — <emphasis>Syntax</emphasis>: list of
- (<replaceable>source_nodegroup</replaceable>,
- <replaceable>destination_nodegroup</replaceable>)</entry>
- <entry><emphasis>None</emphasis></entry>
- </row>
- <row>
- <entry><option>--ndb-nodeid</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Specify a node ID for the <command>ndb_restore</command> process</entry>
- <entry><literal>0</literal></entry>
- </row>
- <row>
- <entry><option>--ndb-optimized-node-selection</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Optimize selection of nodes for transactions</entry>
- <entry><literal>TRUE</literal></entry>
- </row>
- <row>
- <entry><option>--ndb-shm</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Use shared memory connections when available</entry>
- <entry><literal>FALSE</literal></entry>
- </row>
- <row>
- <entry><option>--no-restore-disk-objects</option></entry>
- <entry><option>-d</option></entry>
- <entry>Do not restore Disk Data objects such as tablespaces and log file groups</entry>
- <entry><literal>FALSE</literal> (in other words, restore Disk Data objects
- unless this option is used)</entry>
- </row>
- <row>
- <entry><option>--nodeid</option></entry>
- <entry><option>-n</option></entry>
- <entry>Use backup files from node with the specified ID</entry>
- <entry><literal>0</literal></entry>
- </row>
- <row>
- <entry><option>--parallelism</option></entry>
- <entry><option>-p</option></entry>
- <entry>Set from 1 to 1024 parallel transactions to be used during the
- restoration process</entry>
- <entry><literal>128</literal></entry>
- </row>
- <row>
- <entry><option>--print</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Print data and log to <literal>stdout</literal></entry>
- <entry><literal>FALSE</literal></entry>
- </row>
- <row>
- <entry><option>--print_data</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Print data to <literal>stdout</literal></entry>
- <entry><literal>FALSE</literal></entry>
- </row>
- <row>
- <entry><option>--print_log</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Print log to <literal>stdout</literal></entry>
- <entry><literal>FALSE</literal></entry>
- </row>
- <row>
- <entry><option>--print_meta</option></entry>
- <entry><emphasis>None</emphasis></entry>
- <entry>Print metadata to <literal>stdout</literal></entry>
- <entry><literal>FALSE</literal></entry>
- </row>
- <row>
- <entry><option>--restore_data</option></entry>
- <entry><option>-r</option></entry>
- <entry>Restore data and logs</entry>
- <entry><literal>FALSE</literal></entry>
- </row>
- <row>
- <entry><option>--restore_epoch</option></entry>
- <entry><option>-e</option></entry>
- <entry>Restore epoch data into the status table; the row in the
- <literal>cluster.apply_status</literal> having the id
- <literal>0</literal> is inserted or updated as
- appropriate — this is convenient when starting up
- replication on a MySQL Cluster replication slave</entry>
- <entry><literal>FALSE</literal></entry>
- </row>
- <row>
- <entry><option>--restore_meta</option></entry>
- <entry><option>-m</option></entry>
- <entry>Restore table metadata</entry>
- <entry><literal>FALSE</literal></entry>
- </row>
- <row>
- <entry><option>--version</option></entry>
- <entry><option>-V</option></entry>
- <entry>Output version information and exit</entry>
- <entry>[N/A]</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
+ <informaltable>
+ <tgroup cols="4">
+ <colspec colwidth="25*"/>
+ <colspec colwidth="15*"/>
+ <colspec colwidth="40*"/>
+ <colspec colwidth="20*"/>
+ <tbody>
+ <row>
+ <entry><emphasis role="bold">Long Form</emphasis></entry>
+ <entry><emphasis role="bold">Short Form</emphasis></entry>
+ <entry><emphasis role="bold">Description</emphasis></entry>
+ <entry><emphasis role="bold">Default Value</emphasis></entry>
+ </row>
+ <row>
+ <entry><option>--backup-id</option></entry>
+ <entry><option>-b</option></entry>
+ <entry>Backup sequence ID</entry>
+ <entry><literal>0</literal></entry>
+ </row>
+ <row>
+ <entry><option>--backup_path</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Path to backup files</entry>
+ <entry><filename>./</filename></entry>
+ </row>
+ <row>
+ <entry><option>--character-sets-dir</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Specify the directory where character set information can be found</entry>
+ <entry><emphasis>None</emphasis></entry>
+ </row>
+ <row>
+ <entry><option>--connect</option>, <option>--connectstring</option>, or
+ <option>--ndb-connectstring</option></entry>
+ <entry><option>-c</option> or <option>-C</option></entry>
+ <entry>Set the connectstring in
+ <literal>[nodeid=<replaceable>node_id;][host=]</replaceable><replaceable>host</replaceable>[:<replaceable>port</replaceable>]</literal>
+ format</entry>
+ <entry><emphasis>None</emphasis></entry>
+ </row>
+ <row>
+ <entry><option>--core-file</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Write a core file in the event of an error</entry>
+ <entry><literal>TRUE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--debug</option></entry>
+ <entry><option>-#</option></entry>
+ <entry>Output debug log</entry>
+ <entry><literal>d:t:O,<filename>/tmp/ndb_restore.trace</filename></literal></entry>
+ </row>
+ <row>
+ <entry><option>--dont_ignore_systab_0</option></entry>
+ <entry><option>-f</option></entry>
+ <entry>Do not ignore system table during restore —
+ <emphasis>EXPERIMENTAL; not for production
+ use</emphasis></entry>
+ <entry><literal>FALSE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--help</option> or <option>--usage</option></entry>
+ <entry><option>-?</option></entry>
+ <entry>Display help message with available options and current values, then
+ exit</entry>
+ <entry>[N/A]</entry>
+ </row>
+ <row>
+ <entry><option>--ndb-mgmd-host</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Set the host and port in
+ <literal><replaceable>host</replaceable>[:<replaceable>port</replaceable>]</literal>
+ format for the management server to connect to; this
+ is the same as <option>--connect</option>,
+ <option>--connectstring</option>, or
+ <option>--ndb-connectstring</option>, but without a
+ way to specify the <literal>nodeid</literal></entry>
+ <entry><emphasis>None</emphasis></entry>
+ </row>
+ <row>
+ <entry><option>--ndb-nodegroup-map</option></entry>
+ <entry><option>-z</option></entry>
+ <entry>Specifies a nodegroup map — <emphasis>Syntax</emphasis>: list of
+ (<replaceable>source_nodegroup</replaceable>,
+ <replaceable>destination_nodegroup</replaceable>)</entry>
+ <entry><emphasis>None</emphasis></entry>
+ </row>
+ <row>
+ <entry><option>--ndb-nodeid</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Specify a node ID for the <command>ndb_restore</command> process</entry>
+ <entry><literal>0</literal></entry>
+ </row>
+ <row>
+ <entry><option>--ndb-optimized-node-selection</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Optimize selection of nodes for transactions</entry>
+ <entry><literal>TRUE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--ndb-shm</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Use shared memory connections when available</entry>
+ <entry><literal>FALSE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--no-restore-disk-objects</option></entry>
+ <entry><option>-d</option></entry>
+ <entry>Do not restore Disk Data objects such as tablespaces and log file groups</entry>
+ <entry><literal>FALSE</literal> (in other words, restore Disk Data objects
+ unless this option is used)</entry>
+ </row>
+ <row>
+ <entry><option>--nodeid</option></entry>
+ <entry><option>-n</option></entry>
+ <entry>Use backup files from node with the specified ID</entry>
+ <entry><literal>0</literal></entry>
+ </row>
+ <row>
+ <entry><option>--parallelism</option></entry>
+ <entry><option>-p</option></entry>
+ <entry>Set from 1 to 1024 parallel transactions to be used during the
+ restoration process</entry>
+ <entry><literal>128</literal></entry>
+ </row>
+ <row>
+ <entry><option>--print</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Print data and log to <literal>stdout</literal></entry>
+ <entry><literal>FALSE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--print_data</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Print data to <literal>stdout</literal></entry>
+ <entry><literal>FALSE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--print_log</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Print log to <literal>stdout</literal></entry>
+ <entry><literal>FALSE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--print_meta</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Print metadata to <literal>stdout</literal></entry>
+ <entry><literal>FALSE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--restore_data</option></entry>
+ <entry><option>-r</option></entry>
+ <entry>Restore data and logs</entry>
+ <entry><literal>FALSE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--restore_epoch</option></entry>
+ <entry><option>-e</option></entry>
+ <entry>Restore epoch data into the status table; the row in the
+ <literal>cluster.apply_status</literal> having the
+ id <literal>0</literal> is inserted or updated as
+ appropriate — this is convenient when starting
+ up replication on a MySQL Cluster replication slave</entry>
+ <entry><literal>FALSE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--restore_meta</option></entry>
+ <entry><option>-m</option></entry>
+ <entry>Restore table metadata</entry>
+ <entry><literal>FALSE</literal></entry>
+ </row>
+ <row>
+ <entry><option>--version</option></entry>
+ <entry><option>-V</option></entry>
+ <entry>Output version information and exit</entry>
+ <entry>[N/A]</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
- <indexterm>
- <primary><command>ndb_restore</command></primary>
- <secondary>errors</secondary>
- </indexterm>
+ <indexterm>
+ <primary><command>ndb_restore</command></primary>
+ <secondary>errors</secondary>
+ </indexterm>
- <para>
- <emphasis role="bold">Note</emphasis>:
- <command>ndb_restore</command> reports both temporary and
- permanent errors. In the case of temporary errors, it may able
- to recover from them. Beginning with MySQL 5.1.12, it reports
- <literal>Restore successful, but encountered temporary error,
- please look at configuration</literal> in such cases.
- </para>
+ <para>
+ <emphasis role="bold">Note</emphasis>:
+ <command>ndb_restore</command> reports both temporary and
+ permanent errors. In the case of temporary errors, it may
+ able to recover from them. Beginning with MySQL 5.1.12, it
+ reports <literal>Restore successful, but encountered
+ temporary error, please look at configuration</literal> in
+ such cases.
+ </para>
+ </refsection>
+
+ </refentry>
+
</section>
<section id="mysql-cluster-backup-configuration">
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r5156 - in trunk: . refman-4.1 refman-5.0 refman-5.1 | paul | 2 Mar |
