MySQL Lists are EOL. Please join:

List:Commits« Previous MessageNext Message »
From:jon Date:October 22 2007 5:20pm
Subject:svn commit - mysqldoc@docsrva: r8235 - in trunk: refman-4.1 refman-5.0 refman-5.1 refman-5.2
View as plain text  
Author: jstephens
Date: 2007-10-22 19:20:58 +0200 (Mon, 22 Oct 2007)
New Revision: 8235

Log:

WAIT STARTED|WAIT COMPLETED|NOWAIT for Cluster START BACKUP command

Fixes Docs Bug #31759 (Thanks, Hartmut!)



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


Modified: trunk/refman-4.1/mysql-cluster-backup.xml
===================================================================
--- trunk/refman-4.1/mysql-cluster-backup.xml	2007-10-22 17:09:08 UTC (rev 8234)
+++ trunk/refman-4.1/mysql-cluster-backup.xml	2007-10-22 17:20:58 UTC (rev 8235)
Changed blocks: 1, Lines Added: 171, Lines Deleted: 57; 9159 bytes

@@ -166,81 +166,195 @@
     <para>
       Creating a backup using the management client involves the
       following steps:
-    </para>
 
-    <orderedlist>
+      <orderedlist>
 
-      <listitem>
-        <para>
-          Start the management client (<command>ndb_mgm</command>).
-        </para>
-      </listitem>
+        <listitem>
+          <para>
+            Start the management client (<command>ndb_mgm</command>), if
+            it not running already.
+          </para>
+        </listitem>
 
-      <listitem>
-        <indexterm>
-          <primary>MySQL Cluster</primary>
-          <secondary><literal>START BACKUP</literal> command</secondary>
-        </indexterm>
+        <listitem>
+          <indexterm>
+            <primary>START BACKUP</primary>
+          </indexterm>
 
-        <indexterm>
-          <primary><literal>START BACKUP</literal> command (MySQL Cluster)</primary>
-        </indexterm>
+          <indexterm>
+            <primary>native backup and restore</primary>
+            <secondary>and management client</secondary>
+          </indexterm>
 
-        <para>
-          Execute the command <literal>START BACKUP</literal>.
-        </para>
-      </listitem>
+          <para>
+            Execute the <userinput>START BACKUP</userinput> command.
+            This produces several lines of output indicating the
+            progress of the backup, as shown here:
 
-      <listitem>
-        <para>
-          The management client responds as shown here:
-        </para>
-
 <programlisting>
+ndb_mgm&gt; <userinput>START BACKUP</userinput>
 Waiting for completed, this may take several minutes
-Node 1: Backup <replaceable>backup_id</replaceable> started from node <replaceable>management_node_id</replaceable>
+Node 2: Backup 1 started from node 1
+Node 2: Backup 1 started from node 1 completed
+ StartGCP: 177 StopGCP: 180
+ #Records: 7362 #LogRecords: 0
+ Data: 453648 bytes Log: 0 bytes
+ndb_mgm&gt;
 </programlisting>
+          </para>
 
-        <para>
-          Here, <replaceable>backup_id</replaceable> is the unique
-          identifier for this particular backup. (This identifier will
-          also be saved in the cluster log, if it has not been
-          configured otherwise.)
-          <replaceable>management_node_id</replaceable> is the node ID
-          of the management to which the management client is connected.
-        </para>
+          <para>
+            The first line printed indicates that the management client
+            is waiting for the backup to be completed before returning
+            control to the client. This behavior is the default for the
+            <literal>START BACKUP</literal> command, but can be changed.
+            To specify when <literal>START BACKUP</literal> command
+            should return control to the client, append
+            <literal>NOWAIT</literal>, <literal>WAIT STARTED</literal>,
+            or <literal>WAIT COMPLETED</literal> to the command. The
+            effects that each of these has differs as follows:
 
-        <para>
-          This means that the cluster has received and processed the
-          backup request. It does <emphasis>not</emphasis> mean that the
-          backup has been completed.
-        </para>
-      </listitem>
+            <itemizedlist>
 
-      <listitem>
-        <para>
-          When the backup is completed, the management client will
-          indicate this as shown here:
-        </para>
+              <listitem>
+                <indexterm>
+                  <primary>START BACKUP</primary>
+                  <secondary>NOWAIT</secondary>
+                </indexterm>
 
+                <indexterm>
+                  <primary>NOWAIT (START BACKUP command)</primary>
+                </indexterm>
+
+                <para>
+                  If <literal>NOWAIT</literal> is specified, the
+                  management client displays a prompt immediately, as
+                  seen here:
+
 <programlisting>
-Node 1: Backup <replaceable>backup_id</replaceable> started from node <replaceable>management_node_id</replaceable> completed
- StartGCP: 417599 StopGCP: 417602
- #Records: 105957 #LogRecords: 0
- Data: 99719356 bytes Log: 0 bytes
+ndb_mgm&gt; <userinput>START BACKUP NOWAIT</userinput>
+ndb_mgm&gt; 
 </programlisting>
 
-        <para>
-          The values shown for <literal>StartGCP</literal>,
-          <literal>StopGCP</literal>, <literal>#Records</literal>,
-          <literal>#LogRecords</literal>, <literal>Data</literal>, and
-          <literal>Log</literal> will vary according to the specifics of
-          your cluster.
-        </para>
-      </listitem>
+                  In this case, the management client can be used even
+                  while it prints progress information from the backup
+                  process.
+                </para>
+              </listitem>
 
-    </orderedlist>
+              <listitem>
+                <indexterm>
+                  <primary>START BACKUP</primary>
+                  <secondary>WAIT STARTED</secondary>
+                </indexterm>
 
+                <indexterm>
+                  <primary>WAIT STARTED (START BACKUP command)</primary>
+                </indexterm>
+
+                <para>
+                  With <literal>WAIT STARTED</literal> the management
+                  client waits until the backup has started before
+                  returning control to the user, as shown here:
+
+<programlisting>
+ndb_mgm&gt; <userinput>START BACKUP WAIT STARTED</userinput>
+Waiting for started, this may take several minutes
+Node 2: Backup 3 started from node 1
+ndb_mgm>
+</programlisting>
+                </para>
+              </listitem>
+
+              <listitem>
+                <indexterm>
+                  <primary>START BACKUP</primary>
+                  <secondary>WAIT COMPLETED</secondary>
+                </indexterm>
+
+                <indexterm>
+                  <primary>WAIT COMPLETED (START BACKUP command)</primary>
+                </indexterm>
+
+                <para>
+                  <userinput>WAIT COMPLETED</userinput> explicitly
+                  specifies the default behavior &mdash; that is, it
+                  causes the management client to wait until the backup
+                  process is complete before returning control to the
+                  user.
+                </para>
+              </listitem>
+
+            </itemizedlist>
+          </para>
+        </listitem>
+
+        <listitem>
+          <indexterm>
+            <primary>native backup and restore</primary>
+            <secondary>backup identifiers</secondary>
+          </indexterm>
+
+          <indexterm>
+            <primary>backup identifiers</primary>
+            <secondary>native backup and restore</secondary>
+          </indexterm>
+
+          <para>
+            When the backup has started the management client displays
+            this message:
+
+<programlisting>
+Backup <replaceable>backup_id</replaceable> started from node <replaceable>node_id</replaceable>
+</programlisting>
+
+            <replaceable>backup_id</replaceable> is the unique
+            identifier for this particular backup. This identifier is
+            saved in the cluster log, if it has not been configured
+            otherwise. <replaceable>node_id</replaceable> is the
+            identifier of the management server that is coordinating the
+            backup with the data nodes. At this point in the backup
+            process the cluster has received and processed the backup
+            request. It does not mean that the backup has finished. An
+            example of this statement is shown here:
+
+<programlisting>	
+Node 2: Backup 1 started from node 1
+</programlisting>
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            The management client indicates that the backup has
+            completed with a message in the following format:
+
+<programlisting>
+Backup <replaceable>backup_id</replaceable> started from node <replaceable>node_id</replaceable> completed
+</programlisting>
+
+            As is the case for the notification that the backup has
+            started, <replaceable>backup_id</replaceable> is the unique
+            identifier for this particular backup, and
+            <replaceable>node_id</replaceable> is the node ID of the
+            management server that is coordinating the backup with the
+            data nodes. This output is accompanied by additional
+            information including relevant global checkpoints, the
+            number of records backed up, and the size of the data, as
+            shown here:
+
+<programlisting>	
+Node 2: Backup 1 started from node 1 completed
+ StartGCP: 177 StopGCP: 180
+ #Records: 7362 #LogRecords: 0
+ Data: 453648 bytes Log: 0 bytes
+</programlisting>
+          </para>
+        </listitem>
+
+      </orderedlist>
+    </para>
+
     <para>
       Cluster backups are created by default in the
       <filename>BACKUP</filename> subdirectory of the


Modified: trunk/refman-5.0/mysql-cluster-backup.xml
===================================================================
--- trunk/refman-5.0/mysql-cluster-backup.xml	2007-10-22 17:09:08 UTC (rev 8234)
+++ trunk/refman-5.0/mysql-cluster-backup.xml	2007-10-22 17:20:58 UTC (rev 8235)
Changed blocks: 1, Lines Added: 171, Lines Deleted: 57; 9159 bytes

@@ -166,81 +166,195 @@
     <para>
       Creating a backup using the management client involves the
       following steps:
-    </para>
 
-    <orderedlist>
+      <orderedlist>
 
-      <listitem>
-        <para>
-          Start the management client (<command>ndb_mgm</command>).
-        </para>
-      </listitem>
+        <listitem>
+          <para>
+            Start the management client (<command>ndb_mgm</command>), if
+            it not running already.
+          </para>
+        </listitem>
 
-      <listitem>
-        <indexterm>
-          <primary>MySQL Cluster</primary>
-          <secondary><literal>START BACKUP</literal> command</secondary>
-        </indexterm>
+        <listitem>
+          <indexterm>
+            <primary>START BACKUP</primary>
+          </indexterm>
 
-        <indexterm>
-          <primary><literal>START BACKUP</literal> command (MySQL Cluster)</primary>
-        </indexterm>
+          <indexterm>
+            <primary>native backup and restore</primary>
+            <secondary>and management client</secondary>
+          </indexterm>
 
-        <para>
-          Execute the command <literal>START BACKUP</literal>.
-        </para>
-      </listitem>
+          <para>
+            Execute the <userinput>START BACKUP</userinput> command.
+            This produces several lines of output indicating the
+            progress of the backup, as shown here:
 
-      <listitem>
-        <para>
-          The management client responds as shown here:
-        </para>
-
 <programlisting>
+ndb_mgm&gt; <userinput>START BACKUP</userinput>
 Waiting for completed, this may take several minutes
-Node 1: Backup <replaceable>backup_id</replaceable> started from node <replaceable>management_node_id</replaceable>
+Node 2: Backup 1 started from node 1
+Node 2: Backup 1 started from node 1 completed
+ StartGCP: 177 StopGCP: 180
+ #Records: 7362 #LogRecords: 0
+ Data: 453648 bytes Log: 0 bytes
+ndb_mgm&gt;
 </programlisting>
+          </para>
 
-        <para>
-          Here, <replaceable>backup_id</replaceable> is the unique
-          identifier for this particular backup. (This identifier will
-          also be saved in the cluster log, if it has not been
-          configured otherwise.)
-          <replaceable>management_node_id</replaceable> is the node ID
-          of the management to which the management client is connected.
-        </para>
+          <para>
+            The first line printed indicates that the management client
+            is waiting for the backup to be completed before returning
+            control to the client. This behavior is the default for the
+            <literal>START BACKUP</literal> command, but can be changed.
+            To specify when <literal>START BACKUP</literal> command
+            should return control to the client, append
+            <literal>NOWAIT</literal>, <literal>WAIT STARTED</literal>,
+            or <literal>WAIT COMPLETED</literal> to the command. The
+            effects that each of these has differs as follows:
 
-        <para>
-          This means that the cluster has received and processed the
-          backup request. It does <emphasis>not</emphasis> mean that the
-          backup has been completed.
-        </para>
-      </listitem>
+            <itemizedlist>
 
-      <listitem>
-        <para>
-          When the backup is completed, the management client will
-          indicate this as shown here:
-        </para>
+              <listitem>
+                <indexterm>
+                  <primary>START BACKUP</primary>
+                  <secondary>NOWAIT</secondary>
+                </indexterm>
 
+                <indexterm>
+                  <primary>NOWAIT (START BACKUP command)</primary>
+                </indexterm>
+
+                <para>
+                  If <literal>NOWAIT</literal> is specified, the
+                  management client displays a prompt immediately, as
+                  seen here:
+
 <programlisting>
-Node 1: Backup <replaceable>backup_id</replaceable> started from node <replaceable>management_node_id</replaceable> completed
- StartGCP: 417599 StopGCP: 417602
- #Records: 105957 #LogRecords: 0
- Data: 99719356 bytes Log: 0 bytes
+ndb_mgm&gt; <userinput>START BACKUP NOWAIT</userinput>
+ndb_mgm&gt; 
 </programlisting>
 
-        <para>
-          The values shown for <literal>StartGCP</literal>,
-          <literal>StopGCP</literal>, <literal>#Records</literal>,
-          <literal>#LogRecords</literal>, <literal>Data</literal>, and
-          <literal>Log</literal> will vary according to the specifics of
-          your cluster.
-        </para>
-      </listitem>
+                  In this case, the management client can be used even
+                  while it prints progress information from the backup
+                  process.
+                </para>
+              </listitem>
 
-    </orderedlist>
+              <listitem>
+                <indexterm>
+                  <primary>START BACKUP</primary>
+                  <secondary>WAIT STARTED</secondary>
+                </indexterm>
 
+                <indexterm>
+                  <primary>WAIT STARTED (START BACKUP command)</primary>
+                </indexterm>
+
+                <para>
+                  With <literal>WAIT STARTED</literal> the management
+                  client waits until the backup has started before
+                  returning control to the user, as shown here:
+
+<programlisting>
+ndb_mgm&gt; <userinput>START BACKUP WAIT STARTED</userinput>
+Waiting for started, this may take several minutes
+Node 2: Backup 3 started from node 1
+ndb_mgm>
+</programlisting>
+                </para>
+              </listitem>
+
+              <listitem>
+                <indexterm>
+                  <primary>START BACKUP</primary>
+                  <secondary>WAIT COMPLETED</secondary>
+                </indexterm>
+
+                <indexterm>
+                  <primary>WAIT COMPLETED (START BACKUP command)</primary>
+                </indexterm>
+
+                <para>
+                  <userinput>WAIT COMPLETED</userinput> explicitly
+                  specifies the default behavior &mdash; that is, it
+                  causes the management client to wait until the backup
+                  process is complete before returning control to the
+                  user.
+                </para>
+              </listitem>
+
+            </itemizedlist>
+          </para>
+        </listitem>
+
+        <listitem>
+          <indexterm>
+            <primary>native backup and restore</primary>
+            <secondary>backup identifiers</secondary>
+          </indexterm>
+
+          <indexterm>
+            <primary>backup identifiers</primary>
+            <secondary>native backup and restore</secondary>
+          </indexterm>
+
+          <para>
+            When the backup has started the management client displays
+            this message:
+
+<programlisting>
+Backup <replaceable>backup_id</replaceable> started from node <replaceable>node_id</replaceable>
+</programlisting>
+
+            <replaceable>backup_id</replaceable> is the unique
+            identifier for this particular backup. This identifier is
+            saved in the cluster log, if it has not been configured
+            otherwise. <replaceable>node_id</replaceable> is the
+            identifier of the management server that is coordinating the
+            backup with the data nodes. At this point in the backup
+            process the cluster has received and processed the backup
+            request. It does not mean that the backup has finished. An
+            example of this statement is shown here:
+
+<programlisting>	
+Node 2: Backup 1 started from node 1
+</programlisting>
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            The management client indicates that the backup has
+            completed with a message in the following format:
+
+<programlisting>
+Backup <replaceable>backup_id</replaceable> started from node <replaceable>node_id</replaceable> completed
+</programlisting>
+
+            As is the case for the notification that the backup has
+            started, <replaceable>backup_id</replaceable> is the unique
+            identifier for this particular backup, and
+            <replaceable>node_id</replaceable> is the node ID of the
+            management server that is coordinating the backup with the
+            data nodes. This output is accompanied by additional
+            information including relevant global checkpoints, the
+            number of records backed up, and the size of the data, as
+            shown here:
+
+<programlisting>	
+Node 2: Backup 1 started from node 1 completed
+ StartGCP: 177 StopGCP: 180
+ #Records: 7362 #LogRecords: 0
+ Data: 453648 bytes Log: 0 bytes
+</programlisting>
+          </para>
+        </listitem>
+
+      </orderedlist>
+    </para>
+
     <para>
       Cluster backups are created by default in the
       <filename>BACKUP</filename> subdirectory of the


Modified: trunk/refman-5.1/mysql-cluster-backup.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster-backup.xml	2007-10-22 17:09:08 UTC (rev 8234)
+++ trunk/refman-5.1/mysql-cluster-backup.xml	2007-10-22 17:20:58 UTC (rev 8235)
Changed blocks: 1, Lines Added: 168, Lines Deleted: 62; 9386 bytes

@@ -166,89 +166,195 @@
     <para>
       Creating a backup using the management client involves the
       following steps:
-    </para>
 
-    <orderedlist>
+      <orderedlist>
 
-      <listitem>
-        <para>
-          Start the management client (<command>ndb_mgm</command>).
-        </para>
-      </listitem>
+        <listitem>
+          <para>
+            Start the management client (<command>ndb_mgm</command>), if
+            it not running already.
+          </para>
+        </listitem>
 
-      <listitem>
-        <indexterm>
-          <primary>MySQL Cluster</primary>
-          <secondary><literal>START BACKUP</literal> command</secondary>
-        </indexterm>
+        <listitem>
+          <indexterm>
+            <primary>START BACKUP</primary>
+          </indexterm>
 
-        <indexterm>
-          <primary><literal>START BACKUP</literal> command (MySQL Cluster)</primary>
-        </indexterm>
+          <indexterm>
+            <primary>native backup and restore</primary>
+            <secondary>and management client</secondary>
+          </indexterm>
 
-        <para>
-          Execute the command <literal>START BACKUP</literal>.
-        </para>
-      </listitem>
+          <para>
+            Execute the <userinput>START BACKUP</userinput> command.
+            This produces several lines of output indicating the
+            progress of the backup, as shown here:
 
-      <listitem>
-        <para>
-          The management client responds as shown here:
-        </para>
-
 <programlisting>
+ndb_mgm&gt; <userinput>START BACKUP</userinput>
 Waiting for completed, this may take several minutes
-Node 1: Backup <replaceable>backup_id</replaceable> started from node <replaceable>management_node_id</replaceable>
+Node 2: Backup 1 started from node 1
+Node 2: Backup 1 started from node 1 completed
+ StartGCP: 177 StopGCP: 180
+ #Records: 7362 #LogRecords: 0
+ Data: 453648 bytes Log: 0 bytes
+ndb_mgm&gt;
 </programlisting>
+          </para>
 
-        <para>
-          Here, <replaceable>backup_id</replaceable> is the unique
-          identifier for this particular backup. (This identifier will
-          also be saved in the cluster log, if it has not been
-          configured otherwise.)
-          <replaceable>management_node_id</replaceable> is the node ID
-          of the management to which the management client is connected.
-        </para>
+          <para>
+            The first line printed indicates that the management client
+            is waiting for the backup to be completed before returning
+            control to the client. This behavior is the default for the
+            <literal>START BACKUP</literal> command, but can be changed.
+            To specify when <literal>START BACKUP</literal> command
+            should return control to the client, append
+            <literal>NOWAIT</literal>, <literal>WAIT STARTED</literal>,
+            or <literal>WAIT COMPLETED</literal> to the command. The
+            effects that each of these has differs as follows:
 
-        <para>
-          This means that the cluster has received and processed the
-          backup request. It does <emphasis>not</emphasis> mean that the
-          backup has been completed.
-        </para>
+            <itemizedlist>
 
-        <note>
+              <listitem>
+                <indexterm>
+                  <primary>START BACKUP</primary>
+                  <secondary>NOWAIT</secondary>
+                </indexterm>
+
+                <indexterm>
+                  <primary>NOWAIT (START BACKUP command)</primary>
+                </indexterm>
+
+                <para>
+                  If <literal>NOWAIT</literal> is specified, the
+                  management client displays a prompt immediately, as
+                  seen here:
+
+<programlisting>
+ndb_mgm&gt; <userinput>START BACKUP NOWAIT</userinput>
+ndb_mgm&gt; 
+</programlisting>
+
+                  In this case, the management client can be used even
+                  while it prints progress information from the backup
+                  process.
+                </para>
+              </listitem>
+
+              <listitem>
+                <indexterm>
+                  <primary>START BACKUP</primary>
+                  <secondary>WAIT STARTED</secondary>
+                </indexterm>
+
+                <indexterm>
+                  <primary>WAIT STARTED (START BACKUP command)</primary>
+                </indexterm>
+
+                <para>
+                  With <literal>WAIT STARTED</literal> the management
+                  client waits until the backup has started before
+                  returning control to the user, as shown here:
+
+<programlisting>
+ndb_mgm&gt; <userinput>START BACKUP WAIT STARTED</userinput>
+Waiting for started, this may take several minutes
+Node 2: Backup 3 started from node 1
+ndb_mgm>
+</programlisting>
+                </para>
+              </listitem>
+
+              <listitem>
+                <indexterm>
+                  <primary>START BACKUP</primary>
+                  <secondary>WAIT COMPLETED</secondary>
+                </indexterm>
+
+                <indexterm>
+                  <primary>WAIT COMPLETED (START BACKUP command)</primary>
+                </indexterm>
+
+                <para>
+                  <userinput>WAIT COMPLETED</userinput> explicitly
+                  specifies the default behavior &mdash; that is, it
+                  causes the management client to wait until the backup
+                  process is complete before returning control to the
+                  user.
+                </para>
+              </listitem>
+
+            </itemizedlist>
+          </para>
+        </listitem>
+
+        <listitem>
+          <indexterm>
+            <primary>native backup and restore</primary>
+            <secondary>backup identifiers</secondary>
+          </indexterm>
+
+          <indexterm>
+            <primary>backup identifiers</primary>
+            <secondary>native backup and restore</secondary>
+          </indexterm>
+
           <para>
-            Backup messages were not recorded in the cluster log in
-            MySQL 5.1.12 or 5.1.13. The logging of backup operations was
-            restored in MySQL 5.1.14 (see Bug #24544).
+            When the backup has started the management client displays
+            this message:
+
+<programlisting>
+Backup <replaceable>backup_id</replaceable> started from node <replaceable>node_id</replaceable>
+</programlisting>
+
+            <replaceable>backup_id</replaceable> is the unique
+            identifier for this particular backup. This identifier is
+            saved in the cluster log, if it has not been configured
+            otherwise. <replaceable>node_id</replaceable> is the
+            identifier of the management server that is coordinating the
+            backup with the data nodes. At this point in the backup
+            process the cluster has received and processed the backup
+            request. It does not mean that the backup has finished. An
+            example of this statement is shown here:
+
+<programlisting>	
+Node 2: Backup 1 started from node 1
+</programlisting>
           </para>
-        </note>
-      </listitem>
+        </listitem>
 
-      <listitem>
-        <para>
-          When the backup is completed, the management client will
-          indicate this as shown here:
-        </para>
+        <listitem>
+          <para>
+            The management client indicates that the backup has
+            completed with a message in the following format:
 
 <programlisting>
-Node 1: Backup <replaceable>backup_id</replaceable> started from node <replaceable>management_node_id</replaceable> completed
- StartGCP: 417599 StopGCP: 417602
- #Records: 105957 #LogRecords: 0
- Data: 99719356 bytes Log: 0 bytes
+Backup <replaceable>backup_id</replaceable> started from node <replaceable>node_id</replaceable> completed
 </programlisting>
 
-        <para>
-          The values shown for <literal>StartGCP</literal>,
-          <literal>StopGCP</literal>, <literal>#Records</literal>,
-          <literal>#LogRecords</literal>, <literal>Data</literal>, and
-          <literal>Log</literal> will vary according to the specifics of
-          your cluster.
-        </para>
-      </listitem>
+            As is the case for the notification that the backup has
+            started, <replaceable>backup_id</replaceable> is the unique
+            identifier for this particular backup, and
+            <replaceable>node_id</replaceable> is the node ID of the
+            management server that is coordinating the backup with the
+            data nodes. This output is accompanied by additional
+            information including relevant global checkpoints, the
+            number of records backed up, and the size of the data, as
+            shown here:
 
-    </orderedlist>
+<programlisting>	
+Node 2: Backup 1 started from node 1 completed
+ StartGCP: 177 StopGCP: 180
+ #Records: 7362 #LogRecords: 0
+ Data: 453648 bytes Log: 0 bytes
+</programlisting>
+          </para>
+        </listitem>
 
+      </orderedlist>
+    </para>
+
     <para>
       Cluster backups are created by default in the
       <filename>BACKUP</filename> subdirectory of the


Modified: trunk/refman-5.2/mysql-cluster-backup.xml
===================================================================
--- trunk/refman-5.2/mysql-cluster-backup.xml	2007-10-22 17:09:08 UTC (rev 8234)
+++ trunk/refman-5.2/mysql-cluster-backup.xml	2007-10-22 17:20:58 UTC (rev 8235)
Changed blocks: 1, Lines Added: 171, Lines Deleted: 57; 9159 bytes

@@ -166,81 +166,195 @@
     <para>
       Creating a backup using the management client involves the
       following steps:
-    </para>
 
-    <orderedlist>
+      <orderedlist>
 
-      <listitem>
-        <para>
-          Start the management client (<command>ndb_mgm</command>).
-        </para>
-      </listitem>
+        <listitem>
+          <para>
+            Start the management client (<command>ndb_mgm</command>), if
+            it not running already.
+          </para>
+        </listitem>
 
-      <listitem>
-        <indexterm>
-          <primary>MySQL Cluster</primary>
-          <secondary><literal>START BACKUP</literal> command</secondary>
-        </indexterm>
+        <listitem>
+          <indexterm>
+            <primary>START BACKUP</primary>
+          </indexterm>
 
-        <indexterm>
-          <primary><literal>START BACKUP</literal> command (MySQL Cluster)</primary>
-        </indexterm>
+          <indexterm>
+            <primary>native backup and restore</primary>
+            <secondary>and management client</secondary>
+          </indexterm>
 
-        <para>
-          Execute the command <literal>START BACKUP</literal>.
-        </para>
-      </listitem>
+          <para>
+            Execute the <userinput>START BACKUP</userinput> command.
+            This produces several lines of output indicating the
+            progress of the backup, as shown here:
 
-      <listitem>
-        <para>
-          The management client responds as shown here:
-        </para>
-
 <programlisting>
+ndb_mgm&gt; <userinput>START BACKUP</userinput>
 Waiting for completed, this may take several minutes
-Node 1: Backup <replaceable>backup_id</replaceable> started from node <replaceable>management_node_id</replaceable>
+Node 2: Backup 1 started from node 1
+Node 2: Backup 1 started from node 1 completed
+ StartGCP: 177 StopGCP: 180
+ #Records: 7362 #LogRecords: 0
+ Data: 453648 bytes Log: 0 bytes
+ndb_mgm&gt;
 </programlisting>
+          </para>
 
-        <para>
-          Here, <replaceable>backup_id</replaceable> is the unique
-          identifier for this particular backup. (This identifier will
-          also be saved in the cluster log, if it has not been
-          configured otherwise.)
-          <replaceable>management_node_id</replaceable> is the node ID
-          of the management to which the management client is connected.
-        </para>
+          <para>
+            The first line printed indicates that the management client
+            is waiting for the backup to be completed before returning
+            control to the client. This behavior is the default for the
+            <literal>START BACKUP</literal> command, but can be changed.
+            To specify when <literal>START BACKUP</literal> command
+            should return control to the client, append
+            <literal>NOWAIT</literal>, <literal>WAIT STARTED</literal>,
+            or <literal>WAIT COMPLETED</literal> to the command. The
+            effects that each of these has differs as follows:
 
-        <para>
-          This means that the cluster has received and processed the
-          backup request. It does <emphasis>not</emphasis> mean that the
-          backup has been completed.
-        </para>
-      </listitem>
+            <itemizedlist>
 
-      <listitem>
-        <para>
-          When the backup is completed, the management client will
-          indicate this as shown here:
-        </para>
+              <listitem>
+                <indexterm>
+                  <primary>START BACKUP</primary>
+                  <secondary>NOWAIT</secondary>
+                </indexterm>
 
+                <indexterm>
+                  <primary>NOWAIT (START BACKUP command)</primary>
+                </indexterm>
+
+                <para>
+                  If <literal>NOWAIT</literal> is specified, the
+                  management client displays a prompt immediately, as
+                  seen here:
+
 <programlisting>
-Node 1: Backup <replaceable>backup_id</replaceable> started from node <replaceable>management_node_id</replaceable> completed
- StartGCP: 417599 StopGCP: 417602
- #Records: 105957 #LogRecords: 0
- Data: 99719356 bytes Log: 0 bytes
+ndb_mgm&gt; <userinput>START BACKUP NOWAIT</userinput>
+ndb_mgm&gt; 
 </programlisting>
 
-        <para>
-          The values shown for <literal>StartGCP</literal>,
-          <literal>StopGCP</literal>, <literal>#Records</literal>,
-          <literal>#LogRecords</literal>, <literal>Data</literal>, and
-          <literal>Log</literal> will vary according to the specifics of
-          your cluster.
-        </para>
-      </listitem>
+                  In this case, the management client can be used even
+                  while it prints progress information from the backup
+                  process.
+                </para>
+              </listitem>
 
-    </orderedlist>
+              <listitem>
+                <indexterm>
+                  <primary>START BACKUP</primary>
+                  <secondary>WAIT STARTED</secondary>
+                </indexterm>
 
+                <indexterm>
+                  <primary>WAIT STARTED (START BACKUP command)</primary>
+                </indexterm>
+
+                <para>
+                  With <literal>WAIT STARTED</literal> the management
+                  client waits until the backup has started before
+                  returning control to the user, as shown here:
+
+<programlisting>
+ndb_mgm&gt; <userinput>START BACKUP WAIT STARTED</userinput>
+Waiting for started, this may take several minutes
+Node 2: Backup 3 started from node 1
+ndb_mgm>
+</programlisting>
+                </para>
+              </listitem>
+
+              <listitem>
+                <indexterm>
+                  <primary>START BACKUP</primary>
+                  <secondary>WAIT COMPLETED</secondary>
+                </indexterm>
+
+                <indexterm>
+                  <primary>WAIT COMPLETED (START BACKUP command)</primary>
+                </indexterm>
+
+                <para>
+                  <userinput>WAIT COMPLETED</userinput> explicitly
+                  specifies the default behavior &mdash; that is, it
+                  causes the management client to wait until the backup
+                  process is complete before returning control to the
+                  user.
+                </para>
+              </listitem>
+
+            </itemizedlist>
+          </para>
+        </listitem>
+
+        <listitem>
+          <indexterm>
+            <primary>native backup and restore</primary>
+            <secondary>backup identifiers</secondary>
+          </indexterm>
+
+          <indexterm>
+            <primary>backup identifiers</primary>
+            <secondary>native backup and restore</secondary>
+          </indexterm>
+
+          <para>
+            When the backup has started the management client displays
+            this message:
+
+<programlisting>
+Backup <replaceable>backup_id</replaceable> started from node <replaceable>node_id</replaceable>
+</programlisting>
+
+            <replaceable>backup_id</replaceable> is the unique
+            identifier for this particular backup. This identifier is
+            saved in the cluster log, if it has not been configured
+            otherwise. <replaceable>node_id</replaceable> is the
+            identifier of the management server that is coordinating the
+            backup with the data nodes. At this point in the backup
+            process the cluster has received and processed the backup
+            request. It does not mean that the backup has finished. An
+            example of this statement is shown here:
+
+<programlisting>	
+Node 2: Backup 1 started from node 1
+</programlisting>
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            The management client indicates that the backup has
+            completed with a message in the following format:
+
+<programlisting>
+Backup <replaceable>backup_id</replaceable> started from node <replaceable>node_id</replaceable> completed
+</programlisting>
+
+            As is the case for the notification that the backup has
+            started, <replaceable>backup_id</replaceable> is the unique
+            identifier for this particular backup, and
+            <replaceable>node_id</replaceable> is the node ID of the
+            management server that is coordinating the backup with the
+            data nodes. This output is accompanied by additional
+            information including relevant global checkpoints, the
+            number of records backed up, and the size of the data, as
+            shown here:
+
+<programlisting>	
+Node 2: Backup 1 started from node 1 completed
+ StartGCP: 177 StopGCP: 180
+ #Records: 7362 #LogRecords: 0
+ Data: 453648 bytes Log: 0 bytes
+</programlisting>
+          </para>
+        </listitem>
+
+      </orderedlist>
+    </para>
+
     <para>
       Cluster backups are created by default in the
       <filename>BACKUP</filename> subdirectory of the


Thread
svn commit - mysqldoc@docsrva: r8235 - in trunk: refman-4.1 refman-5.0 refman-5.1 refman-5.2jon22 Oct