| List: | Commits | « Previous MessageNext Message » | |
| From: | jon | Date: | November 27 2006 5:05am |
| Subject: | svn commit - mysqldoc@docsrva: r4038 - trunk/ndbapi | ||
| View as plain text | |||
Author: jstephens Date: 2006-11-27 05:05:23 +0100 (Mon, 27 Nov 2006) New Revision: 4038 Log: Reformat. Modified: trunk/ndbapi/ndb-classes.xml Modified: trunk/ndbapi/ndb-classes.xml =================================================================== --- trunk/ndbapi/ndb-classes.xml 2006-11-27 04:03:46 UTC (rev 4037) +++ trunk/ndbapi/ndb-classes.xml 2006-11-27 04:05:23 UTC (rev 4038) Changed blocks: 25, Lines Added: 340, Lines Deleted: 338; 27941 bytes @@ -22560,14 +22560,13 @@ <title><literal>Table::aggregate()</literal></title> - <indexterm> - <primary><literal>Table::aggregate()</literal></primary> - </indexterm> + <indexterm> + <primary><literal>Table::aggregate()</literal></primary> + </indexterm> - <indexterm> - <primary><literal>aggregate()</literal> (method of - <literal>Table</literal>)</primary> - </indexterm> + <indexterm> + <primary><literal>aggregate()</literal> (method of <literal>Table</literal>)</primary> + </indexterm> <formalpara> @@ -22646,14 +22645,13 @@ <title><literal>Table::validate()</literal></title> - <indexterm> - <primary><literal>Table::validate()</literal></primary> - </indexterm> + <indexterm> + <primary><literal>Table::validate()</literal></primary> + </indexterm> - <indexterm> - <primary><literal>validate()</literal> (method of - <literal>Table</literal>)</primary> - </indexterm> + <indexterm> + <primary><literal>validate()</literal> (method of <literal>Table</literal>)</primary> + </indexterm> <formalpara> @@ -22668,7 +22666,7 @@ when a table is created or retrieved. For this reason, it is usually not necessary to call <literal>aggregate()</literal> or - <literal>validate()</literal> directly. + <literal>validate()</literal> directly. </para> </formalpara> @@ -33776,14 +33774,17 @@ <para> This method is used to perform a comparison between a given - value and the value of a column. - + value and the value of a column. + <note> - <para>In many cases, where the - value to be compared is an integer, you can instead use one - of several convenience methods provided by - <literal>NdbScanFilter</literal> for this purpose. See - <xref linkend="class-ndbscanfilter-integer-comparison-methods"/>.</para></note> + <para> + In many cases, where the value to be compared is an + integer, you can instead use one of several convenience + methods provided by <literal>NdbScanFilter</literal> for + this purpose. See + <xref linkend="class-ndbscanfilter-integer-comparison-methods"/>. + </para> + </note> </para> </formalpara> @@ -33901,11 +33902,11 @@ </formalpara> --> - + </section> <section id="class-ndbscanfilter-integer-comparison-methods"> - + <title><literal>NdbScanFilter</literal> Integer Comparison Methods</title> <indexterm> @@ -33914,10 +33915,9 @@ </indexterm> <indexterm> - <primary>integer comparison methods (of - <literal>NdbScanFilter</literal> class)</primary> + <primary>integer comparison methods (of <literal>NdbScanFilter</literal> class)</primary> </indexterm> - + <para> This section provides information about several convenience methods which can be used in lieu of the @@ -33926,48 +33926,48 @@ methods is essentially a wrapper for <literal>cmp()</literal> that includes an appropriate value of <literal>BinaryCondition</literal> for that method's - <replaceable>condition</replaceable> parameter; for example, + <replaceable>condition</replaceable> parameter; for example, <literal>NdbScanFilter::eq()</literal> is defined like this: - + <programlisting> int eq(int <replaceable>columnId</replaceable>, Uint32 <replaceable>value</replaceable>) { return cmp(BinaryCondition::COND_EQ, <replaceable>columnId</replaceable>, <replaceable>&value</replaceable>, 4); } </programlisting> - + For more information about the <literal>cmp()</literal> method, see <xref linkend="class-ndbscanfilter-cmp"/>. </para> - <section id="class-ndbscanfilter-eq"> + <section id="class-ndbscanfilter-eq"> - <title><literal>NdbScanFilter::eq()</literal></title> + <title><literal>NdbScanFilter::eq()</literal></title> - <indexterm> - <primary><literal>NdbScanFilter::eq()</literal></primary> - </indexterm> + <indexterm> + <primary><literal>NdbScanFilter::eq()</literal></primary> + </indexterm> - <indexterm> - <primary><literal>eq()</literal> (method of <literal>NdbScanFilter</literal>)</primary> - </indexterm> + <indexterm> + <primary><literal>eq()</literal> (method of <literal>NdbScanFilter</literal>)</primary> + </indexterm> - <formalpara> + <formalpara> - <title>Description</title> + <title>Description</title> - <para> - This method is used to perform an equality test on a column - value and an integer. - </para> + <para> + This method is used to perform an equality test on a + column value and an integer. + </para> - </formalpara> + </formalpara> - <formalpara> + <formalpara> - <title>Signature</title> + <title>Signature</title> - <para> + <para> <programlisting> int eq ( @@ -33976,7 +33976,7 @@ ) </programlisting> - or + or <programlisting> int eq @@ -33985,49 +33985,49 @@ Uint64 <replaceable>value</replaceable> ) </programlisting> - </para> + </para> - </formalpara> + </formalpara> - <formalpara> + <formalpara> - <title>Parameters</title> + <title>Parameters</title> - <para> - This method takes two parameters: + <para> + This method takes two parameters: - <itemizedlist> + <itemizedlist> - <listitem> - <para> - The ID (<replaceable>ColId</replaceable>) of the - column whose value is to be tested - </para> - </listitem> + <listitem> + <para> + The ID (<replaceable>ColId</replaceable>) of the + column whose value is to be tested + </para> + </listitem> - <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> + 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> - </itemizedlist> - </para> + </itemizedlist> + </para> - </formalpara> + </formalpara> - <formalpara> + <formalpara> - <title>Return Value</title> + <title>Return Value</title> - <para> - <literal>0</literal> on success, <literal>-1</literal> on - failure. - </para> + <para> + <literal>0</literal> on success, <literal>-1</literal> on + failure. + </para> - </formalpara> + </formalpara> <!-- <formalpara> @@ -34043,36 +34043,36 @@ </formalpara> --> - </section> + </section> - <section id="class-ndbscanfilter-ne"> + <section id="class-ndbscanfilter-ne"> - <title><literal>NdbScanFilter::ne()</literal></title> + <title><literal>NdbScanFilter::ne()</literal></title> - <indexterm> - <primary><literal>NdbScanFilter::ne()</literal></primary> - </indexterm> + <indexterm> + <primary><literal>NdbScanFilter::ne()</literal></primary> + </indexterm> - <indexterm> - <primary><literal>ne()</literal> (method of <literal>NdbScanFilter</literal>)</primary> - </indexterm> + <indexterm> + <primary><literal>ne()</literal> (method of <literal>NdbScanFilter</literal>)</primary> + </indexterm> - <formalpara> + <formalpara> - <title>Description</title> + <title>Description</title> - <para> - This method is used to perform an inequality test on a - column value and an integer. - </para> + <para> + This method is used to perform an inequality test on a + column value and an integer. + </para> - </formalpara> + </formalpara> - <formalpara> + <formalpara> - <title>Signature</title> + <title>Signature</title> - <para> + <para> <programlisting> int ne ( @@ -34081,7 +34081,7 @@ ) </programlisting> - or + or <programlisting> int ne @@ -34090,51 +34090,51 @@ Uint64 <replaceable>value</replaceable> ) </programlisting> - </para> + </para> - </formalpara> + </formalpara> - <formalpara> + <formalpara> - <title>Parameters</title> + <title>Parameters</title> - <para> - Like <literal>eq()</literal> and the other - <literal>NdbScanFilter</literal> methods of this type, this - method takes two parameters: + <para> + Like <literal>eq()</literal> and the other + <literal>NdbScanFilter</literal> methods of this type, + this method takes two parameters: - <itemizedlist> + <itemizedlist> - <listitem> - <para> - The ID (<replaceable>ColId</replaceable>) of the - column whose value is to be tested - </para> - </listitem> + <listitem> + <para> + The ID (<replaceable>ColId</replaceable>) of the + column whose value is to be tested + </para> + </listitem> - <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> + 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> - </itemizedlist> - </para> + </itemizedlist> + </para> - </formalpara> + </formalpara> - <formalpara> + <formalpara> - <title>Return Value</title> + <title>Return Value</title> - <para> - <literal>0</literal> on success, <literal>-1</literal> on - failure. - </para> + <para> + <literal>0</literal> on success, <literal>-1</literal> on + failure. + </para> - </formalpara> + </formalpara> <!-- <formalpara> @@ -34150,36 +34150,36 @@ </formalpara> --> - </section> + </section> - <section id="class-ndbscanfilter-lt"> + <section id="class-ndbscanfilter-lt"> - <title><literal>NdbScanFilter::lt()</literal></title> + <title><literal>NdbScanFilter::lt()</literal></title> - <indexterm> - <primary><literal>NdbScanFilter::lt()</literal></primary> - </indexterm> + <indexterm> + <primary><literal>NdbScanFilter::lt()</literal></primary> + </indexterm> - <indexterm> - <primary><literal>lt()</literal> (method of <literal>NdbScanFilter</literal>)</primary> - </indexterm> + <indexterm> + <primary><literal>lt()</literal> (method of <literal>NdbScanFilter</literal>)</primary> + </indexterm> - <formalpara> + <formalpara> - <title>Description</title> + <title>Description</title> - <para> - This method is used to perform a less-than (strict lower - bound) test on a column value and an integer. - </para> + <para> + This method is used to perform a less-than (strict lower + bound) test on a column value and an integer. + </para> - </formalpara> + </formalpara> - <formalpara> + <formalpara> - <title>Signature</title> + <title>Signature</title> - <para> + <para> <programlisting> int lt ( @@ -34188,7 +34188,7 @@ ) </programlisting> - or + or <programlisting> int lt @@ -34197,51 +34197,51 @@ Uint64 <replaceable>value</replaceable> ) </programlisting> - </para> + </para> - </formalpara> + </formalpara> - <formalpara> + <formalpara> - <title>Parameters</title> + <title>Parameters</title> - <para> - Like <literal>eq()</literal>, <literal>ne()</literal>, and - the other <literal>NdbScanFilter</literal> methods of this - type, this method takes two parameters: + <para> + Like <literal>eq()</literal>, <literal>ne()</literal>, and + the other <literal>NdbScanFilter</literal> methods of this + type, this method takes two parameters: - <itemizedlist> + <itemizedlist> - <listitem> - <para> - The ID (<replaceable>ColId</replaceable>) of the - column whose value is to be tested - </para> - </listitem> + <listitem> + <para> + The ID (<replaceable>ColId</replaceable>) of the + column whose value is to be tested + </para> + </listitem> - <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> + 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> - </itemizedlist> - </para> + </itemizedlist> + </para> - </formalpara> + </formalpara> - <formalpara> + <formalpara> - <title>Return Value</title> + <title>Return Value</title> - <para> - <literal>0</literal> on success, <literal>-1</literal> on - failure. - </para> + <para> + <literal>0</literal> on success, <literal>-1</literal> on + failure. + </para> - </formalpara> + </formalpara> <!-- <formalpara> @@ -34257,36 +34257,36 @@ </formalpara> --> - </section> + </section> - <section id="class-ndbscanfilter-le"> + <section id="class-ndbscanfilter-le"> - <title><literal>NdbScanFilter::le()</literal></title> + <title><literal>NdbScanFilter::le()</literal></title> - <indexterm> - <primary><literal>NdbScanFilter::le()</literal></primary> - </indexterm> + <indexterm> + <primary><literal>NdbScanFilter::le()</literal></primary> + </indexterm> - <indexterm> - <primary><literal>le()</literal> (method of <literal>NdbScanFilter</literal>)</primary> - </indexterm> + <indexterm> + <primary><literal>le()</literal> (method of <literal>NdbScanFilter</literal>)</primary> + </indexterm> - <formalpara> + <formalpara> - <title>Description</title> + <title>Description</title> - <para> - This method is used to perform a less-than-or-equal test on - a column value and an integer. - </para> + <para> + This method is used to perform a less-than-or-equal test + on a column value and an integer. + </para> - </formalpara> + </formalpara> - <formalpara> + <formalpara> - <title>Signature</title> + <title>Signature</title> - <para> + <para> <programlisting> int le ( @@ -34295,7 +34295,7 @@ ) </programlisting> - or + or <programlisting> int le @@ -34304,50 +34304,50 @@ Uint64 <replaceable>value</replaceable> ) </programlisting> - </para> + </para> - </formalpara> + </formalpara> - <formalpara> + <formalpara> - <title>Parameters</title> + <title>Parameters</title> - <para> - Like the other <literal>NdbScanFilter</literal> methods of - this type, this method takes two parameters: + <para> + Like the other <literal>NdbScanFilter</literal> methods of + this type, this method takes two parameters: - <itemizedlist> + <itemizedlist> - <listitem> - <para> - The ID (<replaceable>ColId</replaceable>) of the - column whose value is to be tested - </para> - </listitem> + <listitem> + <para> + The ID (<replaceable>ColId</replaceable>) of the + column whose value is to be tested + </para> + </listitem> - <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> + 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> - </itemizedlist> - </para> + </itemizedlist> + </para> - </formalpara> + </formalpara> - <formalpara> + <formalpara> - <title>Return Value</title> + <title>Return Value</title> - <para> - <literal>0</literal> on success, <literal>-1</literal> on - failure. - </para> + <para> + <literal>0</literal> on success, <literal>-1</literal> on + failure. + </para> - </formalpara> + </formalpara> <!-- <formalpara> @@ -34363,36 +34363,36 @@ </formalpara> --> - </section> + </section> - <section id="class-ndbscanfilter-gt"> + <section id="class-ndbscanfilter-gt"> - <title><literal>NdbScanFilter::gt()</literal></title> + <title><literal>NdbScanFilter::gt()</literal></title> - <indexterm> - <primary><literal>NdbScanFilter::gt()</literal></primary> - </indexterm> + <indexterm> + <primary><literal>NdbScanFilter::gt()</literal></primary> + </indexterm> - <indexterm> - <primary><literal>gt()</literal> (method of <literal>NdbScanFilter</literal>)</primary> - </indexterm> + <indexterm> + <primary><literal>gt()</literal> (method of <literal>NdbScanFilter</literal>)</primary> + </indexterm> - <formalpara> + <formalpara> - <title>Description</title> + <title>Description</title> - <para> - This method is used to perform a greater-than (strict upper - bound) test on a column value and an integer. - </para> + <para> + This method is used to perform a greater-than (strict + upper bound) test on a column value and an integer. + </para> - </formalpara> + </formalpara> - <formalpara> + <formalpara> - <title>Signature</title> + <title>Signature</title> - <para> + <para> <programlisting> int gt ( @@ -34401,7 +34401,7 @@ ) </programlisting> - or + or <programlisting> int gt @@ -34410,50 +34410,50 @@ Uint64 <replaceable>value</replaceable> ) </programlisting> - </para> + </para> - </formalpara> + </formalpara> - <formalpara> + <formalpara> - <title>Parameters</title> + <title>Parameters</title> - <para> - Like the other <literal>NdbScanFilter</literal> methods of - this type, this method takes two parameters: + <para> + Like the other <literal>NdbScanFilter</literal> methods of + this type, this method takes two parameters: - <itemizedlist> + <itemizedlist> - <listitem> - <para> - The ID (<replaceable>ColId</replaceable>) of the - column whose value is to be tested - </para> - </listitem> + <listitem> + <para> + The ID (<replaceable>ColId</replaceable>) of the + column whose value is to be tested + </para> + </listitem> - <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> + 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> - </itemizedlist> - </para> + </itemizedlist> + </para> - </formalpara> + </formalpara> - <formalpara> + <formalpara> - <title>Return Value</title> + <title>Return Value</title> - <para> - <literal>0</literal> on success, <literal>-1</literal> on - failure. - </para> + <para> + <literal>0</literal> on success, <literal>-1</literal> on + failure. + </para> - </formalpara> + </formalpara> <!-- <formalpara> @@ -34469,35 +34469,36 @@ </formalpara> --> - </section> + </section> + <section id="class-ndbscanfilter-ge"> - <title><literal>NdbScanFilter::ge()</literal></title> + <title><literal>NdbScanFilter::ge()</literal></title> - <indexterm> - <primary><literal>NdbScanFilter::ge()</literal></primary> - </indexterm> + <indexterm> + <primary><literal>NdbScanFilter::ge()</literal></primary> + </indexterm> - <indexterm> - <primary><literal>ge()</literal> (method of <literal>NdbScanFilter</literal>)</primary> - </indexterm> + <indexterm> + <primary><literal>ge()</literal> (method of <literal>NdbScanFilter</literal>)</primary> + </indexterm> - <formalpara> + <formalpara> - <title>Description</title> + <title>Description</title> - <para> - This method is used to perform a greater-than-or-equal test - on a column value and an integer. - </para> + <para> + This method is used to perform a greater-than-or-equal + test on a column value and an integer. + </para> - </formalpara> + </formalpara> - <formalpara> + <formalpara> - <title>Signature</title> + <title>Signature</title> - <para> + <para> <programlisting> int ge ( @@ -34506,7 +34507,7 @@ ) </programlisting> - or + or <programlisting> int ge @@ -34515,52 +34516,52 @@ Uint64 <replaceable>value</replaceable> ) </programlisting> - </para> + </para> - </formalpara> + </formalpara> - <formalpara> + <formalpara> - <title>Parameters</title> + <title>Parameters</title> - <para> - Like <literal>eq()</literal>, <literal>lt()</literal>, - <literal>le()</literal>, and the other - <literal>NdbScanFilter</literal> methods of this type, this - method takes two parameters: + <para> + Like <literal>eq()</literal>, <literal>lt()</literal>, + <literal>le()</literal>, and the other + <literal>NdbScanFilter</literal> methods of this type, + this method takes two parameters: - <itemizedlist> + <itemizedlist> - <listitem> - <para> - The ID (<replaceable>ColId</replaceable>) of the - column whose value is to be tested - </para> - </listitem> + <listitem> + <para> + The ID (<replaceable>ColId</replaceable>) of the + column whose value is to be tested + </para> + </listitem> - <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> + 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> - </itemizedlist> - </para> + </itemizedlist> + </para> - </formalpara> + </formalpara> - <formalpara> + <formalpara> - <title>Return Value</title> + <title>Return Value</title> - <para> - <literal>0</literal> on success, <literal>-1</literal> on - failure. - </para> + <para> + <literal>0</literal> on success, <literal>-1</literal> on + failure. + </para> - </formalpara> + </formalpara> <!-- <formalpara> @@ -34576,8 +34577,9 @@ </formalpara> --> + </section> + </section> - </section> <section id="class-ndbscanfilter-isnull">
| Thread | ||
|---|---|---|
| • svn commit - mysqldoc@docsrva: r4038 - trunk/ndbapi | jon | 27 Nov |
© 1995-2008 MySQL AB, 2008-2009 Sun Microsystems, Inc.
Page generated in 0.878 sec. using MySQL 5.1.14-beta-log