2.3.12.1 LogfileGroup Methods

2.3.12.1.1 LogfileGroup Constructor
2.3.12.1.2 LogfileGroup::getAutoGrowSpecification()
2.3.12.1.3 LogfileGroup::getName()
2.3.12.1.4 LogfileGroup::getObjectId()
2.3.12.1.5 LogfileGroup::getObjectStatus()
2.3.12.1.6 LogfileGroup::getObjectVersion()
2.3.12.1.7 LogfileGroup::getUndoBufferSize()
2.3.12.1.8 LogfileGroup::getUndoFreeWords()
2.3.12.1.9 LogfileGroup::setAutoGrowSpecification()
2.3.12.1.10 LogfileGroup::setName()
2.3.12.1.11 LogfileGroup::setUndoBufferSize()

Abstract

This section provides descriptions for the public methods of the LogfileGroup class.

2.3.12.1.1 LogfileGroup Constructor

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

Note

The Dictionary class also supplies methods for creating and destroying LogfileGroup objects. See Section 2.3.4, “The Dictionary Class”.

Signatures.  New instance:

LogfileGroup
    (
      void
    )

Copy constructor:

LogfileGroup
    (
      const LogfileGroup& logfileGroup
    )

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

Return value.  A LogfileGroup object.

Destructor. 

virtual ~LogfileGroup
    (
      void
    )

Examples. 

[To be supplied...]

2.3.12.1.2 LogfileGroup::getAutoGrowSpecification()

Description.  This method retrieves the AutoGrowSpecification associated with the logfile group.

Signature. 

const AutoGrowSpecification& getAutoGrowSpecification
    (
      void
    ) const

Parameters.  None.

Return value.  An AutoGrowSpecification data structure. See Section 2.3.1, “The AutoGrowSpecification Structure”, for details.

2.3.12.1.3 LogfileGroup::getName()

Description.  This method gets the name of the logfile group.

Signature. 

const char* getName
    (
      void
    ) const

Parameters.  None.

Return value.  The logfile group's name, a string (as a character pointer).

2.3.12.1.4 LogfileGroup::getObjectId()

Description.  This method is used to retrieve the object ID of the logfile group.

Signature. 

virtual int getObjectId
    (
      void
    ) const

Parameters.  None.

Return value.  The logfile group's object ID (an integer value).

2.3.12.1.5 LogfileGroup::getObjectStatus()

Description.  This method is used to obtain the object status of the LogfileGroup.

Signature. 

virtual Object::Status getObjectStatus
    (
      void
    ) const

Parameters.  None.

Return value.  The logfile group's Status—see Section 2.3.30.1.3, “The Object::Status Type” for possible values.

2.3.12.1.6 LogfileGroup::getObjectVersion()

Description.  This method gets the logfile group's object version (see Section 8.6, “NDB Schema Object Versions”).

Signature. 

virtual int getObjectVersion
    (
      void
    ) const

Parameters.  None.

Return value.  The object version of the logfile group, as an integer.

2.3.12.1.7 LogfileGroup::getUndoBufferSize()

Description.  This method retrieves the size of the logfile group's UNDO buffer.

Signature. 

Uint32 getUndoBufferSize
    (
      void
    ) const

Parameters.  None.

Return value.  The size of the UNDO buffer, in bytes.

2.3.12.1.8 LogfileGroup::getUndoFreeWords()

Description.  This method retrieves the number of bytes unused in the logfile group's UNDO buffer.

Signature. 

Uint64 getUndoFreeWords
    (
      void
    ) const

Parameters.  None.

Return value.  The number of bytes free, as a 64-bit integer.

2.3.12.1.9 LogfileGroup::setAutoGrowSpecification()

Description.  This method sets the AutoGrowSpecification data for the logfile group.

Signature. 

void setAutoGrowSpecification
    (
      const AutoGrowSpecification& autoGrowSpec
    )

Parameters.  The data is passed as a single parameter, an AutoGrowSpecification data structure—see Section 2.3.1, “The AutoGrowSpecification Structure”.

Return value.  None.

2.3.12.1.10 LogfileGroup::setName()

Description.  This method is used to set a name for the logfile group.

Signature. 

void setName
    (
      const char* name
    )

Parameters.  The name to be given to the logfile group (character pointer).

Return value.  None.

2.3.12.1.11 LogfileGroup::setUndoBufferSize()

Description.  This method can be used to set the size of the logfile group's UNDO buffer.

Signature. 

void setUndoBufferSize
    (
      Uint32 size
    )

Parameters.  The size in bytes for the UNDO buffer (using a 32-bit unsigned integer value).

Return value.  None.