Skip navigation links
2.3.20.2 Object Methods »
Section Navigation      [Toggle]

2.3.20.1. Object Class Enumerated Types

[+/-]

2.3.20.1.1. The Object::FragmentType Type
2.3.20.1.2. The Object::State Type
2.3.20.1.3. The Object::Status Type
2.3.20.1.4. The Object::Store Type
2.3.20.1.5. The Object::Type Type

Abstract

This section details the public enumerated types belonging to the Object class.

2.3.20.1.1. The Object::FragmentType Type

Abstract

This type describes the Object's fragmentation type.

Description.  This parameter specifies how data in the table or index is distributed among the cluster's storage nodes, that is, the number of fragments per node. The larger the table, the larger the number of fragments that should be used. Note that all replicas count as a single fragment. For a table, the default is FragAllMedium. For a unique hash index, the default is taken from the underlying table and cannot currently be changed.

Enumeration values. 

Value Description
FragUndefined The fragmentation type is undefined or the default
FragAllMedium Two fragments per node
FragAllLarge Four fragments per node

2.3.20.1.2. The Object::State Type

Abstract

This type describes the state of the Object.

Description.  This parameter provides us with the object's state. By state, we mean whether or not the object is defined and is in a usable condition.

Enumeration values. 

Value Description
StateUndefined Undefined
StateOffline Offline, not useable
StateBuilding Building (e.g. restore?), not useable(?)
StateDropping Going offline or being dropped; not usable
StateOnline Online, usable
StateBackup Online, being backed up, usable
StateBroken Broken; should be dropped and re-created

2.3.20.1.3. The Object::Status Type

Abstract

This type describes the Object's status.

Description.  Reading an object's Status tells whether or not it is available in the NDB kernel.

Enumeration values. 

Value Description
New The object exists only in memory, and has not yet been created in the NDB kernel
Changed The object has been modified in memory, and must be committed in the NDB Kernel for changes to take effect
Retrieved The object exists, and has been read into main memory from the NDB Kernel
Invalid The object has been invalidated, and should no longer be used
Altered The table has been altered in the NDB kernel, but is still available for use

2.3.20.1.4. The Object::Store Type

Abstract

This type describes the Object's persistence.

Description.  Reading this value tells us is the object is temporary or permanent.

Enumeration values. 

Value Description
StoreUndefined The object is undefined
StoreTemporary Temporary storage; the object or data will be deleted on system restart
StorePermanent The object or data is permanent; it has been logged to disk

2.3.20.1.5. The Object::Type Type

Abstract

This type describes the Object's type.

Description.  The Type of the object can be one of several different sorts of index, trigger, tablespace, and so on.

Enumeration values. 

Value Description
TypeUndefined Undefined
SystemTable System table
UserTable User table (may be temporary)
UniqueHashIndex Unique (but unordered) hash index
OrderedIndex Ordered (but not unique) index
HashIndexTrigger Index maintenance (internal)
IndexTrigger Index maintenance (internal)
SubscriptionTrigger Backup or replication (internal)
ReadOnlyConstraint Trigger (internal)
Tablespace Tablespace
LogfileGroup Logfile group
Datafile Datafile
Undofile Undofile