Author: jstephens
Date: 2007-07-11 22:35:24 +0200 (Wed, 11 Jul 2007)
New Revision: 7091
Log:
Remaining portion of basic docs for NdbRecord (MCCGE 6.2.3+ only feature)
Modified:
trunk/ndbapi/ndb-classes.xml
trunk/ndbapi/xmi/NdbTransaction.xmi.tgz
Modified: trunk/ndbapi/ndb-classes.xml
===================================================================
--- trunk/ndbapi/ndb-classes.xml 2007-07-11 20:16:17 UTC (rev 7090)
+++ trunk/ndbapi/ndb-classes.xml 2007-07-11 20:35:24 UTC (rev 7091)
Changed blocks: 5, Lines Added: 1073, Lines Deleted: 5; 33478 bytes
@@ -36514,10 +36514,52 @@
<entry><literal>getNextCompletedOperation()</literal></entry>
<entry>Gets operations that have been executed; used for finding errors</entry>
</row>
+ <row>
+ <entry><literal>readTuple()</literal></entry>
+ <entry>Read a tuple using <literal>NdbRecord</literal></entry>
+ </row>
+ <row>
+ <entry><literal>insertTuple()</literal></entry>
+ <entry>Insert a tuple using <literal>NdbRecord</literal></entry>
+ </row>
+ <row>
+ <entry><literal>updateTuple()</literal></entry>
+ <entry>Update a tuple using <literal>NdbRecord</literal></entry>
+ </row>
+ <row>
+ <entry><literal>writeTuple()</literal></entry>
+ <entry>Write a tuple using <literal>NdbRecord</literal></entry>
+ </row>
+ <row>
+ <entry><literal>deleteTuple()</literal></entry>
+ <entry>Delete a tuple using <literal>NdbRecord</literal></entry>
+ </row>
+ <row>
+ <entry><literal>scanTable()</literal></entry>
+ <entry>Perform a table scan using <literal>NdbRecord</literal></entry>
+ </row>
+ <row>
+ <entry><literal>scanIndex()</literal></entry>
+ <entry>Perform an index scan using <literal>NdbRecord</literal></entry>
+ </row>
</tbody>
</tgroup>
</informaltable>
+ <important>
+ <para>
+ The methods <literal>readTuple()</literal>,
+ <literal>insertTuple()</literal>,
+ <literal>updateTuple()</literal>,
+ <literal>writeTuple()</literal>,
+ <literal>deleteTuple()</literal>,
+ <literal>scanTable()</literal>, and
+ <literal>scanIndex()</literal> require the use of
+ <literal>NdbRecord</literal>, which is available only in
+ &mccge-series; releases beginning with MySQL 5.1.19-ndb-6.2.3.
+ </para>
+ </important>
+
<para>
For detailed descriptions, signatures, and examples of use for
each of these methods, see
@@ -36588,6 +36630,20 @@
</formalpara>
+ <note>
+ <para>
+ The methods <literal>readTuple()</literal>,
+ <literal>insertTuple()</literal>,
+ <literal>updateTuple()</literal>,
+ <literal>writeTuple()</literal>,
+ <literal>deleteTuple()</literal>,
+ <literal>scanTable()</literal>, and
+ <literal>scanIndex()</literal> (available only in &mccge-series;
+ releases beginning with MySQL 5.1.19-ndb-6.2.3) are not shown in
+ the diagram due to space cosniderations.
+ </para>
+ </note>
+
<section id="class-ndbtransaction-types">
<title><literal>NdbTransaction</literal> Types</title>
@@ -38143,6 +38199,1020 @@
</section>
+ <section id="class-ndbtransaction-readtuple">
+
+ <title><literal>NdbTransaction::readTuple()</literal></title>
+
+ <indexterm>
+ <primary><literal>NdbTransaction::readTuple()</literal></primary>
+ </indexterm>
+
+ <indexterm>
+ <primary><literal>readTuple()</literal> (method of
+ <literal>NdbTransaction</literal>)</primary>
+ </indexterm>
+
+ &mccge-warning-section;
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method reads a tuple using <literal>NdbRecord</literal>
+ objects.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+NdbOperation* readTuple
+ (
+ const NdbRecord* <replaceable>key_rec</replaceable>,
+ const char* <replaceable>key_row</replaceable>,
+ const NdbRecord* <replaceable>result_rec</replaceable>,
+ char* <replaceable>result_row</replaceable>,
+ NdbOperation::LockMode <replaceable>lock_mode</replaceable> = NdbOperation::LM_Read,
+ const unsigned char* <replaceable>result_mask</replaceable> = 0
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ This method takes the following parameters:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <replaceable>key_rec</replaceable> is a pointer to an
+ <literal>NdbRecord</literal> for either a table or an
+ index. If on a table, then the operation uses a
+ primary key; if on an index, then the operation uses a
+ unique key. In either case, the
+ <replaceable>key_rec</replaceable> must include all
+ columns of the key.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <replaceable>key_row</replaceable> passed to this
+ method defines the primary or unique key of the
+ affected tuple, and must remain valid until
+ <literal>execute()</literal> is called.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <replaceable>result_rec</replaceable> is a pointer to
+ an <literal>NdbRecord</literal> used to hold the
+ result
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <replaceable>result_row</replaceable> defines a buffer
+ for the result data.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <replaceable>lock_mode</replaceable> specifies the
+ lock mode in effect for the operation. See
+ <xref linkend="class-ndboperation-lockmode"/>, for
+ permitted values and other information.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <replaceable>result_mask</replaceable> defines a
+ subset of attributes to read. Only if
+ <literal>mask[attrId >> 3] &
+ (1<<(attrId & 7))</literal> is set is the
+ column affected. The mask is copied, and so need not
+ remain valid after the method call returns.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The <literal>NdbOperation</literal> representing this
+ operation (can be used to check for errors).
+ </para>
+
+ </formalpara>
+
+<!--
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+-->
+
+ </section>
+
+ <section id="class-ndbtransaction-inserttuple">
+
+ <title><literal>NdbTransaction::insertTuple()</literal></title>
+
+ <indexterm>
+ <primary><literal>NdbTransaction::insertTuple()</literal></primary>
+ </indexterm>
+
+ <indexterm>
+ <primary><literal>insertTuple()</literal> (method of
+ <literal>NdbTransaction</literal>)</primary>
+ </indexterm>
+
+ &mccge-warning-section;
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ Inserts a tuple using <literal>NdbRecord</literal>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+NdbOperation* insertTuple
+ (
+ const NdbRecord* <replaceable>record</replaceable>,
+ const char* <replaceable>row</replaceable>,
+ const unsigned char* <replaceable>mask</replaceable> = 0
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <literal>insertTuple</literal> takes the following
+ parameters:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ A pointer to an <literal>NdbRecord</literal>
+ indicating the <replaceable>record</replaceable> to be
+ inserted.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ A <replaceable>row</replaceable> of data to be
+ inserted.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ A <replaceable>mask</replaceable> which can be used to
+ filter the columns to be inserted.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The <literal>NdbOperation</literal> representing this insert
+ operation.
+ </para>
+
+ </formalpara>
+
+<!--
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+-->
+
+ </section>
+
+ <section id="class-ndbtransaction-updatetuple">
+
+ <title><literal>NdbTransaction::updateTuple()</literal></title>
+
+ <indexterm>
+ <primary><literal>NdbTransaction::updateTuple()</literal></primary>
+ </indexterm>
+
+ <indexterm>
+ <primary><literal>updateTuple()</literal> (method of
+ <literal>NdbTransaction</literal>)</primary>
+ </indexterm>
+
+ &mccge-warning-section;
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ Updates a tuple using an <literal>NdbRecord</literal>
+ object.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+NdbOperation* updateTuple
+ (
+ const NdbRecord* <replaceable>key_rec</replaceable>,
+ const char* <replaceable>key_row</replaceable>,
+ const NdbRecord* <replaceable>attr_rec</replaceable>,
+ const char* <replaceable>attr_row</replaceable>,
+ const unsigned char* <replaceable>mask</replaceable> = 0
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <literal>updateTuple()</literal> takes the following
+ parameters:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <replaceable>key_rec</replaceable> is a pointer to an
+ <literal>NdbRecord</literal> for either a table or an
+ index. If on a table, then the operation uses a
+ primary key; if on an index, then the operation uses a
+ unique key. In either case, the
+ <replaceable>key_rec</replaceable> must include all
+ columns of the key.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <replaceable>key_row</replaceable> passed to this
+ method defines the primary or unique key of the
+ affected tuple, and must remain valid until
+ <literal>execute()</literal> is called.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <replaceable>attr_rec</replaceable> is an
+ <literal>NdbRecord</literal> referencing the attribute
+ to be updated.
+ </para>
+
+ <note>
+ <para>
+ For unique index operations, the
+ <replaceable>attr_rec</replaceable> must refer to
+ the underlying table of the index, not to the index
+ itself.
+ </para>
+ </note>
+ </listitem>
+
+ <listitem>
+ <para>
+ <replaceable>attr_row</replaceable> is a buffer
+ containing the new data for the update.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <replaceable>mask</replaceable>, if not
+ <literal>NULL</literal>, defines a subset of
+ attributes to be updated. The mask is copied, and so
+ does not need to remain valid after the call to this
+ method returns.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The <literal>NdbOperation</literal> representing this
+ operation (can be used to check for errors).
+ </para>
+
+ </formalpara>
+
+<!--
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+-->
+
+ </section>
+
+ <section id="class-ndbtransaction-writetuple">
+
+ <title><literal>NdbTransaction::writeTuple()</literal></title>
+
+ <indexterm>
+ <primary><literal>NdbTransaction::writeTuple()</literal></primary>
+ </indexterm>
+
+ <indexterm>
+ <primary><literal>writeTuple()</literal> (method of
+ <literal>NdbTransaction</literal>)</primary>
+ </indexterm>
+
+ &mccge-warning-section;
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used with <literal>NdbRecord</literal> to
+ write a tuple of data.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+NdbOperation* writeTuple
+ (
+ const NdbRecord* <replaceable>key_rec</replaceable>,
+ const char* <replaceable>key_row</replaceable>,
+ const NdbRecord* <replaceable>attr_rec</replaceable>,
+ const char* <replaceable>attr_row</replaceable>,
+ const unsigned char* <replaceable>mask</replaceable> = 0
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ This method takes the following parameters:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <replaceable>key_rec</replaceable> is a pointer to an
+ <literal>NdbRecord</literal> for either a table or an
+ index. If on a table, then the operation uses a
+ primary key; if on an index, then the operation uses a
+ unique key. In either case, the
+ <replaceable>key_rec</replaceable> must include all
+ columns of the key.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <replaceable>key_row</replaceable> passed to this
+ method defines the primary or unique key of the tuple
+ to be written, and must remain valid until
+ <literal>execute()</literal> is called.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <replaceable>attr_rec</replaceable> is an
+ <literal>NdbRecord</literal> referencing the attribute
+ to be written.
+ </para>
+
+ <note>
+ <para>
+ For unique index operations, the
+ <replaceable>attr_rec</replaceable> must refer to
+ the underlying table of the index, not to the index
+ itself.
+ </para>
+ </note>
+ </listitem>
+
+ <listitem>
+ <para>
+ <replaceable>attr_row</replaceable> is a buffer
+ containing the new data.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <replaceable>mask</replaceable>, if not
+ <literal>NULL</literal>, defines a subset of
+ attributes to be written. The mask is copied, and so
+ does not need to remain valid after the call to this
+ method returns.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The <literal>NdbOperation</literal> representing this write
+ operation. The operation can be checked for errors if and as
+ necessary.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-ndbtransaction-deletetuple">
+
+ <title><literal>NdbTransaction::deleteTuple()</literal></title>
+
+ <indexterm>
+ <primary><literal>NdbTransaction::deleteTuple()</literal></primary>
+ </indexterm>
+
+ <indexterm>
+ <primary><literal>deleteTuple()</literal> (method of
+ <literal>NdbTransaction</literal>)</primary>
+ </indexterm>
+
+ &mccge-warning-section;
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ Deletes a tuple using <literal>NdbRecord</literal>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+NdbOperation* deleteTuple
+ (
+ const NdbRecord* <replaceable>key_rec</replaceable>,
+ const char* <replaceable>key_row</replaceable>
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ This method takes the following parameters:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <replaceable>key_rec</replaceable> is a pointer to an
+ <literal>NdbRecord</literal> for either a table or an
+ index. If on a table, then the delete operation uses a
+ primary key; if on an index, then the operation uses a
+ unique key. In either case, the
+ <replaceable>key_rec</replaceable> must include all
+ columns of the key.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <replaceable>key_row</replaceable> passed to this
+ method defines the primary or unique key of the tuple
+ to be deleted, and must remain valid until
+ <literal>execute()</literal> is called.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ A pointer to the <literal>NdbOperation</literal>
+ representing this write operation. The operation can be
+ checked for errors if necessary.
+ </para>
+
+ </formalpara>
+
+<!--
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+-->
+
+ </section>
+
+ <section id="class-ndbtransaction-scantable">
+
+ <title><literal>NdbTransaction::scanTable()</literal></title>
+
+ <indexterm>
+ <primary><literal>NdbTransaction::scanTable()</literal></primary>
+ </indexterm>
+
+ <indexterm>
+ <primary><literal>scanTable()</literal> (method of
+ <literal>NdbTransaction</literal>)</primary>
+ </indexterm>
+
+ &mccge-warning-section;
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method performs a table scan, using an
+ <literal>NdbRecord</literal> object to read out column data.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+NdbScanOperation* scanTable
+ (
+ const NdbRecord* <replaceable>result_record</replaceable>,
+ NdbOperation::LockMode <replaceable>lock_mode</replaceable> = NdbOperation::LM_Read,
+ const unsigned char* <replaceable>result_mask</replaceable> = 0,
+ Uint32 <replaceable>scan_flags</replaceable> = 0,
+ Uint32 <replaceable>parallel</replaceable> = 0,
+ Uint32 <replaceable>batch</replaceable> = 0
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ The <literal>scanTable()</literal> method takes the
+ following parameters:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ A pointer to an <literal>NdbRecord</literal> for
+ storing the result. This
+ <replaceable>result_record</replaceable> must remain
+ valid until after the <literal>execute()</literal>
+ call has been made.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <replaceable>lock_mode</replaceable> in effect for
+ the operation. See
+ <xref linkend="class-ndboperation-lockmode"/>, for
+ allowable values and other information.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <replaceable>result_mask</replaceable> pointer is
+ optional. If it is present, only columns for which the
+ corresponding bit (by attribute ID order) in
+ <replaceable>result_mask</replaceable> is set will be
+ retrieved in the scan. The
+ <replaceable>result_mask</replaceable> is copied
+ internally, so in contrast to
+ <replaceable>result_record</replaceable> need not be
+ valid when <literal>execute()</literal> is invoked.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <replaceable>scan_flags</replaceable> can be used to
+ impose ordering and sorting conditions for scans. See
+ <xref linkend="class-ndbscanoperation-scanflag"/>, for
+ a list of permitted values.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <replaceable>parallel</replaceable> argument is
+ the desired parallelism, or <literal>0</literal> for
+ maximum parallelism (receiving rows from all fragments
+ in parallel), which is the default.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <replaceable>batch</replaceable> determines whether
+ batching is employed. The default is 0 (off).
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ A pointer to the <literal>NdbScanOperation</literal>
+ representing this scan. The operation can be checked for
+ errors if necessary.
+ </para>
+
+ </formalpara>
+
+<!--
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+-->
+
+ </section>
+
+ <section id="class-ndbtransaction-scanindex">
+
+ <title><literal>NdbTransaction::scanIndex()</literal></title>
+
+ <indexterm>
+ <primary><literal>NdbTransaction::scanIndex()</literal></primary>
+ </indexterm>
+
+ <indexterm>
+ <primary><literal>scanIndex()</literal> (method of
+ <literal>NdbTransaction</literal>)</primary>
+ </indexterm>
+
+ &mccge-warning-section;
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to perform an index scan of a table,
+ using <literal>NdbRecord</literal>. The scan may optionally
+ be ordered.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+NdbIndexScanOperation* scanIndex
+ (
+ const NdbRecord* <replaceable>key_record</replaceable>,
+ const char* <replaceable>low_key</replaceable>,
+ Uint32 <replaceable>low_key_count</replaceable>,
+ bool <replaceable>low_inclusive</replaceable>,
+ const char* <replaceable>high_key</replaceable>,
+ Uint32 <replaceable>high_key_count</replaceable>,
+ bool <replaceable>high_inclusive</replaceable>,
+ const NdbRecord* <replaceable>result_record</replaceable>,
+ NdbOperation::LockMode <replaceable>lock_mode</replaceable> = NdbOperation::LM_Read,
+ const unsigned char* <replaceable>result_mask</replaceable> = 0,
+ Uint32 <replaceable>scan_flags</replaceable> = 0,
+ Uint32 <replaceable>parallel</replaceable> = 0,
+ Uint32 <replaceable>batch</replaceable> = 0
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <note>
+ <para>
+ For multi-range scans, the
+ <replaceable>low_key</replaceable> and
+ <replaceable>high_key</replaceable> pointers must be unique.
+ In other words, it is not permissible to reuse the same row
+ buffer for several different range bounds within a single
+ scan. However, it is permissible to use the same row pointer
+ as <replaceable>low_key</replaceable> and
+ <replaceable>high_key</replaceable> in order to specify an
+ equals bound; it is also permissible to reuse the rows after
+ the <literal>scanIndex()</literal> method returns —
+ thatis, they need not remain valid until
+ <literal>execute()</literal> time (unlike the
+ <literal>NdbRecord</literal> pointers).
+ </para>
+ </note>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ This method takes the following parameters:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ The <replaceable>key_record</replaceable> describes
+ the index to be scanned. It must be a key record on
+ the index; that is, the columns which it specifies
+ must include all of the key columns of the index. It
+ must be created from the index to be scanned, and not
+ from the underlying table.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <replaceable>low_key</replaceable> determines the
+ lower bound for a range scan.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <replaceable>low_key_count</replaceable> determines
+ the number of columns used for the lower bound when
+ specifying a partial prefix for the scan.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <replaceable>low_inclusive</replaceable> determines
+ whether the lower bound is considered as a
+ <literal>>=</literal> or <literal>></literal>
+ relation.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <replaceable>high_key</replaceable> determines the
+ upper bound for a range scan.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <replaceable>high_key_count</replaceable> determines
+ the number of columns used for the higher bound when
+ specifying a partial prefix for the scan.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <replaceable>high_inclusive</replaceable> determines
+ whether the lower bound is considered as a
+ <literal><=</literal> or <literal><</literal>
+ relation.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <replaceable>result_record</replaceable> describes
+ the rows to be returned from the scan. For an ordered
+ index scan, <replaceable>result_record</replaceable>
+ be a key record on the index; that is, the columns
+ which it specifies must include all of the key columns
+ of the index. This is because the index key is needed
+ for merge sorting of the scans returned from each
+ fragment.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <replaceable>lock_mode</replaceable> for the scan
+ must be one of the values specified in
+ <xref linkend="class-ndboperation-lockmode"/>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <replaceable>result_mask</replaceable> pointer is
+ optional. If it is present, only columns for which the
+ corresponding bit (by attribute ID order) in
+ <replaceable>result_mask</replaceable> is set will be
+ retrieved in the scan. The
+ <replaceable>result_mask</replaceable> is copied
+ internally, so in contrast to
+ <replaceable>result_record</replaceable> need not be
+ valid when <literal>execute()</literal> is invoked.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <replaceable>scan_flags</replaceable> can be used to
+ impose ordering and sorting conditions for scans. See
+ <xref linkend="class-ndbscanoperation-scanflag"/>, for
+ a list of permitted values.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <replaceable>parallel</replaceable> argument is
+ the desired parallelism, or <literal>0</literal> for
+ maximum parallelism (receiving rows from all fragments
+ in parallel), which is the default.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <replaceable>batch</replaceable> determines whether
+ batching is employed. The default is 0 (off).
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The current <literal>NdbIndexScanOperation</literal>, which
+ can be used for error checking.
+ </para>
+
+ </formalpara>
+
+<!--
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+-->
+
+ </section>
+
</section>
</section>
@@ -38247,7 +39317,6 @@
</para>
</listitem>
-<!--
<listitem>
<para>
<literal><link linkend="class-ndbtransaction-readtuple">NdbTransaction::readTuple()</link></literal>
@@ -38289,20 +39358,19 @@
<literal><link linkend="class-ndbtransaction-scanindex">NdbTransaction::scanIndex()</link></literal>
</para>
</listitem>
--->
</itemizedlist>
- In addition, news members of
+ In addition, new members of
<literal>NdbIndexScanOperation</literal> and
- <literal>Dictionary</literal> are introduced in MySQL
+ <literal>NdbDictionary</literal> are introduced in MySQL
5.1.19-ndb-6.2.3 for use with <literal>NdbRecord</literal> scans:
<itemizedlist>
<listitem>
<para>
- <literal>NdbIndexScanOperation::indexBound</literal> is a
+ <literal>NdbIndexScanOperation::IndexBound</literal> is a
structure used to describe index scan bounds. See
<xref linkend="class-ndbindexscanoperation-indexbound"/>.
</para>
Modified: trunk/ndbapi/xmi/NdbTransaction.xmi.tgz
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 137 bytes
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r7091 - in trunk/ndbapi: . xmi | jon | 11 Jul |
