List:Commits« Previous MessageNext Message »
From:jon.stephens Date:June 21 2011 1:57pm
Subject:svn commit - mysqldoc@oter02: r26568 - trunk/ndbapi
View as plain text  
Author: js221926
Date: 2011-06-21 15:57:08 +0200 (Tue, 21 Jun 2011)
New Revision: 26568

Log:

General revisions; improve formatting



Modified:
   trunk/ndbapi/mgm-api.xml
   trunk/ndbapi/ndb-internals.xml
   trunk/ndbapi/ndbapi.xml


Modified: trunk/ndbapi/mgm-api.xml
===================================================================
--- trunk/ndbapi/mgm-api.xml	2011-06-21 13:05:43 UTC (rev 26567)
+++ trunk/ndbapi/mgm-api.xml	2011-06-21 13:57:08 UTC (rev 26568)
Changed blocks: 6, Lines Added: 16, Lines Deleted: 20; 3103 bytes

@@ -13,7 +13,7 @@
       This chapter discusses the MySQL Cluster Management API, a C
       language API that is used for administrative tasks such as
       starting and stopping Cluster nodes, backups, and logging. It also
-      covers MGM concepts, programming constructs, and event types.
+      covers MGM API concepts, programming constructs, and event types.
     </para>
 
   </abstract>

@@ -89,7 +89,7 @@
 
     <para>
       Here is an example using the MGM API (without error handling for
-      brevity's sake):
+      brevity&apos;s sake):
     </para>
 
 <programlisting>

@@ -226,15 +226,12 @@
         <xref linkend="mgm-functions-log-events"/>.
       </para>
 
-      <note>
-        <para>
-          Available log event types are listed in
-          <xref linkend="mgm-ndb-logevent-type"/>, as well as in the
-          file
-          <filename>/storage/ndb/include/mgmapi/ndb_logevent.h</filename>
-          in the MySQL 5.1 sources.
-        </para>
-      </note>
+      <para>
+        Available log event types are listed in
+        <xref linkend="mgm-ndb-logevent-type"/>, as well as in the file
+        <filename>/storage/ndb/include/mgmapi/ndb_logevent.h</filename>
+        in the MySQL 5.1 sources.
+      </para>
 
     </section>
 

@@ -3311,9 +3308,9 @@
 
           <para>
             Normally, you cannot use any of these functions to stop a
-            node while other nodes are starting. Beginning
-            with MySQL Cluster NDB 7.0.21 and MySQL Cluster NDB 7.1.10,
-            you can override this restriction using
+            node while other nodes are starting. Beginning with MySQL
+            Cluster NDB 7.0.21 and MySQL Cluster NDB 7.1.10, you can
+            override this restriction using
             <literal role="mgmapi">ndb_mgm_stop4()</literal> with the
             <replaceable>force</replaceable> parameter set to 1.
           </para>

@@ -3334,12 +3331,12 @@
             </para>
 
           </formalpara>
-          
+
           <para>
             Normally, you cannot use any of these functions to restart a
-            node while other nodes are starting. Beginning
-            with MySQL Cluster NDB 7.0.21 and MySQL Cluster NDB 7.1.10,
-            you can override this restriction using
+            node while other nodes are starting. Beginning with MySQL
+            Cluster NDB 7.0.21 and MySQL Cluster NDB 7.1.10, you can
+            override this restriction using
             <literal role="mgmapi">ndb_mgm_restart4()</literal> with the
             <replaceable>force</replaceable> parameter set to 1.
           </para>

@@ -4450,8 +4447,7 @@
               <literal>0</literal> means that the node will not be
               restarted.
             </para>
-            
-            
+
             <para>
               Beginning with MySQL Cluster NDB 7.0.21 and MySQL Cluster
               NDB 7.1.10, setting <replaceable>force</replaceable> equal


Modified: trunk/ndbapi/ndb-internals.xml
===================================================================
--- trunk/ndbapi/ndb-internals.xml	2011-06-21 13:05:43 UTC (rev 26567)
+++ trunk/ndbapi/ndb-internals.xml	2011-06-21 13:57:08 UTC (rev 26568)
Changed blocks: 2, Lines Added: 131, Lines Deleted: 146; 14976 bytes

@@ -41,9 +41,9 @@
 
         <para>
           A MySQL Cluster data node&apos;s
-          <literal role="ndbparam:ndbd">DataDir</literal> contains at a
-          minimum 3 files. These are named as shown here, where
-          <replaceable>node_id</replaceable> is the node ID:
+          <literal role="ndbparam:ndbd">DataDir</literal> contains at
+          least 3 files. These are named as shown in the following list,
+          where <replaceable>node_id</replaceable> is the node ID:
         </para>
 
         <itemizedlist>

@@ -133,189 +133,174 @@
           node ID. It contains the following files and directories:
         </para>
 
+        <para>
+          <emphasis role="bold">Files</emphasis>:
+        </para>
+
         <itemizedlist>
 
           <listitem>
             <para>
-              <emphasis role="bold">Files</emphasis>:
+              <filename>data-<replaceable>nodeid</replaceable>.dat</filename>
             </para>
+          </listitem>
 
-            <itemizedlist>
+          <listitem>
+            <para>
+              <filename>undo-<replaceable>nodeid</replaceable>.dat</filename>
+            </para>
+          </listitem>
 
-              <listitem>
-                <para>
-                  <filename>data-<replaceable>nodeid</replaceable>.dat</filename>
-                </para>
-              </listitem>
+        </itemizedlist>
 
-              <listitem>
-                <para>
-                  <filename>undo-<replaceable>nodeid</replaceable>.dat</filename>
-                </para>
-              </listitem>
+        <para>
+          <emphasis role="bold">Directories</emphasis>:
+        </para>
 
-            </itemizedlist>
-          </listitem>
+        <itemizedlist>
 
           <listitem>
             <para>
-              <emphasis role="bold">Directories</emphasis>:
+              <filename>LCP</filename>: In MySQL Cluster NDB 6.3.8 and
+              later MySQL Cluster releases, this directory holds 2
+              subdirectories, named <filename>0</filename> and
+              <filename>1</filename>, each of which which contain locals
+              checkpoint data files, one per local checkpoint (see
+              <xref linkend="mysql-cluster-config-lcp-params"/>).
             </para>
 
-            <itemizedlist>
+            <para>
+              Prior to MySQL Cluster NDB 6.3.8, this directory contained
+              3 subdirectories, named <filename>0</filename>,
+              <filename>1</filename>, and <filename>2</filename>, due to
+              the fact that <literal>NDB</literal> saved 3 local
+              checkpoints to disk (rather than 2) in these earlier
+              versions of MySQL Cluster.
+            </para>
 
-              <listitem>
-                <para>
-                  <filename>LCP</filename>: In MySQL Cluster NDB 6.3.8
-                  and later MySQL Cluster releases, this directory holds
-                  2 subdirectories, named <filename>0</filename> and
-                  <filename>1</filename>, each of which which contain
-                  locals checkpoint data files, one per local checkpoint
-                  (see
-                  <xref linkend="mysql-cluster-config-lcp-params"/>).
-                </para>
+            <para>
+              These subdirectories each contain a number of files whose
+              names follow the pattern
+              <filename>T<replaceable>N</replaceable>F<replaceable>M</replaceable>.Data</filename>,
+              where <replaceable>N</replaceable> is a table ID and and M
+              is a fragment number. Each data node typically has one
+              primary fragment and one backup fragment. This means that,
+              for a MySQL Cluster having 2 data nodes, and with
+              <literal role="ndbparam:ndbd">NoOfReplicas</literal> equal
+              to 2, <replaceable>M</replaceable> is either 0 to 1. For a
+              4-node cluster with
+              <literal role="ndbparam:ndbd">NoOfReplicas</literal> equal
+              to 2, <replaceable>M</replaceable> is either 0 or 2 on
+              node group 1, and either 1 or 3 on node group 2.
+            </para>
 
-                <para>
-                  Prior to MySQL Cluster NDB 6.3.8, this directory
-                  contained 3 subdirectories, named
-                  <filename>0</filename>, <filename>1</filename>, and
-                  <filename>2</filename>, due to the fact that
-                  <literal>NDB</literal> saved 3 local checkpoints to
-                  disk (rather than 2) in these earlier versions of
-                  MySQL Cluster.
-                </para>
+            <para>
+              In MySQL Cluster NDB 7.0 and later, when using
+              <command>ndbmtd</command> there may be more than one
+              primary fragment per node. In this case,
+              <replaceable>M</replaceable> is a number in the range of 0
+              to the number of LQH worker threads in the entire cluster,
+              less 1. The number of fragments on each data node is equal
+              to the number of LQH on that node times
+              <literal role="ndbparam:ndbd">NoOfReplicas</literal>.
+            </para>
 
-                <para>
-                  These subdirectories each contain a number of files
-                  whose names follow the pattern
-                  <filename>T<replaceable>N</replaceable>F<replaceable>M</replaceable>.Data</filename>,
-                  where <replaceable>N</replaceable> is a table ID and
-                  and M is a fragment number. Each data node typically
-                  has one primary fragment and one backup fragment. This
-                  means that, for a MySQL Cluster having 2 data nodes,
-                  and with
-                  <literal role="ndbparam:ndbd">NoOfReplicas</literal>
-                  equal to 2, <replaceable>M</replaceable> is either 0
-                  to 1. For a 4-node cluster with
-                  <literal role="ndbparam:ndbd">NoOfReplicas</literal>
-                  equal to 2, <replaceable>M</replaceable> is either 0
-                  or 2 on node group 1, and either 1 or 3 on node group
-                  2.
-                </para>
+            <note>
+              <para>
+                Increasing
+                <literal role="ndbparam:ndbmtd">MaxNoOfExecutionThreads</literal>
+                does not change the number of fragments used by existing
+                tables; only newly-created tables automatically use the
+                new fragment count. To force the new fragment count to
+                be used by an existing table after increasing
+                <literal role="ndbparam:ndbmtd">MaxNoOfExecutionThreads</literal>,
+                you must perform an
+                <literal role="stmt" condition="alter-table-partition-operations">ALTER
+                TABLE ... REORGANIZE PARTITION</literal> statement (just
+                as when adding new node groups in MySQL Cluster NDB 7.0
+                and later).
+              </para>
+            </note>
+          </listitem>
 
-                <para>
-                  In MySQL Cluster NDB 7.0 and later, when using
-                  <command>ndbmtd</command> there may be more than one
-                  primary fragment per node. In this case,
-                  <replaceable>M</replaceable> is a number in the range
-                  of 0 to the number of LQH worker threads in the entire
-                  cluster, less 1. The number of fragments on each data
-                  node is equal to the number of LQH on that node times
-                  <literal role="ndbparam:ndbd">NoOfReplicas</literal>.
-                </para>
+          <listitem>
+            <para>
+              Directories named <filename>D1</filename> and
+              <filename>D2</filename>, each of which contains 2
+              subdirectories:
+            </para>
 
-                <note>
-                  <para>
-                    Increasing
-                    <literal role="ndbparam:ndbmtd">MaxNoOfExecutionThreads</literal>
-                    does not change the number of fragments used by
-                    existing tables; only newly-created tables
-                    automatically use the new fragment count. To force
-                    the new fragment count to be used by an existing
-                    table after increasing
-                    <literal role="ndbparam:ndbmtd">MaxNoOfExecutionThreads</literal>,
-                    you must perform an
-                    <literal role="stmt" condition="alter-table">ALTER
-                    TABLE ... REORGANIZE PARTITION</literal> statement
-                    (just as when adding new node groups in MySQL
-                    Cluster NDB 7.0 and later).
-                  </para>
-                </note>
-              </listitem>
+            <itemizedlist>
 
               <listitem>
                 <para>
-                  Directories named <filename>D1</filename> and
-                  <filename>D2</filename>, each of which contains 2
-                  subdirectories:
+                  <filename>DBDICT</filename>: Contains data dictionary
+                  information. This is stored in:
                 </para>
 
                 <itemizedlist>
 
                   <listitem>
                     <para>
-                      <filename>DBDICT</filename>: Contains data
-                      dictionary information. This is stored in:
+                      The file <filename>P0.SchemaLog</filename>
                     </para>
-
-                    <itemizedlist>
-
-                      <listitem>
-                        <para>
-                          The file <filename>P0.SchemaLog</filename>
-                        </para>
-                      </listitem>
-
-                      <listitem>
-                        <para>
-                          A set of directories <filename>T0</filename>,
-                          <filename>T1</filename>,
-                          <filename>T2</filename>, ..., each of which
-                          contains an <filename>S0.TableList</filename>
-                          file.
-                        </para>
-                      </listitem>
-
-                    </itemizedlist>
                   </listitem>
 
                   <listitem>
                     <para>
-                      Directories named <filename>D8</filename>,
-                      <filename>D9</filename>, <filename>D10</filename>,
-                      and <filename>D11</filename>, each of which
-                      contains a directory named
-                      <filename>DBLQH</filename>.
+                      A set of directories <filename>T0</filename>,
+                      <filename>T1</filename>, <filename>T2</filename>,
+                      ..., each of which contains an
+                      <filename>S0.TableList</filename> file.
                     </para>
+                  </listitem>
 
-                    <para>
-                      In each case, the <filename>DBLQH</filename>
-                      directory contains <replaceable>N</replaceable>
-                      files named <filename>S0.Fraglog</filename>,
-                      <filename>S1.FragLog</filename>,
-                      <filename>S2.FragLog</filename>, ...,
-                      <filename>S<replaceable>N</replaceable>.FragLog</filename>,
-                      where <replaceable>N</replaceable> is equal to the
-                      value of the
-                      <literal role="ndbparam:ndbd">NoOfFragmentLogFiles</literal>
-                      configuration parameter.
-                    </para>
+                </itemizedlist>
+              </listitem>
 
-                    <para>
-                      The <filename>DBLQH</filename> directories also
-                      contain the redo log files.
-                    </para>
-                  </listitem>
+              <listitem>
+                <para>
+                  Directories named <filename>D8</filename>,
+                  <filename>D9</filename>, <filename>D10</filename>, and
+                  <filename>D11</filename>, each of which contains a
+                  directory named <filename>DBLQH</filename>.
+                </para>
 
-                  <listitem>
-                    <para>
-                      <filename>DBDIH</filename>: This directory
-                      contains the file
-                      <filename>P<replaceable>X</replaceable>.sysfile</filename>,
-                      which records information such as the last GCI,
-                      restart status, and node group membership of each
-                      node; its structure is defined in
-                      <filename>storage/ndb/src/kernel/blocks/dbdih/Sysfile.hpp</filename>
-                      in the MySQL Cluster source tree. In addition, the
-                      <filename>S<replaceable>X</replaceable>.FragList</filename>
-                      files keep records of the fragments belonging to
-                      each table.
-                    </para>
-                  </listitem>
+                <para>
+                  In each case, the <filename>DBLQH</filename> directory
+                  contains <replaceable>N</replaceable> files named
+                  <filename>S0.Fraglog</filename>,
+                  <filename>S1.FragLog</filename>,
+                  <filename>S2.FragLog</filename>, ...,
+                  <filename>S<replaceable>N</replaceable>.FragLog</filename>,
+                  where <replaceable>N</replaceable> is equal to the
+                  value of the
+                  <literal role="ndbparam:ndbd">NoOfFragmentLogFiles</literal>
+                  configuration parameter.
+                </para>
 
-                </itemizedlist>
+                <para>
+                  The <filename>DBLQH</filename> directories also
+                  contain the redo log files.
+                </para>
               </listitem>
 
+              <listitem>
+                <para>
+                  <filename>DBDIH</filename>: This directory contains
+                  the file
+                  <filename>P<replaceable>X</replaceable>.sysfile</filename>,
+                  which records information such as the last GCI,
+                  restart status, and node group membership of each
+                  node; its structure is defined in
+                  <filename>storage/ndb/src/kernel/blocks/dbdih/Sysfile.hpp</filename>
+                  in the MySQL Cluster source tree. In addition, the
+                  <filename>S<replaceable>X</replaceable>.FragList</filename>
+                  files keep records of the fragments belonging to each
+                  table.
+                </para>
+              </listitem>
+
             </itemizedlist>
           </listitem>
 


Modified: trunk/ndbapi/ndbapi.xml
===================================================================
--- trunk/ndbapi/ndbapi.xml	2011-06-21 13:05:43 UTC (rev 26567)
+++ trunk/ndbapi/ndbapi.xml	2011-06-21 13:57:08 UTC (rev 26568)
Changed blocks: 5, Lines Added: 9, Lines Deleted: 6; 2254 bytes

@@ -27,7 +27,8 @@
 
       <para>
         This guide provides information for developers wishing to
-        develop applications against MySQL Cluster. These include:
+        develop applications against MySQL Cluster. Such applications
+        include those shown in the following list:
       </para>
 
       <para>

@@ -46,7 +47,7 @@
 
           <listitem>
             <para>
-              the C-language <firstterm>MGM API</firstterm> for
+              The C-language <firstterm>MGM API</firstterm> for
               communicating with and controlling MySQL Cluster
               management servers
             </para>

@@ -69,7 +70,7 @@
         references, practical examples, common problems, and tips for
         using these APIs in applications. It also contains information
         about NDB internals that may be of interest to developers
-        working with <literal>NDBCLUSTER</literal>, such as
+        working with <literal role="se">NDBCLUSTER</literal>, such as
         communication protocols employed between nodes, filesystems used
         by data nodes, and error messages.
       </para>

@@ -78,8 +79,10 @@
         The information presented in this guide is current for recent
         MySQL Cluster NDB 6.2, NDB 6.3, NDB 7.0, and NDB 7.1 releases.
         You should be aware that there have been significant changes in
-        the NDB API, MGM API, and other particulars in MySQL Cluster
-        versions since MySQL 5.1.12.
+        the NDB API, MGM API, and other aspects of MySQL Cluster in
+        versions since MySQL 5.1.12, and especially since MySQL 5.1.24
+        (after which MySQL Cluster was no longer provided or supported
+        as part of the MySQL 5.1 Server).
       </para>
 
     </abstract>

@@ -99,7 +102,7 @@
       <para>
         This chapter contains information about the NDB API, which is
         used to write applications that access data in the
-        <literal>NDBCLUSTER</literal> storage engine.
+        <literal role="se">NDBCLUSTER</literal> storage engine.
       </para>
 
     </abstract>


Thread
svn commit - mysqldoc@oter02: r26568 - trunk/ndbapijon.stephens21 Jun