svn commit - mysqldoc@docsrva: r6747 - trunk/ndbapi

[jon]

Author: jstephens
Date: 2007-06-10 19:22:37 +0200 (Sun, 10 Jun 2007)
New Revision: 6747

Log:

More work on NDB Kernel Blocks section (file descriptions).

A couple of minor additions to the glossary.



Modified:
   trunk/ndbapi/ndb-internals.xml


Modified: trunk/ndbapi/ndb-internals.xml
===================================================================
--- trunk/ndbapi/ndb-internals.xml	2007-06-10 15:04:41 UTC (rev 6746)
+++ trunk/ndbapi/ndb-internals.xml	2007-06-10 17:22:37 UTC (rev 6747)
Changed blocks: 6, Lines Added: 297, Lines Deleted: 80; 13638 bytes

@@ -8469,45 +8469,97 @@
         <itemizedlist>
 
           <listitem>
-            <para>
-              <filename>Backup.cpp</filename>
-            </para>
+            <formalpara>
+
+              <title><filename>Backup.cpp</filename></title>
+
+              <para>
+                Defines methods for node signal handing; also provides
+                output methods for backup status messages to user.
+              </para>
+
+            </formalpara>
           </listitem>
 
           <listitem>
-            <para>
-              <filename>BackupFormat.hpp</filename>
-            </para>
+            <formalpara>
+
+             
<title><filename>BackupFormat.hpp</filename></title>
+
+              <para>
+                Defines the formats used for backup data,
+                <filename>.CTL</filename>, and log files.
+              </para>
+
+            </formalpara>
           </listitem>
 
           <listitem>
-            <para>
-              <filename>Backup.hpp</filename>
-            </para>
+            <formalpara>
+
+              <title><filename>Backup.hpp</filename></title>
+
+              <para>
+                Defines the <literal>Backup</literal> class.
+              </para>
+
+            </formalpara>
           </listitem>
 
           <listitem>
-            <para>
-              <filename>BackupInit.cpp</filename>
-            </para>
+            <formalpara>
+
+              <title><filename>BackupInit.cpp</filename></title>
+
+              <para>
+                Actual <literal>Backup</literal> class constructor is
+                found here.
+              </para>
+
+            </formalpara>
           </listitem>
 
           <listitem>
-            <para>
-              <filename>Backup.txt</filename>
-            </para>
+            <formalpara>
+
+              <title><filename>Backup.txt</filename></title>
+
+              <para>
+                Contains a backup signal diagram (text format). Somewhat
+                dated (from 2003), but still potenitally useful to
+                understanding the sequence of events that is followed
+                during backups.
+              </para>
+
+            </formalpara>
           </listitem>
 
           <listitem>
-            <para>
-              <filename>FsBuffer.hpp</filename>
-            </para>
+            <formalpara>
+
+              <title><filename>FsBuffer.hpp</filename></title>
+
+              <para>
+                Defines the <literal>FsBuffer</literal> class, which
+                implements the circular data buffer that is used
+                (together with the NDB filesystem) for reading and
+                writing backup data and logs.
+              </para>
+
+            </formalpara>
           </listitem>
 
           <listitem>
-            <para>
-              <filename>read.cpp</filename>
-            </para>
+            <formalpara>
+
+              <title><filename>read.cpp</filename></title>
+
+              <para>
+                Contains some utility functions for reading log and
+                checkpoint files to <literal>STDOUT</literal>.
+              </para>
+
+            </formalpara>
           </listitem>
 
         </itemizedlist>

@@ -8530,15 +8582,28 @@
         <itemizedlist>
 
           <listitem>
-            <para>
-              <filename>Cmvmi.cpp</filename>
-            </para>
+            <formalpara>
+
+              <title><filename>Cmvmi.cpp</filename></title>
+
+              <para>
+                Implements communication and reporting methods for the
+                <literal>Cmvmi</literal> class.
+              </para>
+
+            </formalpara>
           </listitem>
 
           <listitem>
-            <para>
-              <filename>Cmvmi.hpp</filename>
-            </para>
+            <formalpara>
+
+              <title><filename>Cmvmi.hpp</filename></title>
+
+              <para>
+                Defines the <literal>Cmvmi</literal> class.
+              </para>
+
+            </formalpara>
           </listitem>
 
         </itemizedlist>

@@ -8565,21 +8630,42 @@
         <itemizedlist>
 
           <listitem>
-            <para>
-              <filename>Dbacc.hpp</filename>
-            </para>
+            <formalpara>
+
+              <title><filename>Dbacc.hpp</filename></title>
+
+              <para>
+                Defines the <literal>Dbacc</literal> class, along with
+                structures for operation, scan, table, and other
+                records.
+              </para>
+
+            </formalpara>
           </listitem>
 
           <listitem>
-            <para>
-              <filename>DbaccInit.cpp</filename>
-            </para>
+            <formalpara>
+
+              <title><filename>DbaccInit.cpp</filename></title>
+
+              <para>
+                <literal>Dbacc</literal> class constructor and
+                destructor; methods for initialising data and records.
+              </para>
+
+            </formalpara>
           </listitem>
 
           <listitem>
-            <para>
-              <filename>DbaccMain.cpp</filename>
-            </para>
+            <formalpara>
+
+              <title><filename>DbaccMain.cpp</filename></title>
+
+              <para>
+                Implements <literal>Dbacc</literal> class methods.
+              </para>
+
+            </formalpara>
           </listitem>
 
         </itemizedlist>

@@ -8623,96 +8709,196 @@
         dictionary information is replicated to all
         <literal>DICT</literal> blocks in the cluster. This is the only
         block other than <literal>DBTC</literal> to which applications
-        can send requests. <literal>DBDICT</literal> responsible for
-        managing metadata via the cluster's master node such as table
-        and index definitions, as well as many Disk Data operations.
-        This block contains the following files:
+        can send direct requests. <literal>DBDICT</literal> is
+        responsible for managing metadata (via the cluster's master
+        node) such as table and index definitions, as well as many Disk
+        Data operations. This block contains the following files:
 
         <itemizedlist>
 
           <listitem>
-            <para>
-              <filename>CreateIndex.txt</filename>
-            </para>
+            <formalpara>
+
+              <title><filename>CreateIndex.txt</filename></title>
+
+              <para>
+                Contains notes about processes for creating, altering,
+                and dropping indexes and triggers.
+              </para>
+
+            </formalpara>
           </listitem>
 
           <listitem>
-            <para>
-              <filename>Dbdict.cpp</filename>
-            </para>
+            <formalpara>
+
+              <title><filename>Dbdict.cpp</filename></title>
+
+              <para>
+                Implements structure for event metadata records (for
+                <literal>NDB$EVENTS_0</literal>), as well as methods for
+                system start and restart, table and schema file
+                handling, and packing table data into pages.
+                Functionality for determining node status and handling
+                node failures is also found here. In addition, this file
+                implements data and other initialisation routines for
+                <literal>Dbdict</literal>.
+              </para>
+
+            </formalpara>
           </listitem>
 
           <listitem>
-            <para>
-              <filename>DictLock.txt</filename>
-            </para>
+            <formalpara>
+
+              <title><filename>DictLock.txt</filename></title>
+
+              <para>
+                Implementation notes: Describes locking of the master
+                node's <literal>DICT</literal> against schema
+                operations.
+              </para>
+
+            </formalpara>
           </listitem>
 
           <listitem>
-            <para>
-              <filename>printSchemaFile.cpp</filename>
-            </para>
+            <formalpara>
+
+             
<title><filename>printSchemaFile.cpp</filename></title>
+
+              <para>
+                Contains the source for the
+                <command>ndb_print_schema_file</command> utility,
+                described in
+                <xref linkend="mysql-cluster-utilities-ndb-print-schema-file"/>.
+              </para>
+
+            </formalpara>
           </listitem>
 
           <listitem>
-            <para>
-              <filename>Slave_AddTable.sfl</filename>
-            </para>
+            <formalpara>
+
+             
<title><filename>Slave_AddTable.sfl</filename></title>
+
+              <para>
+                A signal log trace of a table creation operation for
+                <literal>DBDICT</literal> on a non-master node.
+              </para>
+
+            </formalpara>
           </listitem>
 
           <listitem>
-            <para>
-              <filename>CreateTable.new.txt</filename>
-            </para>
+            <formalpara>
+
+              <title><filename>CreateTable.txt</filename></title>
+
+              <para>
+                Notes outlining the table creation process (dated).
+              </para>
+
+            </formalpara>
           </listitem>
 
           <listitem>
-            <para>
-              <filename>Dbdict.hpp</filename>
-            </para>
+            <formalpara>
+
+             
<title><filename>CreateTable.new.txt</filename></title>
+
+              <para>
+                Notes outlining the table creation process (updated
+                version of <filename>CreateTable.txt</filename>).
+              </para>
+
+            </formalpara>
           </listitem>
 
           <listitem>
-            <para>
-              <filename>DropTable.txt</filename>
-            </para>
+            <formalpara>
+
+              <title><filename>Dbdict.hpp</filename></title>
+
+              <para>
+                Defines the <literal>Dbdict</literal> class; also
+                creates the <literal>NDB$EVENTS_0</literal> table. Also
+                defines a number of structures such as table and index
+                records, as well as for table records.
+              </para>
+
+            </formalpara>
           </listitem>
 
           <listitem>
-            <para>
-              <filename>CreateTable.txt</filename>
-            </para>
+            <formalpara>
+
+              <title><filename>DropTable.txt</filename></title>
+
+              <para>
+                Implementation notes for the process of dropping a
+                table.
+              </para>
+
+            </formalpara>
           </listitem>
 
           <listitem>
-            <para>
-              <filename>Dbdict.txt</filename>
-            </para>
+            <formalpara>
+
+              <title><filename>Dbdict.txt</filename></title>
+
+              <para>
+                Implementation notes for creating and dropping events
+                and <literal>NdbEventOperation</literal> objects (see
+                <xref linkend="class-ndbeventoperation"/>).
+              </para>
+
+            </formalpara>
           </listitem>
 
           <listitem>
-            <para>
-              <filename>Event.txt</filename>
-            </para>
+            <formalpara>
+
+              <title><filename>Event.txt</filename></title>
+
+              <para>
+                A copy of <filename>Dbdict.txt</filename>.
+              </para>
+
+            </formalpara>
           </listitem>
 
           <listitem>
-            <para>
-              <filename>Master_AddTable.sfl</filename>
-            </para>
+            <formalpara>
+
+             
<title><filename>Master_AddTable.sfl</filename></title>
+
+              <para>
+                A signal log trace of a table creation operation for
+                <literal>DBDICT</literal> on the master node.
+              </para>
+
+            </formalpara>
           </listitem>
 
           <listitem>
-            <para>
-              <filename>SchemaFile.hpp</filename>
-            </para>
+            <formalpara>
+
+              <title><filename>SchemaFile.hpp</filename></title>
+
+              <para>
+                Defines the structure of a schema file.
+              </para>
+
+            </formalpara>
           </listitem>
 
         </itemizedlist>
       </para>
 
       <para>
-        This block is implenented as the <literal>Dbdict</literal>
+        This block is implemented as the <literal>Dbdict</literal>
         class, defined in
         <filename>storage/ndb/src/kernel/blocks/dblqh/Dbdict.hpp</filename>.
       </para>

@@ -9732,6 +9918,23 @@
       <listitem>
         <formalpara>
 
+          <title>API node</title>
+
+          <para>
+            In <literal>NDB</literal> terms, this is any application
+            that accesses cluster data using the <literal>NDB</literal>
+            API, including <command>mysqld</command> when functioning as
+            an API node. (MySQL servers acting in this capacity are also
+            referred to as <quote>SQL nodes</quote>). Often abbreviated
+            to <quote>API</quote>.
+          </para>
+
+        </formalpara>
+      </listitem>
+
+      <listitem>
+        <formalpara>
+
           <title>CMVMI</title>
 
           <para>

@@ -9899,6 +10102,20 @@
       <listitem>
         <formalpara>
 
+          <title>STTOR</title>
+
+          <para>
+            <emphasis role="bold">ST</emphasis>art
+            <emphasis role="bold">O</emphasis>r
+            <emphasis role="bold">R</emphasis>estart
+          </para>
+
+        </formalpara>
+      </listitem>
+
+      <listitem>
+        <formalpara>
+
           <title>SUMA</title>
 
           <para>