Author: jstephens
Date: 2006-11-27 05:03:46 +0100 (Mon, 27 Nov 2006)
New Revision: 4037
Log:
Documented NdbScanFilter::cmp() method.
Wrapped NdbScanFilter integer comparison methods into their own
subsection within the methods listing for that class.
Added some index terms and additional explanations to descriptions of
Table::aggregate() and Table::validate() methods.
Fixed a misspelt section ID; updated renamed-nodes.txt
Modified:
trunk/ndbapi/ndb-classes.xml
trunk/ndbapi/renamed-nodes.txt
Modified: trunk/ndbapi/ndb-classes.xml
===================================================================
--- trunk/ndbapi/ndb-classes.xml 2006-11-26 11:20:34 UTC (rev 4036)
+++ trunk/ndbapi/ndb-classes.xml 2006-11-27 04:03:46 UTC (rev 4037)
Changed blocks: 7, Lines Added: 207, Lines Deleted: 4; 7884 bytes
@@ -22560,6 +22560,15 @@
<title><literal>Table::aggregate()</literal></title>
+ <indexterm>
+ <primary><literal>Table::aggregate()</literal></primary>
+ </indexterm>
+
+ <indexterm>
+ <primary><literal>aggregate()</literal> (method of
+ <literal>Table</literal>)</primary>
+ </indexterm>
+
<formalpara>
<title>Description</title>
@@ -22637,6 +22646,15 @@
<title><literal>Table::validate()</literal></title>
+ <indexterm>
+ <primary><literal>Table::validate()</literal></primary>
+ </indexterm>
+
+ <indexterm>
+ <primary><literal>validate()</literal> (method of
+ <literal>Table</literal>)</primary>
+ </indexterm>
+
<formalpara>
<title>Description</title>
@@ -22647,7 +22665,10 @@
<literal>Table::aggregate()</literal> method, as well as
performing additional checks.
<literal>validate()</literal> is called automatically
- when a table is created or retrieved.
+ when a table is created or retrieved. For this reason,
+ it is usually not necessary to call
+ <literal>aggregate()</literal> or
+ <literal>validate()</literal> directly.
</para>
</formalpara>
@@ -33500,7 +33521,7 @@
</abstract>
- <section id="class-ndbscanfoliter-constructor">
+ <section id="class-ndbscanfilter-constructor">
<title><literal>NdbScanFilter</literal> Class Constructor</title>
@@ -33737,6 +33758,188 @@
</section>
+ <section id="class-ndbscanfilter-cmp">
+
+ <title><literal>NdbScanFilter::cmp()</literal></title>
+
+ <indexterm>
+ <primary><literal>NdbScanFilter::cmp()</literal></primary>
+ </indexterm>
+
+ <indexterm>
+ <primary><literal>cmp()</literal> (method of <literal>NdbScanFilter</literal>)</primary>
+ </indexterm>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to perform a comparison between a given
+ value and the value of a column.
+
+ <note>
+ <para>In many cases, where the
+ value to be compared is an integer, you can instead use one
+ of several convenience methods provided by
+ <literal>NdbScanFilter</literal> for this purpose. See
+ <xref linkend="class-ndbscanfilter-integer-comparison-methods"/>.</para></note>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+int cmp
+ (
+ BinaryCondition <replaceable>condition</replaceable>,
+ int <replaceable>columnId</replaceable>,
+ const void* <replaceable>value</replaceable>,
+ Uint32 <replaceable>length</replaceable> = 0
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ This method takes the following parameters:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <replaceable>condition</replaceable>: This represents
+ the condition to be tested which compares the value of
+ the column having the column ID
+ <replaceable>columnID</replaceable> with some
+ arbitrary value. The
+ <replaceable>condition</replaceable> is a
+ <literal>BinaryCondition</literal> value; for
+ permitted values and the relations that they
+ represent, see
+ <xref linkend="class-ndbscanfilter-binarycondition"/>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <replaceable>columnId</replaceable>: This is the
+ column's identifier, which can be obtained using the
+ <literal>Column::getColumnNo()</literal> method (see
+ <xref linkend="class-column-getcolumnno"/>, for
+ details).
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <replaceable>value</replaceable>: The value to be
+ compared, repesented as a pointer to
+ <literal>void</literal>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <replaceable>length</replaceable>: The length of the
+ value to be compared. The default value is
+ <literal>0</literal>.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ This method returns an integer whose value can be
+ interpreted as shown here:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>0</literal>: The comparison is true.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>-1</literal>: The comparison is false.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ </formalpara>
+
+<!--
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+-->
+
+ </section>
+
+ <section id="class-ndbscanfilter-integer-comparison-methods">
+
+ <title><literal>NdbScanFilter</literal> Integer Comparison Methods</title>
+
+ <indexterm>
+ <primary><literal>NdbScanFilter</literal> class</primary>
+ <secondary>integer comparison methods</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>integer comparison methods (of
+ <literal>NdbScanFilter</literal> class)</primary>
+ </indexterm>
+
+ <para>
+ This section provides information about several convenience
+ methods which can be used in lieu of the
+ <literal>NdbScanFilter::cmp()</literal> method when the
+ arbitrary value to be compared is an integer. Each of these
+ methods is essentially a wrapper for <literal>cmp()</literal>
+ that includes an appropriate value of
+ <literal>BinaryCondition</literal> for that method's
+ <replaceable>condition</replaceable> parameter; for example,
+ <literal>NdbScanFilter::eq()</literal> is defined like this:
+
+<programlisting>
+int eq(int <replaceable>columnId</replaceable>, Uint32 <replaceable>value</replaceable>)
+{
+ return cmp(BinaryCondition::COND_EQ, <replaceable>columnId</replaceable>, <replaceable>&value</replaceable>, 4);
+}
+</programlisting>
+
+ For more information about the <literal>cmp()</literal>
+ method, see <xref linkend="class-ndbscanfilter-cmp"/>.
+ </para>
+
<section id="class-ndbscanfilter-eq">
<title><literal>NdbScanFilter::eq()</literal></title>
@@ -34267,9 +34470,8 @@
-->
</section>
+ <section id="class-ndbscanfilter-ge">
- <section id="class-ndbscanfilter-ge">
-
<title><literal>NdbScanFilter::ge()</literal></title>
<indexterm>
@@ -34375,6 +34577,7 @@
-->
</section>
+ </section>
<section id="class-ndbscanfilter-isnull">
Modified: trunk/ndbapi/renamed-nodes.txt
===================================================================
--- trunk/ndbapi/renamed-nodes.txt 2006-11-26 11:20:34 UTC (rev 4036)
+++ trunk/ndbapi/renamed-nodes.txt 2006-11-27 04:03:46 UTC (rev 4037)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 0; 469 bytes
@@ -21,3 +21,4 @@
class-ndbblob-setlength class-ndbblob-getlength
class-ndbtransaction-getnextcompleteoperation class-ndbtransaction-getnextcompletedoperation
+class-ndbscanfoliter-constructor class-ndbscanfilter-constructor
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r4037 - trunk/ndbapi | jon | 27 Nov |
