| List: | Commits | « Previous MessageNext Message » | |
| From: | jon | Date: | June 20 2006 4:43pm |
| Subject: | svn commit - mysqldoc@docsrva: r2435 - trunk/ndbapi | ||
| View as plain text | |||
Author: jstephens Date: 2006-06-20 16:43:42 +0200 (Tue, 20 Jun 2006) New Revision: 2435 Log: Reformat + update Makefile. Modified: trunk/ndbapi/Makefile trunk/ndbapi/ndb-classes.xml Modified: trunk/ndbapi/Makefile =================================================================== --- trunk/ndbapi/Makefile 2006-06-20 14:41:49 UTC (rev 2434) +++ trunk/ndbapi/Makefile 2006-06-20 14:43:42 UTC (rev 2435) @@ -29,7 +29,7 @@ # Dependency list for NDB API document # This variable is updated by "make depend" -NDBAPI_SRCS = $(NDBAPI_SRCS_EXTRA) ndbapi.xml overview.xml tips-tricks-problems.xml mgm-api.xml ndb-classes.xml images/Ndb-class.png images/Ndb-cluster-connection-class.png images/NdbBlob-class.png images/NdbDictionary-classes.png images/NdbDictionary-Column-class.png images/NdbDictionary-Object-class.png images/NdbDictionary-Object-Event-class.png images/NdbDictionary-Object-Index-class.png images/NdbDictionary-Object-Table-class.png images/NdbDictionary-AutoGrowSpecification-struct.png errors.xml examples.xml +NDBAPI_SRCS = $(NDBAPI_SRCS_EXTRA) ndbapi.xml overview.xml tips-tricks-problems.xml mgm-api.xml ndb-classes.xml images/Ndb-class.png images/Ndb-cluster-connection-class.png images/NdbBlob-class.png images/NdbDictionary-classes.png images/NdbDictionary-Column-class.png images/NdbDictionary-Object-class.png images/NdbDictionary-Object-Event-class.png images/NdbDictionary-Object-Index-class.png images/NdbDictionary-Object-LogfileGroup-class.png images/NdbDictionary-Object-Table-class.png images/NdbDictionary-AutoGrowSpecification-struct.png errors.xml examples.xml ndbapi-prepped.xml: $(NDBAPI_SRCS) Modified: trunk/ndbapi/ndb-classes.xml =================================================================== --- trunk/ndbapi/ndb-classes.xml 2006-06-20 14:41:49 UTC (rev 2434) +++ trunk/ndbapi/ndb-classes.xml 2006-06-20 14:43:42 UTC (rev 2435) @@ -1914,7 +1914,7 @@ <literal>NdbOperation::readTuple()</literal> used with any lock mode can read but not write blob values. </para> - + <para> When the <literal>LM_CommittedRead</literal> lock mode is used with <literal>readTuple()</literal>, the lock mode is @@ -1947,28 +1947,28 @@ implicit, non-accessible <literal>BLOB</literal> handles. </para> </listitem> - + <listitem> <para> A scan with any lock mode can use its blob handles to read blob values but not write them. </para> - + <para> A scan using the <literal>LM_Exclusive</literal> lock mode can update row and blob values using <literal>updateCurrentTuple()</literal>; the operation returned must explicitly create its own blob handle. </para> - + <para> A scan using the <literal>LM_Exclusive</literal> lock mode can delete row values (and therefore blob values) using <literal>deleteCurrentTuple()</literal>; this create - implicit non-accessible blob handles. + implicit non-accessible blob handles. </para> </listitem> - + <listitem> <para> An operation which is returned by @@ -1993,7 +1993,7 @@ working with <literal>NdbBlob</literal> objects: <itemizedlist> - + <listitem> <para> Too many pending <literal>BLOB</literal> operations can @@ -9377,12 +9377,12 @@ </para> </formalpara> - + <note> <para> Currently this flag is not inherited by <literal>NdbEventOperation</literal>, and must be set on - <literal>NdbEventOperation</literal> explicitly. See + <literal>NdbEventOperation</literal> explicitly. See <xref linkend="class-ndbeventoperation"/>. </para> </note> @@ -10910,803 +10910,918 @@ <title>The <literal>LogfileGroup</literal> Class</title> - <abstract> + <abstract> + <para> + This section discusses the <literal>LogfileGroup</literal> + class, which represents a MySQL Cluster Disk Data logfile + group. + </para> + + </abstract> + + <formalpara> + + <title>Description</title> + + <para> + This class represnts a MySQL Cluster Disk Data logfile + group, which is used for storing Disk Data undofiles. For + general information about logfile groups and undofiles, see + the + <ulink url="&refman-base-url;mysql-cluster-disk-data.html">Cluster + Disk Data Storage</ulink> section of the MySQL Manual. + </para> + + </formalpara> + + <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>LogfileGroup()</literal></entry> + <entry>Class constructor</entry> + </row> + <row> + <entry><literal>~LogfileGroup()</literal></entry> + <entry>Vrtual destructor</entry> + </row> + <row> + <entry><literal>getName()</literal></entry> + <entry>Retrieves the logfile group's name</entry> + </row> + <row> + <entry><literal>getUndoBufferSize()</literal></entry> + <entry>Gets the size of the logfile group's <literal>UNDO</literal> buffer</entry> + </row> + <row> + <entry><literal>getAutoGrowSpecification()</literal></entry> + <entry>Gets the logfile group's <literal>AutoGrowSpecification</literal> values</entry> + </row> + <row> + <entry><literal>getUndoFreeWords()</literal></entry> + <entry>Retrieves the amount of free space in the <literal>UNDO</literal> buffer</entry> + </row> + <row> + <entry><literal>getObjectStatus()</literal></entry> + <entry>Gets the logfile group's object status value</entry> + </row> + <row> + <entry><literal>getObjectVersion()</literal></entry> + <entry>Retrieves the logfile group's object version</entry> + </row> + <row> + <entry><literal>getObjectId()</literal></entry> + <entry>Get the object ID of thelogfile group</entry> + </row> + <row> + <entry><literal>setName()</literal></entry> + <entry>Sets the name of the logfile group</entry> + </row> + <row> + <entry><literal>setUndoBufferSize()</literal></entry> + <entry>Sets the size of the logfile group's <literal>UNDO</literal> buffer.</entry> + </row> + <row> + <entry><literal>setAutoGrowSpecification()</literal></entry> + <entry>Sets <literal>AutoGrowSpecification</literal> values for the logfile + group</entry> + </row> + </tbody> + </tgroup> + </informaltable> + <para> - This section discusses the <literal>LogfileGroup</literal> - class, which represents a MySQL Cluster Disk Data logfile - group. + For detailed descriptions, signatures, and examples of use for + each of these methods, see + <xref linkend="class-logfilegroup-members"/>. </para> - </abstract> - - + <formalpara> - <formalpara> + <title>Public Types</title> - <title>Description</title> + <para> + The <literal>LogfileGroup</literal> class does not itself + define any public types. However, two of its methods make + use of the <literal>AutoGrowSpecification</literal> data + structure as a parameter or return value. For more + information, see + <xref linkend="struct-autogrowspecification"/>. + </para> - <para> - This class represnts a MySQL Cluster Disk Data logfile group, - which is used for storing Disk Data undofiles. For general - information about logfile groups and undofiles, see the - <ulink url="&refman-base-url;mysql-cluster-disk-data.html">Cluster - Disk Data Storage</ulink> section of the MySQL Manual. - </para> + </formalpara> - </formalpara> + <formalpara> - <formalpara> + <title>Class Diagram</title> - <title>Public Methods</title> + <para> + This diagram shows all the available public methods of the + <literal>LogfileGroup</literal> class: - <para> - The following table lists the public methods of this class and the - purpose or use of each method: - </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/NdbDictionary-Object-LogfileGroup-class.png" format="PNG"/> + </imageobject> + <textobject> + <phrase lang="en">Public methods of the + <literal>LogfileGroup</literal> class.</phrase> + </textobject> + </mediaobject> + </para> - </formalpara> + </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>LogfileGroup()</literal></entry> - <entry>Class constructor</entry> - </row> - <row> - <entry><literal>~LogfileGroup()</literal></entry> - <entry>Vrtual destructor</entry> - </row> - <row> - <entry><literal>getName()</literal></entry> - <entry>Retrieves the logfile group's name</entry> - </row> - <row> - <entry><literal>getUndoBufferSize()</literal></entry> - <entry>Gets the size of the logfile group's <literal>UNDO</literal> buffer</entry> - </row> - <row> - <entry><literal>getAutoGrowSpecification()</literal></entry> - <entry>Gets the logfile group's - <literal>AutoGrowSpecification</literal> values</entry> - </row> - <row> - <entry><literal>getUndoFreeWords()</literal></entry> - <entry>Retrieves the amount of free space in the <literal>UNDO</literal> buffer</entry> - </row> - <row> - <entry><literal>getObjectStatus()</literal></entry> - <entry>Gets the logfile group's object status value</entry> - </row> - <row> - <entry><literal>getObjectVersion()</literal></entry> - <entry>Retrieves the logfile group's object version</entry> - </row> - <row> - <entry><literal>getObjectId()</literal></entry> - <entry>Get the object ID of thelogfile group</entry> - </row> - <row> - <entry><literal>setName()</literal></entry> - <entry>Sets the name of the logfile group</entry> - </row> - <row> - <entry><literal>setUndoBufferSize()</literal></entry> - <entry>Sets the size of the logfile group's <literal>UNDO</literal> buffer.</entry> - </row> - <row> - <entry><literal>setAutoGrowSpecification()</literal></entry> - <entry>Sets <literal>AutoGrowSpecification</literal> values - for the logfile group</entry> - </row> - </tbody> - </tgroup> - </informaltable> + <section id="class-logfilegroup-members"> - <para> - For detailed descriptions, signatures, and examples of use for each - of these methods, see <xref linkend="class-logfilegroup-members"/>. - </para> + <title><literal>LogfileGroup</literal> Class Members</title> - <formalpara> + <abstract> - <title>Public Types</title> + <para> + This section provides descriptions for the public methods + of the <literal>LogfileGroup</literal> class. + </para> - <para> - The <literal>LogfileGroup</literal> class does not itself define - any public types. However, two of its methods make use of the - <literal>AutoGrowSpecification</literal> data structure as a - parameter or return value. For more information, see - <xref linkend="struct-autogrowspecification"/>. - </para> + </abstract> - </formalpara> + <section id="class-logfilegroup-constructor"> - <formalpara> + <title><literal>LogfileGroup</literal> Constructor</title> - <title>Class Diagram</title> + <formalpara> - <para> - This diagram shows all the available public methods of the - <literal>LogfileGroup</literal> class: + <title>Description</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/NdbDictionary-Object-LogfileGroup-class.png" format="PNG"/> - </imageobject> - <textobject> - <phrase lang="en">Public methods of the - <literal>LogfileGroup</literal> class.</phrase> - </textobject> - </mediaobject> - </para> + <para> + The LogfileGroup class has two public constructors, one + of which takes no arguments and creates a completely new + instance. The other is a copy constructor. + </para> - </formalpara> + </formalpara> - <section id="class-logfilegroup-members"> + <note> + <para> + The <literal>Dictionary</literal> class also supplies + methods for creating and destroying + <literal>LogfileGroup</literal> objects. See + <xref linkend="class-dictionary"/>. + </para> + </note> - <title><literal>LogfileGroup</literal> Class Members</title> - - <abstract> - <para> - This section provides descriptions for the public methods of the - <literal>LogfileGroup</literal> class. - </para> - </abstract> - -<section id="class-logfilegroup-constructor"> - <title><literal>LogfileGroup</literal> Constructor</title> - - <formalpara> - <title>Description</title> - - <para> - The LogfileGroup class has two public constructors, one of which - takes no arguments and creates a completely new instance. The - other is a copy constructor. - </para> - </formalpara> - - <note> - <para> - The <literal>Dictionary</literal> class also supplies methods for - creating and destroying <literal>LogfileGroup</literal> objects. - See <xref linkend="class-dictionary"/>. - </para> - </note> - - <formalpara> - <title>Signatures</title> - - <para> - New instance: + <formalpara> + + <title>Signatures</title> + + <para> + New instance: + <programlisting> LogfileGroup ( void ) </programlisting> - Copy constructor: + + Copy constructor: + <programlisting> LogfileGroup ( const LogfileGroup& <replaceable>logfileGroup</replaceable> ) </programlisting> - </para> - </formalpara> - - <formalpara> - <title>Parameters</title> - - <para> - When creating a new instance, the constructor takes no parameters. - When copying an existing instance, the constructor is passed a - reference to the <literal>LogfileGroup</literal> instance to be copied. - </para> - </formalpara> - - <formalpara> - <title>Return Value</title> - - <para> - A <literal>LogfileGroup</literal> object. - </para> - </formalpara> - - <formalpara> - <title>Destructor</title> - <para> + </para> + + </formalpara> + + <formalpara> + + <title>Parameters</title> + + <para> + When creating a new instance, the constructor takes no + parameters. When copying an existing instance, the + constructor is passed a reference to the + <literal>LogfileGroup</literal> instance to be copied. + </para> + + </formalpara> + + <formalpara> + + <title>Return Value</title> + + <para> + A <literal>LogfileGroup</literal> object. + </para> + + </formalpara> + + <formalpara> + + <title>Destructor</title> + + <para> <programlisting> virtual ~LogfileGroup ( void ) </programlisting> - </para> - </formalpara> - - - <formalpara> - <title>Examples</title> - - <para> - + </para> + + </formalpara> + + <formalpara> + + <title>Examples</title> + + <para> <programlisting> [<emphasis>To be supplied...</emphasis>] </programlisting> - </para> - </formalpara> - - -</section> - - - <section id="class-logfilegroup-getname"> - <title><literal>NdbDictionary::Object::LogfileGroup::getName()</literal></title> - - <formalpara> - <title>Description</title> - - <para> - This method gets the name of the logfile group. - </para> - </formalpara> - - <formalpara> - <title>Signature</title> - - <para> + </para> + + </formalpara> + + </section> + + <section id="class-logfilegroup-getname"> + + <title><literal>NdbDictionary::Object::LogfileGroup::getName()</literal></title> + + <formalpara> + + <title>Description</title> + + <para> + This method gets the name of the logfile group. + </para> + + </formalpara> + + <formalpara> + + <title>Signature</title> + + <para> <programlisting> const char* getName ( void ) const </programlisting> - </para> - </formalpara> - - <formalpara> - <title>Parameters</title> - - <para> - <emphasis>None</emphasis>. - </para> - </formalpara> - - <formalpara> - <title>Return Value</title> - - <para> - The logfile group's name, a string (as a character pointer). - </para> - </formalpara> - - <formalpara> - <title>Example</title> - - <para> - + </para> + + </formalpara> + + <formalpara> + + <title>Parameters</title> + + <para> + <emphasis>None</emphasis>. + </para> + + </formalpara> + + <formalpara> + + <title>Return Value</title> + + <para> + The logfile group's name, a string (as a character + pointer). + </para> + + </formalpara> + + <formalpara> + + <title>Example</title> + + <para> <programlisting> [<emphasis>To be supplied...</emphasis>] </programlisting> - </para> - </formalpara> - - - </section> - - <section id="class-logfilegroup-getundobuffersize"> - <title><literal>NdbDictionary::Object::LogfileGroup::getUndoBufferSize()</literal></title> - - <formalpara> - <title>Description</title> - - <para> - This method retrieves the size of the logfile group's <literal>UNDO</literal> buffer. - </para> - </formalpara> - - <formalpara> - <title>Signature</title> - - <para> + </para> + + </formalpara> + + </section> + + <section id="class-logfilegroup-getundobuffersize"> + + <title><literal>NdbDictionary::Object::LogfileGroup::getUndoBufferSize()</literal></title> + + <formalpara> + + <title>Description</title> + + <para> + This method retrieves the size of the logfile group's + <literal>UNDO</literal> buffer. + </para> + + </formalpara> + + <formalpara> + + <title>Signature</title> + + <para> <programlisting> Uint32 getUndoBufferSize ( void ) const </programlisting> - </para> - </formalpara> - - <formalpara> - <title>Parameters</title> - - <para> - <emphasis>None</emphasis>. - </para> - </formalpara> - - <formalpara> - <title>Return Value</title> - - <para> - The size of the <literal>UNDO</literal> buffer, in bytes. - </para> - </formalpara> - - <formalpara> - <title>Example</title> - - <para> - + </para> + + </formalpara> + + <formalpara> + + <title>Parameters</title> + + <para> + <emphasis>None</emphasis>. + </para> + + </formalpara> + + <formalpara> + + <title>Return Value</title> + + <para> + The size of the <literal>UNDO</literal> buffer, in + bytes. + </para> + + </formalpara> + + <formalpara> + + <title>Example</title> + + <para> <programlisting> [<emphasis>To be supplied...</emphasis>] </programlisting> - </para> - </formalpara> - - - </section> - - <section id="class-logfilegroup-getautogrowspecification"> - <title><literal>NdbDictionary::Object::LogfileGroup::getAutoGrowSpecification()</literal></title> - - <formalpara> - <title>Description</title> - - <para> - This method retrieves the <literal>AutoGrowSpecification</literal> - associated with - the logfile group. - </para> - </formalpara> - - <formalpara> - <title>Signature</title> - - <para> + </para> + + </formalpara> + + </section> + + <section id="class-logfilegroup-getautogrowspecification"> + + <title><literal>NdbDictionary::Object::LogfileGroup::getAutoGrowSpecification()</literal></title> + + <formalpara> + + <title>Description</title> + + <para> + This method retrieves the + <literal>AutoGrowSpecification</literal> associated with + the logfile group. + </para> + + </formalpara> + + <formalpara> + + <title>Signature</title> + + <para> <programlisting> const AutoGrowSpecification& getAutoGrowSpecification ( void ) const </programlisting> - </para> - </formalpara> - - <formalpara> - <title>Parameters</title> - - <para> - <emphasis>None</emphasis>. - </para> - </formalpara> - - <formalpara> - <title>Return Value</title> - - <para> - An <literal>AutoGrowSpecification</literal> data structure. See - <xref linkend="struct-autogrowspecification"/>, for details. - </para> - </formalpara> - - <formalpara> - <title>Example</title> - - <para> - + </para> + + </formalpara> + + <formalpara> + + <title>Parameters</title> + + <para> + <emphasis>None</emphasis>. + </para> + + </formalpara> + + <formalpara> + + <title>Return Value</title> + + <para> + An <literal>AutoGrowSpecification</literal> data + structure. See + <xref linkend="struct-autogrowspecification"/>, for + details. + </para> + + </formalpara> + + <formalpara> + + <title>Example</title> + + <para> <programlisting> [<emphasis>To be supplied...</emphasis>] </programlisting> - </para> - </formalpara> - - - </section> - - <section id="class-logfilegroup-getundofreewords"> - <title><literal>NdbDictionary::Object::LogfileGroup::getUndoFreeWords()</literal></title> - - <formalpara> - <title>Description</title> - - <para> - This method retrieves the number of bytes unused in the - logfile group's <literal>UNDO</literal> buffer. - </para> - </formalpara> - - <formalpara> - <title>Signature</title> - - <para> + </para> + + </formalpara> + + </section> + + <section id="class-logfilegroup-getundofreewords"> + + <title><literal>NdbDictionary::Object::LogfileGroup::getUndoFreeWords()</literal></title> + + <formalpara> + + <title>Description</title> + + <para> + This method retrieves the number of bytes unused in the + logfile group's <literal>UNDO</literal> buffer. + </para> + + </formalpara> + + <formalpara> + + <title>Signature</title> + + <para> <programlisting> Uint64 getUndoFreeWords ( void ) const </programlisting> - </para> - </formalpara> - - <formalpara> - <title>Parameters</title> - - <para> - <emphasis>None</emphasis>. - </para> - </formalpara> - - <formalpara> - <title>Return Value</title> - - <para> - The number of bytes free, as a 64-bit integer. - </para> - </formalpara> - - <formalpara> - <title>Example</title> - - <para> - + </para> + + </formalpara> + + <formalpara> + + <title>Parameters</title> + + <para> + <emphasis>None</emphasis>. + </para> + + </formalpara> + + <formalpara> + + <title>Return Value</title> + + <para> + The number of bytes free, as a 64-bit integer. + </para> + + </formalpara> + + <formalpara> + + <title>Example</title> + + <para> <programlisting> [<emphasis>To be supplied...</emphasis>] </programlisting> - </para> - </formalpara> - - - </section> - - <section id="class-logfilegroup-getobjectstatus"> - <title><literal>NdbDictionary::Object::LogfileGroup::getObjectStatus()</literal></title> - - <formalpara> - <title>Description</title> - - <para> - This method is used to obtain the object status of the - <literal>LogfileGroup</literal>. - </para> - </formalpara> - - <formalpara> - <title>Signature</title> - - <para> + </para> + + </formalpara> + + </section> + + <section id="class-logfilegroup-getobjectstatus"> + + <title><literal>NdbDictionary::Object::LogfileGroup::getObjectStatus()</literal></title> + + <formalpara> + + <title>Description</title> + + <para> + This method is used to obtain the object status of the + <literal>LogfileGroup</literal>. + </para> + + </formalpara> + + <formalpara> + + <title>Signature</title> + + <para> <programlisting> virtual Object::Status getObjectStatus ( void ) const </programlisting> - </para> - </formalpara> - - <formalpara> - <title>Parameters</title> - - <para> - <emphasis>None</emphasis>. - </para> - </formalpara> - - <formalpara> - <title>Return Value</title> - - <para> - The logfile group's <literal>Status</literal> — see <xref linkend="class-object-status"/> - for possible values. - </para> - </formalpara> - - <formalpara> - <title>Example</title> - - <para> - + </para> + + </formalpara> + + <formalpara> + + <title>Parameters</title> + + <para> + <emphasis>None</emphasis>. + </para> + + </formalpara> + + <formalpara> + + <title>Return Value</title> + + <para> + The logfile group's <literal>Status</literal> — + see <xref linkend="class-object-status"/> for possible + values. + </para> + + </formalpara> + + <formalpara> + + <title>Example</title> + + <para> <programlisting> [<emphasis>To be supplied...</emphasis>] </programlisting> - </para> - </formalpara> - - - </section> - - <section id="class-logfilegroup-getobjectversion"> - <title><literal>NdbDictionary::Object::LogfileGroup::getObjectVersion()</literal></title> - - <formalpara> - <title>Description</title> - - <para> - This method gets the logfile group's object version. - </para> - </formalpara> - - <formalpara> - <title>Signature</title> - - <para> + </para> + + </formalpara> + + </section> + + <section id="class-logfilegroup-getobjectversion"> + + <title><literal>NdbDictionary::Object::LogfileGroup::getObjectVersion()</literal></title> + + <formalpara> + + <title>Description</title> + + <para> + This method gets the logfile group's object version. + </para> + + </formalpara> + + <formalpara> + + <title>Signature</title> + + <para> <programlisting> virtual int getObjectVersion ( void ) const </programlisting> - </para> - </formalpara> - - <formalpara> - <title>Parameters</title> - - <para> - <emphasis>None</emphasis>. - </para> - </formalpara> - - <formalpara> - <title>Return Value</title> - - <para> - The object version of the logfile group, as an integer. - </para> - </formalpara> - - <formalpara> - <title>Example</title> - - <para> - + </para> + + </formalpara> + + <formalpara> + + <title>Parameters</title> + + <para> + <emphasis>None</emphasis>. + </para> + + </formalpara> + + <formalpara> + + <title>Return Value</title> + + <para> + The object version of the logfile group, as an integer. + </para> + + </formalpara> + + <formalpara> + + <title>Example</title> + + <para> <programlisting> [<emphasis>To be supplied...</emphasis>] </programlisting> - </para> - </formalpara> - - - </section> - - <section id="class-logfilegroup-getobjectid"> - <title><literal>NdbDictionary::Object::LogfileGroup::getObjectId()</literal></title> - - <formalpara> - <title>Description</title> - - <para> - This method is used to retrieve the object ID of the logfile - group. - </para> - </formalpara> - - <formalpara> - <title>Signature</title> - - <para> + </para> + + </formalpara> + + </section> + + <section id="class-logfilegroup-getobjectid"> + + <title><literal>NdbDictionary::Object::LogfileGroup::getObjectId()</literal></title> + + <formalpara> + + <title>Description</title> + + <para> + This method is used to retrieve the object ID of the + logfile group. + </para> + + </formalpara> + + <formalpara> + + <title>Signature</title> + + <para> <programlisting> virtual int getObjectId ( void ) const </programlisting> - </para> - </formalpara> - - <formalpara> - <title>Parameters</title> - - <para> - <emphasis>None</emphasis>. - </para> - </formalpara> - - <formalpara> - <title>Return Value</title> - - <para> - The logfile group's object ID (an integer value). - </para> - </formalpara> - - <formalpara> - <title>Example</title> - - <para> - + </para> + + </formalpara> + + <formalpara> + + <title>Parameters</title> + + <para> + <emphasis>None</emphasis>. + </para> + + </formalpara> + + <formalpara> + + <title>Return Value</title> + + <para> + The logfile group's object ID (an integer value). + </para> + + </formalpara> + + <formalpara> + + <title>Example</title> + + <para> <programlisting> [<emphasis>To be supplied...</emphasis>] </programlisting> - </para> - </formalpara> - - - </section> - - <section id="class-logfilegroup-setname"> - <title><literal>NdbDictionary::Object::LogfileGroup::setName()</literal></title> - - <formalpara> - <title>Description</title> - - <para> - This method is used to set a name for the logfile group. - </para> - </formalpara> - - <formalpara> - <title>Signature</title> - - <para> + </para> + + </formalpara> + + </section> + + <section id="class-logfilegroup-setname"> + + <title><literal>NdbDictionary::Object::LogfileGroup::setName()</literal></title> + + <formalpara> + + <title>Description</title> + + <para> + This method is used to set a name for the logfile group. + </para> + + </formalpara> + + <formalpara> + + <title>Signature</title> + + <para> <programlisting> void setName ( const char* <replaceable>name</replaceable> ) </programlisting> - </para> - </formalpara> - - <formalpara> - <title>Parameters</title> - - <para> - The <replaceable>name</replaceable> to be given to the logfile group (character pointer). - </para> - </formalpara> - - <formalpara> - <title>Return Value</title> - - <para> - <emphasis>None</emphasis>. - </para> - </formalpara> - - <formalpara> - <title>Example</title> - - <para> - + </para> + + </formalpara> + + <formalpara> + + <title>Parameters</title> + + <para> + The <replaceable>name</replaceable> to be given to the + logfile group (character pointer). + </para> + + </formalpara> + + <formalpara> + + <title>Return Value</title> + + <para> + <emphasis>None</emphasis>. + </para> + + </formalpara> + + <formalpara> + + <title>Example</title> + + <para> <programlisting> [<emphasis>To be supplied...</emphasis>] </programlisting> - </para> - </formalpara> - - - </section> - - <section id="class-logfilegroup-setundobuffersize"> - <title><literal>NdbDictionary::Object::LogfileGroup::setUndoBufferSize()</literal></title> - - <formalpara> - <title>Description</title> - - <para> - This method can be used to set the size of the logfile group's <literal>UNDO</literal> buffer. - </para> - </formalpara> - - <formalpara> - <title>Signature</title> - - <para> + </para> + + </formalpara> + + </section> + + <section id="class-logfilegroup-setundobuffersize"> + + <title><literal>NdbDictionary::Object::LogfileGroup::setUndoBufferSize()</literal></title> + + <formalpara> + + <title>Description</title> + + <para> + This method can be used to set the size of the logfile + group's <literal>UNDO</literal> buffer. + </para> + + </formalpara> + + <formalpara> + + <title>Signature</title> + + <para> <programlisting> void setUndoBufferSize ( Uint32 <replaceable>size</replaceable> ) </programlisting> - </para> - </formalpara> - - <formalpara> - <title>Parameters</title> - - <para> - The <replaceable>size</replaceable> in bytes for the - <literal>UNDO</literal> buffer (using a 32-bit unsigned integer - value). - </para> - </formalpara> - - <formalpara> - <title>Return Value</title> - - <para> - <emphasis>None</emphasis>. - </para> - </formalpara> - - <formalpara> - <title>Example</title> - - <para> - + </para> + + </formalpara> + + <formalpara> + + <title>Parameters</title> + + <para> + The <replaceable>size</replaceable> in bytes for the + <literal>UNDO</literal> buffer (using a 32-bit unsigned + integer value). + </para> + + </formalpara> + + <formalpara> + + <title>Return Value</title> + + <para> + <emphasis>None</emphasis>. + </para> + + </formalpara> + + <formalpara> + + <title>Example</title> + + <para> <programlisting> [<emphasis>To be supplied...</emphasis>] </programlisting> - </para> - </formalpara> - - - </section> - - <section id="class-logfilegroup-setautogrowspecification"> - <title><literal>NdbDictionary::Object::LogfileGroup::setAutoGrowSpecification()</literal></title> - - <formalpara> - <title>Description</title> - - <para> - This method sets to the <literal>AutoGrowSpecification</literal> data for the logfile - group. - </para> - </formalpara> - - <formalpara> - <title>Signature</title> - - <para> + </para> + + </formalpara> + + </section> + + <section id="class-logfilegroup-setautogrowspecification"> + + <title><literal>NdbDictionary::Object::LogfileGroup::setAutoGrowSpecification()</literal></title> + + <formalpara> + + <title>Description</title> + + <para> + This method sets to the + <literal>AutoGrowSpecification</literal> data for the + logfile group. + </para> + + </formalpara> + + <formalpara> + + <title>Signature</title> + + <para> <programlisting> void setAutoGrowSpecification ( const AutoGrowSpecification& <replaceable>autoGrowSpec</replaceable> ) </programlisting> - </para> - </formalpara> - - <formalpara> - <title>Parameters</title> - - <para> - The data is passed as a single parameter, an <literal>AutoGrowSpecification</literal> - data structure — see <xref linkend="struct-autogrowspecification"/>. - </para> - </formalpara> - - <formalpara> - <title>Return Value</title> - - <para> - <emphasis>None</emphasis>. - </para> - </formalpara> - - <formalpara> - <title>Example</title> - - <para> - + </para> + + </formalpara> + + <formalpara> + + <title>Parameters</title> + + <para> + The data is passed as a single parameter, an + <literal>AutoGrowSpecification</literal> data structure + — see + <xref linkend="struct-autogrowspecification"/>. + </para> + + </formalpara> + + <formalpara> + + <title>Return Value</title> + + <para> + <emphasis>None</emphasis>. + </para> + + </formalpara> + + <formalpara> + + <title>Example</title> + + <para> <programlisting> [<emphasis>To be supplied...</emphasis>] </programlisting> - </para> - </formalpara> - - -</section> - - + </para> - </section> - + </formalpara> + </section> + + </section> + </section> <section id="class-table"> @@ -16039,54 +16154,66 @@ </section> </section> - + <section id="struct-autogrowspecification"> + <title>The <literal>AutoGrowSpecification</literal> Structure</title> - + <abstract> + <para> - This section describes the <literal>AutoGrowSpecification</literal> structure. + This section describes the + <literal>AutoGrowSpecification</literal> structure. </para> + </abstract> - + <remark role="todo"> [js] Need some more info here... </remark> - + <formalpara> + <title>Description</title> + <para> The <literal>AutoGrowSpecification</literal> is a data structure defined in the <literal>NdbDictionary</literal> class, and is used as a parameter to or return value of some of the methods of the <literal>Tablespace</literal> and - <literal>LogfileGroup</literal> classes. See - <xref linkend="class-tablespace"/>, and + <literal>LogfileGroup</literal> classes. See + <xref linkend="class-tablespace"/>, and <xref linkend="class-logfilegroup"/>, for more information. </para> + </formalpara> - + <remark role="todo"> [js] Need descriptions of members - none in source. </remark> - + <formalpara> + <title>Public Members</title> + <para> <literal>AutoGrowSpecification</literal> has the following members, whose types are as shown in the following diagram: - <mediaobject> - <imageobject> - <imagedata + + <mediaobject> + <imageobject> + <imagedata fileref="images/NdbDictionary-AutoGrowSpecification-struct.png" format="PNG"/> - </imageobject> - <textobject> - <phrase lang="en">Members of the data structure - <literal>AutoGrowSpecification</literal>.</phrase> - </textobject> - </mediaobject> + </imageobject> + <textobject> + <phrase lang="en">Members of the data structure + <literal>AutoGrowSpecification</literal>.</phrase> + </textobject> + </mediaobject> + The purpose and use of each member can be found in the following table: + <informaltable> <tgroup cols="2"> <colspec colwidth="35*"/> @@ -16118,12 +16245,11 @@ </tgroup> </informaltable> </para> + </formalpara> - - + </section> - - + </section> <section id="class-ndbeventoperation">
| Thread | ||
|---|---|---|
| • svn commit - mysqldoc@docsrva: r2435 - trunk/ndbapi | jon | 20 Jun |
© 1995-2008 MySQL AB, 2008-2009 Sun Microsystems, Inc.
Page generated in 1.081 sec. using MySQL 5.1.14-beta-log