Author: jstephens
Date: 2006-06-21 09:29:20 +0200 (Wed, 21 Jun 2006)
New Revision: 2452
Log:
Tablespace class - method descriptions.
Modified:
trunk/ndbapi/ndb-classes.xml
Modified: trunk/ndbapi/ndb-classes.xml
===================================================================
--- trunk/ndbapi/ndb-classes.xml 2006-06-21 05:07:05 UTC (rev 2451)
+++ trunk/ndbapi/ndb-classes.xml 2006-06-21 07:29:20 UTC (rev 2452)
@@ -16299,6 +16299,795 @@
API's <literal>Tablespace</literal> class.
</para>
</abstract>
+
+ <section id="class-tablespace-constructor">
+ <title><literal>Tablespace</literal> Constructor</title>
+
+ <formalpara>
+ <title>Description</title>
+
+ <para>
+ These methods are used to create a new instance of
+ <literal>Tablespace</literal>, or
+ to copy an existing one.
+ </para>
+ </formalpara>
+
+ <note>
+ <para>
+ The <literal>NdbDictionary::Dictionary</literal> class also supplies methods for creating and
+ dropping tablespaces. See <xref linkend="class-dictionary"/>.
+ </para>
+ </note>
+
+ <formalpara>
+ <title>Signatures</title>
+
+ <para>
+ New instance:
+<programlisting>
+Tablespace
+ (
+ void
+ )
+</programlisting>
+ Copy constructor:
+<programlisting>
+Tablespace
+ (
+ const Tablespace& <replaceable>tablespace</replaceable>
+ )
+</programlisting>
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Parameters</title>
+
+ <para>
+ New instance: <emphasis>None</emphasis>. Copy constructor: a
+ reference <replaceable>tablespace</replaceable> to an existing <literal>Tablespace</literal> instance.
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Return Value</title>
+
+ <para>
+ A <literal>Tablespace</literal> object.
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Destructor</title>
+ <para>
+ The class defines a virtual destructor <literal>~Tablespace()</literal> which takes
+ no arguments and returns no value.
+ </para>
+ </formalpara>
+
+
+ <formalpara>
+ <title>Example</title>
+
+ <para>
+
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+ </formalpara>
+
+
+ </section>
+
+ <section id="class-tablespace-getname">
+ <title><literal>NdbDictionary::Object::Tablespace::getName()</literal></title>
+
+ <formalpara>
+ <title>Description</title>
+
+ <para>
+ This method retrieves the name of the tablespace.
+ </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 name of the tablespace, 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-tablespace-getextentsize">
+ <title><literal>NdbDictionary::Object::Tablespace::getExtentSize()</literal></title>
+
+ <formalpara>
+ <title>Description</title>
+
+ <para>
+ This method is used to retrieve the <firstterm>extent
+ size</firstterm> — that is the size of the memory
+ allocation units — used by the tablespace.
+ </para>
+ </formalpara>
+
+ <note>
+ <para>
+ The same extent size is used for all datafiles contained in a
+ given tablespace.
+ </para>
+ </note>
+
+ <formalpara>
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+Uint32 getExtentSize
+ (
+ void
+ ) const
+</programlisting>
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Return Value</title>
+
+ <para>
+ The tablespace's extent size in bytes, 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-tablespace-getautogrowspecification">
+ <title><literal>NdbDictionary::Object::Tablespace::getAutoGrowSpecification()</literal></title>
+
+ <formalpara>
+ <title>Description</title>
+
+ <para>
+
+ </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>
+ A reference to the structure which describes the tablespace
+ auto-grow characteristics — for details, see
+ <xref linkend="struct-autogrowspecification"/>.
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Example</title>
+
+ <para>
+
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+ </formalpara>
+
+
+ </section>
+
+
+ <section id="class-tablespace-getdefaultlogfilegroup">
+ <title><literal>NdbDictionary::Object::Tablespace::getDefaultLogfileGroup()</literal></title>
+
+ <formalpara>
+ <title>Description</title>
+
+ <para>
+ This method retrieves the name of the tablespace's default logfile
+ group.
+ </para>
+ </formalpara>
+
+ <note>
+ <para>
+ Alternatively, you may wish to obtain the ID of the default
+ logfile group — see
+ <xref linkend="class-tablespace-getdefaultlogfilegroupid"/>.
+ </para>
+ </note>
+
+ <formalpara>
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+const char* getDefaultLogfileGroup
+ (
+ 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 (string value as character pointer).
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Example</title>
+
+ <para>
+
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+ </formalpara>
+
+
+</section>
+
+
+ <section id="class-tablespace-getdefaultlogfilegroupid">
+ <title><literal>NdbDictionary::Object::Tablespace::getDefaultLogfileGroupId()</literal></title>
+
+ <formalpara>
+ <title>Description</title>
+
+ <para>
+ This method retrieves the ID of the tablespace's default logfile
+ group.
+ </para>
+ </formalpara>
+
+ <note>
+ <para>
+ You can also obtain directly the name of the default
+ logfile group rather than its ID — see
+ <xref linkend="class-tablespace-getdefaultlogfilegroup"/>.
+ </para>
+ </note>
+
+ <formalpara>
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+Uint32 getDefaultLogfileGroupId
+ (
+ 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-tablespace-getobjectstatus">
+ <title><literal>NdbDictionary::Object::Tablespace::getObjectStatus()</literal></title>
+
+ <formalpara>
+ <title>Description</title>
+
+ <para>
+ This method is used to retrieve the object status of a tablespace.
+ </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-tablespace-getobjectversion">
+ <title><literal>NdbDictionary::Object::Tablespace::getObjectVersion()</literal></title>
+
+ <formalpara>
+ <title>Description</title>
+
+ <para>
+ This method gets the tablespace 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-tablespace-getobjectid">
+ <title><literal>NdbDictionary::Object::Tablespace::getObjectId()</literal></title>
+
+ <formalpara>
+ <title>Description</title>
+
+ <para>
+ This method retrieves the tablespace'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 id="class-tablespace-setname">
+ <title><literal>NdbDictionary::Object::Tablespace::setName()</literal></title>
+
+ <formalpara>
+ <title>Description</title>
+
+ <para>
+ This method sets the name of the tablespace.
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+void setName
+ (
+ const char* <replaceable>name</replaceable>
+ ) const
+</programlisting>
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Parameters</title>
+
+ <para>
+ The <replaceable>name</replaceable> of the tablespace, a string (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-tablespace-setextentsize">
+ <title><literal>NdbDictionary::Object::Tablespace::setExtentSize()</literal></title>
+
+ <formalpara>
+ <title>Description</title>
+
+ <para>
+ This method sets the tablespace's extent size.
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+void setExtentSize
+ (
+ Uint32 <replaceable>size</replaceable>
+ )
+</programlisting>
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Parameters</title>
+
+ <para>
+ The <replaceable>size</replaceable> to be used for this tablespace's extents, in bytes.
+ </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-tablespace-setautogrowspecification">
+ <title><literal>NdbDictionary::Object::Tablespace::setAutoGrowSpecification()</literal></title>
+
+ <formalpara>
+ <title>Description</title>
+
+ <para>
+ This method is used to set the auto-grow characteristics of the
+ tablespace.
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+void setAutoGrowSpecification
+ (
+ const AutoGrowSpecification& <replaceable>autoGrowSpec</replaceable>
+ )
+</programlisting>
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Parameters</title>
+
+ <para>
+ This method takes 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>
+
+ <section id="class-tablespace-setdefaultlogfilegroup">
+ <title><literal>NdbDictionary::Object::Tablespace::setDefaultLogfileGroup()</literal></title>
+
+ <formalpara>
+ <title>Description</title>
+
+ <para>
+ This method is used to set a tablespace's default logfile group.
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Signature</title>
+
+ <para>
+ This method can be called in two different ways. The first of
+ these uses the
+ name of the logfile group, as shown here:
+<programlisting>
+void setDefaultLogfileGroup
+ (
+ const char* <replaceable>name</replaceable>
+ )
+</programlisting>
+ This method can also be called by passing it a reference to a
+ <literal>LogfileGroup</literal> object:
+<programlisting>
+void setDefaultLogfileGroup
+ (
+ const class LogfileGroup& <replaceable>lGroup</replaceable>
+ )
+</programlisting>
+ </para>
+ </formalpara>
+
+ <note>
+ <para>
+ There is no method for setting a logfile group as the the
+ default for a tablespace by referencing the logfile group's
+ ID. (In other words, there is no <literal>set<replaceable>*</replaceable>()</literal> method corresponding to
+ <literal>getDefaultLogfileGroupId()</literal>.)
+ </para>
+ </note>
+
+ <formalpara>
+ <title>Parameters</title>
+
+ <para>
+ Either the <replaceable>name</replaceable> of the logfile group to
+ be assigned to the tablespace, or a reference
+ <replaceable>lGroup</replaceable> to this logfile group.
+ </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>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r2452 - trunk/ndbapi | jon | 21 Jun |
