NdbDictionary::Event Class Reference

#include <NdbDictionary.hpp>

Inheritance diagram for NdbDictionary::Event:

List of all members.

---

Detailed Description

Represents an Event in NDB Cluster.

Public Types

• TE_INSERT = 1

  Insert event on table.
  

• TE_DELETE = 2

  Delete event on table.
  

• TE_UPDATE = 4

  Update event on table.
  

• TE_ALL = 7
• ED_UNDEFINED
• ED_PERMANENT
• enum TableEvent { TE_INSERT = 1, TE_DELETE = 2, TE_UPDATE = 4, TE_ALL = 7 }
• enum EventDurability { ED_UNDEFINED, ED_PERMANENT }

Public Member Functions

• Event (const char *name)
• Event (const char *name, const NdbDictionary::Table &table)
• void setName (const char *name)
• const char * getName () const
• void setTable (const NdbDictionary::Table &table)
• void setTable (const char *tableName)
• const char * getTableName () const
• void addTableEvent (const TableEvent te)
• void setDurability (EventDurability)
• EventDurability getDurability () const
• void addEventColumn (unsigned attrId)
• void addEventColumn (const char *columnName)
• void addEventColumns (int n, const char **columnNames)
• int getNoOfEventColumns () const
• virtual Object::Status getObjectStatus () const
• virtual int getObjectVersion () const

---

Member Enumeration Documentation

enum NdbDictionary::Event::EventDurability

Specifies the durability of an event (future version may supply other types)

Enumerator:

ED_PERMANENT

All API's can use it. It's still defined after a cluster system restart

enum NdbDictionary::Event::TableEvent

Specifies the type of database operations an Event listens to

Enumerator:

TE_INSERT	Insert event on table.
TE_DELETE	Delete event on table.
TE_UPDATE	Update event on table.
TE_ALL	Any/all event on table (not relevant when events are received)

---

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

---

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 char* NdbDictionary::Event::getName

(

)

const

Get unique identifier for the event

int NdbDictionary::Event::getNoOfEventColumns

(

)

const

Get no of columns defined in an Event

Returns:

Number of columns, -1 on error

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.

const char* NdbDictionary::Event::getTableName

(

)

const

Get table name for events

Returns:

table name

void NdbDictionary::Event::setDurability

(

EventDurability

)

Set durability of the event

void NdbDictionary::Event::setName

(

const char *

name

)

Set unique identifier for the event

void 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

---