Skip navigation links
2.3.24 The Ndb_cluster_connection Class »
Section Navigation      [Toggle]

2.3.23.1. Undofile Methods

[+/-]

2.3.23.1.1. Undofile Constructor
2.3.23.1.2. Undofile::getPath()
2.3.23.1.3. Undofile::getSize()
2.3.23.1.4. Undofile::getLogfileGroup()
2.3.23.1.5. Undofile::getLogfileGroupId()
2.3.23.1.6. Undofile::getNode()
2.3.23.1.7. Undofile::getFileNo()
2.3.23.1.8. Undofile::getObjectStatus()
2.3.23.1.9. Undofile::getObjectVersion()
2.3.23.1.10. Undofile::getObjectId()
2.3.23.1.11. Undofile::setPath()
2.3.23.1.12. Undofile::setSize()
2.3.23.1.13. Undofile::setLogfileGroup()
2.3.23.1.14. Undofile::setNode()

Abstract

This section details the public methods of the Undofile class.

2.3.23.1.1. Undofile Constructor

Description.  The class constructor can be used to create a new Undofile instance, or to copy an existing one.

Signatures.  Creates a new instance: 

Undofile
    (
      void
    )

Copy constructor: 

Undofile
    (
      const Undofile& undoFile
    )

Parameters.  New instance: None. The copy constructor takes a single argument — a reference to the Undofile object to be copied.

Return value.  An Undofile object.

Destructor.  The class defines a virtual destructor which takes no arguments and has the return type void.

2.3.23.1.2. Undofile::getPath()

Description.  This method retrieves the path matching the location of the undofile on the data node's file system.

Signature.  

const char* getPath
    (
      void
    ) const

Parameters.  None.

Return value.  The file system path, a string (as a character pointer).

2.3.23.1.3. Undofile::getSize()

Description.  This method gets the size of the undofile in bytes.

Signature.  

Uint64 getSize
    (
      void
    ) const

Parameters.  None.

Return value.  The size in bytes of the undofile, as an unsigned 64-bit integer.

2.3.23.1.4. Undofile::getLogfileGroup()

Description.  This method retrieves the name of the logfile group to which the undofile belongs.

Signature.  

const char* getLogfileGroup
    (
      void
    ) const

Parameters.  None.

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

2.3.23.1.5. Undofile::getLogfileGroupId()

Description.  This method retrieves the ID of the logfile group to which the undofile belongs.

Note

It is also possible to obtain the name of the logfile group directly. See Section 2.3.23.1.4, “Undofile::getLogfileGroup()”

Signature.  

Uint32 getLogfileGroupId
    (
      void
    ) const

Parameters.  None.

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

2.3.23.1.6. Undofile::getNode()

Description.  This method is used to retrieve the node ID of the node where the undofile is located.

Signature.  

Uint32 getNode
    (
      void
    ) const

Parameters.  None.

Return value.  The node ID, as an unsigned 32-bit integer.

2.3.23.1.7. Undofile::getFileNo()

Description.  The getFileNo() method gets the number of the undofile in the logfile group to which it belongs.

Signature.  

Uint32 getFileNo
    (
      void
    ) const

Parameters.  None.

Return value.  The number of the undofile, as an unsigned 32-bit integer.

2.3.23.1.8. Undofile::getObjectStatus()

Description.  This method is used to retrieve the object status of an undofile.

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.23.1.9. Undofile::getObjectVersion()

Description.  This method gets the undofile's object version.

Signature.  

virtual int getObjectVersion
  (
    void
  ) const

Parameters.  None.

Return value.  The object version, as an integer.

2.3.23.1.10. Undofile::getObjectId()

Description.  This method retrieves the undofile's object ID.

Signature.  

virtual int getObjectId
    (
      void
    ) const

Parameters.  None.

Return value.  The object ID, as an integer.

2.3.23.1.11. Undofile::setPath()

Description.  This method is used to set the file system path of the undofile on the data node where it resides.

Signature.  

void setPath
    (
      const char* path
    )

Parameters.  The desired path to the undofile.

Return value.  None.

2.3.23.1.12. Undofile::setSize()

Description.  Sets the size of the undofile in bytes.

Signature.  

void setSize
    (
      Uint64 size
    )

Parameters.  The intended size of the undofile in bytes, as an unsigned 64-bit integer.

Return value.  None.

2.3.23.1.13. Undofile::setLogfileGroup()

Description.  Given either a name or an object reference to a logfile group, the setLogfileGroup() method assigns the undofile to that logfile group.

Signature.  Using a logfile group name: 

void setLogfileGroup
    (
      const char* name
    )

Using a reference to a LogfileGroup instance: 

void setLogfileGroup
    (
      const class LogfileGroup & logfileGroup
    )

Parameters.  The name of the logfile group (a character pointer), or a reference to a LogfileGroup instance.

Return value.  None.

2.3.23.1.14. Undofile::setNode()

Description.  Sets the node on which the logfile group is to reside.

Signature.  

 void setNode
    (
      Uint32 nodeId
    )

Parameters.  The nodeId of the data node where the undofile is to be placed; this is an unsigned 32-bit integer.

Return value.  None.