Author: jstephens
Date: 2006-06-18 09:59:54 +0200 (Sun, 18 Jun 2006)
New Revision: 2407
Log:
Added Event class method listing.
Modified:
trunk/ndbapi/ndb-classes.xml
Modified: trunk/ndbapi/ndb-classes.xml
===================================================================
--- trunk/ndbapi/ndb-classes.xml 2006-06-17 10:17:24 UTC (rev 2406)
+++ trunk/ndbapi/ndb-classes.xml 2006-06-18 07:59:54 UTC (rev 2407)
@@ -3914,11 +3914,11 @@
</para>
</formalpara>
-
+
<note>
<para>
- For the numeric equivalents to enumerations of
- NdbDictionary subclasses, see the file
+ For the numeric equivalents to enumerations of NdbDictionary
+ subclasses, see the file
<filename>/storage/ndb/include/ndbapi/NdbDictionary.hpp</filename>
in the MySQL 5.1 source tree.
</para>
@@ -7543,12 +7543,1880 @@
<title>The <literal>Event</literal> Class</title>
-<!-- <abstract> -->
+ <abstract>
- <para/>
+ <para>
+ This section discusses the <literal>Event</literal> class,
+ its methods and defined types.
+ </para>
-<!-- </abstract> -->
+ </abstract>
+ <remark role="todo">
+ [js] Much more discussion of events is needed or a link here
+ to same. What's the relationship between Event and
+ EventOperation? Table events and log events? - And what about
+ other types of events?
+ </remark>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This class represents a database event in a MySQL Cluster.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Public Methods</title>
+
+ <para>
+ The following table lists the public methods of the
+ <literal>Event</literal> class and the purpose or use of
+ each method:
+ </para>
+
+ </formalpara>
+
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colwidth="35*"/>
+ <colspec colwidth="65*"/>
+ <thead>
+ <row>
+ <entry>Method</entry>
+ <entry>Purpose / Use</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><literal></literal></entry>
+ <entry></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+ <para>
+ For detailed descriptions, signatures, and examples of use for
+ each of these methods, see
+ <xref linkend="class-event-members"/>.
+ </para>
+
+ <formalpara>
+
+ <title>Public Types</title>
+
+ <para>
+ These are the public types of the <literal>Event</literal>
+ class:
+ </para>
+
+ </formalpara>
+
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colwidth="35*"/>
+ <colspec colwidth="65*"/>
+ <thead>
+ <row>
+ <entry>Type</entry>
+ <entry>Purpose / Use</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><literal>YableEvent</literal></entry>
+ <entry>Represents the type of a table event</entry>
+ </row>
+ <row>
+ <entry><literal>EventDurability</literal></entry>
+ <entry>Specifies an event's scope, accessibility, and lifetime</entry>
+ </row>
+ <row>
+ <entry><literal>EventReport</literal></entry>
+ <entry>Specifies the reporting option for a table event</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+ <para>
+ For a discussion of each of these types, along with its
+ possible values, see <xref linkend="class-event-types"/>.
+ </para>
+
+ <formalpara>
+
+ <title>Class Diagram</title>
+
+ <para>
+ This diagram shows all the available methods and enumerated
+ types of the <literal>Event</literal> class:
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/NdbDictionary-Object-Event-class.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Public methods and enumerated types of
+ the <literal>Event</literal> class.</phrase>
+ </textobject>
+ </mediaobject>
+ </para>
+
+ </formalpara>
+
+ <section id="class-event-types">
+
+ <title><literal>Event</literal> Types</title>
+
+ <abstract>
+
+ <para>
+ This section details the public types belonging to the
+ <literal>Event</literal> class.
+ </para>
+
+ </abstract>
+
+ <section id="class-event-tableevent">
+
+ <title><literal>NdbDictionary::Object::Event::TableEvent</literal></title>
+
+ <abstract>
+
+ <para>
+ This section describes <literal>TableEvent</literal>, a
+ type defined by the <literal>Event</literal> class.
+ </para>
+
+ </abstract>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ <literal>TableEvent</literal> is used to classify the
+ types of events that may be associated with tables in
+ the <literal>NDB</literal> API.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Enumeration Values</title>
+
+ <para>
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colwidth="35*"/>
+ <colspec colwidth="65*"/>
+ <thead>
+ <row>
+ <entry>Value</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><literal>TE_INSERT</literal></entry>
+ <entry>Insert event on a table</entry>
+ </row>
+ <row>
+ <entry><literal>TE_DELETE</literal></entry>
+ <entry>Delete event on a table</entry>
+ </row>
+ <row>
+ <entry><literal>TE_UPDATE</literal></entry>
+ <entry>Update event on a table</entry>
+ </row>
+ <row>
+ <entry><literal>TE_DROP</literal></entry>
+ <entry>Occurs when a table is dropped</entry>
+ </row>
+ <row>
+ <entry><literal>TE_ALTER</literal></entry>
+ <entry>Occurs when a table definition is changed</entry>
+ </row>
+ <row>
+ <entry><literal>TE_CREATE</literal></entry>
+ <entry>Occurs when a table is created</entry>
+ </row>
+ <row>
+ <entry><literal>TE_GCP_COMPLETE</literal></entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry><literal>TE_CLUSTER_FAILURE</literal></entry>
+ <entry>Occurs on the completion of a global checkpoint</entry>
+ </row>
+ <row>
+ <entry><literal>TE_STOP</literal></entry>
+ <entry>Occurs when an event operation is stopped</entry>
+ </row>
+ <row>
+ <entry><literal>TE_NODE_FAILURE</literal></entry>
+ <entry>Occurs when a Cluster node fails</entry>
+ </row>
+ <row>
+ <entry><literal>TE_SUBSCRIBE</literal></entry>
+ <entry>Occurs when a cluster node subscribes to an event</entry>
+ </row>
+ <row>
+ <entry><literal>TE_UNSUBSCRIBE</literal></entry>
+ <entry>Occurs when a cluster node unsubscribes from an event</entry>
+ </row>
+ <row>
+ <entry><literal>TE_ALL</literal></entry>
+ <entry>Occurs when any event occurs on a table (not relevant when a specific
+ event is received)</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-event-eventdurability">
+
+ <title><literal>NdbDictionary::Object::Event::EventDurability</literal></title>
+
+ <abstract>
+
+ <para>
+ This section discusses
+ <literal>EventDurability</literal>, a type defined by
+ the <literal>Event</literal> class.
+ </para>
+
+ </abstract>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ The values of this type are used to describe an event's
+ lifetime or persistence as well as its scope.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Enumeration Values</title>
+
+ <para>
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colwidth="35*"/>
+ <colspec colwidth="65*"/>
+ <thead>
+ <row>
+ <entry>Value</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><literal>ED_UNDEFINED</literal></entry>
+ <entry>The event is undefined or of an unsupported type</entry>
+ </row>
+ <row>
+ <entry><literal>ED_SESSION</literal></entry>
+ <entry>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</entry>
+ </row>
+ <row>
+ <entry><literal>ED_TEMPORARY</literal></entry>
+ <entry>Any application may use the event, but it is deleted following a cluster
+ restart</entry>
+ </row>
+ <row>
+ <entry><literal>ED_PERMANENT</literal></entry>
+ <entry>Any application may use the event, and it persists until deleted by an
+ application — even following a cluster
+ restart</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-event-eventreport">
+
+ <title><literal>NdbDictionary::Object::Event::EventReport</literal></title>
+
+ <abstract>
+
+ <para>
+ This section discusses <literal>EventReport</literal>, a
+ type defined by the <literal>Event</literal> class.
+ </para>
+
+ </abstract>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ The values of this type are used to specify reporting
+ options for table events.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Enumeration Values</title>
+
+ <para>
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colwidth="35*"/>
+ <colspec colwidth="65*"/>
+ <thead>
+ <row>
+ <entry>Value</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><literal>ER_UPDATED</literal></entry>
+ <entry>Reporting of update events</entry>
+ </row>
+ <row>
+ <entry><literal>ER_ALL</literal></entry>
+ <entry>Reporting of all events, except for those not resulting in any updates
+ to the inline parts of <literal>BLOB</literal>
+ columns</entry>
+ </row>
+ <row>
+ <entry><literal>ER_SUBSCRIBE</literal></entry>
+ <entry>Reporting of subscription events</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ </section>
+
+ <section id="class-event-members">
+
+ <title><literal>Event</literal> Class Members</title>
+
+ <section id="class-event-constructor">
+
+ <title><literal>Event</literal> Constructor</title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ The <literal>Event</literal> constructor creates a new
+ instance with a given name, and optionally associated
+ with a table.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signatures</title>
+
+ <para>
+ Name only:
+
+<programlisting>
+Event
+ (
+ const char* <replaceable>name</replaceable>
+ )
+</programlisting>
+
+ Name and associated table:
+
+<programlisting>
+Event
+ (
+ const char* <replaceable>name</replaceable>,
+ const NdbDictionary::Table& <replaceable>table</replaceable>
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ At a minimum, a <replaceable>name</replaceable> (as a
+ constant character pointer) for the event is required.
+ Optionally, an event may also be associated with a
+ table; this argument, when present, is a reference to a
+ <literal>Table</literal> object (see
+ <xref linkend="class-table"/>).
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ A new instance of <literal>Event</literal>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Destructor</title>
+
+ <para>
+ A destructor for this class is supplied as a virtual
+ method which takes no arguments and whose return type is
+ <literal>void</literal>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-event-getname">
+
+ <title><literal>NdbDictionary::Object::Event::getName()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method obtains the name of the event.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+const char* getName
+ (
+ void
+ ) const
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The name of the event, as a character pointer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-event-gettable">
+
+ <title><literal>NdbDictionary::Object::Event::getTable()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to find the table with which an
+ event is associated. It returns a reference to the
+ corresponding <literal>Table</literal> object. You may
+ also obtain the name of the table directly using
+ getTableName(). (For details, see
+ <xref linkend="class-event-gettablename"/>.)
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+const NdbDictionary::Table* getTable
+ (
+ void
+ ) const
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The table with which the event is associated — if
+ there is one — as a pointer to a
+ <literal>Table</literal> object; otherwise, this method
+ returns <literal>NULL</literal>. (See
+ <xref linkend="class-table"/>.)
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-event-gettablename">
+
+ <title><literal>NdbDictionary::Object::Event::TableName()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method obtains the name of the table with which an
+ event is associated, and can serve as a convenient
+ alternative to <literal>getTable()</literal>. (See
+ <xref linkend="class-event-gettable"/>.)
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+const char* getTableName
+ (
+ void
+ ) const
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The name of the table associated with this event, as a
+ character pointer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-event-gettableevent">
+
+ <title><literal>NdbDictionary::Object::Event::TableEvent()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to check whether a given table event
+ will be detected.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+bool getTableEvent
+ (
+ const TableEvent <replaceable>te</replaceable>
+ ) const
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ This method takes a single parameter - the table event's
+ type, that is, a <literal>TableEvent</literal> value.
+ See <xref linkend="class-event-tableevent"/>, for the
+ list of possible values.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ This method returns <literal>true</literal> if events of
+ <literal>TableEvent</literal> type
+ <replaceable>te</replaceable> will be detected.
+ Otherwise, the return value is <literal>false</literal>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-event-getdurability">
+
+ <title><literal>NdbDictionary::Object::Event::getDurability()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method gets the event's lifetime and scope (that
+ is, its <literal>EventDurability</literal>).
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+EventDurability getDurability
+ (
+ void
+ ) const
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ An <literal>EventDurability</literal> value. See
+ <xref linkend="class-event-eventdurability"/>, for
+ possible values.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-event-getreport">
+
+ <title><literal>NdbDictionary::Object::Event::getReport()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to obtain the reporting option in
+ force for this event.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+EventReport getReport
+ (
+ void
+ ) const
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ One of the reporting options specified in
+ <xref linkend="class-event-eventreport"/>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-event-getnoofeventcolumns">
+
+ <title><literal>NdbDictionary::Object::Event::getNoOfEventColumns()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method obtains the number of columns on which an
+ event is defined.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+int getNoOfEventColumns() const
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The number of columns (as an integer), or
+ <literal>-1</literal> in the case of an error.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-event-geteventcolumn">
+
+ <title><literal>NdbDictionary::Object::Event::getEventColumn()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to obtain a specific column from
+ among those on which an event is defined.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+const Column* getEventColumn
+ (
+ unsigned <replaceable>no</replaceable>
+ ) const
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ The number (<replaceable>no</replaceable>) of the
+ column, as obtained using
+ <literal>getNoOfColumns()</literal> (see
+ <xref linkend="class-event-getnoofeventcolumns"/>).
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ A pointer to the <literal>Column</literal> corresponding
+ to <replaceable>no</replaceable>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-event-getobjectstatus">
+
+ <title><literal>NdbDictionary::Object::Event::getObjectStatus()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method gets the object status of the event.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+virtual Object::Status getObjectStatus
+ (
+ void
+ ) const
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The object status of the event — for possible
+ values, see <xref linkend="class-object-status"/>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-event-getobjectversion">
+
+ <title><literal>NdbDictionary::Object::Event::getObjectVersion()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method gets the event's object version.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+virtual int getObjectVersion
+ (
+ void
+ ) const
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The object version of the event, as an integer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-event-getobjectid">
+
+ <title><literal>NdbDictionary::Object::Event::getObjectId()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method retrieves an event's object ID.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+virtual int getObjectId
+ (
+ void
+ ) const
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The object ID of the event, as an integer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-event-setname">
+
+ <title><literal>NdbDictionary::Object::Event::setName()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to set the name of an event. The
+ name must be unique among all events visible from the
+ current application (see
+ <xref linkend="class-event-getdurability"/>).
+ </para>
+
+ </formalpara>
+
+ <note>
+ <para>
+ You can also set the event's name when first creating
+ it. See <xref linkend="class-event-constructor"/>.
+ </para>
+ </note>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+void setName
+ (
+ const char* <replaceable>name</replaceable>
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ The <replaceable>name</replaceable> to be given to the
+ event (as a constant character pointer).
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-event-settable">
+
+ <title><literal>NdbDictionary::Object::Event::setTable()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method defines a table on which events are to be
+ detected.
+ </para>
+
+ </formalpara>
+
+ <note>
+ <remark role="todo">
+ [js] So does this mean that - once addEventColumn() is
+ invoked - event detection occurs only on the column that
+ was added?
+ </remark>
+
+ <para>
+ By default, event detection takes place on all columns
+ in the table. Use <literal>addEventColumn()</literal> to
+ override this behaviour. For details, see
+ <xref linkend="class-event-addeventcolumn"/>.
+ </para>
+ </note>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+void setTable
+ (
+ const NdbDictionary::Table& <replaceable>table</replaceable>
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ This method requires a single parameter, a reference to
+ the table (see <xref linkend="class-table"/>) on which
+ events are to be detected.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-event-addtableevent">
+
+ <title><literal>NdbDictionary::Object::Event::addTableEvent()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to add types of events that should
+ be detected.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+void addTableEvent
+ (
+ const TableEvent <replaceable>te</replaceable>
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ This method requires a <literal>TableEvent</literal>
+ value. See <xref linkend="class-event-tableevent"/> for
+ possible values.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-event-setdurability">
+
+ <title><literal>NdbDictionary::Object::Event::setDurability()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method sets an event's durability — that is,
+ its lifetime and scope.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+void setDurability(EventDurability <replaceable>ed</replaceable>)
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ This method requires a single
+ <literal>EventDurability</literal> value as a parameter.
+ See <xref linkend="class-event-eventdurability"/>, for
+ possible values.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-event-setreport">
+
+ <title><literal>NdbDictionary::Object::Event::setReport()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to set a reporting option for an
+ event. Possible option values may be found in
+ <xref linkend="class-event-eventreport"/>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+void setReport
+ (
+ EventReport <replaceable>er</replaceable>
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ An <literal>EventReport</literal> option value.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-event-addeventcolumn">
+
+ <title><literal>NdbDictionary::Object::Event::addEventColumn()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to add a column on which events
+ should be detected. The column may be indicated either
+ by its ID or its name.
+ </para>
+
+ </formalpara>
+
+ <remark role="todo">
+ [js] Update link to point directly to the method indicated
+ once the corresponding section is in place.
+ </remark>
+
+ <important>
+ <para>
+ You must invoke
+ <literal>Dictionary::createEvent()</literal> before any
+ errors will be detected. See
+ <xref linkend="class-dictionary"/>.
+ </para>
+ </important>
+
+ <note>
+ <para>
+ If you know several columns by name, you can enable
+ event detection on all of them at one time by using
+ <literal>addEventColumns()</literal>. See
+ <xref linkend="class-event-addeventcolumns"/>.
+ </para>
+ </note>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+ Identifying the event using its column ID:
+
+<programlisting>
+void addEventColumn
+ (
+ unsigned <replaceable>attrId</replaceable>
+ )
+</programlisting>
+
+ Identifying the column by name:
+
+<programlisting>
+void addEventColumn
+ (
+ const char* <replaceable>columnName</replaceable>
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ This method takes a single argument, which may be either
+ one of:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ The column ID (<literal>attrId</literal>), which
+ should be an integer greater than or equal to
+ <literal>0</literal>, and less than the value
+ returned by
+ <literal>getNoOfEventColumns()</literal>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The column's <replaceable>name</replaceable> (as a
+ constant character pointer).
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-event-addeventcolumns">
+
+ <title><literal>NdbDictionary::Object::Event::addEventColumns()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to enable event detection on several
+ columns at the same time. You must use the names of the
+ columns.
+ </para>
+
+ </formalpara>
+
+ <remark role="todo">
+ [js] Update link to point directly to the method indicated
+ once the corresponding section is in place.
+ </remark>
+
+ <important>
+ <para>
+ As with <literal>addEventColumn()</literal>, you must
+ invoke <literal>Dictionary::createEvent()</literal>
+ before any errors will be detected. See
+ <xref linkend="class-dictionary"/>.
+ </para>
+ </important>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+void addEventColumns
+ (
+ int <replaceable>n</replaceable>,
+ const char** <replaceable>columnNames</replaceable>
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ This method requires two arguments:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ The number of columns <replaceable>n</replaceable>
+ (an integer).
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The names of the columns
+ <replaceable>columnNames</replaceable> —
+ this must be passed as a pointer to a character
+ pointer.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-event-mergeevents">
+
+ <title><literal>NdbDictionary::Object::Event::mergeEvents()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to set the <firstterm>merge events
+ flag</firstterm>, which is <literal>false</literal> by
+ default. Setting it to <literal>true</literal> implies
+ that events are merged as follows:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ For a given <literal>NdbEventOperation</literal>
+ associated with this event, events on the same
+ primary key within the same global checkpoint
+ index (GCI) are merged into a single event.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ A blob table event is created for each blob
+ attribute, and blob events are handled as part of
+ main table events.
+ </para>
+ </listitem>
+
+ <listitem>
+ <remark role="todo">
+ [js] What is meant by "Blob post/pre data"? Before
+ and after what?
+ </remark>
+
+ <para>
+ Blob post/pre data from blob part events can be
+ read via <literal>NdbBlob</literal> methods as a
+ single value.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+void mergeEvents
+ (
+ bool <replaceable>flag</replaceable>
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ A Boolean <replaceable>flag</replaceable> value.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ </section>
+
</section>
<section id="class-index">
@@ -7764,6 +9632,7 @@
<row>
<entry><literal>UniqueHashIndex</literal></entry>
<entry>Unique un-ordered hash index (only index type currently supported)
+
<remark role="todo">
[js] is this still the case?
</remark></entry>
@@ -8944,9 +10813,9 @@
</section>
- <section id="class-">
+ <section id="class-index-setlogging">
- <title><literal></literal></title>
+ <title><literal>NdbDictionary::Object::Index::setLogging</literal></title>
<formalpara>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r2407 - trunk/ndbapi | jon | 18 Jun |
