NdbDictionary::Event Class Reference
Represents an Event in NDB Cluster. More...
#include <NdbDictionary.hpp>
Detailed Description
Represents an Event in NDB Cluster.Member Enumeration Documentation
enum NdbDictionary::Object::FragmentType [inherited] |
Type of fragmentation.
This parameter specifies how data in the table or index will be distributed among the db nodes in the cluster.
The bigger the table the more number of fragments should be used. Note that all replicas count as same "fragment".
For a table, default is FragAllMedium. For a unique hash index, default is taken from underlying table and cannot currently be changed.
enum NdbDictionary::Object::State [inherited] |
Object state
enum NdbDictionary::Object::Status [inherited] |
Status of object
- Enumerator:
-
New The object only exist in memory and has not been created in the NDB Kernel Changed The object has been modified in memory and has to be commited in NDB Kernel for changes to take effect Retrieved The object exist and has been read into main memory from NDB Kernel Invalid The object has been invalidated and should not be used Altered Table has been altered in NDB kernel but is still valid for usage
enum NdbDictionary::Object::Store [inherited] |
Specifies the type of database operations an Event listens to
- Enumerator:
Reimplemented from NdbDictionary::Object.
enum NdbDictionary::Object::Type [inherited] |
Object type
- Enumerator:
-
TypeUndefined Undefined. SystemTable System table. UserTable User table (may be temporary). UniqueHashIndex Unique un-ordered hash index. OrderedIndex Non-unique ordered index. HashIndexTrigger Index maintenance, internal. IndexTrigger Index maintenance, internal. SubscriptionTrigger Backup or replication, internal. ReadOnlyConstraint Trigger, internal. TableEvent Table event. Tablespace Tablespace. LogfileGroup Logfile group. Datafile Datafile. Undofile Undofile. ReorgTrigger HashMap
Reimplemented in NdbDictionary::Index.
Constructor & Destructor Documentation
| NdbDictionary::Event::Event | ( | const char * | name | ) |
Constructor
- Parameters:
-
name Name of event
| NdbDictionary::Event::Event | ( | const char * | name, | |
| const NdbDictionary::Table & | table | |||
| ) |
Constructor
- Parameters:
-
name Name of event table Reference retrieved from NdbDictionary
| virtual NdbDictionary::Event::~Event | ( | ) | [virtual] |
| NdbDictionary::Event::Event | ( | NdbEventImpl & | ) | [private] |
Member Function Documentation
| void NdbDictionary::Event::addEventColumn | ( | const char * | columnName | ) |
Add a column on which events should be detected
- Parameters:
-
columnName Column name
- Note:
- errors will not be detected until createEvent() is called
| void NdbDictionary::Event::addEventColumn | ( | unsigned | attrId | ) |
Add a column on which events should be detected
- Parameters:
-
attrId Column id
- Note:
- errors will mot be detected until createEvent() is called
| void NdbDictionary::Event::addEventColumns | ( | int | n, | |
| const char ** | columnNames | |||
| ) |
Add several columns on which events should be detected
- Parameters:
-
n Number of columns columnNames Column names
- Note:
- errors will mot be detected until NdbDictionary::Dictionary::createEvent() is called
| void NdbDictionary::Event::addTableEvent | ( | const TableEvent | te | ) |
Add type of event that should be detected
| EventDurability NdbDictionary::Event::getDurability | ( | ) | const |
Get durability of the event
| const Column* NdbDictionary::Event::getEventColumn | ( | unsigned | no | ) | const |
Get a specific column in the event
| const char* NdbDictionary::Event::getName | ( | ) | const |
Get unique identifier for the event
| int NdbDictionary::Event::getNoOfEventColumns | ( | ) | const |
| virtual int NdbDictionary::Event::getObjectId | ( | ) | const [virtual] |
Get object id
Implements NdbDictionary::Object.
| virtual Object::Status NdbDictionary::Event::getObjectStatus | ( | ) | const [virtual] |
Get object status
Implements NdbDictionary::Object.
| virtual int NdbDictionary::Event::getObjectVersion | ( | ) | const [virtual] |
Get object version
Implements NdbDictionary::Object.
| EventReport NdbDictionary::Event::getReport | ( | ) | const |
Get report option of the event
| const NdbDictionary::Table* NdbDictionary::Event::getTable | ( | ) | const |
Get table that the event is defined on
- Returns:
- pointer to table or NULL if no table has been defined
| bool NdbDictionary::Event::getTableEvent | ( | const TableEvent | te | ) | const |
Check if a specific table event will be detected
| const char* NdbDictionary::Event::getTableName | ( | ) | const |
Get table name for events
- Returns:
- table name
| void NdbDictionary::Event::mergeEvents | ( | bool | flag | ) |
The merge events flag is false by default. Setting it true implies that events are merged in following ways:
- for given NdbEventOperation associated with this event, events on same PK within same GCI are merged into single event
- a blob table event is created for each blob attribute and blob events are handled as part of main table events
- blob post/pre data from the blob part events can be read via NdbBlob methods as a single value
NOTE: Currently this flag is not inherited by NdbEventOperation and must be set on NdbEventOperation explicitly.
| void NdbDictionary::Event::setDurability | ( | EventDurability | ) |
Set durability of the event
| int NdbDictionary::Event::setName | ( | const char * | name | ) |
Set unique identifier for the event
| void NdbDictionary::Event::setReport | ( | EventReport | ) |
Set report option of the event
| int NdbDictionary::Event::setTable | ( | const char * | tableName | ) |
Set table for which events should be detected
- Note:
- preferred way is using setTable(const NdbDictionary::Table&) or constructor with table object parameter
| void NdbDictionary::Event::setTable | ( | const NdbDictionary::Table & | table | ) |
Define table on which events should be detected
- Note:
- calling this method will default to detection of events on all columns. Calling subsequent addEventColumn calls will override this.
- Parameters:
-
table reference retrieved from NdbDictionary
Member Data Documentation
class NdbEventImpl& NdbDictionary::Event::m_impl [private] |
The documentation for this class was generated from the following file:
- include/ndbapi/NdbDictionary.hpp