Author: jstephens
Date: 2006-06-22 19:25:11 +0200 (Thu, 22 Jun 2006)
New Revision: 2475
Log:
Undofile class/members/reformat.
Updated Makefile.
Modified:
trunk/ndbapi/Makefile
trunk/ndbapi/ndb-classes.xml
Modified: trunk/ndbapi/Makefile
===================================================================
--- trunk/ndbapi/Makefile 2006-06-22 16:22:25 UTC (rev 2474)
+++ trunk/ndbapi/Makefile 2006-06-22 17:25:11 UTC (rev 2475)
@@ -31,7 +31,7 @@
NDBAPI_SRCS_EXTRA = ndb.en.ent
-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-Datafile-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-Object-Tablespace-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-Datafile-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-Object-Tablespace-class.png images/NdbDictionary-Object-Undofile-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-22 16:22:25 UTC (rev 2474)
+++ trunk/ndbapi/ndb-classes.xml 2006-06-22 17:25:11 UTC (rev 2475)
@@ -18422,12 +18422,1117 @@
<title>The <literal>Undofile</literal> Class</title>
-<!-- <abstract> -->
+ <abstract>
- <para/>
+ <para>
+ The section discusses the <literal>Undofile</literal> class
+ and its public methods.
+ </para>
-<!-- </abstract> -->
+ </abstract>
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ The <literal>Undofile</literal> class models a Cluster Disk
+ Data undofile, which stores data used for rolling back
+ transactions.
+ </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>Undofile()</literal></entry>
+ <entry>Class constructor</entry>
+ </row>
+ <row>
+ <entry><literal>~Undofile()</literal></entry>
+ <entry>Virtual destructor</entry>
+ </row>
+ <row>
+ <entry><literal>getPath()</literal></entry>
+ <entry>Gets the undofile's filesystem path</entry>
+ </row>
+ <row>
+ <entry><literal>getSize()</literal></entry>
+ <entry>Gets the size of the undofile</entry>
+ </row>
+ <row>
+ <entry><literal>getLogfileGroup()</literal></entry>
+ <entry>Gets the name of the logfile group to which the undofile belongs</entry>
+ </row>
+ <row>
+ <entry><literal>getLogfileGroupId()</literal></entry>
+ <entry>Gets the ID of the logfile group to which the undofile belongs</entry>
+ </row>
+ <row>
+ <entry><literal>getNode()</literal></entry>
+ <entry>Gets the node where the undofile is located</entry>
+ </row>
+ <row>
+ <entry><literal>getFileNo()</literal></entry>
+ <entry>Gets the number of the undofile in the logfile group</entry>
+ </row>
+ <row>
+ <entry><literal>getObjectStatus()</literal></entry>
+ <entry>Gets the undofile's <literal>Status</literal></entry>
+ </row>
+ <row>
+ <entry><literal>getObjectVersion()</literal></entry>
+ <entry>Gets the undofile's object version</entry>
+ </row>
+ <row>
+ <entry><literal>getObjectId()</literal></entry>
+ <entry>Gets the undofile's object ID</entry>
+ </row>
+ <row>
+ <entry><literal>setPath()</literal></entry>
+ <entry>Sets the filesystem path for the undofile</entry>
+ </row>
+ <row>
+ <entry><literal>setSize()</literal></entry>
+ <entry>Sets the undofile's size</entry>
+ </row>
+ <row>
+ <entry><literal>setLogfileGroup()</literal></entry>
+ <entry>Sets the undofile's logfile group using the name of the logfile group or
+ a reference to the corresponding
+ <literal>LogfileGroup</literal> object</entry>
+ </row>
+ <row>
+ <entry><literal>setNode()</literal></entry>
+ <entry>Sets the node on which the undofile is located</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+ <para>
+ For detailed descriptions, signatures, and examples of use for
+ each of these methods, see
+ <xref linkend="class-undofile-members"/>.
+ </para>
+
+ <formalpara>
+
+ <title>Public Types</title>
+
+ <para>
+ The <literal>Undofile</literal> class defines no public
+ types.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Class Diagram</title>
+
+ <para>
+ This diagram shows all the available methods of the
+ <literal>Undofile</literal> class:
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/NdbDictionary-Object-Undofile-class.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Public methods of the
+ <literal>Undofile</literal> class.</phrase>
+ </textobject>
+ </mediaobject>
+ </para>
+
+ </formalpara>
+
+ <section id="class-undofile-members">
+
+ <title><literal>Undofile</literal> Class Members</title>
+
+ <abstract>
+
+ <para>
+ This section details the public methods of the
+ <literal>Undofile</literal> class.
+ </para>
+
+ </abstract>
+
+ <section id="class-undofile-constructor">
+
+ <title><literal></literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ The class constructor can be used to create a new
+ <literal>Undofile</literal> instance, or to copy an
+ existing one.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signatures</title>
+
+ <para>
+ Creates a new instance:
+
+<programlisting>
+Undofile
+ (
+ void
+ )
+</programlisting>
+
+ Copy constructor:
+
+<programlisting>
+Undofile
+ (
+ const Undofile& <replaceable>undoFile</replaceable>
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ New instance: <emphasis>None</emphasis>. The copy
+ constructor takes a single argument — a reference
+ to the <literal>Undofile</literal> object to be copied.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ An <literal>Undofile</literal> object.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Destructor</title>
+
+ <para>
+ The class defines a virtual destructor which takes no
+ arguments and has the return type
+ <literal>void</literal>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-undofile-getpath">
+
+ <title><literal>NdbDictionary::Object::Undofile::getPath()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method retrieves the path matching the location of
+ the undofile on the data node's filesystem.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+const char* getPath
+ (
+ void
+ ) const
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The filesystem path, 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-undofile-getsize">
+
+ <title><literal>NdbDictionary::Object::Undofile::getSize()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method gets the size of the undofile in bytes.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+Uint64 getSize
+ (
+ void
+ ) const
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The size in bytes of the undofile, as an unsigned 64-bit
+ integer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-undofile-getlogfilegroup">
+
+ <title><literal>NdbDictionary::Object::Undofile::getLogfileGroup()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method retrieves the name of the logfile group to
+ which the undofile belongs.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+const char* getLogfileGroup
+ (
+ void
+ ) const
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The name of the logfile group, a string value (as a
+ character pointer).
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-undofile-getlogfilegroupid">
+
+ <title><literal>NdbDictionary::Object::Undofile::getLogfileGroupId()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method retrieves the ID of the logfile group to
+ which the undofile belongs.
+ </para>
+
+ </formalpara>
+
+ <note>
+ <para>
+ It is also possible to obtain the name of the logfile
+ group directly. See
+ <xref linkend="class-undofile-getlogfilegroup"/>
+ </para>
+ </note>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+Uint32 getLogfileGroupId
+ (
+ void
+ ) const
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The ID of the logfile group, as an unsigned 32-bit
+ integer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-undofile-getnode">
+
+ <title><literal>NdbDictionary::Object::Undofile::getNode()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to retrieve the node ID of the node
+ where the undofile is located.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+Uint32 getNode
+ (
+ void
+ ) const
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The node ID, as an unsigned 32-bit integer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-undofile-getfileno">
+
+ <title><literal>NdbDictionary::Object::Undofile::getFileNo()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ The <literal>getFileNo()</literal> method gets the
+ number of the undofile in the logfile group to which it
+ belongs.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+Uint32 getFileNo
+ (
+ void
+ ) const
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The number of the undofile, as an unsigned 32-bit
+ integer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-undofile-getobjectstatus">
+
+ <title><literal>NdbDictionary::Object::Undofile::getObjectStatus()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to retrieve the object status of an
+ undofile.
+ </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>
+ An <literal>Object::Status</literal> value — see
+ <xref linkend="class-object-status"/>, for details.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-undofile-getobjectversion">
+
+ <title><literal>NdbDictionary::Object::Undofile::getObjectVersion()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method gets the undofile'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, as an integer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-undofile-getobjectid">
+
+ <title><literal>NdbDictionary::Object::Undofile::getObjectId()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method retrieves the undofile's object ID.
+ </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 object ID, as an integer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ </section>
+
+ <section id="class-undofile-setpath">
+
+ <title><literal>NdbDictionary::Object::Undofile::setPath()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to set the filesystem path of the
+ undofile on the data node where it resides.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+void setPath
+ (
+ const char* <replaceable>path</replaceable>
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ The desired <replaceable>path</replaceable> to the
+ undofile.
+ </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-undofile-setsize">
+
+ <title><literal>NdbDictionary::Object::Undofile::setSize()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ Sets the size of the undofile in bytes.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+void setSize
+ (
+ Uint64 <replaceable>size</replaceable>
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ The intended <replaceable>size</replaceable> of the
+ undofile in bytes, as an unsigned 64-bit integer.
+ </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-undofile-setlogfilegroup">
+
+ <title><literal>NdbDictionary::Object::Undofile::setLogfileGroup()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ Given either a name or an object reference to a logfile
+ group, the <literal>setLogfileGroup()</literal> method
+ assigns the undofile to that logfile group.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+ Using a logfile group name:
+
+<programlisting>
+void setLogfileGroup
+ (
+ const char* <replaceable>name</replaceable>
+ )
+</programlisting>
+
+ Using a reference to a LogfileGroup instance:
+
+<programlisting>
+void setLogfileGroup
+ (
+ const class LogfileGroup & <replaceable>logfileGroup</replaceable>
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ The <replaceable>name</replaceable> of the logfile group
+ (a character pointer), or a reference to a
+ <literal>LogfileGroup</literal> instance.
+ </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-undofile-setnode">
+
+ <title><literal>NdbDictionary::Object::Undofile::setNode()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ Sets the node on which the logfile group is to reside.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+ void setNode
+ (
+ Uint32 <replaceable>nodeId</replaceable>
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ The <replaceable>nodeId</replaceable> of the data node
+ where the undofile is to be placed; this is an unsigned
+ 32-bit integer.
+ </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>
</section>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r2475 - trunk/ndbapi | jon | 22 Jun |
