| List: | Commits | « Previous MessageNext Message » | |
| From: | jon | Date: | May 21 2006 7:04pm |
| Subject: | svn commit - mysqldoc@docsrva: r2138 - trunk/ndbapi | ||
| View as plain text | |||
Author: jstephens Date: 2006-05-21 19:04:35 +0200 (Sun, 21 May 2006) New Revision: 2138 Log: Prototype/skeleton class listing format. Reorganised section hierarchy in NDB Classes chapter. Simplified some section identifiers. Modified: trunk/ndbapi/errors.xml trunk/ndbapi/examples.xml trunk/ndbapi/ndb-classes.xml trunk/ndbapi/overview.xml Modified: trunk/ndbapi/errors.xml =================================================================== --- trunk/ndbapi/errors.xml 2006-05-19 23:36:15 UTC (rev 2137) +++ trunk/ndbapi/errors.xml 2006-05-21 17:04:35 UTC (rev 2138) @@ -26,7 +26,7 @@ <para> Contains status and other information about errors, including - error codes, classificaitons, and messages. + error codes, classifications, and messages. </para> </abstract> Modified: trunk/ndbapi/examples.xml =================================================================== --- trunk/ndbapi/examples.xml 2006-05-19 23:36:15 UTC (rev 2137) +++ trunk/ndbapi/examples.xml 2006-05-21 17:04:35 UTC (rev 2138) @@ -632,8 +632,8 @@ </para> <para> - (See <xref linkend="ndb-class-ndbscanfilter"/>, and - <xref linkend="ndb-class-ndbscanoperation"/>.) + (See <xref linkend="class-ndbscanfilter"/>, and + <xref linkend="class-ndbscanoperation"/>.) </para> <para> @@ -672,7 +672,7 @@ </itemizedlist> <para> - See <xref linkend="ndb-class-ndb-cluster-connection"/>. + See <xref linkend="class-ndb-cluster-connection"/>. </para> </listitem> @@ -710,7 +710,7 @@ </itemizedlist> <para> - See <xref linkend="ndb-class-ndb"/>. + See <xref linkend="class-ndb"/>. </para> </listitem> @@ -736,7 +736,7 @@ </itemizedlist> <para> - See <xref linkend="ndb-class-ndbtransaction"/>. + See <xref linkend="class-ndbtransaction"/>. </para> </listitem> @@ -768,7 +768,7 @@ </itemizedlist> <para> - See <xref linkend="ndb-class-ndboperation"/>. + See <xref linkend="class-ndboperation"/>. </para> </listitem> @@ -812,7 +812,7 @@ </itemizedlist> <para> - See <xref linkend="ndb-class-ndbscanoperation"/>. + See <xref linkend="class-ndbscanoperation"/>. </para> </listitem> @@ -829,7 +829,7 @@ </para> <para> - See <xref linkend="ndb-class-dictionary"/>. + See <xref linkend="class-dictionary"/>. </para> </listitem> @@ -839,7 +839,7 @@ </para> <para> - See <xref linkend="ndb-class-table"/>. + See <xref linkend="class-table"/>. </para> </listitem> @@ -849,7 +849,7 @@ </para> <para> - See <xref linkend="ndb-class-column"/>. + See <xref linkend="class-column"/>. </para> </listitem> @@ -884,7 +884,7 @@ </itemizedlist> <para> - See <xref linkend="ndb-class-ndbscanfilter"/>. + See <xref linkend="class-ndbscanfilter"/>. </para> </listitem> Modified: trunk/ndbapi/ndb-classes.xml =================================================================== --- trunk/ndbapi/ndb-classes.xml 2006-05-19 23:36:15 UTC (rev 2137) +++ trunk/ndbapi/ndb-classes.xml 2006-05-21 17:04:35 UTC (rev 2138) @@ -11,106 +11,740 @@ <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: + <para> Each class listing includes: <itemizedlist> - <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> - <section id="ndb-class-ndb"> + <section id="class-ndb"> <title>The <literal>Ndb</literal> Class</title> -<!-- <abstract> --> + <abstract> - <para></para> + <para> This class represents the NDB kernel; it is the main class + of the NDB API. </para> -<!-- </abstract> --> + </abstract> - <section id="ndb-class-ndb-cluster-connection"> + <formalpara> + <title>Description</title> + <para> + Any non-trivial NDBAPI program makes use of at least one + instance of <literal>Ndb</literal>. By using several + <literal>Ndb</literal> objects, it is possible to implement a + multi-threaded application. You should remember that one + <literal>Ndb</literal> object cannot be shared between threads; + however, it is possible for a single thread to use multiple + <literal>Ndb</literal> objects. A single application process can + support a maximum of 128 <literal>Ndb</literal> objects. + </para> + </formalpara> + + <note> + <para> + The Ndb object is multi-thread safe in that each + <literal>Ndb</literal> object can be handled by one thread at a + time. If an <literal>Ndb</literal> object is handed over to + another thread, then the application must ensure that a memory + 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. + </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> + </formalpara> + + <informaltable> + <tgroup cols="2"> + <colspec colwidth="35*"/> + <colspec colwidth="65*"/> + <thead> + <row> + <entry>Method</entry> + <entry>Purpose / Use</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>Ndb()</literal></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> + </row> + <row> + <entry><literal>init()</literal></entry> + <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> + </row> + <row> + <entry><literal>setDatabaseName()</literal></entry> + <entry>Sets the name of the current database.</entry> + </row> + <row> + <entry><literal>getDatabaseSchemaName()</literal></entry> + <entry>Gets the name of the current database schema.</entry> + </row> + <row> + <entry><literal>setDatabaseSchemaName()</literal></entry> + <entry>Sets the name of the current database schema.</entry> + </row> + <row> + <entry><literal>startTransaction()</literal></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> + </row> + <row> + <entry><literal>createEventOperation()</literal></entry> + <entry>Creates a subscription to a database event. (See + <xref linkend="class-ndbeventoperation"/>.)</entry> + </row> + <row> + <entry><literal>dropEventOperation()</literal></entry> + <entry>Drops a subscription to a database event.</entry> + </row> + <row> + <entry><literal>pollEvents()</literal></entry> + <entry>Waits for an event to occur.</entry> + </row> + <row> + <entry><literal>getNdbError()</literal></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 + applications should begin with the creation of at least one + <literal>Ndb</literal> object. This requires the creation of + at least one instance of + <literal>Ndb_cluster_connection</literal>, which serves as a + container for a cluster connectstring. + </para> + </formalpara> + + <formalpara> + <title>Signature</title> + + <para> +<programlisting> +Ndb + ( + Ndb_cluster_connection *<replaceable>ndb_cluster_connection</replaceable>, + const char *<replaceable>catalogName</replaceable>="", + const char *<replaceable>schemaName</replaceable>="def" + ) +</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 + <xref linkend="class-ndb-cluster-connection"/>.) In addition, + you may specify either a catalogue name + (<replaceable>catalogName</replaceable>), a schema name + (<replaceable>schemaName</replaceable>), or both. The + <replaceable>catalogName</replaceable> provides a namespace for + the tables and indexes created in any connection from the + <literal>Ndb</literal> object. The + <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> + + </section> + + <section id="class-ndb-init"> + <title><literal>Ndb::init()</literal></title> + + <formalpara> + <title>Description</title> + + <para> + + </para> + </formalpara> + + <formalpara> + <title>Signature</title> + + <para> +<programlisting> + +</programlisting> + </para> + </formalpara> + + <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> + </formalpara> + + <formalpara> + <title>Signature</title> + + <para> +<programlisting> + +</programlisting> + </para> + </formalpara> + + <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> + </formalpara> + + <formalpara> + <title>Signature</title> + + <para> +<programlisting> + +</programlisting> + </para> + </formalpara> + + <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> + </formalpara> + + <formalpara> + <title>Signature</title> + + <para> +<programlisting> + +</programlisting> + </para> + </formalpara> + + <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: + +<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> + </formalpara> + + <formalpara> + <title>Signature</title> + + <para> +<programlisting> + +</programlisting> + </para> + </formalpara> + + <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: + +<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> + </formalpara> + + <formalpara> + <title>Signature</title> + + <para> +<programlisting> + +</programlisting> + </para> + </formalpara> + + <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> + </formalpara> + + <formalpara> + <title>Signature</title> + + <para> +<programlisting> + +</programlisting> + </para> + </formalpara> + + <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> + </formalpara> + + <formalpara> + <title>Signature</title> + + <para> +<programlisting> + +</programlisting> + </para> + </formalpara> + + <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> + </formalpara> + + <formalpara> + <title>Signature</title> + + <para> +<programlisting> + +</programlisting> + </para> + </formalpara> + + <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> + </formalpara> + + <formalpara> + <title>Signature</title> + + <para> +<programlisting> + +</programlisting> + </para> + </formalpara> + + <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> + </formalpara> + + <formalpara> + <title>Signature</title> + + <para> +<programlisting> + +</programlisting> + </para> + </formalpara> + + <para> + + </para> + + <formalpara> + <title>Example</title> + + <para> + 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> -<!-- <abstract> --> + <!-- <abstract> --> - <para></para> + <para/> -<!-- </abstract> --> + <!-- </abstract> --> </section> - <section id="ndb-class-ndbdictionary"> + <section id="class-ndbdictionary"> <title>The <literal>NdbDictionary</literal> Class</title> -<!-- <abstract> --> + <!-- <abstract> --> - <para></para> + <para/> -<!-- </abstract> --> + <!-- </abstract> --> - <section id="ndb-class-dictionary"> + <section id="class-dictionary"> <title>The <literal>Dictionary</literal> Class</title> -<!-- <abstract> --> + <!-- <abstract> --> - <para></para> + <para/> -<!-- </abstract> --> + <!-- </abstract> --> - <section id="ndb-class-list-struct"> + <section id="list-struct"> <title>The <literal>List</literal> Structure</title> -<!-- <abstract> --> + <!-- <abstract> --> - <para></para> + <para/> -<!-- </abstract> --> + <!-- </abstract> --> - <section id="ndb-class-element-struct"> + <section id="element-struct"> <title>The <literal>Element</literal> Structure</title> -<!-- <abstract> --> + <!-- <abstract> --> - <para></para> + <para/> -<!-- </abstract> --> + <!-- </abstract> --> </section> @@ -118,224 +752,222 @@ </section> - <section id="ndb-class-column"> + <section id="class-column"> <title>The <literal>Column</literal> Class</title> -<!-- <abstract> --> + <!-- <abstract> --> - <para></para> + <para/> -<!-- </abstract> --> + <!-- </abstract> --> </section> - <section id="ndb-class-datafile"> + <section id="class-datafile"> <title>The <literal>Datafile</literal> Class</title> -<!-- <abstract> --> + <!-- <abstract> --> - <para></para> + <para/> -<!-- </abstract> --> + <!-- </abstract> --> </section> - <section id="ndb-class-event"> + <section id="class-event"> <title>The <literal>Event</literal> Class</title> -<!-- <abstract> --> + <!-- <abstract> --> - <para></para> + <para/> -<!-- </abstract> --> + <!-- </abstract> --> </section> - <section id="ndb-class-index"> + <section id="class-index"> <title>The <literal>Index</literal> Class</title> -<!-- <abstract> --> + <!-- <abstract> --> - <para></para> + <para/> -<!-- </abstract> --> + <!-- </abstract> --> </section> - <section id="ndb-class-logfilegroup"> + <section id="class-logfilegroup"> <title>The <literal>LogfileGroup</literal> Class</title> -<!-- <abstract> --> + <!-- <abstract> --> - <para></para> + <para/> -<!-- </abstract> --> + <!-- </abstract> --> </section> - <section id="ndb-class-object"> + <section id="class-object"> <title>The <literal>Object</literal> Class</title> -<!-- <abstract> --> + <!-- <abstract> --> - <para></para> + <para/> -<!-- </abstract> --> + <!-- </abstract> --> </section> - <section id="ndb-class-table"> + <section id="class-table"> <title>The <literal>Table</literal> Class</title> -<!-- <abstract> --> + <!-- <abstract> --> - <para></para> + <para/> -<!-- </abstract> --> + <!-- </abstract> --> </section> </section> - <section id="ndb-class-tablespace"> + <section id="class-tablespace"> <title>The <literal>Tablespace</literal> Class</title> -<!-- <abstract> --> + <!-- <abstract> --> - <para></para> + <para/> -<!-- </abstract> --> + <!-- </abstract> --> </section> - <section id="ndb-class-undofile"> + <section id="class-undofile"> <title>The <literal>Undofile</literal> Class</title> -<!-- <abstract> --> + <!-- <abstract> --> - <para></para> + <para/> -<!-- </abstract> --> + <!-- </abstract> --> </section> - <section id="ndb-class-ndboperation"> + <section id="class-ndboperation"> <title>The <literal>NdbOperation</literal> Class</title> -<!-- <abstract> --> + <!-- <abstract> --> - <para></para> + <para/> -<!-- </abstract> --> + <!-- </abstract> --> - <section id="ndbclass-ndbindexoperation"> + <section id="class-ndbindexoperation"> <title>The <literal>NdbIndexOperation</literal> Class</title> -<!-- <abstract> --> + <!-- <abstract> --> - <para></para> + <para/> -<!-- </abstract> --> + <!-- </abstract> --> </section> - <section id="ndb-class-ndbscanoperation"> + <section id="class-ndbscanoperation"> <title>The <literal>NdbScanOperation</literal> Class</title> -<!-- <abstract> --> + <!-- <abstract> --> - <para></para> + <para/> -<!-- </abstract> --> + <!-- </abstract> --> - <section id="nsb-class-ndbindexscanoperation"> + <section id="class-ndbindexscanoperation"> <title>The <literal>NdbIndexScanOperation</literal> Class</title> -<!-- <abstract> --> + <!-- <abstract> --> - <para></para> + <para/> -<!-- </abstract> --> + <!-- </abstract> --> </section> </section> - <section id="ndb-class-ndbeventoperation"> + <section id="class-ndbeventoperation"> <title>The <literal>NdbEventOperation</literal> Class</title> -<!-- <abstract> --> + <!-- <abstract> --> - <para></para> + <para/> -<!-- </abstract> --> + <!-- </abstract> --> </section> </section> - <section id="ndb-class-ndbtransaction"> + <section id="class-ndbtransaction"> <title>The <literal>NdbTransaction</literal> Class</title> -<!-- <abstract> --> + <!-- <abstract> --> - <para></para> + <para/> -<!-- </abstract> --> + <!-- </abstract> --> </section> - <section id="ndb-class-ndbblob"> + <section id="class-ndbblob"> <title>The <literal>NdbBlob</literal> Class</title> -<!-- <abstract> --> + <!-- <abstract> --> - <para></para> + <para/> -<!-- </abstract> --> + <!-- </abstract> --> </section> - <section id="ndb-class-ndbrecattr"> + <section id="class-ndbrecattr"> <title>The <literal>NdbRecAttr</literal> Class</title> -<!-- <abstract> --> + <!-- <abstract> --> - <para></para> + <para/> -<!-- </abstract> --> + <!-- </abstract> --> </section> - <section id="ndb-class-ndbscanfilter"> + <section id="class-ndbscanfilter"> <title>The <literal>NdbScanFilter</literal> Class</title> -<!-- <abstract> --> + <!-- <abstract> --> - <para></para> + <para/> -<!-- </abstract> --> + <!-- </abstract> --> </section> - </section> - </chapter> Modified: trunk/ndbapi/overview.xml =================================================================== --- trunk/ndbapi/overview.xml 2006-05-19 23:36:15 UTC (rev 2137) +++ trunk/ndbapi/overview.xml 2006-05-21 17:04:35 UTC (rev 2138) @@ -65,7 +65,7 @@ The NDB API supports both table scans and row scans; the latter can be performed using either unique or ordered indexes. Event detection and handling is discussed in - <xref linkend="ndb-class-ndbeventoperation"/>, as well as + <xref linkend="class-ndbeventoperation"/>, as well as <xref linkend="example-event-handling"/>. </para>
| Thread | ||
|---|---|---|
| • svn commit - mysqldoc@docsrva: r2138 - trunk/ndbapi | jon | 21 May |
© 1995-2008 MySQL AB, 2008-2009 Sun Microsystems, Inc.
Page generated in 0.903 sec. using MySQL 5.1.14-beta-log