svn commit - mysqldoc@docsrva: r2359 - in trunk: refman-5.0 refman-5.1 refman-common

[jon]

Author: jstephens
Date: 2006-06-13 14:09:37 +0200 (Tue, 13 Jun 2006)
New Revision: 2359

Log:
Documenting --initial-start and --no-wait-nodes options for ndbd.

(Thanks, Tomas!)

Modified:
   trunk/refman-5.0/ndbcluster.xml
   trunk/refman-5.1/ndbcluster.xml
   trunk/refman-common/news-5.0.xml
   trunk/refman-common/news-5.1.xml

Modified: trunk/refman-5.0/ndbcluster.xml
===================================================================
--- trunk/refman-5.0/ndbcluster.xml	2006-06-13 07:24:40 UTC (rev 2358)
+++ trunk/refman-5.0/ndbcluster.xml	2006-06-13 12:09:37 UTC (rev 2359)
@@ -8922,6 +8922,74 @@
               already been created by the affected node.
             </para>
           </listitem>
+          
+          <listitem>
+            <para>
+              <option>--initial-start</option>
+            </para>
+            
+            <para>
+              This option is used when performing a partial initial
+              start of the cluster. Each node should be started with
+              this option, as well as <option>--no-wait-nodes</option>.
+            </para>
+            
+            <para>
+              For example, suppose you have a 4-node cluster whose data
+              nodes have the IDs 2, 3, 4, and 5, and you wish to perform
+              a partial initial start using only nodes 2, 4, and 5
+              &mdash; that is, omitting node 3:
+            </para>
+            
+<programlisting>
+ndbd --ndbd-nodeid=2 --no-wait-nodes=3 --initial-start
+ndbd --ndbd-nodeid=4 --no-wait-nodes=3 --initial-start
+ndbd --ndbd-nodeid=5 --no-wait-nodes=3 --initial-start
+</programlisting>
+            
+            <para>
+              This option was added in MySQL 5.1.9.
+            </para>
+          </listitem>
+          
+          <listitem>
+            <para>
+             
<option>--nowait-nodes=<replaceable>node_id_1</replaceable>[,
+                <replaceable>node_id_2</replaceable>[, ...]]</option>
+            </para>
+            
+            <para>
+              This option takes a list of data nodes which for which the
+              cluster will not wait for before starting.
+            </para>
+            
+            <para>
+              This can be used to start the cluster in a
+              partitioned state. For example, to start the cluster with
+              only half of the data nodes (nodes 2, 3, 4, and 5) running
+              in a 4-node cluster, you can start each
+              <command>ndbd</command> process with
+              <option>--nowait-nodes=3,5</option>. In this case, the
+              cluster starts as soon as nodes 2 and 4 connect, and does
+              <emphasis>not</emphasis> wait
+              <literal>StartPartitionedTimeout</literal> milliseconds
+              for nodes 3 and 5 to connect as it would otherwise.
+            </para>
+            
+            <para>
+              If you wanted to start up the same cluster as in the
+              previous example without one <command>ndbd</command>
+              &mdash; say, for example, that the host machine for node
+              3 has suffered a hardware failure &mdash; then start
+              nodes 2, 4, and 5 with <option>--no-wait-nodes=3</option>.
+              Then the cluster will start as soon as nodes 2, 4, and 5
+              connect and will not wait for node 3 to start.
+            </para>
+            
+            <para>
+              This option was added in MySQL 5.1.9.
+            </para>
+          </listitem>
 
           <listitem>
             <para>

Modified: trunk/refman-5.1/ndbcluster.xml
===================================================================
--- trunk/refman-5.1/ndbcluster.xml	2006-06-13 07:24:40 UTC (rev 2358)
+++ trunk/refman-5.1/ndbcluster.xml	2006-06-13 12:09:37 UTC (rev 2359)
@@ -8872,11 +8872,6 @@
               <option>--initial</option>
             </para>
 
-            <remark role="todo">
-              "Initial start" sounds clumsy. See if there's a better way
-              to word this. [js]
-            </remark>
-
             <para>
               Instructs <command>ndbd</command> to perform an initial
               start. An initial start erases any files created for
@@ -8927,6 +8922,74 @@
               already been created by the affected node.
             </para>
           </listitem>
+          
+          <listitem>
+            <para>
+              <option>--initial-start</option>
+            </para>
+            
+            <para>
+              This option is used when performing a partial initial
+              start of the cluster. Each node should be started with
+              this option, as well as <option>--no-wait-nodes</option>.
+            </para>
+            
+            <para>
+              For example, suppose you have a 4-node cluster whose data
+              nodes have the IDs 2, 3, 4, and 5, and you wish to perform
+              a partial initial start using only nodes 2, 4, and 5
+              &mdash; that is, omitting node 3:
+            </para>
+            
+<programlisting>
+ndbd --ndbd-nodeid=2 --no-wait-nodes=3 --initial-start
+ndbd --ndbd-nodeid=4 --no-wait-nodes=3 --initial-start
+ndbd --ndbd-nodeid=5 --no-wait-nodes=3 --initial-start
+</programlisting>
+            
+            <para>
+              This option was added in MySQL 5.1.9.
+            </para>
+          </listitem>
+          
+          <listitem>
+            <para>
+             
<option>--nowait-nodes=<replaceable>node_id_1</replaceable>[,
+                <replaceable>node_id_2</replaceable>[, ...]]</option>
+            </para>
+            
+            <para>
+              This option takes a list of data nodes which for which the
+              cluster will not wait for before starting.
+            </para>
+            
+            <para>
+              This can be used to start the cluster in a
+              partitioned state. For example, to start the cluster with
+              only half of the data nodes (nodes 2, 3, 4, and 5) running
+              in a 4-node cluster, you can start each
+              <command>ndbd</command> process with
+              <option>--nowait-nodes=3,5</option>. In this case, the
+              cluster starts as soon as nodes 2 and 4 connect, and does
+              <emphasis>not</emphasis> wait
+              <literal>StartPartitionedTimeout</literal> milliseconds
+              for nodes 3 and 5 to connect as it would otherwise.
+            </para>
+            
+            <para>
+              If you wanted to start up the same cluster as in the
+              previous example without one <command>ndbd</command>
+              &mdash; say, for example, that the host machine for node
+              3 has suffered a hardware failure &mdash; then start
+              nodes 2, 4, and 5 with <option>--no-wait-nodes=3</option>.
+              Then the cluster will start as soon as nodes 2, 4, and 5
+              connect and will not wait for node 3 to start.
+            </para>
+            
+            <para>
+              This option was added in MySQL 5.1.9.
+            </para>
+          </listitem>
 
           <listitem>
             <para>

Modified: trunk/refman-common/news-5.0.xml
===================================================================
--- trunk/refman-common/news-5.0.xml	2006-06-13 07:24:40 UTC (rev 2358)
+++ trunk/refman-common/news-5.0.xml	2006-06-13 12:09:37 UTC (rev 2359)
@@ -1341,6 +1341,17 @@
           all configured data nodes first. (Bug #18606)
         </para>
       </listitem>
+      
+      <listitem>
+        <para>
+          <literal>NDB Cluster</literal>: A new
+          <option>--nowait-nodes</option> startup option for 
+          <command>ndbd</command> makes it possible to
+          <quote>skip</quote> specific nodes without waiting for them to
+          start when starting the cluster. See 
+          <xref linkend="ndbd-command-options"/>.  
+        </para>
+      </listitem>
 
       <listitem>
         <para>

Modified: trunk/refman-common/news-5.1.xml
===================================================================
--- trunk/refman-common/news-5.1.xml	2006-06-13 07:24:40 UTC (rev 2358)
+++ trunk/refman-common/news-5.1.xml	2006-06-13 12:09:37 UTC (rev 2359)
@@ -2428,6 +2428,17 @@
           #17631)
         </para>
       </listitem>
+      
+      <listitem>
+        <para>
+          <literal>NDB Cluster</literal>: A new
+          <option>--nowait-nodes</option> startup option for 
+          <command>ndbd</command> makes it possible to
+          <quote>skip</quote> specific nodes without waiting for them to
+          start when starting the cluster. See 
+          <xref linkend="ndbd-command-options"/>.  
+        </para>
+      </listitem>
 
       <listitem>
         <para>