Documentation Home
MySQL Cluster API Developer Guide
Download this Manual
PDF (US Ltr) - 5.0Mb
PDF (A4) - 5.0Mb
EPUB - 1.9Mb
HTML Download (TGZ) - 1.9Mb
HTML Download (Zip) - 1.9Mb


2.3.6.1 Event Types

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:

Value Description
TE_INSERT Insert event on a table
TE_DELETE Delete event on a table
TE_UPDATE Update event on a table
TE_DROP Occurs when a table is dropped
TE_ALTER Occurs when a table definition is changed
TE_CREATE Occurs when a table is created
TE_GCP_COMPLETE Occurs on the completion of a global checkpoint
TE_CLUSTER_FAILURE Occurs on Cluster failures
TE_STOP Occurs when an event operation is stopped
TE_NODE_FAILURE Occurs when a Cluster node fails
TE_SUBSCRIBE Occurs when a cluster node subscribes to an event
TE_UNSUBSCRIBE Occurs when a cluster node unsubscribes from an event
TE_EMPTY Empty epoch received from data nodes
TE_INCONSISTENT Missing data or buffer overflow at data node
TE_OUT_OF_MEMORY Overflow in event buffer
TE_ALL Occurs when any event occurs on a table (not relevant when a specific event is received)

TE_EMPTY, TE_INCONSISTENT, and TE_OUT_OF_MEMORY were added in MySQL Cluster NDB 7.4.3.

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:

Value Description
ED_UNDEFINED The event is undefined or of an unsupported type.
ED_SESSION This 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_TEMPORARY Any 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_PERMANENT Any 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:

Value Description
ER_UPDATED Reporting of update events
ER_ALL Reporting of all events, except for those not resulting in any updates to the inline parts of BLOB columns
ER_SUBSCRIBE Reporting of subscription events
ER_DDL Reporting of DDL events (added in MySQL Cluster NDB 7.1.4; see Section 2.3.6.2.18, “Event::setReport()”, for more information)

User Comments
Sign Up Login You must be logged in to post a comment.