2.3.36 The Tablespace Class

2.3.36.1 Tablespace Methods

Abstract

This section discusses the Tablespace class and its public members.

Parent class.  NdbDictionary

Child classes.  None

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 Syntax, in the MySQL Manual.

Note

Currently, only unindexed column data can be stored on disk. Indexes and indexes columns are always stored in memory.

MySQL Cluster prior to MySQL 5.1 does not support Disk Data storage, and so does not support tablespaces; thus the Tablespace class is unavailable for NDB API applications written against these older releases.

Methods.  The following table lists the public methods of this class and the purpose or use of each method:

MethodPurpose / Use
Tablespace()Class constructor
~Tablespace()Virtual destructor method
getAutoGrowSpecification()Used to obtain the AutoGrowSpecification structure associated with the tablespace
getDefaultLogfileGroup()Gets the name of the tablespace's default log file group
getDefaultLogfileGroupId()Gets the ID of the tablespace's default log file group
getExtentSize()Gets the extent size used by the tablespace
getName()Gets the name of the tablespace
getObjectId()Gets the object ID of a Tablespace instance
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
setAutoGrowSpecification()Used to set the auto-grow characteristics of the tablespace
setDefaultLogfileGroup()Sets the tablespace's default log file group
setExtentSize()Sets the size of the extents used by the tablespace
setName()Sets the name for the tablespace

For detailed descriptions, signatures, and examples of use for each of these methods, see Section 2.3.36.1, “Tablespace Methods”.

Types.  The Tablespace class defines no public types of its own; however, two of its methods make use of the AutoGrowSpecification data structure.

Class diagram.  This diagram shows all the available methods and enumerated types of the Tablespace class:

Public methods of the Tablespace class.