Author: jstephens
Date: 2010-10-06 17:32:07 +0200 (Wed, 06 Oct 2010)
New Revision: 23011
Log:
De-gunking
General revisions
Modified:
trunk/ndbapi/ndb-ndboperation.xml
trunk/ndbapi/ndb-ndbrecattr.xml
trunk/ndbapi/ndb-ndbrecord.xml
trunk/ndbapi/ndb-ndbscanfilter.xml
Modified: trunk/ndbapi/ndb-ndboperation.xml
===================================================================
--- trunk/ndbapi/ndb-ndboperation.xml 2010-10-06 15:15:42 UTC (rev 23010)
+++ trunk/ndbapi/ndb-ndboperation.xml 2010-10-06 15:32:07 UTC (rev 23011)
Changed blocks: 35, Lines Added: 435, Lines Deleted: 424; 35322 bytes
@@ -45,23 +45,23 @@
<title><literal>NdbOperation</literal> Subclasses</title>
<para>
- This diagram shows the relationships of
+ The following diagram shows the relationships of
<literal>NdbOperation</literal>, its subclasses, and their public
types:
-
- <mediaobject>
- <imageobject>
- <imagedata contentwidth="554" contentdepth="474" fileref="images/published/NdbOperation-subclasses.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase lang="en">The <literal>NdbOperation</literal> class
- and its subclasses.</phrase>
- </textobject>
- </mediaobject>
</para>
</formalpara>
+ <mediaobject>
+ <imageobject>
+ <imagedata contentwidth="554" contentdepth="474" fileref="images/published/NdbOperation-subclasses.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">The <literal>NdbOperation</literal> class and
+ its subclasses.</phrase>
+ </textobject>
+ </mediaobject>
+
<formalpara>
<title>Description</title>
@@ -178,7 +178,7 @@
<para>
The <literal>NdbOperation</literal> class defines three public
- types, as shown in the following table:
+ types, shown in the following table:
</para>
</formalpara>
@@ -221,22 +221,22 @@
<title>Class diagram</title>
<para>
- This diagram shows all the available methods and enumerated types
- of the <literal>NdbOperation</literal> class:
-
- <mediaobject>
- <imageobject>
- <imagedata contentwidth="410" contentdepth="805" fileref="images/published/NdbOperation-class.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase lang="en">Public methods and types of the
- <literal>NdbOperation</literal> class.</phrase>
- </textobject>
- </mediaobject>
+ The following diagram shows all the available methods and
+ enumerated types of the <literal>NdbOperation</literal> class:
</para>
</formalpara>
+ <mediaobject>
+ <imageobject>
+ <imagedata contentwidth="410" contentdepth="805" fileref="images/published/NdbOperation-class.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Public methods and types of the
+ <literal>NdbOperation</literal> class.</phrase>
+ </textobject>
+ </mediaobject>
+
<note>
<para>
For more information about the use of
@@ -293,60 +293,65 @@
<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>AbortOnError</literal></entry>
- <entry>A failed operation causes the transaction to abort.</entry>
- </row>
- <row>
- <entry><literal>AO_IgnoreOnError</literal></entry>
- <entry>Failed operations are ignored; the transaction continues to execute.</entry>
- </row>
- <row>
- <entry><literal>DefaultAbortOption</literal></entry>
- <entry>The <literal>AbortOption</literal> value is set according to the
- operation type:
+ Possible values are shown, along with descriptions, in the
+ following table:
+ </para>
- <itemizedlist>
+ </formalpara>
- <listitem>
- <para>
- Read operations:
- <literal>AO_IgnoreOnError</literal>
- </para>
- </listitem>
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colwidth="35*"/>
+ <colspec colwidth="65*"/>
+ <thead>
+ <row>
+ <entry>Value</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><literal>AbortOnError</literal></entry>
+ <entry>A failed operation causes the transaction to abort.</entry>
+ </row>
+ <row>
+ <entry><literal>AO_IgnoreOnError</literal></entry>
+ <entry>Failed operations are ignored; the transaction continues to execute.</entry>
+ </row>
+ <row>
+ <entry><literal>DefaultAbortOption</literal></entry>
+ <entry>The <literal>AbortOption</literal> value is set according to the
+ operation type:
- <listitem>
- <para>
- Scan takeover or DML operations:
- <literal>AbortOnError</literal>
- </para>
- </listitem>
+ <itemizedlist>
- </itemizedlist></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
+ <listitem>
+ <para>
+ Read operations:
+ <literal>AO_IgnoreOnError</literal>
+ </para>
+ </listitem>
- <literal>DefaultAbortOperation</literal> is available
- beginning with MySQL Cluster NDB 6.2.0. See
- <xref linkend="ndb-ndbtransaction-execute"/>, for more
- information.
- </para>
+ <listitem>
+ <para>
+ Scan takeover or DML operations:
+ <literal>AbortOnError</literal>
+ </para>
+ </listitem>
- </formalpara>
+ </itemizedlist></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>
+ <literal>DefaultAbortOperation</literal> is available beginning
+ with MySQL Cluster NDB 6.2.0. See
+ <xref linkend="ndb-ndbtransaction-execute"/>, for more
+ information.
+ </para>
+
<important>
<para>
Previous to MySQL Cluster NDB 6.2.0, this type belonged to the
@@ -386,47 +391,50 @@
<title>Enumeration values</title>
<para>
- <informaltable>
- <tgroup cols="3">
- <colspec colwidth="35*"/>
- <colspec colwidth="30*"/>
- <colspec colwidth="35*"/>
- <thead>
- <row>
- <entry>Value</entry>
- <entry>Description</entry>
- <entry>Class</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><literal>PrimaryKeyAccess</literal></entry>
- <entry>A read, insert, update, or delete operation using the table's primary
- key</entry>
- <entry><literal>NdbOperation</literal></entry>
- </row>
- <row>
- <entry><literal>UniqueIndexAccess</literal></entry>
- <entry>A read, update, or delete operation using a unique index</entry>
- <entry><literal>NdbIndexOperation</literal></entry>
- </row>
- <row>
- <entry><literal>TableScan</literal></entry>
- <entry>A full table scan</entry>
- <entry><literal>NdbScanOperation</literal></entry>
- </row>
- <row>
- <entry><literal>OrderedIndexScan</literal></entry>
- <entry>An ordered index scan</entry>
- <entry><literal>NdbIndexScanOperation</literal></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
+ Possible values are shown, along with descriptions, in the
+ following table:
</para>
</formalpara>
+ <informaltable>
+ <tgroup cols="3">
+ <colspec colwidth="35*"/>
+ <colspec colwidth="30*"/>
+ <colspec colwidth="35*"/>
+ <thead>
+ <row>
+ <entry>Value</entry>
+ <entry>Description</entry>
+ <entry>Class</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><literal>PrimaryKeyAccess</literal></entry>
+ <entry>A read, insert, update, or delete operation using the table's primary
+ key</entry>
+ <entry><literal>NdbOperation</literal></entry>
+ </row>
+ <row>
+ <entry><literal>UniqueIndexAccess</literal></entry>
+ <entry>A read, update, or delete operation using a unique index</entry>
+ <entry><literal>NdbIndexOperation</literal></entry>
+ </row>
+ <row>
+ <entry><literal>TableScan</literal></entry>
+ <entry>A full table scan</entry>
+ <entry><literal>NdbScanOperation</literal></entry>
+ </row>
+ <row>
+ <entry><literal>OrderedIndexScan</literal></entry>
+ <entry>An ordered index scan</entry>
+ <entry><literal>NdbIndexScanOperation</literal></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
</section>
<section id="ndb-ndboperation-lockmode">
@@ -457,40 +465,43 @@
<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>LM_Read</literal></entry>
- <entry>Read with shared lock</entry>
- </row>
- <row>
- <entry><literal>LM_Exclusive</literal></entry>
- <entry>Read with exclusive lock</entry>
- </row>
- <row>
- <entry><literal>LM_CommittedRead</literal></entry>
- <entry>Ignore locks; read last committed</entry>
- </row>
- <row>
- <entry><literal>LM_SimpleRead</literal></entry>
- <entry>Read with shared lock, but release lock directly</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
+ Possible values for this type are shown, along with
+ descriptions, in the following table:
</para>
</formalpara>
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colwidth="35*"/>
+ <colspec colwidth="65*"/>
+ <thead>
+ <row>
+ <entry>Value</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><literal>LM_Read</literal></entry>
+ <entry>Read with shared lock</entry>
+ </row>
+ <row>
+ <entry><literal>LM_Exclusive</literal></entry>
+ <entry>Read with exclusive lock</entry>
+ </row>
+ <row>
+ <entry><literal>LM_CommittedRead</literal></entry>
+ <entry>Ignore locks; read last committed</entry>
+ </row>
+ <row>
+ <entry><literal>LM_SimpleRead</literal></entry>
+ <entry>Read with shared lock, but release lock directly</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
<note>
<para>
There is also support for dirty reads
@@ -589,7 +600,10 @@
<para>
There are three versions of this method, each having different
parameters:
+ </para>
+ </formalpara>
+
<programlisting>
NdbRecAttr* getValue
(
@@ -609,10 +623,7 @@
char* <replaceable>value</replaceable> = 0
)
</programlisting>
- </para>
- </formalpara>
-
<formalpara>
<title>Parameters</title>
@@ -620,40 +631,42 @@
<para>
All three forms of this method have two parameters, the second
parameter being optional (defaults to <literal>0</literal>).
- They differ with regard to the type of the first parameter,
- which can be any one of the following:
+ They differ only with regard to the type of the first
+ parameter, which can be any one of the following:
+ </para>
- <itemizedlist>
+ </formalpara>
- <listitem>
- <para>
- The attribute <replaceable>name</replaceable>
- </para>
- </listitem>
+ <itemizedlist>
- <listitem>
- <para>
- The attribute <replaceable>id</replaceable>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ The attribute <replaceable>name</replaceable>
+ </para>
+ </listitem>
- <listitem>
- <para>
- The <replaceable>column</replaceable> on which the
- attribute is defined
- </para>
- </listitem>
+ <listitem>
+ <para>
+ The attribute <replaceable>id</replaceable>
+ </para>
+ </listitem>
- </itemizedlist>
+ <listitem>
+ <para>
+ The <replaceable>column</replaceable> on which the attribute
+ is defined
+ </para>
+ </listitem>
- In all three cases, the second parameter is a character buffer
- in which a non-<literal>NULL</literal> attribute value is
- returned. In the event that the attribute is
- <literal>NULL</literal>, is it stored only in the
- <literal>NdbRecAttr</literal> object returned by this method.
- </para>
+ </itemizedlist>
- </formalpara>
+ <para>
+ In all three cases, the second parameter is a character buffer
+ in which a non-<literal>NULL</literal> attribute value is
+ returned. In the event that the attribute is
+ <literal>NULL</literal>, is it stored only in the
+ <literal>NdbRecAttr</literal> object returned by this method.
+ </para>
<para>
If no <replaceable>value</replaceable> is specified in the
@@ -723,8 +736,11 @@
(<literal>NdbOperation</literal> object),
<literal>name</literal> is the name of the column from which
to get the bit value, and <literal>trans</literal> is an
- <literal>NdbTransaction</literal> object.
+ <literal>NdbTransaction</literal> object:
+ </para>
+ </formalpara>
+
<programlisting>
Uint32 buf[];
@@ -737,22 +753,19 @@
/* bit X set */
}
</programlisting>
- </para>
- </formalpara>
-
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -851,17 +864,17 @@
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -925,17 +938,17 @@
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -993,24 +1006,24 @@
<title>Return value</title>
<para>
- An instance of <literal>Table</literal>. For more information,
- see <xref linkend="ndb-table"/>.
+ Apointer to an instance of <literal>Table</literal>. For more
+ information, see <xref linkend="ndb-table"/>.
</para>
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -1075,17 +1088,17 @@
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -1120,7 +1133,10 @@
<para>
Beginning with MySQL Cluster NDB 6.2.17 and MySQL Cluster NDB
6.3.19, this method can (and should) be used as shown here:
+ </para>
+ </formalpara>
+
<programlisting>
int getNdbErrorLine
(
@@ -1128,9 +1144,11 @@
) const
</programlisting>
- The non-<literal>const</literal> version of this method, shown
- here, was removed in MySQL Cluster NDB 6.2.19, MySQL Cluster
- NDB 6.3.28, and MySQL Cluster NDB 7.0.9. (Bug #47798)
+ <para>
+ The non-<literal>const</literal> version of this method, shown
+ here, was removed in MySQL Cluster NDB 6.2.19, MySQL Cluster NDB
+ 6.3.28, and MySQL Cluster NDB 7.0.9 (see Bug#47798):
+ </para>
<programlisting>
int getNdbErrorLine
@@ -1138,10 +1156,7 @@
void
)
</programlisting>
- </para>
- </formalpara>
-
<formalpara>
<title>Parameters</title>
@@ -1163,17 +1178,17 @@
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -1229,7 +1244,8 @@
<note>
<para>
Prior to MySQL Cluster NDB 7.1.0, this method used
- <literal>const Type</literal> as its return type. (Bug #44840)
+ <literal>const Type</literal> as its return type (see
+ Bug#44840).
</para>
</note>
@@ -1245,17 +1261,17 @@
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -1319,17 +1335,17 @@
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -1395,18 +1411,18 @@
</formalpara>
<!--
- <formalpara>
+ <formalpara>
<title>Example</title>
<para>
- <programlisting>
- [<emphasis>To be supplied...</emphasis>]
- </programlisting>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
</para>
- </formalpara>
- -->
+ </formalpara>
+-->
</section>
@@ -1540,67 +1556,67 @@
<listitem>
<para>
The first parameter can be either of the following:
+ </para>
- <itemizedlist>
+ <orderedlist>
- <listitem>
- <para>
- The <replaceable>name</replaceable> of the
- attribute (a string)
- </para>
- </listitem>
+ <listitem>
+ <para>
+ The <replaceable>name</replaceable> of the attribute
+ (a string)
+ </para>
+ </listitem>
- <listitem>
- <para>
- The <replaceable>id</replaceable> of the attribute
- (an unsigned 32-bit integer)
- </para>
- </listitem>
+ <listitem>
+ <para>
+ The <replaceable>id</replaceable> of the attribute
+ (an unsigned 32-bit integer)
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ </orderedlist>
</listitem>
<listitem>
<para>
The second parameter is the attribute
- <replaceable>value</replaceable> to be tested; it can be
- any one of the following 5 types:
+ <replaceable>value</replaceable> to be tested. This
+ value can be any one of the following 5 types:
+ </para>
- <itemizedlist>
+ <orderedlist>
- <listitem>
- <para>
- String
- </para>
- </listitem>
+ <listitem>
+ <para>
+ String
+ </para>
+ </listitem>
- <listitem>
- <para>
- 32-bit integer
- </para>
- </listitem>
+ <listitem>
+ <para>
+ 32-bit integer
+ </para>
+ </listitem>
- <listitem>
- <para>
- Unsigned 32-bit integer
- </para>
- </listitem>
+ <listitem>
+ <para>
+ Unsigned 32-bit integer
+ </para>
+ </listitem>
- <listitem>
- <para>
- 64-bit integer
- </para>
- </listitem>
+ <listitem>
+ <para>
+ 64-bit integer
+ </para>
+ </listitem>
- <listitem>
- <para>
- Unsigned 64-bit integer
- </para>
- </listitem>
+ <listitem>
+ <para>
+ Unsigned 64-bit integer
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ </orderedlist>
</listitem>
</itemizedlist>
@@ -1619,17 +1635,17 @@
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -1656,49 +1672,44 @@
</formalpara>
- <important>
- <para>
- There are a number of
- <literal>NdbOperation::setValue()</literal> methods that take
- a certain type as input (pass by value rather than passing a
- pointer). It is the responsibility of the application
- programmer to use the correct types.
- </para>
+ <para>
+ There are a number of
+ <literal>NdbOperation::setValue()</literal> methods that take a
+ certain type as input (pass by value rather than passing a
+ pointer). It is the responsibility of the application programmer
+ to use the correct types.
+ </para>
- <para>
- However, the NDB API does check that the application sends a
- correct length to the interface as given in the length
- parameter. A <literal>char*</literal> value can contain any
- data type or any type of array. If the length is not provided,
- or if it is set to zero, then the API assumes that the pointer
- is correct, and does not check it.
- </para>
- </important>
+ <para>
+ However, the NDB API does check that the application sends a
+ correct length to the interface as given in the length
+ parameter. A <literal>char*</literal> value can contain any data
+ type or any type of array. If the length is not provided, or if
+ it is set to zero, then the API assumes that the pointer is
+ correct, and does not check it.
+ </para>
- <tip>
- <para>
- To set a <literal>NULL</literal> value, use the following
- construct:
+ <para>
+ To set a <literal>NULL</literal> value, use the following
+ construct:
+ </para>
<programlisting>
setValue("ATTR_NAME", (char*)NULL);
</programlisting>
- </para>
- </tip>
- <note>
- <para>
- When you use <literal>insertTuple()</literal>, the NDB API
- will automatically detect that it is supposed to use
- <literal>equal()</literal> instead.
- </para>
+ <para>
+ When you use <literal>insertTuple()</literal>, the NDB API
+ automatically detects that it is supposed to use
+ <literal>equal()</literal> instead.
+ </para>
- <para>
- In addition, it is not necessary when using insertTuple() to
- use <literal>setValue()</literal> on key attributes before
- other attributes.
- </para>
- </note>
+ <para>
+ In addition, it is not necessary when using
+ <literal>insertTuple()</literal> to use
+ <literal>setValue()</literal> on key attributes before other
+ attributes.
+ </para>
<formalpara>
@@ -1708,8 +1719,11 @@
There are 14 versions of
<literal>NdbOperation::setValue()</literal>, each with
slightly different parameters, as listed here (and summarised
- in the <emphasis>Parameters</emphasis> section following):
+ in the <citetitle>Parameters</citetitle> section following):
+ </para>
+ </formalpara>
+
<programlisting>
int setValue
(
@@ -1795,107 +1809,104 @@
double <replaceable>value</replaceable>
)
</programlisting>
- </para>
- </formalpara>
-
<formalpara>
<title>Parameters</title>
<para>
- This method requires two parameters:
+ This method requires the following two parameters:
+ </para>
- <itemizedlist>
+ </formalpara>
- <listitem>
- <para>
- The first parameter identified the attribute to be set,
- and may be either one of:
+ <itemizedlist>
- <itemizedlist>
+ <listitem>
+ <para>
+ The first parameter identified the attribute to be set, and
+ may be either one of the following:
+ </para>
- <listitem>
- <para>
- The attribute <replaceable>name</replaceable> (a
- string)
- </para>
- </listitem>
+ <orderedlist>
- <listitem>
- <para>
- The attribute <replaceable>id</replaceable> (an
- unsigned 32-bit integer)
- </para>
- </listitem>
-
- </itemizedlist>
+ <listitem>
+ <para>
+ The attribute <replaceable>name</replaceable> (a string)
</para>
</listitem>
<listitem>
<para>
- The second parameter is the
- <replaceable>value</replaceable> to which the attribute
- is to be set; its type may be any one of the following 7
- types:
+ The attribute <replaceable>id</replaceable> (an unsigned
+ 32-bit integer)
+ </para>
+ </listitem>
- <itemizedlist>
+ </orderedlist>
+ </listitem>
- <listitem>
- <para>
- String (<literal>const char*</literal>)
- </para>
- </listitem>
+ <listitem>
+ <para>
+ The second parameter is the <replaceable>value</replaceable>
+ to which the attribute is to be set; its type may be any one
+ of the following 7 types:
+ </para>
- <listitem>
- <para>
- 32-bit integer
- </para>
- </listitem>
+ <orderedlist>
- <listitem>
- <para>
- Unsigned 32-bit integer
- </para>
- </listitem>
+ <listitem>
+ <para>
+ String (<literal>const char*</literal>)
+ </para>
+ </listitem>
- <listitem>
- <para>
- 64-bit integer
- </para>
- </listitem>
+ <listitem>
+ <para>
+ 32-bit integer
+ </para>
+ </listitem>
- <listitem>
- <para>
- Unsigned 64-bit integer
- </para>
- </listitem>
+ <listitem>
+ <para>
+ Unsigned 32-bit integer
+ </para>
+ </listitem>
- <listitem>
- <para>
- Double
- </para>
- </listitem>
+ <listitem>
+ <para>
+ 64-bit integer
+ </para>
+ </listitem>
- <listitem>
- <para>
- Float
- </para>
- </listitem>
+ <listitem>
+ <para>
+ Unsigned 64-bit integer
+ </para>
+ </listitem>
- </itemizedlist>
+ <listitem>
+ <para>
+ Double
</para>
</listitem>
- </itemizedlist>
+ <listitem>
+ <para>
+ Float
+ </para>
+ </listitem>
- See <xref linkend="ndb-ndboperation-equal"/>, for important
- information regarding the value's format and length.
- </para>
+ </orderedlist>
+ </listitem>
- </formalpara>
+ </itemizedlist>
+ <para>
+ See <xref linkend="ndb-ndboperation-equal"/>, for important
+ information regarding the value's format and length.
+ </para>
+
<formalpara>
<title>Return value</title>
@@ -1907,17 +1918,17 @@
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -1978,24 +1989,24 @@
<title>Return value</title>
<para>
- <literal>0</literal> on success, <literal>-1</literal> on
- failure.
+ Returns <literal>0</literal> on success, <literal>-1</literal>
+ on failure.
</para>
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -2017,7 +2028,7 @@
<title>Description</title>
<para>
- This method define the <literal>NdbOperation</literal> as a
+ This method defines the <literal>NdbOperation</literal> as a
<literal>READ</literal> operation. When the
<literal>NdbTransaction::execute()</literal> method is
invoked, the operation reads a tuple. See
@@ -2059,24 +2070,24 @@
<title>Return value</title>
<para>
- <literal>0</literal> on success, <literal>-1</literal> on
- failure.
+ Returns <literal>0</literal> on success, <literal>-1</literal>
+ on failure.
</para>
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -2138,24 +2149,24 @@
<title>Return value</title>
<para>
- <literal>0</literal> on success, <literal>-1</literal> on
- failure.
+ Returns <literal>0</literal> on success, <literal>-1</literal>
+ on failure.
</para>
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -2216,24 +2227,24 @@
<title>Return value</title>
<para>
- <literal>0</literal> on success, <literal>-1</literal> on
- failure.
+ Returns <literal>0</literal> on success, <literal>-1</literal>
+ on failure.
</para>
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -2294,24 +2305,24 @@
<title>Return value</title>
<para>
- <literal>0</literal> on success, <literal>-1</literal> on
- failure.
+ Returns <literal>0</literal> on success, <literal>-1</literal>
+ on failure.
</para>
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
Modified: trunk/ndbapi/ndb-ndbrecattr.xml
===================================================================
--- trunk/ndbapi/ndb-ndbrecattr.xml 2010-10-06 15:15:42 UTC (rev 23010)
+++ trunk/ndbapi/ndb-ndbrecattr.xml 2010-10-06 15:32:07 UTC (rev 23011)
Changed blocks: 23, Lines Added: 137, Lines Deleted: 133; 10901 bytes
@@ -51,7 +51,10 @@
<literal>NDB</literal> Cluster using the
<literal>NdbOperation::getValue()</literal>. This object is
allocated by the NDB API. A brief example is shown here:
+ </para>
+ </formalpara>
+
<programlisting>
MyRecAttr = MyOperation->getValue("ATTR2", NULL);
@@ -64,16 +67,15 @@
ndbout << MyRecAttr->u_32_value();
</programlisting>
- For more examples, see
- <xref linkend="ndb-examples-synchronous-transactions"/>.
- </para>
+ <para>
+ For additional examples, see
+ <xref linkend="ndb-examples-synchronous-transactions"/>.
+ </para>
- </formalpara>
-
<note>
<para>
An <literal>NdbRecAttr</literal> object is instantiated with its
- value when <literal>NdbTransaction::execute()</literal> is
+ value only when <literal>NdbTransaction::execute()</literal> is
invoked. Prior to this, the value is undefined. (Use
<literal>NdbRecAttr::isNULL()</literal> to check whether the value
is defined.) This means that an <literal>NdbRecAttr</literal>
@@ -247,20 +249,20 @@
<para>
This diagram shows all the available methods of the
<literal>NdbRecAttr</literal> class:
-
- <mediaobject>
- <imageobject>
- <imagedata contentwidth="218" contentdepth="292" fileref="images/published/NdbRecAttr-class.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase lang="en">Public methods of the
- <literal>NdbRecAttr</literal> class.</phrase>
- </textobject>
- </mediaobject>
</para>
</formalpara>
+ <mediaobject>
+ <imageobject>
+ <imagedata contentwidth="218" contentdepth="292" fileref="images/published/NdbRecAttr-class.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Public methods of the
+ <literal>NdbRecAttr</literal> class.</phrase>
+ </textobject>
+ </mediaobject>
+
<section id="ndb-ndbrecattr-methods">
<title><literal>NdbRecAttr</literal> Methods</title>
@@ -348,17 +350,17 @@
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -423,17 +425,17 @@
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -497,17 +499,17 @@
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -565,57 +567,56 @@
<title>Return value</title>
<para>
- One of the following 3 values:
+ One of the following three values:
+ </para>
- <itemizedlist>
+ </formalpara>
- <listitem>
- <para>
- <literal>-1</literal>: The attribute value is not
- defined due to an error.
- </para>
- </listitem>
+ <itemizedlist>
- <listitem>
- <para>
- <literal>0</literal>: The attribute value is defined,
- but is not <literal>NULL</literal>.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>-1</literal>: The attribute value is not defined
+ due to an error.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>1</literal>: The attribute value is defined and
- is <literal>NULL</literal>.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>0</literal>: The attribute value is defined, but is
+ not <literal>NULL</literal>.
+ </para>
+ </listitem>
- </itemizedlist>
+ <listitem>
+ <para>
+ <literal>1</literal>: The attribute value is defined and is
+ <literal>NULL</literal>.
+ </para>
+ </listitem>
- <important>
- <para>
- In the event that
- <literal>NdbTransaction::execute()</literal> has not yet
- been called, the value returned by
- <literal>isNull()</literal> is not determined.
- </para>
- </important>
+ </itemizedlist>
+
+ <important>
+ <para>
+ In the event that <literal>NdbTransaction::execute()</literal>
+ has not yet been called, the value returned by
+ <literal>isNull()</literal> is not determined.
</para>
+ </important>
- </formalpara>
-
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -680,17 +681,17 @@
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -755,17 +756,17 @@
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -905,17 +906,17 @@
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -980,17 +981,17 @@
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -1130,17 +1131,17 @@
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -1205,17 +1206,17 @@
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -1279,6 +1280,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -1290,6 +1292,7 @@
</para>
</formalpara>
+-->
</section>
@@ -1353,17 +1356,17 @@
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -1428,17 +1431,17 @@
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -1578,17 +1581,17 @@
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -1653,17 +1656,17 @@
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -1717,7 +1720,8 @@
<para>
A pointer to the attribute value. Because this pointer is
constant, this method can be called anytime after
- <literal>NdbOperation::getValue()</literal> has been called.
+ <link linkend="ndb-ndboperation-getvalue"><literal>NdbOperation::getValue()</literal></link>
+ has been called.
</para>
</formalpara>
@@ -1733,17 +1737,17 @@
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -1815,17 +1819,17 @@
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -1889,17 +1893,17 @@
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
Modified: trunk/ndbapi/ndb-ndbrecord.xml
===================================================================
--- trunk/ndbapi/ndb-ndbrecord.xml 2010-10-06 15:15:42 UTC (rev 23010)
+++ trunk/ndbapi/ndb-ndbrecord.xml 2010-10-06 15:32:07 UTC (rev 23011)
Changed blocks: 2, Lines Added: 117, Lines Deleted: 110; 8623 bytes
@@ -19,36 +19,39 @@
<para>
<literal>NdbRecord</literal> has no API methods of its own; rather
it acts as a handle that can be passed between various method calls
- for use in many different sorts of operations, including these:
+ for use in many different sorts of operations, including the
+ following operation types:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- Unique key reads and primary key reads
- </para>
- </listitem>
+ <listitem>
+ <para>
+ Unique key reads and primary key reads
+ </para>
+ </listitem>
- <listitem>
- <para>
- Table scans and index scans
- </para>
- </listitem>
+ <listitem>
+ <para>
+ Table scans and index scans
+ </para>
+ </listitem>
- <listitem>
- <para>
- DML operations involving unique keys or primary keys
- </para>
- </listitem>
+ <listitem>
+ <para>
+ DML operations involving unique keys or primary keys
+ </para>
+ </listitem>
- <listitem>
- <para>
- Operations involving index bounds
- </para>
- </listitem>
+ <listitem>
+ <para>
+ Operations involving index bounds
+ </para>
+ </listitem>
- </itemizedlist>
+ </itemizedlist>
+ <para>
The same <literal>NdbRecord</literal> can be used simultaneously in
multiple operations, transactions, and threads.
</para>
@@ -60,120 +63,124 @@
API methods have additional declarations in MySQL Cluster NDB 6.2.3
and later MySQL Cluster releases that enable the programmer to
leverage <literal>NdbRecord</literal>:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <literal><link linkend="ndb-ndbscanoperation-nextresult">NdbScanOperation::nextResult()</link></literal>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal><link linkend="ndb-ndbscanoperation-nextresult">NdbScanOperation::nextResult()</link></literal>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal><link linkend="ndb-ndbscanoperation-lockcurrenttuple">NdbScanOperation::lockCurrentTuple()</link></literal>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal><link linkend="ndb-ndbscanoperation-lockcurrenttuple">NdbScanOperation::lockCurrentTuple()</link></literal>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal><link linkend="ndb-ndbscanoperation-updatecurrenttuple">NdbScanOperation::updateCurrentTuple()</link></literal>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal><link linkend="ndb-ndbscanoperation-updatecurrenttuple">NdbScanOperation::updateCurrentTuple()</link></literal>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal><link linkend="ndb-ndbscanoperation-deletecurrenttuple">NdbScanOperation::deleteCurrentTuple()</link></literal>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal><link linkend="ndb-ndbscanoperation-deletecurrenttuple">NdbScanOperation::deleteCurrentTuple()</link></literal>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal><link linkend="ndb-dictionary-createrecord">Dictionary::createRecord()</link></literal>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal><link linkend="ndb-dictionary-createrecord">Dictionary::createRecord()</link></literal>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal><link linkend="ndb-dictionary-releaserecord">Dictionary::releaseRecord()</link></literal>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal><link linkend="ndb-dictionary-releaserecord">Dictionary::releaseRecord()</link></literal>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal><link linkend="ndb-ndbtransaction-readtuple">NdbTransaction::readTuple()</link></literal>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal><link linkend="ndb-ndbtransaction-readtuple">NdbTransaction::readTuple()</link></literal>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal><link linkend="ndb-ndbtransaction-inserttuple">NdbTransaction::insertTuple()</link></literal>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal><link linkend="ndb-ndbtransaction-inserttuple">NdbTransaction::insertTuple()</link></literal>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal><link linkend="ndb-ndbtransaction-updatetuple">NdbTransaction::updateTuple()</link></literal>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal><link linkend="ndb-ndbtransaction-updatetuple">NdbTransaction::updateTuple()</link></literal>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal><link linkend="ndb-ndbtransaction-writetuple">NdbTransaction::writeTuple()</link></literal>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal><link linkend="ndb-ndbtransaction-writetuple">NdbTransaction::writeTuple()</link></literal>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal><link linkend="ndb-ndbtransaction-deletetuple">NdbTransaction::deleteTuple()</link></literal>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal><link linkend="ndb-ndbtransaction-deletetuple">NdbTransaction::deleteTuple()</link></literal>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal><link linkend="ndb-ndbtransaction-scantable">NdbTransaction::scanTable()</link></literal>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal><link linkend="ndb-ndbtransaction-scantable">NdbTransaction::scanTable()</link></literal>
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal><link linkend="ndb-ndbtransaction-scanindex">NdbTransaction::scanIndex()</link></literal>
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal><link linkend="ndb-ndbtransaction-scanindex">NdbTransaction::scanIndex()</link></literal>
+ </para>
+ </listitem>
- </itemizedlist>
+ </itemizedlist>
+ <para>
In addition, new members of <literal>NdbIndexScanOperation</literal>
and <literal>NdbDictionary</literal> are introduced in MySQL Cluster
NDB 6.2.3 for use with <literal>NdbRecord</literal> scans:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- <literal>NdbIndexScanOperation::IndexBound</literal> is a
- structure used to describe index scan bounds. See
- <xref linkend="ndb-indexbound"/>.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>NdbIndexScanOperation::IndexBound</literal> is a
+ structure used to describe index scan bounds. See
+ <xref linkend="ndb-indexbound"/>.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <literal>NdbDictionary::RecordSpecification</literal> is a
- structure used to specify columns and range offsets. See
- <xref linkend="ndb-recordspecification"/>.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>NdbDictionary::RecordSpecification</literal> is a
+ structure used to specify columns and range offsets. See
+ <xref linkend="ndb-recordspecification"/>.
+ </para>
+ </listitem>
- </itemizedlist>
+ </itemizedlist>
+ <para>
Beginning with MySQL Cluster NDB 6.3.24 and MySQL Cluster NDB 7.0.4,
you can also use <literal>NdbRecord</literal> in conjunction with
the new <literal>Ndb::PartitionSpec</literal> structure to perform
- scans that take advantage of partition pruning, by means of a new
- variant of <literal>NdbIndexScanOperation::setBound()</literal>. For
- more information, see
- <xref linkend="ndb-ndbindexscanoperation-setbound"/>, and
+ scans that take advantage of partition pruning, by means of a
+ variant of <literal>NdbIndexScanOperation::setBound()</literal> that
+ was added in the same MySQL Cluster releases. For more information,
+ see <xref linkend="ndb-ndbindexscanoperation-setbound"/>, and
<xref linkend="ndb-partitionspec"/>.
</para>
Modified: trunk/ndbapi/ndb-ndbscanfilter.xml
===================================================================
--- trunk/ndbapi/ndb-ndbscanfilter.xml 2010-10-06 15:15:42 UTC (rev 23010)
+++ trunk/ndbapi/ndb-ndbscanfilter.xml 2010-10-06 15:32:07 UTC (rev 23011)
Changed blocks: 28, Lines Added: 479, Lines Deleted: 476; 42281 bytes
@@ -170,30 +170,30 @@
<para>
The <literal>NdbScanFilter</literal> class defines two public
types:
+ </para>
- <itemizedlist>
+ </formalpara>
- <listitem>
- <para>
- <literal>BinaryCondition</literal>: The type of condition,
- such as lower bound or upper bound.
- </para>
- </listitem>
+ <itemizedlist>
- <listitem>
- <para>
- <literal>Group</literal>: A logical grouping operator, such
- as <literal>AND</literal> or <literal>OR</literal>.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>BinaryCondition</literal>: The type of condition, such
+ as lower bound or upper bound.
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ <listitem>
+ <para>
+ <literal>Group</literal>: A logical grouping operator, such as
+ <literal>AND</literal> or <literal>OR</literal>.
+ </para>
+ </listitem>
- </formalpara>
+ </itemizedlist>
<para>
- For a discussion of each of these types, along with its possible
+ For discussions of each of these types, along with its possible
values, see <xref linkend="ndb-ndbscanfilter-types"/>.
</para>
@@ -204,20 +204,20 @@
<para>
This diagram shows all the public members of the
<literal>NdbScanFilter</literal> class:
-
- <mediaobject>
- <imageobject>
- <imagedata contentwidth="390" contentdepth="636" fileref="images/published/NdbScanFilter-class.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase lang="en">Public members of the
- <literal>NdbScanFilter</literal> class.</phrase>
- </textobject>
- </mediaobject>
</para>
</formalpara>
+ <mediaobject>
+ <imageobject>
+ <imagedata contentwidth="390" contentdepth="636" fileref="images/published/NdbScanFilter-class.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Public members of the
+ <literal>NdbScanFilter</literal> class.</phrase>
+ </textobject>
+ </mediaobject>
+
<section id="ndb-ndbscanfilter-types">
<title><literal>NdbScanFilter</literal> Types</title>
@@ -261,88 +261,91 @@
<title>Enumeration values</title>
<para>
- <informaltable>
- <tgroup cols="3">
- <colspec colwidth="35*"/>
- <colspec colwidth="35*"/>
- <colspec colwidth="30*"/>
- <thead>
- <row>
- <entry>Enumeration value</entry>
- <entry>Description</entry>
- <entry>Type of column values compared</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><literal>COND_LE</literal></entry>
- <entry>Lower bound (<literal><=</literal>)</entry>
- <entry>integer</entry>
- </row>
- <row>
- <entry><literal>COND_LT</literal></entry>
- <entry>Strict lower bound (<literal><</literal>)</entry>
- <entry>integer</entry>
- </row>
- <row>
- <entry><literal>COND_GE</literal></entry>
- <entry>Upper bound (<literal>>=</literal>)</entry>
- <entry>integer</entry>
- </row>
- <row>
- <entry><literal>COND_GT</literal></entry>
- <entry>Strict upper bound (>)</entry>
- <entry>integer</entry>
- </row>
- <row>
- <entry><literal>COND_EQ</literal></entry>
- <entry>Equality (<literal>=</literal>)</entry>
- <entry>integer</entry>
- </row>
- <row>
- <entry><literal>COND_NE</literal></entry>
- <entry>Inequality (<literal><></literal> or <literal>!=</literal>)</entry>
- <entry>integer</entry>
- </row>
- <row>
- <entry><literal>COND_LIKE</literal></entry>
- <entry><literal>LIKE</literal> condition</entry>
- <entry>string</entry>
- </row>
- <row>
- <entry><literal>COND_NOTLIKE</literal></entry>
- <entry><literal>NOT LIKE</literal> condition</entry>
- <entry>string</entry>
- </row>
- <row>
- <entry><literal>COL_AND_MASK_EQ_MASK</literal></entry>
- <entry>Column value is equal to column value <literal>AND</literal>ed with
- bitmask</entry>
- <entry><literal>BIT</literal></entry>
- </row>
- <row>
- <entry><literal>COL_AND_MASK_NE_MASK</literal></entry>
- <entry>Column value is not equal to column value <literal>AND</literal>ed with
- bitmask</entry>
- <entry><literal>BIT</literal></entry>
- </row>
- <row>
- <entry><literal>COL_AND_MASK_EQ_ZERO</literal></entry>
- <entry>Column value <literal>AND</literal>ed with bitmask is equal to zero</entry>
- <entry><literal>BIT</literal></entry>
- </row>
- <row>
- <entry><literal>COL_AND_MASK_NE_ZERO</literal></entry>
- <entry>Column value <literal>AND</literal>ed with bitmask is not equal to zero</entry>
- <entry><literal>BIT</literal></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
+ Possible values are shown, along with descriptions, in the
+ following table:
</para>
</formalpara>
+ <informaltable>
+ <tgroup cols="3">
+ <colspec colwidth="35*"/>
+ <colspec colwidth="35*"/>
+ <colspec colwidth="30*"/>
+ <thead>
+ <row>
+ <entry>Enumeration value</entry>
+ <entry>Description</entry>
+ <entry>Type of column values compared</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><literal>COND_LE</literal></entry>
+ <entry>Lower bound (<literal><=</literal>)</entry>
+ <entry>integer</entry>
+ </row>
+ <row>
+ <entry><literal>COND_LT</literal></entry>
+ <entry>Strict lower bound (<literal><</literal>)</entry>
+ <entry>integer</entry>
+ </row>
+ <row>
+ <entry><literal>COND_GE</literal></entry>
+ <entry>Upper bound (<literal>>=</literal>)</entry>
+ <entry>integer</entry>
+ </row>
+ <row>
+ <entry><literal>COND_GT</literal></entry>
+ <entry>Strict upper bound (>)</entry>
+ <entry>integer</entry>
+ </row>
+ <row>
+ <entry><literal>COND_EQ</literal></entry>
+ <entry>Equality (<literal>=</literal>)</entry>
+ <entry>integer</entry>
+ </row>
+ <row>
+ <entry><literal>COND_NE</literal></entry>
+ <entry>Inequality (<literal><></literal> or <literal>!=</literal>)</entry>
+ <entry>integer</entry>
+ </row>
+ <row>
+ <entry><literal>COND_LIKE</literal></entry>
+ <entry><literal>LIKE</literal> condition</entry>
+ <entry>string</entry>
+ </row>
+ <row>
+ <entry><literal>COND_NOTLIKE</literal></entry>
+ <entry><literal>NOT LIKE</literal> condition</entry>
+ <entry>string</entry>
+ </row>
+ <row>
+ <entry><literal>COL_AND_MASK_EQ_MASK</literal></entry>
+ <entry>Column value is equal to column value <literal>AND</literal>ed with
+ bitmask</entry>
+ <entry><literal>BIT</literal></entry>
+ </row>
+ <row>
+ <entry><literal>COL_AND_MASK_NE_MASK</literal></entry>
+ <entry>Column value is not equal to column value <literal>AND</literal>ed with
+ bitmask</entry>
+ <entry><literal>BIT</literal></entry>
+ </row>
+ <row>
+ <entry><literal>COL_AND_MASK_EQ_ZERO</literal></entry>
+ <entry>Column value <literal>AND</literal>ed with bitmask is equal to zero</entry>
+ <entry><literal>BIT</literal></entry>
+ </row>
+ <row>
+ <entry><literal>COL_AND_MASK_NE_ZERO</literal></entry>
+ <entry>Column value <literal>AND</literal>ed with bitmask is not equal to zero</entry>
+ <entry><literal>BIT</literal></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
<formalpara>
<title>String comparisons</title>
@@ -407,50 +410,53 @@
<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>AND</literal></entry>
- <entry>Logical <literal>AND</literal>: <literal><replaceable>A</replaceable>
- AND <replaceable>B</replaceable> AND
- <replaceable>C</replaceable></literal></entry>
- </row>
- <row>
- <entry><literal>OR</literal></entry>
- <entry>Logical <literal>OR</literal>: <literal><replaceable>A</replaceable> OR
- <replaceable>B</replaceable> OR
- <replaceable>C</replaceable></literal></entry>
- </row>
- <row>
- <entry><literal>NAND</literal></entry>
- <entry>Logical <literal>NOT AND</literal>: <literal>NOT
- (<replaceable>A</replaceable> AND
- <replaceable>B</replaceable> AND
- <replaceable>C</replaceable>)</literal></entry>
- </row>
- <row>
- <entry><literal>NOR</literal></entry>
- <entry>Logical <literal>NOT OR</literal>: <literal>NOT
- (<replaceable>A</replaceable> OR
- <replaceable>B</replaceable> OR
- <replaceable>C</replaceable>)</literal></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
+ Possible values are shown, along with descriptions, in the
+ following table:
</para>
</formalpara>
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colwidth="35*"/>
+ <colspec colwidth="65*"/>
+ <thead>
+ <row>
+ <entry>Value</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><literal>AND</literal></entry>
+ <entry>Logical <literal>AND</literal>: <literal><replaceable>A</replaceable>
+ AND <replaceable>B</replaceable> AND
+ <replaceable>C</replaceable></literal></entry>
+ </row>
+ <row>
+ <entry><literal>OR</literal></entry>
+ <entry>Logical <literal>OR</literal>: <literal><replaceable>A</replaceable> OR
+ <replaceable>B</replaceable> OR
+ <replaceable>C</replaceable></literal></entry>
+ </row>
+ <row>
+ <entry><literal>NAND</literal></entry>
+ <entry>Logical <literal>NOT AND</literal>: <literal>NOT
+ (<replaceable>A</replaceable> AND
+ <replaceable>B</replaceable> AND
+ <replaceable>C</replaceable>)</literal></entry>
+ </row>
+ <row>
+ <entry><literal>NOR</literal></entry>
+ <entry>Logical <literal>NOT OR</literal>: <literal>NOT
+ (<replaceable>A</replaceable> OR
+ <replaceable>B</replaceable> OR
+ <replaceable>C</replaceable>)</literal></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
</section>
</section>
@@ -504,7 +510,7 @@
<title>Parameters</title>
<para>
- This method takes a single parameter: a pointer to the
+ This method takes a single parameter, a pointer to the
<literal>NdbOperation</literal> to which the filter applies.
</para>
@@ -534,17 +540,17 @@
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -614,17 +620,17 @@
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -682,24 +688,24 @@
<title>Return value</title>
<para>
- <literal>0</literal> on success, <literal>-1</literal> on
- failure.
+ Returns <literal>0</literal> on success, or
+ <literal>-1</literal> on failure.
</para>
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -757,8 +763,8 @@
<title>Return value</title>
<para>
- <literal>0</literal> on success, <literal>-1</literal> on
- failure.
+ Returns <literal>0</literal> on success, <literal>-1</literal>
+ on failure.
</para>
</formalpara>
@@ -832,7 +838,7 @@
<title>Return value</title>
<para>
- <literal>0</literal> on success, <literal>-1</literal> on
+ <literal>0</literal> on success, or <literal>-1</literal> on
failure.
</para>
@@ -873,20 +879,20 @@
<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="ndb-ndbscanfilter-integer-comparison-methods"/>.
- </para>
- </note>
</para>
</formalpara>
+ <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="ndb-ndbscanfilter-integer-comparison-methods"/>.
+ </para>
+ </note>
+
<formalpara>
<title>Signature</title>
@@ -911,150 +917,149 @@
<para>
This method takes the following parameters:
+ </para>
- <itemizedlist>
+ </formalpara>
- <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="ndb-ndbscanfilter-binarycondition"/>.
- </para>
+ <itemizedlist>
- <para>
- The <replaceable>condition</replaceable> values
- <literal>COND_LIKE</literal> or
- <literal>COND_NOTLIKE</literal> are used to compare a
- column value with a string pattern.
- </para>
- </listitem>
+ <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="ndb-ndbscanfilter-binarycondition"/>.
+ </para>
- <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="ndb-column-getcolumnno"/>, for details).
- </para>
- </listitem>
+ <para>
+ The <replaceable>condition</replaceable> values
+ <literal>COND_LIKE</literal> or
+ <literal>COND_NOTLIKE</literal> are used to compare a column
+ value with a string pattern.
+ </para>
+ </listitem>
- <listitem>
- <para>
- <replaceable>value</replaceable>: The value to be
- compared, repesented as a pointer to
- <literal>void</literal>.
- </para>
+ <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="ndb-column-getcolumnno"/>, for details).
+ </para>
+ </listitem>
- <para>
- Using using a <literal>COND_LIKE</literal> or
- <literal>COND_NOTLIKE</literal> comparison condition,
- the <replaceable>value</replaceable> is treated as a
- string pattern which can include the pattern
- metacharacters or <quote>wildcard</quote> characters
- <literal>%</literal> and <literal>_</literal>, which
- have the meanings shown here:
+ <listitem>
+ <para>
+ <replaceable>value</replaceable>: The value to be compared,
+ repesented as a pointer to <literal>void</literal>.
+ </para>
- <informaltable>
- <tgroup cols="2">
- <colspec colwidth="20*"/>
- <colspec colwidth="80*"/>
- <tbody>
- <row>
- <entry><emphasis role="bold">Metacharacter</emphasis></entry>
- <entry><emphasis role="bold">Description</emphasis></entry>
- </row>
- <row>
- <entry><literal>%</literal></entry>
- <entry>Matches zero or more characters</entry>
- </row>
- <row>
- <entry><literal>_</literal></entry>
- <entry>Matches exactly one character</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
+ <para>
+ Using using a <literal>COND_LIKE</literal> or
+ <literal>COND_NOTLIKE</literal> comparison condition, the
+ <replaceable>value</replaceable> is treated as a string
+ pattern which can include the pattern metacharacters or
+ <quote>wildcard</quote> characters <literal>%</literal> and
+ <literal>_</literal>, which have the meanings shown here:
+ </para>
- To match against a literal <quote>%</quote> or
- <quote>_</quote> character, use the backslash
- (<literal>\</literal>) as an escape character. To match
- a literal <quote>\</quote> character, use
- <literal>\\</literal>.
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colwidth="20*"/>
+ <colspec colwidth="80*"/>
+ <tbody>
+ <row>
+ <entry><emphasis role="bold">Metacharacter</emphasis></entry>
+ <entry><emphasis role="bold">Description</emphasis></entry>
+ </row>
+ <row>
+ <entry><literal>%</literal></entry>
+ <entry>Matches zero or more characters</entry>
+ </row>
+ <row>
+ <entry><literal>_</literal></entry>
+ <entry>Matches exactly one character</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
- <note>
- <para>
- These are the same wildcard characters that are
- supported by the SQL <literal>LIKE</literal> and
- <literal>NOT LIKE</literal> operators, and are
- interpreted in the same way. See
- <xref linkend="string-comparison-functions"/>, for
- more information.
- </para>
- </note>
- </para>
- </listitem>
+ <para>
+ To match against a literal <quote>%</quote> or
+ <quote>_</quote> character, use the backslash
+ (<literal>\</literal>) as an escape character. To match a
+ literal <quote>\</quote> character, use
+ <literal>\\</literal>.
+ </para>
- <listitem>
- <para>
- <replaceable>length</replaceable>: The length of the
- value to be compared. The default value is
- <literal>0</literal>. Using <literal>0</literal> for the
- <replaceable>length</replaceable> has the same effect as
- comparing to <literal>NULL</literal>, that is using the
- <literal>isnull()</literal> method (see
- <xref linkend="ndb-ndbscanfilter-isnull"/>).
- </para>
- </listitem>
+ <note>
+ <para>
+ These are the same wildcard characters that are supported
+ by the SQL <literal>LIKE</literal> and <literal>NOT
+ LIKE</literal> operators, and are interpreted in the same
+ way. See <xref linkend="string-comparison-functions"/>,
+ for more information.
+ </para>
+ </note>
+ </listitem>
- </itemizedlist>
- </para>
+ <listitem>
+ <para>
+ <replaceable>length</replaceable>: The length of the value
+ to be compared. The default value is <literal>0</literal>.
+ Using <literal>0</literal> for the
+ <replaceable>length</replaceable> has the same effect as
+ comparing to <literal>NULL</literal>, that is using the
+ <literal>isnull()</literal> method (see
+ <xref linkend="ndb-ndbscanfilter-isnull"/>).
+ </para>
+ </listitem>
- </formalpara>
+ </itemizedlist>
<formalpara>
<title>Return value</title>
<para>
- This method returns an integer whose value can be interpreted
- as shown here:
+ This method returns an integer whose possible values are
+ listed here:
+ </para>
- <itemizedlist>
+ </formalpara>
- <listitem>
- <para>
- <literal>0</literal>: The comparison is true.
- </para>
- </listitem>
+ <itemizedlist>
- <listitem>
- <para>
- <literal>-1</literal>: The comparison is false.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>0</literal>: The comparison is true.
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ <listitem>
+ <para>
+ <literal>-1</literal>: The comparison is false.
+ </para>
+ </listitem>
- </formalpara>
+ </itemizedlist>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -1082,6 +1087,7 @@
<literal>BinaryCondition</literal> for that method's
<replaceable>condition</replaceable> parameter; for example,
<literal>NdbScanFilter::eq()</literal> is defined like this:
+ </para>
<programlisting>
int eq(int <replaceable>columnId</replaceable>, Uint32 <replaceable>value</replaceable>)
@@ -1090,6 +1096,7 @@
}
</programlisting>
+ <para>
For more information about the <literal>cmp()</literal> method,
see <xref linkend="ndb-ndbscanfilter-cmp"/>.
</para>
@@ -1148,53 +1155,53 @@
<title>Parameters</title>
<para>
- This method takes two parameters:
+ This method takes two parameters, listed here:
+ </para>
- <itemizedlist>
+ </formalpara>
- <listitem>
- <para>
- The ID (<replaceable>ColId</replaceable>) of the
- column whose value is to be tested
- </para>
- </listitem>
+ <itemizedlist>
- <listitem>
- <para>
- An integer with which to compare the column value;
- this integer may be either 32-bit or 64-bit, and is
- unsigned in either case.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ The ID (<replaceable>ColId</replaceable>) of the column
+ whose value is to be tested
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ <listitem>
+ <para>
+ An integer with which to compare the column value; this
+ integer may be either 32-bit or 64-bit, and is unsigned in
+ either case.
+ </para>
+ </listitem>
- </formalpara>
+ </itemizedlist>
<formalpara>
<title>Return value</title>
<para>
- <literal>0</literal> on success, <literal>-1</literal> on
- failure.
+ Returns <literal>0</literal> on success, or
+ <literal>-1</literal> on failure.
</para>
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -1227,27 +1234,25 @@
<title>Signature</title>
<para>
+ This method has 32-bit and 64-bit variants, as shown here:
+ </para>
+
+ </formalpara>
+
<programlisting>
int ne
(
int <replaceable>ColId</replaceable>,
Uint32 <replaceable>value</replaceable>
)
-</programlisting>
- or
-
-<programlisting>
int ne
(
int <replaceable>ColId</replaceable>,
Uint64 <replaceable>value</replaceable>
)
</programlisting>
- </para>
- </formalpara>
-
<formalpara>
<title>Parameters</title>
@@ -1256,52 +1261,52 @@
Like <literal>eq()</literal> and the other
<literal>NdbScanFilter</literal> methods of this type, this
method takes two parameters:
+ </para>
- <itemizedlist>
+ </formalpara>
- <listitem>
- <para>
- The ID (<replaceable>ColId</replaceable>) of the
- column whose value is to be tested
- </para>
- </listitem>
+ <itemizedlist>
- <listitem>
- <para>
- An integer with which to compare the column value;
- this integer may be either 32-bit or 64-bit, and is
- unsigned in either case.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ The ID (<replaceable>ColId</replaceable>) of the column
+ whose value is to be tested
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ <listitem>
+ <para>
+ An integer with which to compare the column value; this
+ integer may be either 32-bit or 64-bit, and is unsigned in
+ either case.
+ </para>
+ </listitem>
- </formalpara>
+ </itemizedlist>
<formalpara>
<title>Return value</title>
<para>
- <literal>0</literal> on success, <literal>-1</literal> on
- failure.
+ Returns <literal>0</literal> on success, or
+ <literal>-1</literal> on failure.
</para>
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -1334,27 +1339,25 @@
<title>Signature</title>
<para>
+ This method has 32-bit and 64-bit variants, as shown here:
+ </para>
+
+ </formalpara>
+
<programlisting>
int lt
(
int <replaceable>ColId</replaceable>,
Uint32 <replaceable>value</replaceable>
)
-</programlisting>
- or
-
-<programlisting>
int lt
(
int <replaceable>ColId</replaceable>,
Uint64 <replaceable>value</replaceable>
)
</programlisting>
- </para>
- </formalpara>
-
<formalpara>
<title>Parameters</title>
@@ -1362,53 +1365,53 @@
<para>
Like <literal>eq()</literal>, <literal>ne()</literal>, and
the other <literal>NdbScanFilter</literal> methods of this
- type, this method takes two parameters:
+ type, this method takes two parameters, listed here:
+ </para>
- <itemizedlist>
+ </formalpara>
- <listitem>
- <para>
- The ID (<replaceable>ColId</replaceable>) of the
- column whose value is to be tested
- </para>
- </listitem>
+ <itemizedlist>
- <listitem>
- <para>
- An integer with which to compare the column value;
- this integer may be either 32-bit or 64-bit, and is
- unsigned in either case.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ The ID (<replaceable>ColId</replaceable>) of the column
+ whose value is to be tested
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ <listitem>
+ <para>
+ An integer with which to compare the column value; this
+ integer may be either 32-bit or 64-bit, and is unsigned in
+ either case.
+ </para>
+ </listitem>
- </formalpara>
+ </itemizedlist>
<formalpara>
<title>Return value</title>
<para>
- <literal>0</literal> on success, <literal>-1</literal> on
- failure.
+ Retrturns <literal>0</literal> on success, or
+ <literal>-1</literal> on failure.
</para>
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -1441,27 +1444,27 @@
<title>Signature</title>
<para>
+ This method has two variants, to accomodate 32-bit and
+ 64-bit values:
+ </para>
+
+ </formalpara>
+
<programlisting>
int le
(
int <replaceable>ColId</replaceable>,
Uint32 <replaceable>value</replaceable>
)
-</programlisting>
- or
-<programlisting>
int le
(
int <replaceable>ColId</replaceable>,
Uint64 <replaceable>value</replaceable>
)
</programlisting>
- </para>
- </formalpara>
-
<formalpara>
<title>Parameters</title>
@@ -1469,52 +1472,52 @@
<para>
Like the other <literal>NdbScanFilter</literal> methods of
this type, this method takes two parameters:
+ </para>
- <itemizedlist>
+ </formalpara>
- <listitem>
- <para>
- The ID (<replaceable>ColId</replaceable>) of the
- column whose value is to be tested
- </para>
- </listitem>
+ <itemizedlist>
- <listitem>
- <para>
- An integer with which to compare the column value;
- this integer may be either 32-bit or 64-bit, and is
- unsigned in either case.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ The ID (<replaceable>ColId</replaceable>) of the column
+ whose value is to be tested
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ <listitem>
+ <para>
+ An integer with which to compare the column value; this
+ integer may be either 32-bit or 64-bit, and is unsigned in
+ either case.
+ </para>
+ </listitem>
- </formalpara>
+ </itemizedlist>
<formalpara>
<title>Return value</title>
<para>
- <literal>0</literal> on success, <literal>-1</literal> on
- failure.
+ Returns <literal>0</literal> on success, or
+ <literal>-1</literal> on failure.
</para>
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -1547,27 +1550,26 @@
<title>Signature</title>
<para>
+ This method accomodates both 32-bit and 64-bit values:
+ </para>
+
+ </formalpara>
+
<programlisting>
int gt
(
int <replaceable>ColId</replaceable>,
Uint32 <replaceable>value</replaceable>
)
-</programlisting>
- or
-<programlisting>
int gt
(
int <replaceable>ColId</replaceable>,
Uint64 <replaceable>value</replaceable>
)
</programlisting>
- </para>
- </formalpara>
-
<formalpara>
<title>Parameters</title>
@@ -1575,52 +1577,52 @@
<para>
Like the other <literal>NdbScanFilter</literal> methods of
this type, this method takes two parameters:
+ </para>
- <itemizedlist>
+ </formalpara>
- <listitem>
- <para>
- The ID (<replaceable>ColId</replaceable>) of the
- column whose value is to be tested
- </para>
- </listitem>
+ <itemizedlist>
- <listitem>
- <para>
- An integer with which to compare the column value;
- this integer may be either 32-bit or 64-bit, and is
- unsigned in either case.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ The ID (<replaceable>ColId</replaceable>) of the column
+ whose value is to be tested
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ <listitem>
+ <para>
+ An integer with which to compare the column value; this
+ integer may be either 32-bit or 64-bit, and is unsigned in
+ either case.
+ </para>
+ </listitem>
- </formalpara>
+ </itemizedlist>
<formalpara>
<title>Return value</title>
<para>
- <literal>0</literal> on success, <literal>-1</literal> on
+ <literal>0</literal> on success; <literal>-1</literal> on
failure.
</para>
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -1653,27 +1655,27 @@
<title>Signature</title>
<para>
+ This method accepts both 32-bit and 64-bit values, as shown
+ here:
+ </para>
+
+ </formalpara>
+
<programlisting>
int ge
(
int <replaceable>ColId</replaceable>,
Uint32 <replaceable>value</replaceable>
)
-</programlisting>
- or
-<programlisting>
int ge
(
int <replaceable>ColId</replaceable>,
Uint64 <replaceable>value</replaceable>
)
</programlisting>
- </para>
- </formalpara>
-
<formalpara>
<title>Parameters</title>
@@ -1683,52 +1685,52 @@
<literal>le()</literal>, and the other
<literal>NdbScanFilter</literal> methods of this type, this
method takes two parameters:
+ </para>
- <itemizedlist>
+ </formalpara>
- <listitem>
- <para>
- The ID (<replaceable>ColId</replaceable>) of the
- column whose value is to be tested
- </para>
- </listitem>
+ <itemizedlist>
- <listitem>
- <para>
- An integer with which to compare the column value;
- this integer may be either 32-bit or 64-bit, and is
- unsigned in either case.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ The ID (<replaceable>ColId</replaceable>) of the column
+ whose value is to be tested
+ </para>
+ </listitem>
- </itemizedlist>
- </para>
+ <listitem>
+ <para>
+ An integer with which to compare the column value; this
+ integer may be either 32-bit or 64-bit, and is unsigned in
+ either case.
+ </para>
+ </listitem>
- </formalpara>
+ </itemizedlist>
<formalpara>
<title>Return value</title>
<para>
- <literal>0</literal> on success, <literal>-1</literal> on
+ <literal>0</literal> on success; <literal>-1</literal> on
failure.
</para>
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -1788,23 +1790,24 @@
<title>Return value</title>
<para>
- <literal>0</literal> if the value is <literal>NULL</literal>.
+ Returns <literal>0</literal>, if the column value is
+ <literal>NULL</literal>.
</para>
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
@@ -1862,7 +1865,7 @@
<title>Return value</title>
<para>
- <literal>0</literal> if the value is not
+ Returns <literal>0</literal>, if the column value is not
<literal>NULL</literal>.
</para>
@@ -1901,10 +1904,10 @@
<title>Description</title>
<para>
- Because errors encountered when building an NdbScanFilter do
- not propagate to any involved <literal>NdbOperation</literal>
- object, it is necessary to use this method to access error
- information.
+ Because errors encountered when building an
+ <literal>NdbScanFilter</literal> do not propagate to any
+ involved <literal>NdbOperation</literal> object, it is
+ necessary to use this method to access error information.
</para>
</formalpara>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r23011 - trunk/ndbapi | jon.stephens | 6 Oct |
