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

[jon]

Author: jstephens
Date: 2006-09-02 05:16:22 +0200 (Sat, 02 Sep 2006)
New Revision: 3203

Log:
Updates to ndb_restore section (suggested by users)

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


Modified: trunk/refman-4.1/mysql-cluster.xml
===================================================================
--- trunk/refman-4.1/mysql-cluster.xml	2006-09-02 02:46:21 UTC (rev 3202)
+++ trunk/refman-4.1/mysql-cluster.xml	2006-09-02 03:16:22 UTC (rev 3203)
Changed blocks: 4, Lines Added: 20, Lines Deleted: 5; 2645 bytes

@@ -12311,9 +12311,16 @@
         set of backup files — that is, once for each data node in
         the cluster at the time that the backup was created.
       </para>
+      
+      <para>
+        <emphasis role="bold">Important</emphasis>: In order to use
+        <command>ndb_restore</command>, the cluster must be running in
+        single user mode. See 
+        <xref linkend="mysql-cluster-single-user-mode"/>. 
+      </para>
 
       <para>
-        The most important options for this utility are shown here:
+        Typical options for this utility are shown here:
       </para>
 
 <programlisting>

@@ -12336,8 +12343,14 @@
         to keep at least one empty <literal>[API]</literal> section in
         <filename>config.ini</filename> that is not being used for a
         MySQL server or for an application for this reason (see
-        <xref linkend="mysql-cluster-api-definition"/>). You can verify
-        that <command>ndb_restore</command> is connected by using the
+        <xref linkend="mysql-cluster-api-definition"/>).
+        <command>ndb_restore</command> can also employ an unused
+        <literal>[MYSQLD]</literal> section in the
+        <filename>config.ini</filename> file for this purpose. 
+      </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:

@@ -12358,7 +12371,9 @@
         other words, you must re-create the database tables &mdash; 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.
+        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>

@@ -12371,7 +12386,7 @@
       </para>
 
       <para>
-        The <option>-r</option> option is used to tell
+        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


Modified: trunk/refman-5.0/mysql-cluster.xml
===================================================================
--- trunk/refman-5.0/mysql-cluster.xml	2006-09-02 02:46:21 UTC (rev 3202)
+++ trunk/refman-5.0/mysql-cluster.xml	2006-09-02 03:16:22 UTC (rev 3203)
Changed blocks: 4, Lines Added: 20, Lines Deleted: 5; 2646 bytes

@@ -12352,9 +12352,16 @@
         set of backup files &mdash; that is, once for each data node in
         the cluster at the time that the backup was created.
       </para>
+      
+      <para>
+        <emphasis role="bold">Important</emphasis>: In order to use
+        <command>ndb_restore</command>, the cluster must be running in
+        single user mode. See 
+        <xref linkend="mysql-cluster-single-user-mode"/>. 
+      </para>
 
       <para>
-        The most important options for this utility are shown here:
+        Typical options for this utility are shown here:
       </para>
 
 <programlisting>

@@ -12377,8 +12384,14 @@
         to keep at least one empty <literal>[API]</literal> section in
         <filename>config.ini</filename> that is not being used for a
         MySQL server or for an application for this reason (see
-        <xref linkend="mysql-cluster-api-definition"/>). You can verify
-        that <command>ndb_restore</command> is connected by using the
+        <xref linkend="mysql-cluster-api-definition"/>).
+        <command>ndb_restore</command> can also employ an unused
+        <literal>[MYSQLD]</literal> section in the
+        <filename>config.ini</filename> file for this purpose. 
+      </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:

@@ -12399,7 +12412,9 @@
         other words, you must re-create the database tables &mdash; 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.
+        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>

@@ -12412,7 +12427,7 @@
       </para>
 
       <para>
-        The <option>-r</option> option is used to tell
+        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


Modified: trunk/refman-5.1/mysql-cluster.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster.xml	2006-09-02 02:46:21 UTC (rev 3202)
+++ trunk/refman-5.1/mysql-cluster.xml	2006-09-02 03:16:22 UTC (rev 3203)
Changed blocks: 4, Lines Added: 23, Lines Deleted: 6; 3122 bytes

@@ -12248,9 +12248,16 @@
         set of backup files &mdash; that is, once for each data node in
         the cluster at the time that the backup was created.
       </para>
+      
+      <para>
+        <emphasis role="bold">Important</emphasis>: In order to use
+        <command>ndb_restore</command>, the cluster must be running in
+        single user mode. See 
+        <xref linkend="mysql-cluster-single-user-mode"/>. 
+      </para>
 
       <para>
-        The most important options for this utility are shown here:
+        Typical options for this utility are shown here:
       </para>
 
 <programlisting>

@@ -12269,12 +12276,18 @@
         connection <quote>slot</quote> to connect to the cluster
         management server. This means that there must be at least one
         <literal>[API]</literal> section that can be used by it in the
-        cluster <filename>config.ini</filename> file. It is a good idea
+        cluster <filename>config.ini</filename> file.  It is a good idea
         to keep at least one empty <literal>[API]</literal> section in
         <filename>config.ini</filename> that is not being used for a
         MySQL server or for an application for this reason (see
-        <xref linkend="mysql-cluster-api-definition"/>). You can verify
-        that <command>ndb_restore</command> is connected by using the
+        <xref linkend="mysql-cluster-api-definition"/>).
+        <command>ndb_restore</command> can also employ an unused
+        <literal>[MYSQLD]</literal> section in the
+        <filename>config.ini</filename> file for this purpose. 
+      </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:

@@ -12295,7 +12308,11 @@
         other words, you must re-create the database tables &mdash; 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.
+        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>

@@ -12308,7 +12325,7 @@
       </para>
 
       <para>
-        The <option>-r</option> option is used to tell
+        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