From: Date: June 21 2006 10:18am
Subject: svn commit - mysqldoc@docsrva: r2453 - trunk/ndbapi
List-Archive: http://lists.mysql.com/commits/7996
Message-Id: <200606210818.k5L8IO7F022881@docsrva.mysql.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
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 @@
The <literal>Tablespace</literal> Class
-
+
+
+ This section discusses the Tablespace
+ class and its public members.
+
+
+
+
+
+
+ Description
+
+
+ The Tablespace 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
+ CREATE
+ TABLESPACE, in the MySQL Manual.
+
+
+
+
+
+
+ Public Methods
+
+
+ The following table lists the public methods of this class
+ and the purpose or use of each method:
+
+
+
+
+
+
+
+
+
+
+ Method
+ Purpose / Use
+
+
+
+
+ Tablespace()
+ Class constructor
+
+
+ ~Tablespace()
+ Virtual destructor method
+
+
+ getName()
+ Gets the name of the tablespace
+
+
+ getExtentSize()
+ Gets the extent size used by the tablespace
+
+
+ getAutoGrowSpecification()
+ Used to obtain the AutoGrowSpecification structure associated with the
+ tablespace
+
+
+ getDefaultLogfileGroup()
+ Gets the name of the tablespace's default logfile group
+
+
+ getDefaultLogfileGroupId()
+ Gets the ID of the tablespace's default logfile group
+
+
+ getObjectStatus()
+ Used to obtain the Object::Status of the
+ Tablespace instance for which it is
+ called
+
+
+ getObjectVersion()
+ Gets the object version of the Tablespace object for
+ which it is invoked
+
+
+ getObjectId()
+ Gets the object ID of a Tablespace instance
+
+
+ setName()
+ Sets the name for the tablespace
+
+
+ setExtentSize()
+ Sets the size of the extents used by the tablespace
+
+
+ setAutoGrowSpecification()
+ Used to set the auto-grow characteristics of the tablespace
+
+
+ setDefaultLogfileGroup()
+ Sets the tablespace's default logfile group
+
+
+
+
+
- This section discusses the Tablespace class
- and its public
- members.
+ For detailed descriptions, signatures, and examples of use for
+ each of these methods, see
+ .
-
-
-
+
- Description
+ Public Types
-
- The Tablespace 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
- CREATE
- TABLESPACE, in the MySQL Manual.
-
+
+ The Tablespace class defines no public types of its own;
+ however, two of its methods make use of the
+ AutoGrowSpecification data structure.
+ Information about this structure can be found in
+ .
+
-
-
+
-
+
- Public Methods
+ Class Diagram
-
- The following table lists the public methods of this class and the
- purpose or use of each method:
-
+
+ This diagram shows all the available methods and enumerated
+ types of the Tablespace class:
-
+
+
+
+
+
+ Public methods of the
+ Tablespace class.
+
+
+
-
-
-
-
-
-
- Method
- Purpose / Use
-
-
-
-
- Tablespace()
- Class constructor
-
-
- ~Tablespace()
- Virtual destructor method
-
-
- getName()
- Gets the name of the tablespace
-
-
- getExtentSize()
- Gets the extent size used by the tablespace
-
-
- getAutoGrowSpecification()
- Used to obtain the AutoGrowSpecification structure
- associated with the tablespace
-
-
- getDefaultLogfileGroup()
- Gets the name of the tablespace's default logfile group
-
-
- getDefaultLogfileGroupId()
- Gets the ID of the tablespace's default logfile group
-
-
- getObjectStatus()
- Used to obtain the Object::Status of
- the Tablespace instance for which it is
- called
-
-
- getObjectVersion()
- Gets the object version of the Tablespace object for
- which it is invoked
-
-
- getObjectId()
- Gets the object ID of a Tablespace
- instance
-
-
- setName()
- Sets the name for the tablespace
-
-
- setExtentSize()
- Sets the size of the extents used by the tablespace
-
-
- setAutoGrowSpecification()
- Used to set the auto-grow characteristics of the
- tablespace
-
-
- setDefaultLogfileGroup()
- Sets the tablespace's default logfile group
-
-
-
-
+
-
- For detailed descriptions, signatures, and examples of use for each
- of these methods, see .
-
+
-
+ <literal>Tablespace</literal> Class Members
- Public Types
+
-
- The Tablespace class defines no public types of its own; however,
- two of its methods
- make use of the AutoGrowSpecification data
- structure. Information about this structure can be found in
- .
-
+
+ This section provides details of the public members of the
+ NDB API's Tablespace
+ class.
+
-
+
-
+
- Class Diagram
+ <literal>Tablespace</literal> Constructor
-
- This diagram shows all the available methods and enumerated types
- of the Tablespace class:
+
-
-
-
-
-
- Public methods of the
- Tablespace class.
-
-
-
+ Description
-
-
-
+
+ These methods are used to create a new instance of
+ Tablespace, or to copy an existing
+ one.
+
-
+
- <literal>Tablespace</literal> Class Members
-
-
-
- This section provides details of the public members of the NDB
- API's Tablespace class.
-
-
-
-
- <literal>Tablespace</literal> Constructor
-
-
- Description
-
-
- These methods are used to create a new instance of
- Tablespace, or
- to copy an existing one.
-
-
-
-
-
- The NdbDictionary::Dictionary class also supplies methods for creating and
- dropping tablespaces. See .
-
-
-
-
- Signatures
-
-
- New instance:
+
+
+ The NdbDictionary::Dictionary class
+ also supplies methods for creating and dropping
+ tablespaces. See .
+
+
+
+
+
+ Signatures
+
+
+ New instance:
+
Tablespace
(
void
)
- Copy constructor:
+
+ Copy constructor:
+
Tablespace
(
const Tablespace& tablespace
)
-
-
-
-
- Parameters
-
-
- New instance: None. Copy constructor: a
- reference tablespace to an existing Tablespace instance.
-
-
-
-
- Return Value
-
-
- A Tablespace object.
-
-
-
-
- Destructor
-
- The class defines a virtual destructor ~Tablespace() which takes
- no arguments and returns no value.
-
-
-
-
-
- Example
-
-
-
+
+
+
+
+
+
+ Parameters
+
+
+ New instance: None. Copy
+ constructor: a reference
+ tablespace to an existing
+ Tablespace instance.
+
+
+
+
+
+
+ Return Value
+
+
+ A Tablespace object.
+
+
+
+
+
+
+ Destructor
+
+
+ The class defines a virtual destructor
+ ~Tablespace() which takes no
+ arguments and returns no value.
+
+
+
+
+
+
+ Example
+
+
[To be supplied...]
-
-
-
-
-
-
-
- <literal>NdbDictionary::Object::Tablespace::getName()</literal>
-
-
- Description
-
-
- This method retrieves the name of the tablespace.
-
-
-
-
- Signature
-
-
+
+
+
+
+
+
+
+
+ <literal>NdbDictionary::Object::Tablespace::getName()</literal>
+
+
+
+ Description
+
+
+ This method retrieves the name of the tablespace.
+
+
+
+
+
+
+ Signature
+
+
const char* getName
(
void
) const
-
-
-
-
- Parameters
-
-
- None.
-
-
-
-
- Return Value
-
-
- The name of the tablespace, a string value (as a character pointer).
-
-
-
-
- Example
-
-
-
+
+
+
+
+
+
+ Parameters
+
+
+ None.
+
+
+
+
+
+
+ Return Value
+
+
+ The name of the tablespace, a string value (as a
+ character pointer).
+
+
+
+
+
+
+ Example
+
+
[To be supplied...]
-
-
-
-
-
-
-
- <literal>NdbDictionary::Object::Tablespace::getExtentSize()</literal>
-
-
- Description
-
-
- This method is used to retrieve the extent
- size — that is the size of the memory
- allocation units — used by the tablespace.
-
-
-
-
-
- The same extent size is used for all datafiles contained in a
- given tablespace.
-
-
-
-
- Signature
-
-
+
+
+
+
+
+
+
+
+ <literal>NdbDictionary::Object::Tablespace::getExtentSize()</literal>
+
+
+
+ Description
+
+
+ This method is used to retrieve the extent
+ size — that is the size of the memory
+ allocation units — used by the tablespace.
+
+
+
+
+
+
+ The same extent size is used for all datafiles contained
+ in a given tablespace.
+
+
+
+
+
+ Signature
+
+
Uint32 getExtentSize
(
void
) const
-
-
-
-
- Parameters
-
-
- None.
-
-
-
-
- Return Value
-
-
- The tablespace's extent size in bytes, as an unsigned 32-bit
- integer.
-
-
-
-
- Example
-
-
-
+
+
+
+
+
+
+ Parameters
+
+
+ None.
+
+
+
+
+
+
+ Return Value
+
+
+ The tablespace's extent size in bytes, as an unsigned
+ 32-bit integer.
+
+
+
+
+
+
+ Example
+
+
[To be supplied...]
-
-
-
-
-
-
-
- <literal>NdbDictionary::Object::Tablespace::getAutoGrowSpecification()</literal>
-
-
- Description
-
-
-
-
-
-
-
- Signature
-
-
+
+
+
+
+
+
+
+
+ <literal>NdbDictionary::Object::Tablespace::getAutoGrowSpecification()</literal>
+
+
+
+ Description
+
+
+
+
+
+
+
+ Signature
+
+
const AutoGrowSpecification& getAutoGrowSpecification
(
void
) const
-
-
-
-
- Parameters
-
-
- None.
-
-
-
-
- Return Value
-
-
- A reference to the structure which describes the tablespace
- auto-grow characteristics — for details, see
- .
-
-
-
-
- Example
-
-
-
+
+
+
+
+
+
+ Parameters
+
+
+ None.
+
+
+
+
+
+
+ Return Value
+
+
+ A reference to the structure which describes the
+ tablespace auto-grow characteristics — for
+ details, see
+ .
+
+
+
+
+
+
+ Example
+
+
[To be supplied...]
-
-
-
-
-
-
-
-
- <literal>NdbDictionary::Object::Tablespace::getDefaultLogfileGroup()</literal>
-
-
- Description
-
-
- This method retrieves the name of the tablespace's default logfile
- group.
-
-
-
-
-
- Alternatively, you may wish to obtain the ID of the default
- logfile group — see
- .
-
-
-
-
- Signature
-
-
+
+
+
+
+
+
+
+
+ <literal>NdbDictionary::Object::Tablespace::getDefaultLogfileGroup()</literal>
+
+
+
+ Description
+
+
+ This method retrieves the name of the tablespace's
+ default logfile group.
+
+
+
+
+
+
+ Alternatively, you may wish to obtain the ID of the
+ default logfile group — see
+ .
+
+
+
+
+
+ Signature
+
+
const char* getDefaultLogfileGroup
(
void
) const
-
-
-
-
- Parameters
-
-
- None.
-
-
-
-
- Return Value
-
-
- The name of the logfile group (string value as character pointer).
-
-
-
-
- Example
-
-
-
+
+
+
+
+
+
+ Parameters
+
+
+ None.
+
+
+
+
+
+
+ Return Value
+
+
+ The name of the logfile group (string value as character
+ pointer).
+
+
+
+
+
+
+ Example
+
+
[To be supplied...]
-
-
-
-
-
-
-
-
- <literal>NdbDictionary::Object::Tablespace::getDefaultLogfileGroupId()</literal>
-
-
- Description
-
-
- This method retrieves the ID of the tablespace's default logfile
- group.
-
-
-
-
-
- You can also obtain directly the name of the default
- logfile group rather than its ID — see
- .
-
-
-
-
- Signature
-
-
+
+
+
+
+
+
+
+
+ <literal>NdbDictionary::Object::Tablespace::getDefaultLogfileGroupId()</literal>
+
+
+
+ Description
+
+
+ This method retrieves the ID of the tablespace's default
+ logfile group.
+
+
+
+
+
+
+ You can also obtain directly the name of the default
+ logfile group rather than its ID — see
+ .
+
+
+
+
+
+ Signature
+
+
Uint32 getDefaultLogfileGroupId
(
void
) const
-
-
-
-
- Parameters
-
-
- None.
-
-
-
-
- Return Value
-
-
- The ID of the logfile group, as an unsigned 32-bit integer.
-
-
-
-
- Example
-
-
-
+
+
+
+
+
+
+ Parameters
+
+
+ None.
+
+
+
+
+
+
+ Return Value
+
+
+ The ID of the logfile group, as an unsigned 32-bit
+ integer.
+
+
+
+
+
+
+ Example
+
+
[To be supplied...]
-
-
-
-
-
-
-
- <literal>NdbDictionary::Object::Tablespace::getObjectStatus()</literal>
-
-
- Description
-
-
- This method is used to retrieve the object status of a tablespace.
-
-
-
-
- Signature
-
-
+
+
+
+
+
+
+
+
+ <literal>NdbDictionary::Object::Tablespace::getObjectStatus()</literal>
+
+
+
+ Description
+
+
+ This method is used to retrieve the object status of a
+ tablespace.
+
+
+
+
+
+
+ Signature
+
+
virtual Object::Status getObjectStatus
(
void
) const
-
-
-
-
- Parameters
-
-
- None.
-
-
-
-
- Return Value
-
-
- An Object::Status value — see
- , for details.
-
-
-
-
- Example
-
-
-
+
+
+
+
+
+
+ Parameters
+
+
+ None.
+
+
+
+
+
+
+ Return Value
+
+
+ An Object::Status value — see
+ , for details.
+
+
+
+
+
+
+ Example
+
+
[To be supplied...]
-
-
-
-
-
-
-
- <literal>NdbDictionary::Object::Tablespace::getObjectVersion()</literal>
-
-
- Description
-
-
- This method gets the tablespace object version.
-
-
-
-
- Signature
-
-
+
+
+
+
+
+
+
+
+ <literal>NdbDictionary::Object::Tablespace::getObjectVersion()</literal>
+
+
+
+ Description
+
+
+ This method gets the tablespace object version.
+
+
+
+
+
+
+ Signature
+
+
virtual int getObjectVersion
(
void
) const
-
-
-
-
- Parameters
-
-
- None.
-
-
-
-
- Return Value
-
-
- The object version, as an integer.
-
-
-
-
- Example
-
-
-
+
+
+
+
+
+
+ Parameters
+
+
+ None.
+
+
+
+
+
+
+ Return Value
+
+
+ The object version, as an integer.
+
+
+
+
+
+
+ Example
+
+
[To be supplied...]
-
-
-
-
-
-
-
- <literal>NdbDictionary::Object::Tablespace::getObjectId()</literal>
-
-
- Description
-
-
- This method retrieves the tablespace's object ID.
-
-
-
-
- Signature
-
-
+
+
+
+
+
+
+
+
+ <literal>NdbDictionary::Object::Tablespace::getObjectId()</literal>
+
+
+
+ Description
+
+
+ This method retrieves the tablespace's object ID.
+
+
+
+
+
+
+ Signature
+
+
virtual int getObjectId
(
void
) const
-
-
-
-
- Parameters
-
-
- None.
-
-
-
-
- Return Value
-
-
- The object ID, as an integer.
-
-
-
-
- Example
-
-
-
+
+
+
+
+
+
+ Parameters
+
+
+ None.
+
+
+
+
+
+
+ Return Value
+
+
+ The object ID, as an integer.
+
+
+
+
+
+
+ Example
+
+
[To be supplied...]
-
-
-
-
-
-
-
- <literal>NdbDictionary::Object::Tablespace::setName()</literal>
-
-
- Description
-
-
- This method sets the name of the tablespace.
-
-
-
-
- Signature
-
-
+
+
+
+
+
+
+
+
+ <literal>NdbDictionary::Object::Tablespace::setName()</literal>
+
+
+
+ Description
+
+
+ This method sets the name of the tablespace.
+
+
+
+
+
+
+ Signature
+
+
void setName
(
const char* name
) const
-
-
-
-
- Parameters
-
-
- The name of the tablespace, a string (character pointer).
-
-
-
-
- Return Value
-
-
- None.
-
-
-
-
- Example
-
-
-
+
+
+
+
+
+
+ Parameters
+
+
+ The name of the tablespace, a
+ string (character pointer).
+
+
+
+
+
+
+ Return Value
+
+
+ None.
+
+
+
+
+
+
+ Example
+
+
[To be supplied...]
-
-
-
-
-
-
-
- <literal>NdbDictionary::Object::Tablespace::setExtentSize()</literal>
-
-
- Description
-
-
- This method sets the tablespace's extent size.
-
-
-
-
- Signature
-
-
+
+
+
+
+
+
+
+
+ <literal>NdbDictionary::Object::Tablespace::setExtentSize()</literal>
+
+
+
+ Description
+
+
+ This method sets the tablespace's extent size.
+
+
+
+
+
+
+ Signature
+
+
void setExtentSize
(
Uint32 size
)
-
-
-
-
- Parameters
-
-
- The size to be used for this tablespace's extents, in bytes.
-
-
-
-
- Return Value
-
-
- None.
-
-
-
-
- Example
-
-
-
+
+
+
+
+
+
+ Parameters
+
+
+ The size to be used for this
+ tablespace's extents, in bytes.
+
+
+
+
+
+
+ Return Value
+
+
+ None.
+
+
+
+
+
+
+ Example
+
+
[To be supplied...]
-
-
-
-
-
-
-
- <literal>NdbDictionary::Object::Tablespace::setAutoGrowSpecification()</literal>
-
-
- Description
-
-
- This method is used to set the auto-grow characteristics of the
- tablespace.
-
-
-
-
- Signature
-
-
+
+
+
+
+
+
+
+
+ <literal>NdbDictionary::Object::Tablespace::setAutoGrowSpecification()</literal>
+
+
+
+ Description
+
+
+ This method is used to set the auto-grow characteristics
+ of the tablespace.
+
+
+
+
+
+
+ Signature
+
+
void setAutoGrowSpecification
(
const AutoGrowSpecification& autoGrowSpec
)
-
-
-
-
- Parameters
-
-
- This method takes a single parameter, an
- AutoGrowSpecification data structure. See
- .
-
-
-
-
- Return Value
-
-
- None.
-
-
-
-
- Example
-
-
-
+
+
+
+
+
+
+ Parameters
+
+
+ This method takes a single parameter, an
+ AutoGrowSpecification data structure.
+ See .
+
+
+
+
+
+
+ Return Value
+
+
+ None.
+
+
+
+
+
+
+ Example
+
+
[To be supplied...]
-
-
-
-
-
-
-
- <literal>NdbDictionary::Object::Tablespace::setDefaultLogfileGroup()</literal>
-
-
- Description
-
-
- This method is used to set a tablespace's default logfile group.
-
-
-
-
- Signature
-
-
- This method can be called in two different ways. The first of
- these uses the
- name of the logfile group, as shown here:
+
+
+
+
+
+
+
+
+ <literal>NdbDictionary::Object::Tablespace::setDefaultLogfileGroup()</literal>
+
+
+
+ Description
+
+
+ This method is used to set a tablespace's default
+ logfile group.
+
+
+
+
+
+
+ Signature
+
+
+ This method can be called in two different ways. The
+ first of these uses the name of the logfile group, as
+ shown here:
+
void setDefaultLogfileGroup
(
const char* name
)
- This method can also be called by passing it a reference to a
- LogfileGroup object:
+
+ This method can also be called by passing it a reference
+ to a LogfileGroup object:
+
void setDefaultLogfileGroup
(
const class LogfileGroup& lGroup
)
-
-
-
-
-
- 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 set*() method corresponding to
- getDefaultLogfileGroupId().)
-
-
-
-
- Parameters
-
-
- Either the name of the logfile group to
- be assigned to the tablespace, or a reference
- lGroup to this logfile group.
-
-
-
-
- Return Value
-
-
- None.
-
-
-
-
- Example
-
-
-
+
+
+
+
+
+
+ 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
+ set*()
+ method corresponding to
+ getDefaultLogfileGroupId().)
+
+
+
+
+
+ Parameters
+
+
+ Either the name of the
+ logfile group to be assigned to the tablespace, or a
+ reference lGroup to this
+ logfile group.
+
+
+
+
+
+
+ Return Value
+
+
+ None.
+
+
+
+
+
+
+ Example
+
+
[To be supplied...]
-
-
-
-
-
-
-
+
-
+
+
+
+
+