Author: jstephens
Date: 2006-06-21 21:20:09 +0200 (Wed, 21 Jun 2006)
New Revision: 2463
Log:
Reformat
Modified:
trunk/ndbapi/ndb-classes.xml
Modified: trunk/ndbapi/ndb-classes.xml
===================================================================
--- trunk/ndbapi/ndb-classes.xml 2006-06-21 19:18:09 UTC (rev 2462)
+++ trunk/ndbapi/ndb-classes.xml 2006-06-21 19:20:09 UTC (rev 2463)
@@ -7543,25 +7543,25 @@
<title>The <literal>Datafile</literal> Class</title>
- <abstract>
+ <abstract>
- <para>
- Thise section covers the <literal>Datafile</literal> class.
- </para>
+ <para>
+ Thise section covers the <literal>Datafile</literal> class.
+ </para>
- </abstract>
-
- <formalpara>
+ </abstract>
- <title>Description</title>
+ <formalpara>
- <para>
- The <literal>Datafile</literal> class models a Cluster Disk
- Data datafile, which is used to store Disk Data table data.
- </para>
+ <title>Description</title>
- </formalpara>
-
+ <para>
+ The <literal>Datafile</literal> class models a Cluster Disk
+ Data datafile, which is used to store Disk Data table data.
+ </para>
+
+ </formalpara>
+
<note>
<para>
In MySQL 5.1, only unindexed column data can be stored on
@@ -7570,1024 +7570,1177 @@
</para>
</note>
- <formalpara>
+ <formalpara>
- <title>Public Methods</title>
+ <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>
+ The following table lists the public methods of this class
+ and the purpose or use of each method:
+ </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>Datafile()</literal></entry>
- <entry>Class constructor</entry>
- </row>
- <row>
- <entry><literal>~Datafile()</literal></entry>
- <entry>Destructor</entry>
- </row>
- <row>
- <entry><literal>getPath()</literal></entry>
- <entry>Gets the filesystem path to the datafile</entry>
- </row>
- <row>
- <entry><literal>getSize()</literal></entry>
- <entry>Gets the size of the datafile</entry>
- </row>
- <row>
- <entry><literal>getFree()</literal></entry>
- <entry>Gets the amount of free space in the datafile</entry>
- </row>
- <row>
- <entry><literal>getNode()</literal></entry>
- <entry>Gets the ID of the node where the datafile is located</entry>
- </row>
- <row>
- <entry><literal>getTablespace()</literal></entry>
- <entry>Gets the name of the tablespace to which the datafile belongs</entry>
- </row>
- <row>
- <entry><literal>getTablespaceId()</literal></entry>
- <entry>Gets the ID of the tablespace to which the datafile
- belongs</entry>
- </row>
- <row>
- <entry><literal>getFileNo()</literal></entry>
- <entry>Gets the number of the datafile in the table space</entry>
- </row>
- <row>
- <entry><literal>getObjectStatus()</literal></entry>
- <entry>Gets the datafile's object status</entry>
- </row>
- <row>
- <entry><literal>getObjectVersion()</literal></entry>
- <entry>Gets the datafile's object version</entry>
- </row>
- <row>
- <entry><literal>getObjectId()</literal></entry>
- <entry>Gets the datafile's object ID</entry>
- </row>
- <row>
- <entry><literal>setPath()</literal></entry>
- <entry>Sets the name and location of the datafile on the filesystem</entry>
- </row>
- <row>
- <entry><literal>setSize()</literal></entry>
- <entry>Sets the datafile's size</entry>
- </row>
- <row>
- <entry><literal>setTablespace()</literal></entry>
- <entry>Sets the tablespace to which the datafile belongs</entry>
- </row>
- <row>
- <entry><literal>setNode()</literal></entry>
- <entry>Sets the Cluster node where the datafile is to be
- located</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
+ <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>Datafile()</literal></entry>
+ <entry>Class constructor</entry>
+ </row>
+ <row>
+ <entry><literal>~Datafile()</literal></entry>
+ <entry>Destructor</entry>
+ </row>
+ <row>
+ <entry><literal>getPath()</literal></entry>
+ <entry>Gets the filesystem path to the datafile</entry>
+ </row>
+ <row>
+ <entry><literal>getSize()</literal></entry>
+ <entry>Gets the size of the datafile</entry>
+ </row>
+ <row>
+ <entry><literal>getFree()</literal></entry>
+ <entry>Gets the amount of free space in the datafile</entry>
+ </row>
+ <row>
+ <entry><literal>getNode()</literal></entry>
+ <entry>Gets the ID of the node where the datafile is located</entry>
+ </row>
+ <row>
+ <entry><literal>getTablespace()</literal></entry>
+ <entry>Gets the name of the tablespace to which the datafile belongs</entry>
+ </row>
+ <row>
+ <entry><literal>getTablespaceId()</literal></entry>
+ <entry>Gets the ID of the tablespace to which the datafile belongs</entry>
+ </row>
+ <row>
+ <entry><literal>getFileNo()</literal></entry>
+ <entry>Gets the number of the datafile in the table space</entry>
+ </row>
+ <row>
+ <entry><literal>getObjectStatus()</literal></entry>
+ <entry>Gets the datafile's object status</entry>
+ </row>
+ <row>
+ <entry><literal>getObjectVersion()</literal></entry>
+ <entry>Gets the datafile's object version</entry>
+ </row>
+ <row>
+ <entry><literal>getObjectId()</literal></entry>
+ <entry>Gets the datafile's object ID</entry>
+ </row>
+ <row>
+ <entry><literal>setPath()</literal></entry>
+ <entry>Sets the name and location of the datafile on the filesystem</entry>
+ </row>
+ <row>
+ <entry><literal>setSize()</literal></entry>
+ <entry>Sets the datafile's size</entry>
+ </row>
+ <row>
+ <entry><literal>setTablespace()</literal></entry>
+ <entry>Sets the tablespace to which the datafile belongs</entry>
+ </row>
+ <row>
+ <entry><literal>setNode()</literal></entry>
+ <entry>Sets the Cluster node where the datafile is to be located</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
- <para>
- For detailed descriptions, signatures, and examples of use for each
- of these methods, see <xref linkend="class-datafile-members"/>.
- </para>
+ <para>
+ For detailed descriptions, signatures, and examples of use for
+ each of these methods, see
+ <xref linkend="class-datafile-members"/>.
+ </para>
- <formalpara>
+ <formalpara>
- <title>Public Types</title>
+ <title>Public Types</title>
- <para>
- The <literal>Datafile</literal> class defines no public types.
- </para>
+ <para>
+ The <literal>Datafile</literal> class defines no public
+ types.
+ </para>
- </formalpara>
+ </formalpara>
- <formalpara>
+ <formalpara>
- <title>Class Diagram</title>
+ <title>Class Diagram</title>
- <para>
- This diagram shows all the available methods
- of the <literal>Datafile</literal> class:
+ <para>
+ This diagram shows all the available methods of the
+ <literal>Datafile</literal> class:
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/NdbDictionary-Object-Datafile-class.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase lang="en">Public methods of the
- <literal>Datafile</literal> class.</phrase>
- </textobject>
- </mediaobject>
- </para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/NdbDictionary-Object-Datafile-class.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Public methods of the
+ <literal>Datafile</literal> class.</phrase>
+ </textobject>
+ </mediaobject>
+ </para>
- </formalpara>
+ </formalpara>
- <section id="class-datafile-members">
+ <section id="class-datafile-members">
- <title><literal>Datafile</literal> Class Members</title>
-
- <abstract>
- <para>
- This section provides descriptions of the public methods of the
- <literal>Datafile</literal> class.
- </para>
- </abstract>
-
- <section id="class-datafile-constructor">
- <title><literal>Datafile</literal> Class Constructor</title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method creates a new instance of <literal>Datafile</literal>, or a copy of an
- existing one.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
- To create a new instance:
+ <title><literal>Datafile</literal> Class Members</title>
+
+ <abstract>
+
+ <para>
+ This section provides descriptions of the public methods
+ of the <literal>Datafile</literal> class.
+ </para>
+
+ </abstract>
+
+ <section id="class-datafile-constructor">
+
+ <title><literal>Datafile</literal> Class Constructor</title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method creates a new instance of
+ <literal>Datafile</literal>, or a copy of an existing
+ one.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+ To create a new instance:
+
<programlisting>
Datafile
(
void
)
</programlisting>
- To create a copy of an existing <literal>Datafile</literal> instance:
+
+ To create a copy of an existing
+ <literal>Datafile</literal> instance:
+
<programlisting>
Datafile
(
const Datafile& <replaceable>datafile</replaceable>
)
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- New instance: <emphasis>None</emphasis>. Copy constructor: a
- reference to the <literal>Datafile</literal> instance to be copied.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- A <literal>Datafile</literal> object.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ New instance: <emphasis>None</emphasis>. Copy
+ constructor: a reference to the
+ <literal>Datafile</literal> instance to be copied.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ A <literal>Datafile</literal> object.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
- </section>
-
- <section id="class-datafile-getpath">
- <title><literal>NdbDictionary::Object::Datafile::getPath()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method returns the filesystem path to the datafile.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-datafile-getpath">
+
+ <title><literal>NdbDictionary::Object::Datafile::getPath()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method returns the filesystem path to the datafile.
+ </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 path to the datafile on the data node's filesystem, a string
- (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 path to the datafile on the data node's filesystem,
+ a string (character pointer).
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
- </section>
-
- <section id="class-datafile-getsize">
- <title><literal>NdbDictionary::Object::Datafile::getSize()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method gets the size of the datafile in bytes.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-datafile-getsize">
+
+ <title><literal>NdbDictionary::Object::Datafile::getSize()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method gets the size of the datafile 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 of the data file, in bytes, as an unsigned 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 size of the data file, in bytes, 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-datafile-getfree">
- <title><literal>NdbDictionary::Object::Datafile::getFree()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method gets the free space available in the datafile.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-datafile-getfree">
+
+ <title><literal>NdbDictionary::Object::Datafile::getFree()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method gets the free space available in the
+ datafile.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
Uint64 getFree
(
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 in the datafile, as an unsigned 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 in the datafile, 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-datafile-gettablespace">
- <title><literal>NdbDictionary::Object::Datafile::getTablespace()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method can be used to obtain the name of the tablespace to
- which the datafile belongs.
- </para>
- </formalpara>
-
- <note>
- <para>
- You can also access the associated tablespace's ID directly.
- See <xref linkend="class-datafile-gettablespaceid"/>.
- </para>
- </note>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-datafile-gettablespace">
+
+ <title><literal>NdbDictionary::Object::Datafile::getTablespace()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method can be used to obtain the name of the
+ tablespace to which the datafile belongs.
+ </para>
+
+ </formalpara>
+
+ <note>
+ <para>
+ You can also access the associated tablespace's ID
+ directly. See
+ <xref linkend="class-datafile-gettablespaceid"/>.
+ </para>
+ </note>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
const char* getTablespace
(
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 associated tablespace (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 name of the associated tablespace (as a character
+ pointer).
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
-</section>
+ </para>
+ </formalpara>
-<section id="class-datafile-gettablespaceid">
- <title><literal>NdbDictionary::Object::Datafile::getTablespaceId()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method gets the ID of the tablespace to which the datafile
- belongs.
- </para>
- </formalpara>
-
- <note>
- <para>
- You can also access the name of the associated tablespace directly.
- See <xref linkend="class-datafile-gettablespace"/>.
- </para>
- </note>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+ </section>
+
+ <section id="class-datafile-gettablespaceid">
+
+ <title><literal>NdbDictionary::Object::Datafile::getTablespaceId()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method gets the ID of the tablespace to which the
+ datafile belongs.
+ </para>
+
+ </formalpara>
+
+ <note>
+ <para>
+ You can also access the name of the associated
+ tablespace directly. See
+ <xref linkend="class-datafile-gettablespace"/>.
+ </para>
+ </note>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
Uint32 getTablespaceId
(
void
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- The is method returns the tablespace ID as an unsigned 32-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 is method returns the tablespace 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-datafile-getnode">
- <title><literal>NdbDictionary::Object::Datafile::getBode()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method retrieves the ID of the Cluster node on which the
- datafile resides.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-datafile-getnode">
+
+ <title><literal>NdbDictionary::Object::Datafile::getBode()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method retrieves the ID of the Cluster node on
+ which the datafile resides.
+ </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>
-
+ </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-datafile-getfileno">
- <title><literal>NdbDictionary::Object::Datafile::getFileNo()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method gets the number of the file within the associated tablespace.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-datafile-getfileno">
+
+ <title><literal>NdbDictionary::Object::Datafile::getFileNo()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method gets the number of the file within the
+ associated tablespace.
+ </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 file number, as an unsigned 32-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 file number, 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-datafile-getobjectstatus">
- <title><literal>NdbDictionary::Object::Datafile::getObjectStatus()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method is used to obtain the datafile's object status.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-datafile-getobjectstatus">
+
+ <title><literal>NdbDictionary::Object::Datafile::getObjectStatus()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to obtain the datafile's object
+ status.
+ </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 datafile's <literal>Status</literal>. See
- <xref linkend="class-object-status"/>.
- </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 datafile's <literal>Status</literal>. See
+ <xref linkend="class-object-status"/>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
-</section>
-
-
- <section id="class-datafile-getobjectversion">
- <title><literal>NdbDictionary::Object::Datafile::getObjectVersion()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method retrieves the datafile's object version.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-datafile-getobjectversion">
+
+ <title><literal>NdbDictionary::Object::Datafile::getObjectVersion()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method retrieves the datafile'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 datafile's object version, 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 datafile's 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-datafile-getobjectid">
- <title><literal>NdbDictionary::Object::Datafile::getObjectId()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method is used to obtain the object ID of the datafile.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-datafile-getobjectid">
+
+ <title><literal>NdbDictionary::Object::Datafile::getObjectId()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to obtain the object ID of the
+ datafile.
+ </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 datafile's object ID, 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 datafile's object ID, as an integer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
-</section>
+ </para>
+ </formalpara>
-<section id="class-datafile-setpath">
- <title><literal>NdbDictionary::Object::Datafile::setPath()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method sets the path to the datafile on the data node's
- filesystem.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+ </section>
+
+ <section id="class-datafile-setpath">
+
+ <title><literal>NdbDictionary::Object::Datafile::setPath()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method sets the path to the datafile 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>
- The path to the file, astring (as a 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 path to the file, astring (as a 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>
+ </para>
+ </formalpara>
-<section id="class-datafile-setsize">
- <title><literal>NdbDictionary::Object::Datafile::setSize()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method sets the size of the datafile.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+ </section>
+
+ <section id="class-datafile-setsize">
+
+ <title><literal>NdbDictionary::Object::Datafile::setSize()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method sets the size of the datafile.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
void setSize
(
Uint64 <replaceable>size</replaceable>
)
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- This method takes a single parameter — the desired <replaceable>size</replaceable> in
- bytes for the datafile, as an unsigned 64-bit integer.
- </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>
+ This method takes a single parameter — the desired
+ <replaceable>size</replaceable> in bytes for the
+ datafile, 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>
+ </para>
-<section id="class-datafile-settablespace">
- <title><literal>NdbDictionary::Object::Datafile::setTablespace()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method is used to associate the datafile with a tablespace.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signatures</title>
-
- <para>
- <literal>setTablespace()</literal> can be invoked with either the
- name of the tablespace, as shown here:
+ </formalpara>
+
+ </section>
+
+ <section id="class-datafile-settablespace">
+
+ <title><literal>NdbDictionary::Object::Datafile::setTablespace()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to associate the datafile with a
+ tablespace.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signatures</title>
+
+ <para>
+ <literal>setTablespace()</literal> can be invoked with
+ either the name of the tablespace, as shown here:
+
<programlisting>
void setTablespace
(
const char* <replaceable>name</replaceable>
)
</programlisting>
- Or with a reference to a <literal>Tablespace</literal> object.
+
+ Or with a reference to a <literal>Tablespace</literal>
+ object.
+
<programlisting>
void setTablespace
(
const class Tablespace& <replaceable>tablespace</replaceable>
)
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- This method takes a single parameter, which can be either one of
- the following:
- <itemizedlist>
- <listitem>
- <para>
- The <replaceable>name</replaceable> of the tablespace
- (as a character pointer).
- </para>
- </listitem>
-
- <listitem>
- <para>
- A reference <replaceable>tablespace</replaceable> to the
- corresponding <literal>Tablespace</literal> object.
- </para>
- </listitem>
- </itemizedlist>
-
- </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>
+ This method takes a single parameter, which can be
+ either one of the following:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ The <replaceable>name</replaceable> of the
+ tablespace (as a character pointer).
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ A reference <replaceable>tablespace</replaceable>
+ to the corresponding <literal>Tablespace</literal>
+ object.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </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-datafile-setnode">
- <title><literal>NdbDictionary::Object::Datafile::setNode()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- Designates the node to which this datafile belongs.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-datafile-setnode">
+
+ <title><literal>NdbDictionary::Object::Datafile::setNode()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ Designates the node to which this datafile belongs.
+ </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 node on which the
- datafile is to be located (an unsigned 32-bit 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>nodeId</replaceable> of the node on
+ which the datafile is to be located (an unsigned 32-bit
+ 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>
+ </para>
+ </formalpara>
+ </section>
- </section>
+ </section>
</section>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r2463 - trunk/ndbapi | jon | 21 Jun |
