Author: jstephens
Date: 2006-06-17 07:08:53 +0200 (Sat, 17 Jun 2006)
New Revision: 2404
Log:
Index class members + misc. fixes.
Tweaks in template file.
Modified:
trunk/ndbapi/class-member-template.xml
trunk/ndbapi/ndb-classes.xml
Modified: trunk/ndbapi/class-member-template.xml
===================================================================
--- trunk/ndbapi/class-member-template.xml 2006-06-16 17:43:07 UTC (rev 2403)
+++ trunk/ndbapi/class-member-template.xml 2006-06-17 05:08:53 UTC (rev 2404)
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section SYSTEM "http://www.docbook.org/xml/4.3/docbookx.dtd">
-<section role="class-member">
+<section id="class-">
<title><literal></literal></title>
<formalpara>
@@ -43,7 +43,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
</formalpara>
Modified: trunk/ndbapi/ndb-classes.xml
===================================================================
--- trunk/ndbapi/ndb-classes.xml 2006-06-16 17:43:07 UTC (rev 2403)
+++ trunk/ndbapi/ndb-classes.xml 2006-06-17 05:08:53 UTC (rev 2404)
@@ -337,7 +337,7 @@
object:
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -453,7 +453,7 @@
method to initialise an <literal>Ndb</literal> object:
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -521,7 +521,7 @@
the current database:
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -590,7 +590,7 @@
current database:
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -658,7 +658,7 @@
name of the current database schema:
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -726,7 +726,7 @@
of the current database schema:
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -847,7 +847,7 @@
transaction:
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -926,7 +926,7 @@
instance of <literal>NdbTransaction</literal>:
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -997,7 +997,7 @@
database event:
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -1068,7 +1068,7 @@
subscription to a database event:
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -1191,7 +1191,7 @@
waiting in a given subscription queue:
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -1263,7 +1263,7 @@
to obtain the next event in a series of database events:
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -1362,7 +1362,7 @@
NDB API error:
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
The next example shows how to retrieve an
@@ -1371,7 +1371,7 @@
code:
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -1545,7 +1545,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -1641,7 +1641,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -1740,7 +1740,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -2411,7 +2411,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -2486,7 +2486,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -2561,7 +2561,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -2632,7 +2632,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -2730,7 +2730,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -2818,7 +2818,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -2883,7 +2883,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -2951,7 +2951,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -3020,7 +3020,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -3086,7 +3086,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -3162,7 +3162,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -3231,7 +3231,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -3308,7 +3308,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -3372,7 +3372,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -3438,7 +3438,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -3502,7 +3502,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -3567,7 +3567,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -3667,7 +3667,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -3772,7 +3772,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -4743,7 +4743,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -4807,7 +4807,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -4873,7 +4873,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -4939,7 +4939,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -5003,7 +5003,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -5071,7 +5071,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -5136,7 +5136,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -5210,7 +5210,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -5287,7 +5287,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -5352,7 +5352,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -5428,7 +5428,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -5500,7 +5500,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -5574,7 +5574,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -5639,7 +5639,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -5741,7 +5741,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -5806,7 +5806,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -5871,7 +5871,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -5945,7 +5945,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -6021,7 +6021,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -6095,7 +6095,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -6177,7 +6177,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -6256,7 +6256,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -6336,7 +6336,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -6410,7 +6410,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -6493,7 +6493,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -6572,7 +6572,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -6654,7 +6654,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -6733,7 +6733,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -6815,7 +6815,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -7601,19 +7601,19 @@
</row>
<row>
<entry><literal>getName()</literal></entry>
- <entry></entry>
+ <entry>Gets the name of the index</entry>
</row>
<row>
<entry><literal>getTable()</literal></entry>
- <entry></entry>
+ <entry>Gets the name of the table being indexed</entry>
</row>
<row>
<entry><literal>getNoOfColumns()</literal></entry>
- <entry></entry>
+ <entry>Gets the number of columns belonging to the index</entry>
</row>
<row>
<entry><literal>getColumn()</literal></entry>
- <entry></entry>
+ <entry>Gets a column making up (part of) the index</entry>
</row>
<row>
<entry><literal>getType()</literal></entry>
@@ -7782,12 +7782,1233 @@
<title><literal>Index</literal> Class Members</title>
-<!-- <abstract> -->
+ <abstract>
- <para/>
+ <para>
+ This section contain descriptions of all public methods of
+ the <literal>Index</literal> class. This class has
+ relatively few methods (compared to, say,
+ <literal>Table</literal>), which are fairly
+ straightforward to use.
+ </para>
-<!-- </abstract> -->
+ </abstract>
+ <important>
+ <para>
+ If you create or change indexes using the
+ <literal>NDB</literal> API, these modifications cannot be
+ seen by MySQL. The only exception to this is renaming the
+ index using <literal>Index::setName()</literal>.
+ </para>
+ </important>
+
+ <section id="class-index-constructor">
+
+ <title><literal>Index</literal> Class Constructor</title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This is used to create an new instance of
+ <literal>Index</literal>.
+ </para>
+
+ </formalpara>
+
+ <important>
+ <para>
+ Indexes created using the <literal>NDB</literal> API
+ cannot be seen by the MySQL Server.
+ </para>
+ </important>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+Index
+ (
+ const char* <replaceable>name</replaceable> = ""
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ The name of the new index. It is possible to create an
+ index without a name, and then assign a name to it later
+ using <literal>setName()</literal>. See
+ <xref linkend="class-index-setname"/>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ A new instance of <literal>Index</literal>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Destructor</title>
+
+ <para>
+ The destructor (<literal>~Index()</literal>) is supplied
+ as a virtual method.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-index-getname">
+
+ <title><literal>NdbDictionary::Object::Index::getName()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to obtain the name of an index.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+const char* getName
+ (
+ void
+ ) const
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The name of the index, as a constant character pointer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-index-gettable">
+
+ <title><literal>NdbDictionary::Object::Index::getTable()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method can be used to obtain the name of the table
+ to which the index belongs.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+const char* getTable
+ (
+ void
+ ) const
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The name of the table, as a constant character pointer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-index-getnoofcolumns">
+
+ <title><literal>NdbDictionary::Object::Index::getNoOfColumns()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to obtain the number of columns
+ making up the index.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+unsigned getNoOfColumns
+ (
+ void
+ ) const
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ An unsigned integer representing the number of columns
+ in the index.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-index-getcolumn">
+
+ <title><literal>NdbDictionary::Object::Index::getColumn()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method retrieves the column at the specified
+ position within the index.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+const Column* getColumn
+ (
+ unsigned <replaceable>no</replaceable>
+ ) const
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ The ordinal position number
+ <replaceable>no</replaceable> of the column, as an
+ unsigned integer. Use the
+ <literal>getNoOfColumns()</literal> method to determine
+ how many columns make up the index — see
+ <xref linkend="class-index-getnoofcolumns"/>, for
+ details.
+ </para>
+
+ </formalpara>
+
+ <remark role="todo">
+ [js] Do these positions start with 0 or 1?
+ </remark>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The column having position <replaceable>no</replaceable>
+ in the index, as a pointer to an instance of
+ <literal>Column</literal>. See
+ <xref linkend="class-column"/>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-index-gettype">
+
+ <title><literal>NdbDictionary::Object::Index::getType()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method can be used to find the type of index.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+Type getType
+ (
+ void
+ ) const
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ An index type. See <xref linkend="class-index-type"/>,
+ for possible values.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-index-getlogging">
+
+ <title><literal>NdbDictionary::Object::Index::getLogging()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ Use this method to determine whether logging to disk has
+ been enabled for the index.
+ </para>
+
+ </formalpara>
+
+ <note>
+ <para>
+ Indexes which are not logged are rebuilt when the
+ cluster is started or restarted.
+ </para>
+
+ <para>
+ Ordered indexes currently do not support logging to
+ disk; they are rebuilt each time the cluster is started.
+ (This includes restarts.)
+ </para>
+ </note>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+bool getLogging
+ (
+ void
+ ) const
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ A Boolean value:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>true</literal>: The index is being logged
+ to disk.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>false</literal>: The index is not being
+ logged.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-index-getobjectstatus">
+
+ <title><literal>NdbDictionary::Object::Index::getObjectStatus()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method gets the object status of the index.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+virtual Object::Status getObjectStatus
+ (
+ void
+ ) const
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ A <literal>Status</literal> value — see
+ <xref linkend="class-object-status"/>, for more
+ information.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-index-getobjectversion">
+
+ <title><literal>NdbDictionary::Object::Index::getObjectVersion()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method gets the object version of the index.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+virtual int getObjectVersion
+ (
+ void
+ ) const
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The object version for the index, as an integer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-index-getobjectid">
+
+ <title><literal>NdbDictionary::Object::Index::getObjectId()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to obtain the object ID of the
+ index.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+virtual int getObjectId
+ (
+ void
+ ) const
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The object ID, as an integer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-index-setname">
+
+ <title><literal>NdbDictionary::Object::Index::setName()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method sets the name of the index.
+ </para>
+
+ </formalpara>
+
+ <note>
+ <para>
+ This is the only
+ <literal>Index::set<replaceable>*</replaceable>()</literal>
+ method whose result is visible to a MySQL Server.
+ </para>
+ </note>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+void setName
+ (
+ const char* <replaceable>name</replaceable>
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ The desired <replaceable>name</replaceable> for the
+ index, as a constant character pointer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-index-settable">
+
+ <title><literal>NdbDictionary::Object::Index::setTable()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method sets the table that is to be indexed. The
+ table is referenced by name.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+void setTable
+ (
+ const char* <replaceable>name</replaceable>
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ The <replaceable>name</replaceable> of the table to be
+ indexed, as a constant character pointer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-index-addcolumn">
+
+ <title><literal>NdbDictionary::Object::Index::addColumn()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method may be used to add a column to an index.
+ </para>
+
+ </formalpara>
+
+ <note>
+ <para>
+ The order of the columns matches the order in which they
+ are added to the index. However, this matters only with
+ ordered indexes.
+ </para>
+ </note>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+void addColumn
+ (
+ const Column& <replaceable>c</replaceable>
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ A reference <replaceable>c</replaceable> to the column
+ which is to be added to the index.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-index-addcolumnname">
+
+ <title><literal>NdbDictionary::Object::Index::addColumnName()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method works in the same way as
+ <literal>addColumn()</literal>, except that it takes the
+ name of the column as a parameter. See
+ <xref linkend="class-index-getcolumn"/>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+void addColumnName
+ (
+ const char* <replaceable>name</replaceable>
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ The <replaceable>name</replaceable> of the column to be
+ added to the index, as a constant character pointer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-index-addcolumnnames">
+
+ <title><literal>NdbDictionary::Object::Index::addColumnNames()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to add several column names to an
+ index definition at one time.
+ </para>
+
+ </formalpara>
+
+ <note>
+ <para>
+ As with the <literal>addColumn()</literal> and
+ <literal>addColumnName()</literal> methods, the indexes
+ are numbered in the order in which they were added.
+ (However, this matters only for ordered indexes.)
+ </para>
+ </note>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+void addColumnNames
+ (
+ unsigned <replaceable>noOfNames</replaceable>,
+ const char** <replaceable>names</replaceable>
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ This method takes two parameters:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ The number of columns/names
+ <replaceable>noOfNames</replaceable> to be added
+ to the index.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <replaceable>names</replaceable> to be added
+ (as a pointer to a pointer).
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-index-settype">
+
+ <title><literal>NdbDictionary::Object::Index::setType()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to set the index type.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+void setType
+ (
+ Type <replaceable>type</replaceable>
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ The <replaceable>type</replaceable> of index. For
+ possible values, see <xref linkend="class-index-type"/>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-">
+
+ <title><literal></literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to enable or disable logging of the
+ index to disk.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+void setLogging
+ (
+ bool <replaceable>enable</replaceable>
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <literal>setLogging()</literal> takes a single Boolean
+ parameter <replaceable>enable</replaceable>. If
+ <replaceable>enable</replaceable> is
+ <literal>true</literal>, then logging is enabled for the
+ index; if false, then logging of this index is disabled.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ </section>
+
</section>
</section>
@@ -8320,7 +9541,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -8395,7 +9616,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -8458,7 +9679,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -8538,7 +9759,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -8610,7 +9831,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -8674,7 +9895,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -8740,7 +9961,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -8808,7 +10029,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -8878,7 +10099,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -8942,7 +10163,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -9006,7 +10227,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -9071,7 +10292,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -9137,7 +10358,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -9201,7 +10422,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -9266,7 +10487,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -9330,7 +10551,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -9395,7 +10616,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -9459,7 +10680,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -9523,7 +10744,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -9587,7 +10808,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -9651,7 +10872,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -9720,7 +10941,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -9784,7 +11005,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -9940,7 +11161,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -10005,7 +11226,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -10070,7 +11291,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -10133,7 +11354,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -10199,7 +11420,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -10267,7 +11488,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -10330,7 +11551,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -10398,7 +11619,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -10464,7 +11685,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -10530,7 +11751,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -10596,7 +11817,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -10669,7 +11890,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -10731,7 +11952,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -10798,7 +12019,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -10860,7 +12081,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -10924,7 +12145,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -10990,7 +12211,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -11064,7 +12285,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -11139,7 +12360,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -11215,7 +12436,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -11310,7 +12531,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -11376,7 +12597,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -11446,7 +12667,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -11535,7 +12756,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -11640,7 +12861,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -11727,7 +12948,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -11811,7 +13032,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -11900,7 +13121,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -11965,7 +13186,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -12031,7 +13252,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
@@ -12097,7 +13318,7 @@
<para>
<programlisting>
-[<emphasis>To be written...</emphasis>]
+[<emphasis>To be supplied...</emphasis>]
</programlisting>
</para>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r2404 - trunk/ndbapi | jon | 17 Jun |
