Skip navigation links
2.3.23 The Undofile Class »
Section Navigation      [Toggle]

2.3.22.1. Tablespace Methods

[+/-]

2.3.22.1.1. Tablespace Constructor
2.3.22.1.2. Tablespace::getName()
2.3.22.1.3. Tablespace::getExtentSize()
2.3.22.1.4. Tablespace::getAutoGrowSpecification()
2.3.22.1.5. Tablespace::getDefaultLogfileGroup()
2.3.22.1.6. Tablespace::getDefaultLogfileGroupId()
2.3.22.1.7. Tablespace::getObjectStatus()
2.3.22.1.8. Tablespace::getObjectVersion()
2.3.22.1.9. Tablespace::getObjectId()
2.3.22.1.10. Tablespace::setName()
2.3.22.1.11. Tablespace::setExtentSize()
2.3.22.1.12. Tablespace::setAutoGrowSpecification()
2.3.22.1.13. Tablespace::setDefaultLogfileGroup()

Abstract

This section provides details of the public members of the NDB API's Tablespace class.

2.3.22.1.1. Tablespace Constructor

Description.  These methods are used to create a new instance of Tablespace, or to copy an existing one.

Note

The NdbDictionary::Dictionary class also supplies methods for creating and dropping tablespaces. See Section 2.3.3, “The Dictionary Class”.

Signatures.  New instance: 

Tablespace
    (
      void
    )

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.

2.3.22.1.2. Tablespace::getName()

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).

2.3.22.1.3. Tablespace::getExtentSize()

Description.  This method is used to retrieve the extent size — that is the size of the memory allocation units — used by the tablespace.

Note

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.

2.3.22.1.4. Tablespace::getAutoGrowSpecification()

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 Section 2.3.26, “The AutoGrowSpecification Structure”.

2.3.22.1.5. Tablespace::getDefaultLogfileGroup()

Description.  This method retrieves the name of the tablespace's default logfile group.

Note

Alternatively, you may wish to obtain the ID of the default logfile group — see Section 2.3.22.1.6, “Tablespace::getDefaultLogfileGroupId()”.

Signature.  

const char* getDefaultLogfileGroup
    (
      void
    ) const

Parameters.  None.

Return value.  The name of the logfile group (string value as character pointer).

2.3.22.1.6. Tablespace::getDefaultLogfileGroupId()

Description.  This method retrieves the ID of the tablespace's default logfile group.

Note

You can also obtain directly the name of the default logfile group rather than its ID — see Section 2.3.22.1.5, “Tablespace::getDefaultLogfileGroup()”.

Signature.  

Uint32 getDefaultLogfileGroupId
    (
      void
    ) const

Parameters.  None.

Return value.  The ID of the logfile group, as an unsigned 32-bit integer.

2.3.22.1.7. Tablespace::getObjectStatus()

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 Section 2.3.20.1.3, “The Object::Status Type”, for details.

2.3.22.1.8. Tablespace::getObjectVersion()

Description.  This method gets the tablespace object version.

Signature.  

virtual int getObjectVersion
  (
    void
  ) const

Parameters.  None.

Return value.  The object version, as an integer.

2.3.22.1.9. Tablespace::getObjectId()

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.

2.3.22.1.10. Tablespace::setName()

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.

2.3.22.1.11. Tablespace::setExtentSize()

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.

2.3.22.1.12. Tablespace::setAutoGrowSpecification()

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 Section 2.3.26, “The AutoGrowSpecification Structure”.

Return value.  None.

2.3.22.1.13. Tablespace::setDefaultLogfileGroup()

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: 

void setDefaultLogfileGroup
    (
      const class LogfileGroup& lGroup
    )

Note

There is no method for setting a logfile group as 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.