svn commit - mysqldoc@docsrva: r5757 - in trunk: refman-4.1 refman-5.0 refman-5.1

[jon]

Author: jstephens
Date: 2007-04-06 08:48:49 +0200 (Fri, 06 Apr 2007)
New Revision: 5757

Log:

Corrections to ndb_restore info.



Modified:
   trunk/refman-4.1/mysql-cluster.xml
   trunk/refman-5.0/mysql-cluster.xml
   trunk/refman-5.1/mysql-cluster.xml


Modified: trunk/refman-4.1/mysql-cluster.xml
===================================================================
--- trunk/refman-4.1/mysql-cluster.xml	2007-04-05 20:04:37 UTC (rev 5756)
+++ trunk/refman-4.1/mysql-cluster.xml	2007-04-06 06:48:49 UTC (rev 5757)
Changed blocks: 5, Lines Added: 40, Lines Deleted: 29; 5453 bytes

@@ -12915,7 +12915,7 @@
           </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>
+ndb_restore [-c <replaceable>connectstring</replaceable>] -n
<replaceable>node_id</replaceable> [-m] -b
<replaceable>backup_id</replaceable> -r
[backup_path=]<replaceable>/path/to/backup/files</replaceable>
 </programlisting>
 
           <para>

@@ -12976,15 +12976,32 @@
             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.
+            The path to the backup directory is required, and must
+            include the subdirectory corresponding to the ID backup of
+            the backup to be restored. For example, if the data node's
+            <literal>DataDir</literal> is
+            <filename>/var/lib/mysql-cluster</filename>, then the backup
+            directory is
+            <filename>/var/lib/mysql-cluster/BACKUP</filename>, and the
+            backup files for the backup with the ID 3 can be found in
+            <filename>/var/lib/mysql-cluster/BACKUP/BACKUP-3</filename>.
+            The path may be absolute or relative to the directory in
+            which the <command>ndb_restore</command> executable is
+            located, and may be optionally prefixed with
+            <option>backup_path=</option>.
           </para>
+          
+          <important>
+            <para>
+              When restoring cluster backups, you must be sure to
+              restore all data nodes from backups having the same backup
+              ID. Using files from different backups will at best result
+              in restoring the cluster to an inconsistent state, and may
+              fail altogether.
+            </para>
+          </important>
 
           <para>
             It is possible to restore a backup to a database with a

@@ -13003,19 +13020,21 @@
             for more information.
           </para>
 
+          <note>
+            <para>
+              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>
+          </note>
+          
           <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>

@@ -13092,14 +13111,6 @@
                   <entry><emphasis>None</emphasis></entry>
                 </row>
                 <row>
-                 
<entry><option>--ndb-nodegroup-map</option></entry>
-                  <entry><option>-z</option></entry>
-                  <entry>Specifies a nodegroup map &mdash;
<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>

@@ -13133,7 +13144,7 @@
                 <row>
                   <entry><option>--print</option></entry>
                   <entry><emphasis>None</emphasis></entry>
-                  <entry>Print data and log to
<literal>stdout</literal></entry>
+                  <entry>Print metadata and log to
<literal>stdout</literal></entry>
                   <entry><literal>FALSE</literal></entry>
                 </row>
                 <row>


Modified: trunk/refman-5.0/mysql-cluster.xml
===================================================================
--- trunk/refman-5.0/mysql-cluster.xml	2007-04-05 20:04:37 UTC (rev 5756)
+++ trunk/refman-5.0/mysql-cluster.xml	2007-04-06 06:48:49 UTC (rev 5757)
Changed blocks: 5, Lines Added: 40, Lines Deleted: 29; 5530 bytes

@@ -13014,7 +13014,7 @@
           </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>
+ndb_restore [-c <replaceable>connectstring</replaceable>] -n
<replaceable>node_id</replaceable> [-m] -b
<replaceable>backup_id</replaceable> -r
[backup_path=]<replaceable>/path/to/backup/files</replaceable>
 </programlisting>
 
           <para>

@@ -13075,15 +13075,32 @@
             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.
+            The path to the backup directory is required, and must
+            include the subdirectory corresponding to the ID backup of
+            the backup to be restored. For example, if the data node's
+            <literal>DataDir</literal> is
+            <filename>/var/lib/mysql-cluster</filename>, then the backup
+            directory is
+            <filename>/var/lib/mysql-cluster/BACKUP</filename>, and the
+            backup files for the backup with the ID 3 can be found in
+            <filename>/var/lib/mysql-cluster/BACKUP/BACKUP-3</filename>.
+            The path may be absolute or relative to the directory in
+            which the <command>ndb_restore</command> executable is
+            located, and may be optionally prefixed with
+            <option>backup_path=</option>.
           </para>
+          
+          <important>
+            <para>
+              When restoring cluster backups, you must be sure to
+              restore all data nodes from backups having the same backup
+              ID. Using files from different backups will at best result
+              in restoring the cluster to an inconsistent state, and may
+              fail altogether.
+            </para>
+          </important>
 
           <para>
             It is possible to restore a backup to a database with a

@@ -13101,20 +13118,22 @@
             <xref linkend="mysql-cluster-upgrade-downgrade-compatibility"/>,
             for more information.
           </para>
+          
+          <note>
+            <para>
+              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>
+          </note>
 
           <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>

@@ -13191,14 +13210,6 @@
                   <entry><emphasis>None</emphasis></entry>
                 </row>
                 <row>
-                 
<entry><option>--ndb-nodegroup-map</option></entry>
-                  <entry><option>-z</option></entry>
-                  <entry>Specifies a nodegroup map &mdash;
<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>

@@ -13232,7 +13243,7 @@
                 <row>
                   <entry><option>--print</option></entry>
                   <entry><emphasis>None</emphasis></entry>
-                  <entry>Print data and log to
<literal>stdout</literal></entry>
+                  <entry>Print metadata and log to
<literal>stdout</literal></entry>
                   <entry><literal>FALSE</literal></entry>
                 </row>
                 <row>


Modified: trunk/refman-5.1/mysql-cluster.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster.xml	2007-04-05 20:04:37 UTC (rev 5756)
+++ trunk/refman-5.1/mysql-cluster.xml	2007-04-06 06:48:49 UTC (rev 5757)
Changed blocks: 4, Lines Added: 40, Lines Deleted: 20; 4573 bytes

@@ -13294,7 +13294,8 @@
           </para>
 
 <programlisting>
-ndb_restore [-c <replaceable>connectstring</replaceable>] -n
<replaceable>node_id</replaceable> [-s] [-m] -b
<replaceable>backup_id</replaceable> -r
<replaceable>/path/to/backup/files</replaceable>
+ndb_restore [-c <replaceable>connectstring</replaceable>] -n
+<replaceable>node_id</replaceable> [-s] [-m] -b
<replaceable>backup_id</replaceable> -r
[backup_path=]<replaceable>/path/to/backup/files</replaceable>
 </programlisting>
 
           <para>

@@ -13381,13 +13382,30 @@
           </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.
+            The path to the backup directory is required, and must
+            include the subdirectory corresponding to the ID backup of
+            the backup to be restored. For example, if the data node's
+            <literal>DataDir</literal> is
+            <filename>/var/lib/mysql-cluster</filename>, then the backup
+            directory is
+            <filename>/var/lib/mysql-cluster/BACKUP</filename>, and the
+            backup files for the backup with the ID 3 can be found in
+            <filename>/var/lib/mysql-cluster/BACKUP/BACKUP-3</filename>.
+            The path may be absolute or relative to the directory in
+            which the <command>ndb_restore</command> executable is
+            located, and may be optionally prefixed with
+            <option>backup_path=</option>.
           </para>
+          
+          <important>
+            <para>
+              When restoring cluster backups, you must be sure to
+              restore all data nodes from backups having the same backup
+              ID. Using files from different backups will at best result
+              in restoring the cluster to an inconsistent state, and may
+              fail altogether.
+            </para>
+          </important>
 
           <para>
             It is possible to restore a backup to a database with a

@@ -13405,20 +13423,22 @@
             <xref linkend="mysql-cluster-upgrade-downgrade-compatibility"/>,
             for more information.
           </para>
+          
+          <note>
+            <para>
+              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>
+          </note>
 
           <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>

@@ -13551,7 +13571,7 @@
                 <row>
                   <entry><option>--print</option></entry>
                   <entry><emphasis>None</emphasis></entry>
-                  <entry>Print data and log to
<literal>stdout</literal></entry>
+                  <entry>Print metadata and log to
<literal>stdout</literal></entry>
                   <entry><literal>FALSE</literal></entry>
                 </row>
                 <row>