2.3.30.1 Object Class Enumerated Types

2.3.30.1.1 The Object::FragmentType Type
2.3.30.1.2 The Object::State Type
2.3.30.1.3 The Object::Status Type
2.3.30.1.4 The Object::Store Type
2.3.30.1.5 The Object::Type Type

Abstract

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

2.3.30.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.  Possible values for FragmentType are shown, along with descriptions, in the following table:

ValueDescription
FragUndefinedThe fragmentation type is undefined or the default
FragAllMediumTwo fragments per node
FragAllLargeFour fragments per node
DistrKeyHashDistributed hash key
DistrKeyLinDistributed linear hash key
UserDefinedUser defined
HashMapPartitionHash map partition
2.3.30.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.  Possible values for State are shown, along with descriptions, in the following table:

ValueDescription
StateUndefinedUndefined
StateOfflineOffline, not useable
StateBuildingBuilding (e.g. restore?), not useable(?)
StateDroppingGoing offline or being dropped; not usable
StateOnlineOnline, usable
StateBackupOnline, being backed up, usable
StateBrokenBroken; should be dropped and re-created
2.3.30.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.  Possible values for Status are shown, along with descriptions, in the following table:

ValueDescription
NewThe object exists only in memory, and has not yet been created in the NDB kernel
ChangedThe object has been modified in memory, and must be committed in the NDB Kernel for changes to take effect
RetrievedThe object exists, and has been read into main memory from the NDB Kernel
InvalidThe object has been invalidated, and should no longer be used
AlteredThe table has been altered in the NDB kernel, but is still available for use
2.3.30.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.  Possible values for Store are shown, along with descriptions, in the following table:

ValueDescription
StoreUndefinedThe object is undefined
StoreTemporaryTemporary storage; the object or data will be deleted on system restart
StorePermanentThe object or data is permanent; it has been logged to disk
2.3.30.1.5 The Object::Type Type

Abstract

This type describes the type of the Object.

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

Enumeration values.  Possible values for Type are shown, along with descriptions, in the following table:

ValueDescription
TypeUndefinedUndefined
SystemTableSystem table
UserTableUser table (may be temporary)
UniqueHashIndexUnique (but unordered) hash index
OrderedIndexOrdered (but not unique) index
HashIndexTriggerIndex maintenance (internal)
IndexTriggerIndex maintenance (internal)
SubscriptionTriggerBackup or replication (internal)
ReadOnlyConstraintTrigger (internal)
TablespaceTablespace
LogfileGroupLogfile group
DatafileDatafile
UndofileUndofile
ReorgTriggerTrigger
HashMapHash map
ForeignKeyForeign key
FKParentTriggerTrigger on a foreign key's parent table
FKChildTriggerTrigger on a foreign key's child table

HashMap was added in MySQL Cluster NDB 7.1.23 and MySQL Cluster NDB 7.2.7.

ForeignKey, FKParentTrigger, and FKChildTrigger were added in MySQL Cluster NDB 7.3. See Section 2.3.7, “The ForeignKey Class”.