| List: | Commits | « Previous MessageNext Message » | |
| From: | jon | Date: | June 30 2006 7:13am |
| Subject: | svn commit - mysqldoc@docsrva: r2554 - trunk/ndbapi | ||
| View as plain text | |||
Author: jstephens Date: 2006-06-30 07:13:36 +0200 (Fri, 30 Jun 2006) New Revision: 2554 Log: NdbEventOperation method descriptions. Modified: trunk/ndbapi/ndb-classes.xml Modified: trunk/ndbapi/ndb-classes.xml =================================================================== --- trunk/ndbapi/ndb-classes.xml 2006-06-30 04:58:31 UTC (rev 2553) +++ trunk/ndbapi/ndb-classes.xml 2006-06-30 05:13:36 UTC (rev 2554) @@ -22400,7 +22400,7 @@ </itemizedlist> - We intend to fix these issues in future releases of MySQL + We intend to remedy these issues in future releases of MySQL Cluster and the <literal>NDB</literal> API. </para> @@ -22486,7 +22486,7 @@ <entry><literal>isOverrun()</literal></entry> <entry></entry> </row> - --> +--> <row> <entry><literal>isConsistent()</literal></entry> <entry>Detects event loss caused by node failure</entry> @@ -22612,11 +22612,8 @@ A <literal>State</literal> value is returned by the <literal>getState()</literal> method. See - <literal>NdbEventOperation::getState()</literal> - -<!--<xref linkend="class-ndbeventoperation-getstate"/>--> - - , for more information. + <xref linkend="class-ndbeventoperation-getstate"/>, for more + information. </para> </formalpara> @@ -22637,6 +22634,1236 @@ </abstract> + <section id="class-ndbeventoperation-getstate"> + + <title><literal>NdbEventOperation::getState()</literal></title> + + <formalpara> + + <title>Description</title> + + <para> + This method gets the event operation's current state. + </para> + + </formalpara> + + <formalpara> + + <title>Signature</title> + + <para> +<programlisting> +State getState + ( + void + ) +</programlisting> + </para> + + </formalpara> + + <formalpara> + + <title>Parameters</title> + + <para> + <emphasis>None</emphasis>. + </para> + + </formalpara> + + <formalpara> + + <title>Return Value</title> + + <para> + A <literal>State</literal> value. See + <xref linkend="class-ndbeventoperation-state"/>. + </para> + + </formalpara> + + <formalpara> + + <title>Example</title> + + <para> +<programlisting> +[<emphasis>To be supplied...</emphasis>] +</programlisting> + </para> + + </formalpara> + + </section> + + <section id="class-ndbeventoperation-geteventtype"> + + <title><literal>NdbEventOperation::getEventType()</literal></title> + + <formalpara> + + <title>Description</title> + + <para> + This method is used to obtain the event's type + (<literal>TableEvent</literal>). + </para> + + </formalpara> + + <formalpara> + + <title>Signature</title> + + <para> +<programlisting> +NdbDictionary::Event::TableEvent getEventType + ( + void + ) const +</programlisting> + </para> + + </formalpara> + + <formalpara> + + <title>Parameters</title> + + <para> + <emphasis>None</emphasis>. + </para> + + </formalpara> + + <formalpara> + + <title>Return Value</title> + + <para> + A <literal>TableEvent</literal> value. See + <xref linkend="class-event-tableevent"/>. + </para> + + </formalpara> + + <formalpara> + + <title>Example</title> + + <para> +<programlisting> +[<emphasis>To be supplied...</emphasis>] +</programlisting> + </para> + + </formalpara> + + </section> + + <section id="class-ndbeventoperation-getvalue"> + + <title><literal>NdbEventOperation::getValue()</literal></title> + + <formalpara> + + <title>Description</title> + + <para> + This method defines the retrieval of an attribute value. The + <literal>NDB</literal> API allocates memory for the + <literal>NdbRecAttr</literal> object that is to hold the + returned attribute value. + </para> + + </formalpara> + + <important> + <para> + This method does <emphasis>not</emphasis> fetch the + attribute value from the database, and the + <literal>NdbRecAttr</literal> object returned by this method + is not readable or printable before calling the execute() + method and <literal>Ndb::nextEvent()</literal> has returned + not <literal>NULL</literal>. + </para> + + <para> + If a specific attribute has not changed, the corresponding + <literal>NdbRecAttr</literal> will be in the state + <literal>UNDEFINED</literal>. This can be checked by using + <literal>NdbRecAttr::isNULL()</literal> which in such cases + returns <literal>-1</literal>. + </para> + </important> + + <formalpara id="class-ndbeventoperation-getvalue-memory"> + + <title><replaceable>value</replaceable> Buffer Memory Allocation</title> + + <para> + It is the application's responsibility to allocate + sufficient memory for the <replaceable>value</replaceable> + buffer (if not <literal>NULL</literal>), and this buffer + must be aligned appropriately. The buffer is used directly + (thus avoiding a copy penalty) only if it is aligned on a + 4-byte boundary and the attribute size in bytes (calculated + as <literal>NdbRecAttr::attrSize()</literal> times + <literal>NdbRecAttr::arraySize()</literal>) is a multiple of + 4. + </para> + + </formalpara> + + <note> + <para> + <literal>getValue()</literal> retrieves the current value. + Use <literal>getPreValue()</literal> for retrieving the + previous value. See + <xref linkend="class-ndbeventoperation-getprevalue"/>. + </para> + </note> + + <formalpara> + + <title>Signature</title> + + <para> +<programlisting> +NdbRecAttr* getValue + ( + const char* <replaceable>name</replaceable>, + char* <replaceable>value</replaceable> = 0 + ) +</programlisting> + </para> + + </formalpara> + + <formalpara> + + <title>Parameters</title> + + <para> + This method takes two parameters: + + <itemizedlist> + + <listitem> + <para> + The <replaceable>name</replaceable> of the attribute + (as a constant character pointer). + </para> + </listitem> + + <listitem> + <para> + A pointer to a <replaceable>value</replaceable>: + + <itemizedlist> + + <listitem> + <para> + If the attribute value is not + <literal>NULL</literal>, then the attribute + value is returned in this parameter. + </para> + </listitem> + + <listitem> + <para> + If the attribute value is + <literal>NULL</literal>, then the attribute + value is stored only in the + <literal>NdbRecAttr</literal> object returned by + this method. + </para> + </listitem> + + </itemizedlist> + + See + <xref linkend="class-ndbeventoperation-getvalue-memory"/>, + for more information regarding this parameter. + </para> + </listitem> + + </itemizedlist> + </para> + + </formalpara> + + <formalpara> + + <title>Return Value</title> + + <para> + An <literal>NdbRecAttr</literal> object to hold the value of + the attribute, or a <literal>NULL</literal> pointer + indicating that an error has occurred. See + <xref linkend="class-ndbrecattr"/>. + </para> + + </formalpara> + + <formalpara> + + <title>Example</title> + + <para> +<programlisting> +[<emphasis>To be supplied...</emphasis>] +</programlisting> + </para> + + </formalpara> + + </section> + + <section id="class-ndbeventoperation-getprevalue"> + + <title><literal>NdbEventOperation::getPreValue()</literal></title> + + <formalpara> + + <title>Description</title> + + <para> + This method performs identically to getValue(), except that + it is used to define a retrieval operation of an attribute's + previous value rather than the current value. See + <xref linkend="class-ndbeventoperation-getvalue"/>, for + details. + </para> + + </formalpara> + + <formalpara> + + <title>Signature</title> + + <para> +<programlisting> +NdbRecAttr* getPreValue + ( + const char* <replaceable>name</replaceable>, + char* <replaceable>value</replaceable> = 0 + ) +</programlisting> + </para> + + </formalpara> + + <formalpara> + + <title>Parameters</title> + + <para> + This method takes two parameters: + + <itemizedlist> + + <listitem> + <para> + The <replaceable>name</replaceable> of the attribute + (as a constant character pointer). + </para> + </listitem> + + <listitem> + <para> + A pointer to a <replaceable>value</replaceable>: + + <itemizedlist> + + <listitem> + <para> + If the attribute value is not + <literal>NULL</literal>, then the attribute + value is returned in this parameter. + </para> + </listitem> + + <listitem> + <para> + If the attribute value is + <literal>NULL</literal>, then the attribute + value is stored only in the + <literal>NdbRecAttr</literal> object returned by + this method. + </para> + </listitem> + + </itemizedlist> + + See + <xref linkend="class-ndbeventoperation-getvalue-memory"/>, + for more information regarding this parameter. + </para> + </listitem> + + </itemizedlist> + </para> + + </formalpara> + + <formalpara> + + <title>Return Value</title> + + <para> + An <literal>NdbRecAttr</literal> object to hold the value of + the attribute, or a <literal>NULL</literal> pointer + indicating that an error has occurred. See + <xref linkend="class-ndbrecattr"/>. + </para> + + </formalpara> + + <formalpara> + + <title>Example</title> + + <para> +<programlisting> +[<emphasis>To be supplied...</emphasis>] +</programlisting> + </para> + + </formalpara> + + </section> + + <section id="class-ndbeventoperation-getblobhandle"> + + <title><literal>NdbEventOperation::getBlobHandle()</literal></title> + + <formalpara> + + <title>Description</title> + + <para> + This method is used in place of getValue() for blob + attributes. The blob handle + (<literal>NdbBlob</literal>)returned by this method supports + read operations only. + </para> + + </formalpara> + + <note> + <para> + To obtain the previous value for a blob attribute, use + <literal>getPreBlobHandle</literal>. See + <xref linkend="class-ndbeventoperation-getpreblobhandle"/>. + </para> + </note> + + <formalpara> + + <title>Signature</title> + + <para> +<programlisting> +NdbBlob* getBlobHandle + ( + const char* <replaceable>name</replaceable> + ) +</programlisting> + </para> + + </formalpara> + + <formalpara> + + <title>Parameters</title> + + <para> + The <replaceable>name</replaceable> of the blob attribute. + </para> + + </formalpara> + + <formalpara> + + <title>Return Value</title> + + <para> + A pointer to an <literal>NdbBlob</literal> object. See + <xref linkend="class-ndbblob"/>. + </para> + + </formalpara> + + <formalpara> + + <title>Example</title> + + <para> +<programlisting> +[<emphasis>To be supplied...</emphasis>] +</programlisting> + </para> + + </formalpara> + + </section> + + <section id="class-ndbeventoperation-getpreblobhandle"> + + <title><literal>NdbEventOperation::getPreBlobHandle()</literal></title> + + <formalpara> + + <title>Description</title> + + <para> + This function is the same as + <literal>getBlobHandle()</literal>, except that it is used + to access the previous value of the blob attribute. See + <xref linkend="class-ndbeventoperation-getblobhandle"/>. + </para> + + </formalpara> + + <formalpara> + + <title>Signature</title> + + <para> +<programlisting> +NdbBlob* getPreBlobHandle + ( + const char* <replaceable>name</replaceable> + ) +</programlisting> + </para> + + </formalpara> + + <formalpara> + + <title>Parameters</title> + + <para> + The <replaceable>name</replaceable> of the blob attribute. + </para> + + </formalpara> + + <formalpara> + + <title>Return Value</title> + + <para> + A pointer to an <literal>NdbBlob</literal>. See + <xref linkend="class-ndbblob"/>. + </para> + + </formalpara> + + <formalpara> + + <title>Example</title> + + <para> +<programlisting> +[<emphasis>To be supplied...</emphasis>] +</programlisting> + </para> + + </formalpara> + + </section> + + <section id="class-ndbeventoperationgetgci"> + + <title><literal>NdbEventOperation::getGCI()</literal></title> + + <formalpara> + + <title>Description</title> + + <para> + This method retrieves the GCI for the most recently + retrieved event. + </para> + + </formalpara> + + <formalpara> + + <title>Signature</title> + + <para> +<programlisting> +Uint64 getGCI + ( + void + ) const +</programlisting> + </para> + + </formalpara> + + <formalpara> + + <title>Parameters</title> + + <para> + <emphasis>None</emphasis>. + </para> + + </formalpara> + + <formalpara> + + <title>Return Value</title> + + <para> + The global checkpoint index of the most recently retrieved + event (an integer). + </para> + + </formalpara> + + <formalpara> + + <title>Example</title> + + <para> +<programlisting> +[<emphasis>To be supplied...</emphasis>] +</programlisting> + </para> + + </formalpara> + + </section> + + <section id="class-ndbeventoperation-getlatestgci"> + + <title><literal>NdbEventOperation::getLatestGCI()</literal></title> + + <formalpara> + + <title>Description</title> + + <para> + This method retrieves the most recent GCI. + </para> + + </formalpara> + + <note> + <para> + The CGI obtained using this method is not necessarily + associated with an event. + </para> + </note> + + <formalpara> + + <title>Signature</title> + + <para> +<programlisting> +Uint64 getLatestGCI + ( + void + ) const +</programlisting> + </para> + + </formalpara> + + <formalpara> + + <title>Parameters</title> + + <para> + <emphasis>None</emphasis>. + </para> + + </formalpara> + + <formalpara> + + <title>Return Value</title> + + <para> + The index of the latest global checkpoint, an integer. + </para> + + </formalpara> + + <formalpara> + + <title>Example</title> + + <para> +<programlisting> +[<emphasis>To be supplied...</emphasis>] +</programlisting> + </para> + + </formalpara> + + </section> + + <section id="class-ndbeventoperation-getndberror"> + + <title><literal>NdbEventOperation::getNdbError()</literal></title> + + <formalpara> + + <title>Description</title> + + <para> + This method retrieves the most recent error. + </para> + + </formalpara> + + <formalpara> + + <title>Signature</title> + + <para> +<programlisting> +const struct NdbError& getNdbError + ( + void + ) const +</programlisting> + </para> + + </formalpara> + + <formalpara> + + <title>Parameters</title> + + <para> + <emphasis>None</emphasis>. + </para> + + </formalpara> + + <formalpara> + + <title>Return Value</title> + + <para> + A reference to an <literal>NdbError</literal> structure. See + <xref linkend="struct-ndberror"/>. + </para> + + </formalpara> + + <formalpara> + + <title>Example</title> + + <para> +<programlisting> +[<emphasis>To be supplied...</emphasis>] +</programlisting> + </para> + + </formalpara> + + </section> + + <section id="class-ndbeventoperation-isconsistent"> + + <title><literal>NdbEventOperation::isConsistent()</literal></title> + + <formalpara> + + <title>Description</title> + + <para> + Tnis method is used to determine whether event loss has + taken place following the failure of a node. + </para> + + </formalpara> + + <formalpara> + + <title>Signature</title> + + <para> +<programlisting> +bool isConsistent + ( + void + ) const +</programlisting> + </para> + + </formalpara> + + <formalpara> + + <title>Parameters</title> + + <para> + <emphasis>None</emphasis>. + </para> + + </formalpara> + + <formalpara> + + <title>Return Value</title> + + <para> + If event loss has taken place, then this method returns + <literal>false</literal>; otherwise, it returns + <literal>true</literal>. + </para> + + </formalpara> + + <formalpara> + + <title>Example</title> + + <para> +<programlisting> +[<emphasis>To be supplied...</emphasis>] +</programlisting> + </para> + + </formalpara> + + </section> + + <section id="class-ndbeventoperation-tablenamechanged"> + + <title><literal>NdbEventOperation::tableNameChanged()</literal></title> + + <formalpara> + + <title>Description</title> + + <para> + This method tests whether a table name has changed as the + result of a <literal>TE_ALTER</literal> table event. (See + <xref linkend="class-event-tableevent"/>.) + </para> + + </formalpara> + + <formalpara> + + <title>Signature</title> + + <para> +<programlisting> +const bool tableNameChanged + ( + void + ) const +</programlisting> + </para> + + </formalpara> + + <formalpara> + + <title>Parameters</title> + + <para> + <emphasis>None</emphasis>. + </para> + + </formalpara> + + <formalpara> + + <title>Return Value</title> + + <para> + Returns <literal>true</literal> if the name of the table has + changed; otherwise, the mothod returns + <literal>false</literal>. + </para> + + </formalpara> + + <formalpara> + + <title>Example</title> + + <para> +<programlisting> +[<emphasis>To be supplied...</emphasis>] +</programlisting> + </para> + + </formalpara> + + </section> + + <section id="class-ndbeventoperation-tablefrmchanged"> + + <title><literal>NdbEventOperation::tableFrmChanged()</literal></title> + + <formalpara> + + <title>Description</title> + + <para> + Use this method to determine whether a table + <filename>.FRM</filename> file has changed in connection + with a TE_ALTER event. (See + <xref linkend="class-event-tableevent"/>.) + </para> + + </formalpara> + + <formalpara> + + <title>Signature</title> + + <para> +<programlisting> +const bool tableFrmChanged + ( + void + ) const +</programlisting> + </para> + + </formalpara> + + <formalpara> + + <title>Parameters</title> + + <para> + <emphasis>None</emphasis>. + </para> + + </formalpara> + + <formalpara> + + <title>Return Value</title> + + <para> + Returns <literal>true</literal> if the the table + <filename>.FRM</filename> file has changed; otherwise, the + mothod returns <literal>false</literal>. + </para> + + </formalpara> + + <formalpara> + + <title>Example</title> + + <para> +<programlisting> +[<emphasis>To be supplied...</emphasis>] +</programlisting> + </para> + + </formalpara> + + </section> + + <section id="class-ndbeventoperation-tablefragmentationchanged"> + + <title><literal>NdbEventOperation::tableFragmentationChanged()</literal></title> + + <formalpara> + + <title>Description</title> + + <para> + This method is used to test whether a table's fragmentation + has changed in connection with a <literal>TE_ALTER</literal> + event. (See <xref linkend="class-event-tableevent"/>.) + </para> + + </formalpara> + + <formalpara> + + <title>Signature</title> + + <para> +<programlisting> +const bool tableFragmentationChanged + ( + void + ) const +</programlisting> + </para> + + </formalpara> + + <formalpara> + + <title>Parameters</title> + + <para> + <emphasis>None</emphasis>. + </para> + + </formalpara> + + <formalpara> + + <title>Return Value</title> + + <para> + Returns <literal>true</literal> if the the table's + fragmentation has changed; otherwise, the method returns + <literal>false</literal>. + </para> + + </formalpara> + + <formalpara> + + <title>Example</title> + + <para> +<programlisting> +[<emphasis>To be supplied...</emphasis>] +</programlisting> + </para> + + </formalpara> + + </section> + + <section id="class-"> + + <title><literal></literal></title> + + <formalpara> + + <title>Description</title> + + <para> + Use this method to check whether a table range partition + list name has changed in connection with a + <literal>TE_ALTER</literal> event. + </para> + + </formalpara> + + <formalpara> + + <title>Signature</title> + + <para> +<programlisting> +const bool tableRangeListChanged + ( + void + ) const +</programlisting> + </para> + + </formalpara> + + <formalpara> + + <title>Parameters</title> + + <para> + <emphasis>None</emphasis>. + </para> + + </formalpara> + + <formalpara> + + <title>Return Value</title> + + <para> + This method returns <literal>true</literal> if range or list + partition name has changed; otherwise it returns + <literal>false</literal>. + </para> + + </formalpara> + + <formalpara> + + <title>Example</title> + + <para> +<programlisting> +[<emphasis>To be supplied...</emphasis>] +</programlisting> + </para> + + </formalpara> + + </section> + + <section id="class-ndbeventoperation-mergeevents"> + + <title><literal>NdbEventOperation::mergeEvents()</literal></title> + + <formalpara> + + <title>Description</title> + + <para> + This method is used to set the merge events flag. For + information about event merging, see + <xref linkend="class-event-mergeevents"/>. + </para> + + </formalpara> + + <note> + <para> + The merge events flag is <literal>false</literal> by + default. + </para> + </note> + + <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>. + </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-ndbeventoperation-execute"> + + <title><literal>NdbEventOperation::execute()</literal></title> + + <formalpara> + + <title>Description</title> + + <para> + Activates the <literal>NdbEventOperation</literal>, so that + it can begin receiving events. Changed attribute values may + be retrieved after <literal>Ndb::nextEvent()</literal> has + returned not <literal>NULL</literal>. + <literal>getValue()</literal> or + <literal>getPreValue()</literal> must be called before + invoking <literal>execute()</literal>. + </para> + + </formalpara> + + <important> + <para> + Before attempting to use this method, you should have read + the explanations provided in + <xref linkend="class-ndb-nextevent"/>, and + <xref linkend="class-ndbeventoperation-getvalue"/>. Also see + <xref linkend="class-ndbeventoperation"/>. + </para> + </important> + + <formalpara> + + <title>Signature</title> + + <para> +<programlisting> +int execute + ( + void + ) +</programlisting> + </para> + + </formalpara> + + <formalpara> + + <title>Parameters</title> + + <para> + <emphasis>None</emphasis>. + </para> + + </formalpara> + + <formalpara> + + <title>Return Value</title> + + <para> + This method returns <literal>0</literal> on success and + <literal>-1</literal> on failure. + </para> + + </formalpara> + + <formalpara> + + <title>Example</title> + + <para> +<programlisting> +[<emphasis>To be supplied...</emphasis>] +</programlisting> + </para> + + </formalpara> + + </section> + </section> </section>
| Thread | ||
|---|---|---|
| • svn commit - mysqldoc@docsrva: r2554 - trunk/ndbapi | jon | 30 Jun |
© 1995-2008 MySQL AB, 2008-2009 Sun Microsystems, Inc.
Page generated in 1.044 sec. using MySQL 5.1.14-beta-log