| List: | Commits | « Previous MessageNext Message » | |
| From: | jon | Date: | June 21 2006 10:18am |
| Subject: | svn commit - mysqldoc@docsrva: r2453 - trunk/ndbapi | ||
| View as plain text | |||
Author: jstephens Date: 2006-06-21 10:18:21 +0200 (Wed, 21 Jun 2006) New Revision: 2453 Log: Reformat. Modified: trunk/ndbapi/ndb-classes.xml Modified: trunk/ndbapi/ndb-classes.xml =================================================================== --- trunk/ndbapi/ndb-classes.xml 2006-06-21 07:29:20 UTC (rev 2452) +++ trunk/ndbapi/ndb-classes.xml 2006-06-21 08:18:21 UTC (rev 2453) @@ -16133,964 +16133,1096 @@ <title>The <literal>Tablespace</literal> Class</title> - <abstract> + <abstract> + <para> + This section discusses the <literal>Tablespace</literal> + class and its public members. + </para> + + </abstract> + + <formalpara> + + <title>Description</title> + + <para> + The <literal>Tablespace</literal> class models a MySQL + Cluster Disk Data tablespace, which contains the datafiles + used to store Cluster Disk Data. For an overview of Cluster + Disk Data and their characteristics, see + <ulink url="&refman-base-url;/create-tablespace"><literal>CREATE + TABLESPACE</literal></ulink>, in 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>Tablespace()</literal></entry> + <entry>Class constructor</entry> + </row> + <row> + <entry><literal>~Tablespace()</literal></entry> + <entry>Virtual destructor method</entry> + </row> + <row> + <entry><literal>getName()</literal></entry> + <entry>Gets the name of the tablespace</entry> + </row> + <row> + <entry><literal>getExtentSize()</literal></entry> + <entry>Gets the extent size used by the tablespace</entry> + </row> + <row> + <entry><literal>getAutoGrowSpecification()</literal></entry> + <entry>Used to obtain the AutoGrowSpecification structure associated with the + tablespace</entry> + </row> + <row> + <entry><literal>getDefaultLogfileGroup()</literal></entry> + <entry>Gets the name of the tablespace's default logfile group</entry> + </row> + <row> + <entry><literal>getDefaultLogfileGroupId()</literal></entry> + <entry>Gets the ID of the tablespace's default logfile group</entry> + </row> + <row> + <entry><literal>getObjectStatus()</literal></entry> + <entry>Used to obtain the <literal>Object::Status</literal> of the + <literal>Tablespace</literal> instance for which it is + called</entry> + </row> + <row> + <entry><literal>getObjectVersion()</literal></entry> + <entry>Gets the object version of the <literal>Tablespace</literal> object for + which it is invoked</entry> + </row> + <row> + <entry><literal>getObjectId()</literal></entry> + <entry>Gets the object ID of a <literal>Tablespace</literal> instance</entry> + </row> + <row> + <entry><literal>setName()</literal></entry> + <entry>Sets the name for the tablespace</entry> + </row> + <row> + <entry><literal>setExtentSize()</literal></entry> + <entry>Sets the size of the extents used by the tablespace</entry> + </row> + <row> + <entry><literal>setAutoGrowSpecification()</literal></entry> + <entry>Used to set the auto-grow characteristics of the tablespace</entry> + </row> + <row> + <entry><literal>setDefaultLogfileGroup()</literal></entry> + <entry>Sets the tablespace's default logfile group</entry> + </row> + </tbody> + </tgroup> + </informaltable> + <para> - This section discusses the <literal>Tablespace</literal> class - and its public - members. + For detailed descriptions, signatures, and examples of use for + each of these methods, see + <xref linkend="class-tablespace-members"/>. </para> - </abstract> - - <formalpara> + <formalpara> - <title>Description</title> + <title>Public Types</title> - <para> - The <literal>Tablespace</literal> class models a MySQL Cluster - Disk Data tablespace, which contains the datafiles used to store - Cluster Disk Data. For an overview of Cluster Disk Data and their - characteristics, see - <ulink url="&refman-base-url;/create-tablespace"><literal>CREATE - TABLESPACE</literal></ulink>, in the MySQL Manual. - </para> + <para> + The Tablespace class defines no public types of its own; + however, two of its methods make use of the + <literal>AutoGrowSpecification</literal> data structure. + Information about this structure can be found in + <xref linkend="struct-autogrowspecification"/>. + </para> - </formalpara> - + </formalpara> - <formalpara> + <formalpara> - <title>Public Methods</title> + <title>Class Diagram</title> - <para> - The following table lists the public methods of this class and the - purpose or use of each method: - </para> + <para> + This diagram shows all the available methods and enumerated + types of the <literal>Tablespace</literal> class: - </formalpara> + <mediaobject> + <imageobject> + <imagedata fileref="images/NdbDictionary-Object-Tablespace-class.png" format="PNG"/> + </imageobject> + <textobject> + <phrase lang="en">Public methods of the + <literal>Tablespace</literal> class.</phrase> + </textobject> + </mediaobject> + </para> - <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>Tablespace()</literal></entry> - <entry>Class constructor</entry> - </row> - <row> - <entry><literal>~Tablespace()</literal></entry> - <entry>Virtual destructor method</entry> - </row> - <row> - <entry><literal>getName()</literal></entry> - <entry>Gets the name of the tablespace</entry> - </row> - <row> - <entry><literal>getExtentSize()</literal></entry> - <entry>Gets the extent size used by the tablespace</entry> - </row> - <row> - <entry><literal>getAutoGrowSpecification()</literal></entry> - <entry>Used to obtain the AutoGrowSpecification structure - associated with the tablespace</entry> - </row> - <row> - <entry><literal>getDefaultLogfileGroup()</literal></entry> - <entry>Gets the name of the tablespace's default logfile group</entry> - </row> - <row> - <entry><literal>getDefaultLogfileGroupId()</literal></entry> - <entry>Gets the ID of the tablespace's default logfile group</entry> - </row> - <row> - <entry><literal>getObjectStatus()</literal></entry> - <entry>Used to obtain the <literal>Object::Status</literal> of - the <literal>Tablespace</literal> instance for which it is - called</entry> - </row> - <row> - <entry><literal>getObjectVersion()</literal></entry> - <entry>Gets the object version of the <literal>Tablespace</literal> object for - which it is invoked</entry> - </row> - <row> - <entry><literal>getObjectId()</literal></entry> - <entry>Gets the object ID of a <literal>Tablespace</literal> - instance</entry> - </row> - <row> - <entry><literal>setName()</literal></entry> - <entry>Sets the name for the tablespace</entry> - </row> - <row> - <entry><literal>setExtentSize()</literal></entry> - <entry>Sets the size of the extents used by the tablespace</entry> - </row> - <row> - <entry><literal>setAutoGrowSpecification()</literal></entry> - <entry>Used to set the auto-grow characteristics of the - tablespace</entry> - </row> - <row> - <entry><literal>setDefaultLogfileGroup()</literal></entry> - <entry>Sets the tablespace's default logfile group</entry> - </row> - </tbody> - </tgroup> - </informaltable> + </formalpara> - <para> - For detailed descriptions, signatures, and examples of use for each - of these methods, see <xref linkend="class-tablespace-members"/>. - </para> + <section id="class-tablespace-members"> - <formalpara> + <title><literal>Tablespace</literal> Class Members</title> - <title>Public Types</title> + <abstract> - <para> - The Tablespace class defines no public types of its own; however, - two of its methods - make use of the <literal>AutoGrowSpecification</literal> data - structure. Information about this structure can be found in - <xref linkend="struct-autogrowspecification"/>. - </para> + <para> + This section provides details of the public members of the + <literal>NDB</literal> API's <literal>Tablespace</literal> + class. + </para> - </formalpara> + </abstract> - <formalpara> + <section id="class-tablespace-constructor"> - <title>Class Diagram</title> + <title><literal>Tablespace</literal> Constructor</title> - <para> - This diagram shows all the available methods and enumerated types - of the <literal>Tablespace</literal> class: + <formalpara> - <mediaobject> - <imageobject> - <imagedata fileref="images/NdbDictionary-Object-Tablespace-class.png" format="PNG"/> - </imageobject> - <textobject> - <phrase lang="en">Public methods of the - <literal>Tablespace</literal> class.</phrase> - </textobject> - </mediaobject> - </para> + <title>Description</title> - </formalpara> - - + <para> + These methods are used to create a new instance of + <literal>Tablespace</literal>, or to copy an existing + one. + </para> - <section id="class-tablespace-members"> + </formalpara> - <title><literal>Tablespace</literal> Class Members</title> - - <abstract> - <para> - This section provides details of the public members of the <literal>NDB</literal> - 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: + <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: + + 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> - + </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> + </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> - + </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> + </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> - + </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> + </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> - + </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> + </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> - + </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> + </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> - + </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> + </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> - + </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> + </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> - + </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> + </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> - + </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> + </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> - + </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> + </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> - + </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> + </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> - + </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: + </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: + + 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> - + </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> - - + </para> - </section> + </formalpara> + </section> + + </section> + </section> <section id="class-undofile">
| Thread | ||
|---|---|---|
| • svn commit - mysqldoc@docsrva: r2453 - trunk/ndbapi | jon | 21 Jun |
© 1995-2008 MySQL AB, 2008-2009 Sun Microsystems, Inc.
Page generated in 1.058 sec. using MySQL 5.1.14-beta-log