2.3.6.1 Event Types

2.3.6.1.1 The Event::TableEvent Type
2.3.6.1.2 The Event::EventDurability Type
2.3.6.1.3 The Event::EventReport Type

Abstract

This section details the public types belonging to the Event class.

2.3.6.1.1 The Event::TableEvent Type

Abstract

This section describes TableEvent, a type defined by the Event class.

Description.  TableEvent is used to classify the types of events that may be associated with tables in the NDB API.

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

ValueDescription
TE_INSERTInsert event on a table
TE_DELETEDelete event on a table
TE_UPDATEUpdate event on a table
TE_DROPOccurs when a table is dropped
TE_ALTEROccurs when a table definition is changed
TE_CREATEOccurs when a table is created
TE_GCP_COMPLETEOccurs on the completion of a global checkpoint
TE_CLUSTER_FAILUREOccurs on Cluster failures
TE_STOPOccurs when an event operation is stopped
TE_NODE_FAILUREOccurs when a Cluster node fails
TE_SUBSCRIBEOccurs when a cluster node subscribes to an event
TE_UNSUBSCRIBEOccurs when a cluster node unsubscribes from an event
TE_ALLOccurs when any event occurs on a table (not relevant when a specific event is received)
2.3.6.1.2 The Event::EventDurability Type

Abstract

This section discusses EventDurability, a type defined by the Event class.

Description.  The values of this type are used to describe an event's lifetime or persistence as well as its scope.

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

ValueDescription
ED_UNDEFINEDThe event is undefined or of an unsupported type.
ED_SESSIONThis event persists only for the duration of the current session, and is available only to the current application. It is deleted after the application disconnects or following a cluster restart.
Important

The value ED_SESSION is reserved for future use and is not yet supported in any MySQL Cluster release.

ED_TEMPORARYAny application may use the event, but it is deleted following a cluster restart.
Important

The value ED_TEMPORARY is reserved for future use and is not yet supported in any MySQL Cluster release.

ED_PERMANENTAny application may use the event, and it persists until deleted by an application—even following a cluster. restart
Important

The value ED_PERMANENT is reserved for future use and is not yet supported in any MySQL Cluster release.

2.3.6.1.3 The Event::EventReport Type

Abstract

This section discusses EventReport, a type defined by the Event class.

Description.  The values of this type are used to specify reporting options for table events.

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

ValueDescription
ER_UPDATEDReporting of update events
ER_ALLReporting of all events, except for those not resulting in any updates to the inline parts of BLOB columns
ER_SUBSCRIBEReporting of subscription events
ER_DDLReporting of DDL events (added in MySQL Cluster NDB 6.3.34, 7.0.15, and 7.1.4; see Section 2.3.6.2.18, “Event::setReport(), for more information)