MySQL NDB Cluster API Developer Guide
This section provides information about the
LogfileGroup
class, which models an NDB Cluster
Disk Data log file group.
None
This class represents an NDB Cluster Disk Data log file group, which is used for storing Disk Data undo files. For general information about log file groups and undo files, see NDB Cluster Disk Data Tables, in the MySQL Manual.
Only unindexed column data can be stored on disk. Indexes and indexes columns are always stored in memory.
The following table lists the public methods of this class and the purpose or use of each method:
Table 2.24 LogfileGroup class methods and descriptions
Name | Description |
---|---|
LogfileGroup() |
Class constructor |
~LogfileGroup() |
Virtual destructor |
getAutoGrowSpecification() |
Gets the log file group's
AutoGrowSpecification
values |
getName() |
Retrieves the log file group's name |
getObjectId() |
Get the object ID of the log file group |
getObjectStatus() |
Gets the log file group's object status value |
getObjectVersion() |
Retrieves the log file group's object version |
getUndoBufferSize() |
Gets the size of the log file group's undo buffer |
getUndoFreeWords() |
Retrieves the amount of free space in the undo buffer |
setAutoGrowSpecification() |
Sets
AutoGrowSpecification
values for the log file group |
setName() |
Sets the name of the log file group |
setUndoBufferSize() |
Sets the size of the log file group's undo buffer. |
While the LogfileGroup
class does not
itself define any public types, two of its methods make use
of the
AutoGrowSpecification
data structure as a parameter or return value.
The LogfileGroup
class has two public
constructors, one of which takes no arguments and creates a
completely new instance. The other is a copy constructor.
The Dictionary
class also
supplies methods for creating and destroying
LogfileGroup
objects. See
Section 2.3.3, “The Dictionary Class”.
New instance:
LogfileGroup ( void )
Copy constructor:
LogfileGroup
(
const LogfileGroup& logfileGroup
)
When creating a new instance, the constructor takes no
parameters. When copying an existing instance, the
constructor is passed a reference to the
LogfileGroup
instance to be
copied.
A LogfileGroup
object.
virtual ~LogfileGroup ( void )
This method retrieves the
AutoGrowSpecification
associated with the log file group.
const AutoGrowSpecification& getAutoGrowSpecification ( void ) const
None.
An
AutoGrowSpecification
data structure.
This method gets the name of the log file group.
const char* getName ( void ) const
None.
The logfile group's name, a string (as a character pointer).
This method is used to retrieve the object ID of the log file group.
virtual int getObjectId ( void ) const
None.
The log file group's object ID (an integer value).
This method is used to obtain the object status of the
LogfileGroup
.
virtual Object::Status getObjectStatus ( void ) const
None.
The logfile group's Status
—see
Object::Status for possible values.
This method gets the log file group's object version (see NDB Schema Object Versions).
virtual int getObjectVersion ( void ) const
None.
The object version of the log file group, as an integer.
This method retrieves the size of the log file group's undo buffer.
Uint32 getUndoBufferSize ( void ) const
None.
The size of the undo buffer, in bytes.
This method retrieves the number of bytes unused in the log file group's undo buffer.
Uint64 getUndoFreeWords ( void ) const
None.
The number of bytes free, as a 64-bit integer.
This method sets the
AutoGrowSpecification
data for the log file group.
void setAutoGrowSpecification
(
const AutoGrowSpecification& autoGrowSpec
)
The data is passed as a single parameter, an
AutoGrowSpecification
data structure.
None.