Abstract
This section discusses the Event class, its
methods and defined types.
Parent class. NdbDictionary
Child classes. None
Description. This class represents a database event in a MySQL Cluster.
Methods.
The following table lists the public methods of the
Event class and the purpose or use of each
method:
| Method | Purpose / Use |
|---|---|
Event() |
Class constructor |
~Event() |
Destructor |
getName() |
Gets the event's name |
getTable() |
Gets the Table object on which the event is defined |
getTableName() |
Gets the name of the table on which the event is defined |
getTableEvent() |
Checks whether an event is to be detected |
getDurability() |
Gets the event's durability |
getReport() |
Gets the event's reporting options |
getNoOfEventColumns() |
Gets the number of columns for which an event is defined |
getEventColumn() |
Gets a column for which an event is defined |
getObjectStatus() |
Gets the event's object status |
getObjectVersion() |
Gets the event's object version |
getObjectId() |
Gets the event's object ID |
setName() |
Sets the event's name |
setTable() |
Sets the Table object on which the event is defined |
addTableEvent() |
Adds the type of event that should be detected |
setDurability() |
Sets the event's durability |
setReport() |
The the event's reporting options |
addEventColumn() |
Adds a column on which events should be detected |
addEventColumns() |
Adds multiple columns on which events should be detected |
mergeEvents() |
Sets the event's merge flag |
For detailed descriptions, signatures, and examples of use for each
of these methods, see Section 2.3.4.2, “Event Methods”.
Types.
These are the public types of the Event class:
| Type | Purpose / Use |
|---|---|
TableEvent |
Represents the type of a table event |
EventDurability |
Specifies an event's scope, accessibility, and lifetime |
EventReport |
Specifies the reporting option for a table event |
For a discussion of each of these types, along with its possible
values, see Section 2.3.4.1, “Event Types”.
Class diagram.
This diagram shows all the available methods and enumerated types
of the Event class:
