Author: jstephens
Date: 2006-05-23 04:27:27 +0200 (Tue, 23 May 2006)
New Revision: 2165
Log:
Reformat.
Modified:
trunk/ndbapi/ndb-classes.xml
Modified: trunk/ndbapi/ndb-classes.xml
===================================================================
--- trunk/ndbapi/ndb-classes.xml 2006-05-22 23:55:47 UTC (rev 2164)
+++ trunk/ndbapi/ndb-classes.xml 2006-05-23 02:27:27 UTC (rev 2165)
@@ -11,30 +11,42 @@
<abstract>
- <para> This chapter provides a detailed listing of all NDB API
- classes. </para>
+ <para>
+ This chapter provides a detailed listing of all NDB API classes.
+ </para>
- <para> Each class listing includes: <itemizedlist>
+ <para>
+ Each class listing includes:
+ <itemizedlist>
+
<listitem>
- <para> Description of the class' purpose in the API </para>
+ <para>
+ Description of the class' purpose in the API
+ </para>
</listitem>
<listitem>
- <para> Listing of all members, including descriptions of all
- method parameters and enumerated class constants </para>
+ <para>
+ Listing of all members, including descriptions of all method
+ parameters and enumerated class constants
+ </para>
</listitem>
<listitem>
- <para> One or more brief examples, showing the use of the most
- important class members </para>
+ <para>
+ One or more brief examples, showing the use of the most
+ important class members
+ </para>
</listitem>
</itemizedlist>
</para>
- <para> The introductory section of the chapter includes a class
- relationship diagram. </para>
+ <para>
+ The introductory section of the chapter includes a class
+ relationship diagram.
+ </para>
</abstract>
@@ -44,12 +56,15 @@
<abstract>
- <para> This class represents the NDB kernel; it is the main class
- of the NDB API. </para>
+ <para>
+ This class represents the NDB kernel; it is the main class of
+ the NDB API.
+ </para>
</abstract>
<formalpara>
+
<title>Description</title>
<para>
@@ -62,6 +77,7 @@
<literal>Ndb</literal> objects. A single application process can
support a maximum of 128 <literal>Ndb</literal> objects.
</para>
+
</formalpara>
<note>
@@ -73,21 +89,25 @@
barrier is used to ensure that the new thread sees all updates
performed by the previous thread.
</para>
-
+
<para>
Semaphores and mutexes are examples of easy ways to provide
- memory barriers without having to bother about the memory barrier concept.
+ memory barriers without having to bother about the memory
+ barrier concept.
</para>
</note>
<formalpara>
+
<title>Public Methods</title>
+
<para>
The following table lists the public methods of this class and
the purpose or use of each method:
- </para>
+ </para>
+
</formalpara>
-
+
<informaltable>
<tgroup cols="2">
<colspec colwidth="35*"/>
@@ -101,19 +121,17 @@
<tbody>
<row>
<entry><literal>Ndb()</literal></entry>
- <entry>Class constructor; represents a connection to a MySQL
- Cluster.</entry>
+ <entry>Class constructor; represents a connection to a MySQL Cluster.</entry>
</row>
<row>
<entry><literal>~Ndb()</literal></entry>
- <entry>Class destructor; terminates a Cluster connection
- when it is no longer to be used</entry>
+ <entry>Class destructor; terminates a Cluster connection when it is no longer
+ to be used</entry>
</row>
<row>
<entry><literal>init()</literal></entry>
- <entry>Initialises an <literal>Ndb</literal> object and
- makes it ready for use.</entry>
- </row>
+ <entry>Initialises an <literal>Ndb</literal> object and makes it ready for use.</entry>
+ </row>
<row>
<entry><literal>getDatabaseName()</literal></entry>
<entry>Gets the name of the current database.</entry>
@@ -125,24 +143,22 @@
<row>
<entry><literal>getDatabaseSchemaName()</literal></entry>
<entry>Gets the name of the current database schema.</entry>
- </row>
+ </row>
<row>
<entry><literal>setDatabaseSchemaName()</literal></entry>
<entry>Sets the name of the current database schema.</entry>
- </row>
+ </row>
<row>
<entry><literal>startTransaction()</literal></entry>
- <entry>Begins a transaction. (See
- <xref linkend="class-ndbtransaction"/>.)</entry>
+ <entry>Begins a transaction. (See <xref linkend="class-ndbtransaction"/>.)</entry>
</row>
<row>
<entry><literal>closeTransaction()</literal></entry>
- <entry>Closes a transaction. (See
- <xref linkend="class-ndbtransaction"/>.)</entry>
+ <entry>Closes a transaction. (See <xref linkend="class-ndbtransaction"/>.)</entry>
</row>
<row>
<entry><literal>createEventOperation()</literal></entry>
- <entry>Creates a subscription to a database event. (See
+ <entry>Creates a subscription to a database event. (See
<xref linkend="class-ndbeventoperation"/>.)</entry>
</row>
<row>
@@ -155,25 +171,25 @@
</row>
<row>
<entry><literal>getNdbError()</literal></entry>
- <entry>Retrieves an error. (See
- <xref linkend="errors-ndberror-struct"/>.)</entry>
+ <entry>Retrieves an error. (See <xref linkend="errors-ndberror-struct"/>.)</entry>
</row>
</tbody>
</tgroup>
-
</informaltable>
-
+
<para>
The sections that follow provide descriptions, signatures, and
examples of use for each of these methods.
</para>
-
+
<section id="class-ndb-constructor">
+
<title><literal>Ndb</literal> Class Constructor</title>
-
+
<formalpara>
+
<title>Description</title>
-
+
<para>
This creates an instance of <literal>Ndb</literal>, which
represents a connection to the MySQL Cluster. All NDBAPI
@@ -183,11 +199,13 @@
<literal>Ndb_cluster_connection</literal>, which serves as a
container for a cluster connectstring.
</para>
- </formalpara>
-
+
+ </formalpara>
+
<formalpara>
+
<title>Signature</title>
-
+
<para>
<programlisting>
Ndb
@@ -198,13 +216,14 @@
)
</programlisting>
</para>
+
</formalpara>
-
+
<para>
The <literal>Ndb</literal> class constructor can take up to 3
arguments, of which only the first — an instance of
<literal>Ndb_cluster_connection</literal>, which represents a
- cluster connectstring — is required. (See
+ cluster connectstring — is required. (See
<xref linkend="class-ndb-cluster-connection"/>.) In addition,
you may specify either a catalogue name
(<replaceable>catalogName</replaceable>), a schema name
@@ -215,759 +234,794 @@
<replaceable>schemaName</replaceable> provides an additional
namespace for the tables and indexes created in a given catalog.
</para>
-
+
<formalpara>
+
<title>Example</title>
-
+
<para>
This example shows how to create an <literal>Ndb</literal>
object:
-
+
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
</para>
+
</formalpara>
-
+
<formalpara>
+
<title><literal>~Ndb()</literal> (Class Destructor)</title>
-
+
<para>
The destructor for the <literal>Ndb</literal> class should be
called in order to terminate an instance of
<literal>Ndb</literal>. It requires no arguments, nor any
special handling.
</para>
- </formalpara>
-
+
+ </formalpara>
+
</section>
-
+
<section id="class-ndb-init">
+
<title><literal>Ndb::init()</literal></title>
-
+
<formalpara>
+
<title>Description</title>
-
- <para>
-
- </para>
+
+ <para></para>
+
</formalpara>
-
+
<formalpara>
+
<title>Signature</title>
-
+
<para>
<programlisting>
</programlisting>
</para>
+
</formalpara>
- <para>
-
- </para>
-
+ <para></para>
+
<formalpara>
+
<title>Example</title>
-
+
<para>
This example shows how to use the <literal>init()</literal>
method to initialise an <literal>Ndb</literal> object:
-
+
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
</para>
+
</formalpara>
+
</section>
-
-
+
<section id="class-ndb-getdatabasename">
+
<title><literal>Ndb::getDatabaseName()</literal></title>
-
+
<formalpara>
+
<title>Description</title>
-
- <para>
-
- </para>
+
+ <para></para>
+
</formalpara>
-
+
<formalpara>
+
<title>Signature</title>
-
+
<para>
<programlisting>
</programlisting>
</para>
+
</formalpara>
- <para>
-
- </para>
-
+ <para></para>
+
<formalpara>
+
<title>Example</title>
-
+
<para>
This example shows how to use
<literal>getDatabaseName()</literal> to obtain the name of the
current database:
-
+
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
</para>
+
</formalpara>
-
+
</section>
-
+
<section id="class-ndb-setdatabasename">
+
<title><literal>Ndb::setDatabaseName()</literal></title>
-
+
<formalpara>
+
<title>Description</title>
-
- <para>
-
- </para>
+
+ <para></para>
+
</formalpara>
-
+
<formalpara>
+
<title>Signature</title>
-
+
<para>
<programlisting>
</programlisting>
</para>
+
</formalpara>
- <para>
-
- </para>
-
+ <para></para>
+
<formalpara>
+
<title>Example</title>
-
+
<para>
This example shows how to use
<literal>setDatabaseName()</literal> to set the name of the
current database:
-
+
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
</para>
+
</formalpara>
-
+
</section>
-
+
<section id="class-ndb-getdatabaseschemaname">
+
<title><literal>Ndb::getDatabaseSchemaName()</literal></title>
-
+
<formalpara>
+
<title>Description</title>
-
- <para>
-
- </para>
+
+ <para></para>
+
</formalpara>
-
+
<formalpara>
+
<title>Signature</title>
-
+
<para>
<programlisting>
</programlisting>
</para>
+
</formalpara>
- <para>
-
- </para>
-
+ <para></para>
+
<formalpara>
+
<title>Example</title>
-
+
<para>
This example shows how to use
- <literal>getDatabaseSchemaName()</literal> to obtain the name of the
- current database schema:
-
+ <literal>getDatabaseSchemaName()</literal> to obtain the name
+ of the current database schema:
+
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
</para>
+
</formalpara>
-
+
</section>
-
+
<section id="class-ndb-setdatabaseschemaname">
+
<title><literal>Ndb::setDatabaseSchemaName()</literal></title>
-
+
<formalpara>
+
<title>Description</title>
-
- <para>
-
- </para>
+
+ <para></para>
+
</formalpara>
-
+
<formalpara>
+
<title>Signature</title>
-
+
<para>
<programlisting>
</programlisting>
</para>
+
</formalpara>
- <para>
-
- </para>
-
+ <para></para>
+
<formalpara>
+
<title>Example</title>
-
+
<para>
This example shows how to use
- <literal>setDatabaseSchemaName()</literal> to set the name of the
- current database schema:
-
+ <literal>setDatabaseSchemaName()</literal> to set the name of
+ the current database schema:
+
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
</para>
+
</formalpara>
-
+
</section>
-
+
<section id="class-ndb-starttransaction">
+
<title><literal>Ndb::startTransaction()</literal></title>
-
+
<formalpara>
+
<title>Description</title>
-
- <para>
-
- </para>
+
+ <para></para>
+
</formalpara>
-
+
<formalpara>
+
<title>Signature</title>
-
+
<para>
<programlisting>
</programlisting>
</para>
+
</formalpara>
- <para>
-
- </para>
-
+ <para></para>
+
<formalpara>
+
<title>Example</title>
-
+
<para>
This example shows how to use
<literal>startTransaction()</literal> to begin a new
transaction:
-
+
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
</para>
+
</formalpara>
-
+
</section>
-
+
<section id="class-ndb-closetransaction">
+
<title><literal>Ndb::closeTransaction()</literal></title>
-
+
<formalpara>
+
<title>Description</title>
-
- <para>
-
- </para>
+
+ <para></para>
+
</formalpara>
-
+
<formalpara>
+
<title>Signature</title>
-
+
<para>
<programlisting>
</programlisting>
</para>
+
</formalpara>
- <para>
-
- </para>
-
+ <para></para>
+
<formalpara>
+
<title>Example</title>
-
+
<para>
This example shows how to use
<literal>closeTransaction()</literal> to terminate an instance
of <literal>NdbTransaction</literal>:
-
+
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
</para>
+
</formalpara>
-
+
</section>
-
+
<section id="class-ndb-createeventoperation">
+
<title><literal>Ndb::createEventOperation</literal></title>
-
+
<formalpara>
+
<title>Description</title>
-
- <para>
-
- </para>
+
+ <para></para>
+
</formalpara>
-
+
<formalpara>
+
<title>Signature</title>
-
+
<para>
<programlisting>
</programlisting>
</para>
+
</formalpara>
- <para>
-
- </para>
-
+ <para></para>
+
<formalpara>
+
<title>Example</title>
-
+
<para>
This example shows how to use
<literal>createEventOperation()</literal> to subscribe to a
database event:
-
+
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
</para>
+
</formalpara>
-
+
</section>
-
+
<section id="class-ndb-dropeventoperation">
+
<title><literal>Ndb::dropEventOperation()</literal></title>
-
+
<formalpara>
+
<title>Description</title>
-
- <para>
-
- </para>
+
+ <para></para>
+
</formalpara>
-
+
<formalpara>
+
<title>Signature</title>
-
+
<para>
<programlisting>
</programlisting>
</para>
+
</formalpara>
- <para>
-
- </para>
-
+ <para></para>
+
<formalpara>
+
<title>Example</title>
-
+
<para>
This example shows how to use
<literal>dropEventOperation()</literal> to drop a subscription
to a database event:
-
+
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
</para>
+
</formalpara>
-
+
</section>
-
+
<section id="class-ndb-pollevents">
+
<title><literal>Ndb::pollEvents()</literal></title>
-
+
<formalpara>
+
<title>Description</title>
-
- <para>
-
- </para>
+
+ <para></para>
+
</formalpara>
-
+
<formalpara>
+
<title>Signature</title>
-
+
<para>
<programlisting>
</programlisting>
</para>
+
</formalpara>
- <para>
-
- </para>
-
+ <para></para>
+
<formalpara>
+
<title>Example</title>
-
+
<para>
This example shows how the <literal>pollEvents()</literal>
method is used to wait until a database event occurs:
-
+
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
</para>
+
</formalpara>
-
+
</section>
-
+
<section id="class-ndb-getndberror">
+
<title><literal>Ndb::getNdbError()</literal></title>
-
+
<formalpara>
+
<title>Description</title>
-
- <para>
-
- </para>
+
+ <para></para>
+
</formalpara>
-
+
<formalpara>
+
<title>Signature</title>
-
+
<para>
<programlisting>
</programlisting>
</para>
+
</formalpara>
- <para>
-
- </para>
-
+ <para></para>
+
<formalpara>
+
<title>Example</title>
-
+
<para>
- This example shows how to use
- <literal>getNdbError()</literal> to retrieve one or more
- NDPAPI errors:
-
+ This example shows how to use <literal>getNdbError()</literal>
+ to retrieve one or more NDPAPI errors:
+
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
</para>
+
</formalpara>
-
+
</section>
-
-
+
</section>
-
- <section id="class-ndb-cluster-connection">
- <title>The <literal>Ndb_cluster_connection</literal> Class</title>
+ <section id="class-ndb-cluster-connection">
- <!-- <abstract> -->
+ <title>The <literal>Ndb_cluster_connection</literal> Class</title>
- <para/>
+<!-- <abstract> -->
- <!-- </abstract> -->
+ <para/>
- </section>
+<!-- </abstract> -->
- <section id="class-ndbdictionary">
+ </section>
- <title>The <literal>NdbDictionary</literal> Class</title>
+ <section id="class-ndbdictionary">
- <!-- <abstract> -->
+ <title>The <literal>NdbDictionary</literal> Class</title>
- <para/>
+<!-- <abstract> -->
- <!-- </abstract> -->
+ <para/>
- <section id="class-dictionary">
+<!-- </abstract> -->
- <title>The <literal>Dictionary</literal> Class</title>
+ <section id="class-dictionary">
- <!-- <abstract> -->
+ <title>The <literal>Dictionary</literal> Class</title>
- <para/>
+<!-- <abstract> -->
- <!-- </abstract> -->
+ <para/>
- <section id="list-struct">
+<!-- </abstract> -->
- <title>The <literal>List</literal> Structure</title>
+ <section id="list-struct">
- <!-- <abstract> -->
+ <title>The <literal>List</literal> Structure</title>
- <para/>
+<!-- <abstract> -->
- <!-- </abstract> -->
+ <para/>
- <section id="element-struct">
+<!-- </abstract> -->
- <title>The <literal>Element</literal> Structure</title>
+ <section id="element-struct">
- <!-- <abstract> -->
+ <title>The <literal>Element</literal> Structure</title>
- <para/>
+<!-- <abstract> -->
- <!-- </abstract> -->
+ <para/>
- </section>
+<!-- </abstract> -->
</section>
</section>
- <section id="class-column">
+ </section>
- <title>The <literal>Column</literal> Class</title>
+ <section id="class-column">
- <!-- <abstract> -->
+ <title>The <literal>Column</literal> Class</title>
- <para/>
+<!-- <abstract> -->
- <!-- </abstract> -->
+ <para/>
- </section>
+<!-- </abstract> -->
- <section id="class-datafile">
+ </section>
- <title>The <literal>Datafile</literal> Class</title>
+ <section id="class-datafile">
- <!-- <abstract> -->
+ <title>The <literal>Datafile</literal> Class</title>
- <para/>
+<!-- <abstract> -->
- <!-- </abstract> -->
+ <para/>
- </section>
+<!-- </abstract> -->
- <section id="class-event">
+ </section>
- <title>The <literal>Event</literal> Class</title>
+ <section id="class-event">
- <!-- <abstract> -->
+ <title>The <literal>Event</literal> Class</title>
- <para/>
+<!-- <abstract> -->
- <!-- </abstract> -->
+ <para/>
- </section>
+<!-- </abstract> -->
- <section id="class-index">
+ </section>
- <title>The <literal>Index</literal> Class</title>
+ <section id="class-index">
- <!-- <abstract> -->
+ <title>The <literal>Index</literal> Class</title>
- <para/>
+<!-- <abstract> -->
- <!-- </abstract> -->
+ <para/>
- </section>
+<!-- </abstract> -->
- <section id="class-logfilegroup">
+ </section>
- <title>The <literal>LogfileGroup</literal> Class</title>
+ <section id="class-logfilegroup">
- <!-- <abstract> -->
+ <title>The <literal>LogfileGroup</literal> Class</title>
- <para/>
+<!-- <abstract> -->
- <!-- </abstract> -->
+ <para/>
- </section>
+<!-- </abstract> -->
- <section id="class-object">
+ </section>
- <title>The <literal>Object</literal> Class</title>
+ <section id="class-object">
- <!-- <abstract> -->
+ <title>The <literal>Object</literal> Class</title>
- <para/>
+<!-- <abstract> -->
- <!-- </abstract> -->
+ <para/>
- </section>
+<!-- </abstract> -->
- <section id="class-table">
+ </section>
- <title>The <literal>Table</literal> Class</title>
+ <section id="class-table">
- <!-- <abstract> -->
+ <title>The <literal>Table</literal> Class</title>
- <para/>
+<!-- <abstract> -->
- <!-- </abstract> -->
+ <para/>
- </section>
+<!-- </abstract> -->
</section>
- <section id="class-tablespace">
+ </section>
- <title>The <literal>Tablespace</literal> Class</title>
+ <section id="class-tablespace">
- <!-- <abstract> -->
+ <title>The <literal>Tablespace</literal> Class</title>
- <para/>
+<!-- <abstract> -->
- <!-- </abstract> -->
+ <para/>
- </section>
+<!-- </abstract> -->
- <section id="class-undofile">
+ </section>
- <title>The <literal>Undofile</literal> Class</title>
+ <section id="class-undofile">
- <!-- <abstract> -->
+ <title>The <literal>Undofile</literal> Class</title>
- <para/>
+<!-- <abstract> -->
- <!-- </abstract> -->
+ <para/>
- </section>
+<!-- </abstract> -->
- <section id="class-ndboperation">
+ </section>
- <title>The <literal>NdbOperation</literal> Class</title>
+ <section id="class-ndboperation">
- <!-- <abstract> -->
+ <title>The <literal>NdbOperation</literal> Class</title>
- <para/>
+<!-- <abstract> -->
- <!-- </abstract> -->
+ <para/>
- <section id="class-ndbindexoperation">
+<!-- </abstract> -->
- <title>The <literal>NdbIndexOperation</literal> Class</title>
+ <section id="class-ndbindexoperation">
- <!-- <abstract> -->
+ <title>The <literal>NdbIndexOperation</literal> Class</title>
- <para/>
+<!-- <abstract> -->
- <!-- </abstract> -->
+ <para/>
- </section>
+<!-- </abstract> -->
- <section id="class-ndbscanoperation">
+ </section>
- <title>The <literal>NdbScanOperation</literal> Class</title>
+ <section id="class-ndbscanoperation">
- <!-- <abstract> -->
+ <title>The <literal>NdbScanOperation</literal> Class</title>
- <para/>
+<!-- <abstract> -->
- <!-- </abstract> -->
+ <para/>
- <section id="class-ndbindexscanoperation">
+<!-- </abstract> -->
- <title>The <literal>NdbIndexScanOperation</literal> Class</title>
+ <section id="class-ndbindexscanoperation">
- <!-- <abstract> -->
+ <title>The <literal>NdbIndexScanOperation</literal> Class</title>
- <para/>
+<!-- <abstract> -->
- <!-- </abstract> -->
+ <para/>
- </section>
+<!-- </abstract> -->
</section>
- <section id="class-ndbeventoperation">
+ </section>
- <title>The <literal>NdbEventOperation</literal> Class</title>
+ <section id="class-ndbeventoperation">
- <!-- <abstract> -->
+ <title>The <literal>NdbEventOperation</literal> Class</title>
- <para/>
+<!-- <abstract> -->
- <!-- </abstract> -->
+ <para/>
- </section>
+<!-- </abstract> -->
</section>
- <section id="class-ndbtransaction">
+ </section>
- <title>The <literal>NdbTransaction</literal> Class</title>
+ <section id="class-ndbtransaction">
- <!-- <abstract> -->
+ <title>The <literal>NdbTransaction</literal> Class</title>
- <para/>
+<!-- <abstract> -->
- <!-- </abstract> -->
+ <para/>
- </section>
+<!-- </abstract> -->
- <section id="class-ndbblob">
+ </section>
- <title>The <literal>NdbBlob</literal> Class</title>
+ <section id="class-ndbblob">
- <!-- <abstract> -->
+ <title>The <literal>NdbBlob</literal> Class</title>
- <para/>
+<!-- <abstract> -->
- <!-- </abstract> -->
+ <para/>
- </section>
+<!-- </abstract> -->
- <section id="class-ndbrecattr">
+ </section>
- <title>The <literal>NdbRecAttr</literal> Class</title>
+ <section id="class-ndbrecattr">
- <!-- <abstract> -->
+ <title>The <literal>NdbRecAttr</literal> Class</title>
- <para/>
+<!-- <abstract> -->
- <!-- </abstract> -->
+ <para/>
- </section>
+<!-- </abstract> -->
- <section id="class-ndbscanfilter">
+ </section>
- <title>The <literal>NdbScanFilter</literal> Class</title>
+ <section id="class-ndbscanfilter">
- <!-- <abstract> -->
+ <title>The <literal>NdbScanFilter</literal> Class</title>
- <para/>
+<!-- <abstract> -->
- <!-- </abstract> -->
+ <para/>
- </section>
+<!-- </abstract> -->
+ </section>
+
</chapter>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r2165 - trunk/ndbapi | jon | 23 May |
