Author: jstephens
Date: 2006-06-15 10:05:27 +0200 (Thu, 15 Jun 2006)
New Revision: 2390
Log:
Reformat.
Modified:
trunk/ndbapi/ndb-classes.xml
Modified: trunk/ndbapi/ndb-classes.xml
===================================================================
--- trunk/ndbapi/ndb-classes.xml 2006-06-15 07:47:17 UTC (rev 2389)
+++ trunk/ndbapi/ndb-classes.xml 2006-06-15 08:05:27 UTC (rev 2390)
@@ -7958,681 +7958,801 @@
from MySQL. For example, if you add a new column to a
table using <literal>Table::addColumn()</literal>, MySQL
will not see the new column. The only exception to this
- rule with regard to tables is that you can change the
- name of an existing table using
+ rule with regard to tables is that you can change the name
+ of an existing table using
<literal>Table::setName()</literal>.
</para>
</warning>
-
+
<section id="class-table-constructor">
- <title><literal>Table</literal> Constructor</title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- Creates a <literal>Table</literal> instance. There
- are two version of the <literal>Table</literal> constructor, one
- for creating a new instance, and a copy constructor.
- </para>
- </formalpara>
-
+
+ <title><literal>Table</literal> Constructor</title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ Creates a <literal>Table</literal> instance. There are
+ two version of the <literal>Table</literal> constructor,
+ one for creating a new instance, and a copy constructor.
+ </para>
+
+ </formalpara>
+
<important>
<para>
Tables created in the <literal>NDB</literal> API using
this method are not accessible from MySQL.
</para>
</important>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
- New instance:
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+ New instance:
+
<programlisting>
Table
(
const char* <replaceable>name</replaceable> = ""
)
</programlisting>
- Copy constructor:
+
+ Copy constructor:
+
<programlisting>
Table
(
const Table& <replaceable>table</replaceable>
)
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- For a new instance, the name of the table to be created. For a
- copy, a reference to the table to be copied.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- A <literal>Table</literal> object.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ For a new instance, the name of the table to be created.
+ For a copy, a reference to the table to be copied.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ A <literal>Table</literal> object.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
+ </para>
+
+ </formalpara>
+
<formalpara>
+
<title>Destructor</title>
+
<para>
<programlisting>
virtual ~Table()
</programlisting>
</para>
+
</formalpara>
-
-
-
+
</section>
-
+
<section id="class-table-getname">
- <title><literal>NdbDictionary::Object::Table:getName()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- Gets the name of a table.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table:getName()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ Gets the name of a table.
+ </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 table (a string).
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The name of the table (a string).
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
-</section>
+ </para>
+ </formalpara>
+
+ </section>
+
<section id="class-table-getid">
- <title><literal>NdbDictionary::Object::Table::getId()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method gets a table's ID.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::getId()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method gets a table's ID.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
int getTableId
(
void
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- An integer.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ An integer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-getcolumn">
- <title><literal>NdbDictionary::Object::Table::getColumn()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method is used to obtain a column definition, given either
- the index or the name of the column.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
- Using the column ID:
+
+ <title><literal>NdbDictionary::Object::Table::getColumn()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to obtain a column definition, given
+ either the index or the name of the column.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+ Using the column ID:
+
<programlisting>
Column* getColumn
(
const int <replaceable>AttributeId</replaceable>
)
</programlisting>
- Using the column name:
+
+ Using the column name:
+
<programlisting>
Column* getColumn
(
const char* <replaceable>name</replaceable>
)
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- Either of: the column's index in the table (as would be returned
- by the column's <literal>getColumnNo()</literal> method), or the
- name of the column.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- A pointer to the the column with the specified index or name. If
- there is no such column, then this method returns
- <literal>NULL</literal>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ Either of: the column's index in the table (as would be
+ returned by the column's
+ <literal>getColumnNo()</literal> method), or the name of
+ the column.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ A pointer to the the column with the specified index or
+ name. If there is no such column, then this method
+ returns <literal>NULL</literal>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-getlogging">
- <title><literal>NdbDictionary::Object::Table::getLogging()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This class is used to check whether a table is logged to disk — that
- is, whether it is permanent or temporary.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::getLogging()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This class is used to check whether a table is logged to
+ disk — that is, whether it is permanent or
+ temporary.
+ </para>
+
+ </formalpara>
+
+ <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>
- Returns a Boolean value. If this method returns
- <literal>true</literal>, then full checkpointing and logging are
- done on the table. If <literal>false</literal>, then the table is
- a temporary table and is not logged to disk; in the event of a
- system restart the table still exists and retains its definition,
- but it will be empty. The default logging value is
- <literal>true</literal>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ Returns a Boolean value. If this method returns
+ <literal>true</literal>, then full checkpointing and
+ logging are done on the table. If
+ <literal>false</literal>, then the table is a temporary
+ table and is not logged to disk; in the event of a
+ system restart the table still exists and retains its
+ definition, but it will be empty. The default logging
+ value is <literal>true</literal>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-getfragmentationtype">
- <title><literal>NdbDictionary::Object::Table::getFragmentationType()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method gets the table's fragmentation type.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::getFragmentationType()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method gets the table's fragmentation type.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
FragmentType getFragmentType
(
void
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- A <literal>FragmentType</literal> value, as defined in
- <xref linkend="class-object-fragmenttype"/>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ A <literal>FragmentType</literal> value, as defined in
+ <xref linkend="class-object-fragmenttype"/>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-getkvalue">
- <title><literal>NdbDictionary::Object::Table::getKValue()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method gets the KValue, a hashing parameter which is
- currently restricted to the value <literal>6</literal>. In a
- future release, it may become feasible to set this parameter to
- other values.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::getKValue()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method gets the KValue, a hashing parameter which
+ is currently restricted to the value
+ <literal>6</literal>. In a future release, it may become
+ feasible to set this parameter to other values.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
int getKValue
(
void
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- An integer (currently always <literal>6</literal>).
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ An integer (currently always <literal>6</literal>).
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-getminloadfactor">
- <title><literal>NdbDictionary::Object::Table::getMinLoadFactor()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method gets the value of the load factor when reduction of
- the hash table begins. This should always be less than the value
- returned by <literal>getMaxLoadFactor()</literal>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::getMinLoadFactor()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method gets the value of the load factor when
+ reduction of the hash table begins. This should always
+ be less than the value returned by
+ <literal>getMaxLoadFactor()</literal>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
int getMinLoadFactor
(
void
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- An integer (actually, a percentage expressed as an integer —
- see <xref linkend="class-table-getmaxloadfactor"/>).
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ An integer (actually, a percentage expressed as an
+ integer — see
+ <xref linkend="class-table-getmaxloadfactor"/>).
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-getmaxloadfactor">
- <title><literal>NdbDictionary::Object::Table::getMaxLoadFactor()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method returns the load factor (a hashing parameter) when
- splitting of the containers in the local hash tables begins.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::getMaxLoadFactor()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method returns the load factor (a hashing
+ parameter) when splitting of the containers in the local
+ hash tables begins.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
int getMaxLoadFactor
(
void
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- An integer whose maximum value is 100. When the maximum value is
- returned, this means that memory usage is optimised. Smaller
- values indicate that less data is stored in each container, which
- means that keys are found more quickly; however, this also
- consumes more memory.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ An integer whose maximum value is 100. When the maximum
+ value is returned, this means that memory usage is
+ optimised. Smaller values indicate that less data is
+ stored in each container, which means that keys are
+ found more quickly; however, this also consumes more
+ memory.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-getnoofcolumns">
- <title><literal>NdbDictionary::Object::Table::getNoOfCOlumns()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method is used to obtain the number of columns in a table.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::getNoOfCOlumns()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to obtain the number of columns in a
+ table.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
int getNoOfColumns
(
void
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- An integer — the number of columns in the table.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ An integer — the number of columns in the table.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-getnoofprimarykeys">
- <title><literal>NdbDictionary::Object::Table::getNoOfPrimaryKeys()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method finds the number of primary key columns in the table.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::getNoOfPrimaryKeys()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method finds the number of primary key columns in
+ the table.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
int getNoOfPrimaryKeys
(
void
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- An integer.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ An integer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-getprimarykey">
+
<title><literal>NdbDictionary::Object::Table::getPrimaryKey()</literal></title>
-
+
<formalpara>
+
<title>Description</title>
-
+
<para>
This method is used to obtain the name of the table's
primary key.
</para>
+
</formalpara>
-
+
<formalpara>
+
<title>Signature</title>
-
+
<para>
<programlisting>
const char* getPrimaryKey
@@ -8641,673 +8761,796 @@
) const
</programlisting>
</para>
+
</formalpara>
-
+
<formalpara>
+
<title>Parameters</title>
-
+
<para>
<emphasis>None</emphasis>.
</para>
+
</formalpara>
-
+
<formalpara>
+
<title>Return Value</title>
-
+
<para>
The name of the primary key, a string (charracter
pointer).
</para>
+
</formalpara>
-
+
<formalpara>
+
<title>Example</title>
-
+
<para>
-
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
</para>
+
</formalpara>
-
-
+
</section>
-
-
+
<section id="class-table-equal">
- <title><literal>NdbDictionary::Object::Table::equal()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method is used to compare one instance of
- <literal>Table</literal> with another.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::equal()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to compare one instance of
+ <literal>Table</literal> with another.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
bool equal
(
const Table& <replaceable>table</replaceable>
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- A reference to the <literal>Table</literal> object with which the
- current instance is to be compared.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- <literal>true</literal> if the two tables are the same, otherwise <literal>false</literal>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ A reference to the <literal>Table</literal> object with
+ which the current instance is to be compared.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <literal>true</literal> if the two tables are the same,
+ otherwise <literal>false</literal>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
-</section>
-<section id="class-table-getfrmdata">
- <title><literal>NdbDictionary::Object::Table::getFrmData()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- The the data from the <filename>.FRM</filename> file associated with the table.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-table-getfrmdata">
+
+ <title><literal>NdbDictionary::Object::Table::getFrmData()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ The the data from the <filename>.FRM</filename> file
+ associated with the table.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
const void* getFrmData
(
void
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- A pointer to the <filename>.FRM</filename> data.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ A pointer to the <filename>.FRM</filename> data.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
-</section>
+ </para>
+ </formalpara>
+
+ </section>
+
<section id="class-table-getfrmlength">
- <title><literal>NdbDictionary::Object::Table::getFrmLength()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- Gets the length of the table's <filename>.FRM</filename>
- file data, in bytes.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::getFrmLength()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ Gets the length of the table's <filename>.FRM</filename>
+ file data, in bytes.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
Uint32 getFrmLength
(
void
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- The length of the <filename>.FRM</filename> file data (unsigned 32-bit integer).
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The length of the <filename>.FRM</filename> file data
+ (unsigned 32-bit integer).
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-getfragmentdata">
- <title><literal>NdbDictionary::Object::Table::getFragmentData()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method gets the table's fragment data (ID, state, and
- node group).
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::getFragmentData()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method gets the table's fragment data (ID, state,
+ and node group).
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
const void* getFragmentData
(
void
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- A pointer to the data to be read.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ A pointer to the data to be read.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
-</section>
-<section id="class-table-getfragmentdatalen">
- <title><literal>NdbDictionary::Object::Table::getFragmentDataLen()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- Gets the length of the table fragment data to be read, in bytes.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-table-getfragmentdatalen">
+
+ <title><literal>NdbDictionary::Object::Table::getFragmentDataLen()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ Gets the length of the table fragment data to be read,
+ in bytes.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
Uint32 getFragmentDataLen
(
void
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- The number of bytes to be read, as an unsigned 32-bit integer.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The number of bytes to be read, as an unsigned 32-bit
+ integer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
-</section>
-
+ </para>
+
+ </formalpara>
+
+ </section>
+
<section id="class-table-getrangelistdata">
- <title><literal>NdbDictionary::Object::Table::getRangeListData()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method gets the range or list data associated with the
- table.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::getRangeListData()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method gets the range or list data associated with
+ the table.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
const void* getRangeListData
(
void
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- A pointer to the data.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ A pointer to the data.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
-</section>
+ </para>
-<section id="class-table-getrangelistdatalen">
- <title><literal>NdbDictionary::Object::Table::getRangeListDataLen()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method gets the size of the table's range or list array.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+ </formalpara>
+
+ </section>
+
+ <section id="class-table-getrangelistdatalen">
+
+ <title><literal>NdbDictionary::Object::Table::getRangeListDataLen()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method gets the size of the table's range or list
+ array.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
Uint32 getRangeListDataLen
(
void
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- The length of the list or range array, as an integer.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The length of the list or range array, as an integer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
-</section>
-
+ </para>
+
+ </formalpara>
+
+ </section>
+
<section id="class-table-gettablespacedata">
- <title><literal>NdbDictionary::Object::Table::getTablespaceData()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method gets the table's tablespace data (ID and version).
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::getTablespaceData()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method gets the table's tablespace data (ID and
+ version).
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
const void* getTablespaceData
(
void
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- A pointer to the data.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ A pointer to the data.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
-</section>
+ </para>
-<section id="class-table-gettablespacedatalen">
- <title><literal>NdbDictionary::Object::Table::getTablespaceDataLen()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method is used to get the length of the table's tablespace
- data.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+ </formalpara>
+
+ </section>
+
+ <section id="class-table-gettablespacedatalen">
+
+ <title><literal>NdbDictionary::Object::Table::getTablespaceDataLen()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to get the length of the table's
+ tablespace data.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
Uint32 getTablespaceDataLen
(
void
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- The length of the data, as a 32-bit unsigned integer.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The length of the data, as a 32-bit unsigned integer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
-</section>
-
+ </para>
+
+ </formalpara>
+
+ </section>
+
<section id="class-table-getlinearflag">
- <title><literal>NdbDictionary::Object::Table::getLinearFlag()</literal></title>
-
+
+ <title><literal>NdbDictionary::Object::Table::getLinearFlag()</literal></title>
+
<remark role="todo">
[js] Find out why we get a Boolean, but set a Uint32.
</remark>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method retrieves the value of the table's linear hashing flag.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method retrieves the value of the table's linear
+ hashing flag.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
bool getLinearFlag
(
void
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- <literal>true</literal> if the flag is set, and <literal>false</literal> if it is not.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <literal>true</literal> if the flag is set, and
+ <literal>false</literal> if it is not.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-getfragmentcount">
- <title><literal>NdbDictionary::Object::Table::getFragmentCount()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method gets the number of fragments in the table.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::getFragmentCount()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method gets the number of fragments in the table.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
Uint32 getFragmentCount
(
void
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- The number of table fragments, as a 32-bit unsigned integer.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The number of table fragments, as a 32-bit unsigned
+ integer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-gettablespace">
- <title><literal></literal></title>
-
+
+ <title><literal></literal></title>
+
<remark role="todo">
[js] Is this description correct? Im assuming it must be
something like this, given the method signatures...
</remark>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method is used in two ways: to obtain the name of the
- tablespace to which this table is assigned; to verify that a given
- tablespace is the one being used by this table.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signatures</title>
-
- <para>
- To obtain the name of the tablespace:
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used in two ways: to obtain the name of
+ the tablespace to which this table is assigned; to
+ verify that a given tablespace is the one being used by
+ this table.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signatures</title>
+
+ <para>
+ To obtain the name of the tablespace:
+
<programlisting>
const char* getTablespace
(
void
) const
</programlisting>
- To determine whether the tablespace is the one indicated by the
- given ID and version:
+
+ To determine whether the tablespace is the one indicated
+ by the given ID and version:
+
<programlisting>
bool getTablespace
(
@@ -9316,1395 +9559,1647 @@
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- The number and types of parameters depend on how this method is
- being used:
-
- <itemizedlist>
- <listitem>
- <para>
- When used to obtain the name of the tablespace in use by the
- table, it is called without any arguments.
- </para>
- </listitem>
- <listitem>
- <para>
- When used to determine whether the given tablespace is the
- one being used by this table, then getTablespace() takes two
- parameters:
- <orderedlist>
- <listitem>
- <para>
- The tablespace <replaceable>id</replaceable>, given as
- a pointer to a 32-bit unsigned integer
- </para>
- </listitem>
- <listitem>
- <para>
- The tablespace <replaceable>version</replaceable>, also given as
- a pointer to a 32-bit unsigned integer
- </para>
- </listitem>
- </orderedlist>
- The default value for both <replaceable>id</replaceable> and
- <replaceable>version</replaceable> is <literal>0</literal>.
- </para>
- </listitem></itemizedlist>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- The return type depends on how the method is called.
- <itemizedlist>
- <listitem>
- <para>
- When <literal>getTablespace()</literal> is called without any arguments, it
- returns a <literal>Tablespace</literal> object instance. See
- <xref linkend="class-tablespace"/>, for more information.
- </para>
- </listitem>
-
- <listitem>
- <para>
- When called with two arguments, it returns <literal>true</literal> if the
- tablespace is the same as the one having the ID and version
- indicated; otherwise, it returns <literal>false</literal>.
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Examples</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ The number and types of parameters depend on how this
+ method is being used:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ When used to obtain the name of the tablespace in
+ use by the table, it is called without any
+ arguments.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ When used to determine whether the given
+ tablespace is the one being used by this table,
+ then getTablespace() takes two parameters:
+
+ <orderedlist>
+
+ <listitem>
+ <para>
+ The tablespace
+ <replaceable>id</replaceable>, given as a
+ pointer to a 32-bit unsigned integer
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The tablespace
+ <replaceable>version</replaceable>, also
+ given as a pointer to a 32-bit unsigned
+ integer
+ </para>
+ </listitem>
+
+ </orderedlist>
+
+ The default value for both
+ <replaceable>id</replaceable> and
+ <replaceable>version</replaceable> is
+ <literal>0</literal>.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The return type depends on how the method is called.
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ When <literal>getTablespace()</literal> is called
+ without any arguments, it returns a
+ <literal>Tablespace</literal> object instance. See
+ <xref linkend="class-tablespace"/>, for more
+ information.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ When called with two arguments, it returns
+ <literal>true</literal> if the tablespace is the
+ same as the one having the ID and version
+ indicated; otherwise, it returns
+ <literal>false</literal>.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Examples</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-getobjecttype">
- <title><literal>NdbDictionary::Object::Table::getObjectType()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method is used to obtain the table's type — that is, its
- <literal>Object::Type</literal> value
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::getObjectType()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to obtain the table's type —
+ that is, its <literal>Object::Type</literal> value
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
Object::Type getObjectType
(
void
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- Returns a <literal>Type</literal> value. For possible values,
- see <xref linkend="class-object-type"/>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ Returns a <literal>Type</literal> value. For possible
+ values, see <xref linkend="class-object-type"/>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-getstatus">
- <title><literal>NdbDictionary::Object::Table::getStatus()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method gets the table's status — that is, its
- <literal>Object::Status</literal>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::getStatus()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method gets the table's status — that is, its
+ <literal>Object::Status</literal>.
+ </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. For possible values, see
- <xref linkend="class-object-status"/>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ A <literal>Status</literal> value. For possible values,
+ see <xref linkend="class-object-status"/>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-getobjectversion">
- <title><literal>NdbDictionary::Object::Table::getObjectVersion()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method gets the table's object version.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::getObjectVersion()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method gets the table's object version.
+ </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 table's object version, as an integer.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The table's object version, as an integer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-getmaxrows">
- <title><literal>NdbDictionary::Object::Table::getMaxRows()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method gets the maximum number of rows that the table can
- hold. This is used for calculating the number of partitions.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::getMaxRows()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method gets the maximum number of rows that the
+ table can hold. This is used for calculating the number
+ of partitions.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
Uint64 getMaxRows
(
void
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- The maximum number of table rows, as a 64-bit unsigned integer.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The maximum number of table rows, as a 64-bit unsigned
+ integer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-getdefaultnopartitionsflag">
- <title><literal>NdbDictionary::Object::Table::getDefaultNoPartitionsFlag()</literal></title>
-
+
+ <title><literal>NdbDictionary::Object::Table::getDefaultNoPartitionsFlag()</literal></title>
+
<remark role="todo">
[js] Shouldn't this return a true/false value?
</remark>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method is used to find out whether the default number of
- partitions is used for the table.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to find out whether the default
+ number of partitions is used for the table.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
Uint32 getDefaultNoPartitionsFlag
(
void
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- A 32-bit unsigned integer.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ A 32-bit unsigned integer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-getobjectid">
- <title><literal>NdbDictionary::Object::Table::getObjectId()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method gets the table's object ID.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::getObjectId()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method gets the table's object ID.
+ </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 is returned as an integer.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The object ID is returned as an integer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-gettablespacenames">
- <title><literal>NdbDictionary::Object::Table::getTablespaceNames()</literal></title>
-
+
+ <title><literal>NdbDictionary::Object::Table::getTablespaceNames()</literal></title>
+
<remark role="todo">
[js] Check description...?
</remark>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method gets a pointer to the names of the tablespaces used in
- the table fragments.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method gets a pointer to the names of the
+ tablespaces used in the table fragments.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
const void* getTablespaceNames
(
void
)
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- A pointer to the tablespace name data.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ A pointer to the tablespace name data.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-gettablespacenameslen">
- <title><literal>NdbDictionary::Object::Table::getTablespaceNamesLen()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method gets the length of the tablespace name data returned
- by <literal>getTablespaceNames()</literal>. (See
- <xref linkend="class-table-gettablespacenames"/>.)
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::getTablespaceNamesLen()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method gets the length of the tablespace name data
+ returned by <literal>getTablespaceNames()</literal>.
+ (See <xref linkend="class-table-gettablespacenames"/>.)
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
Uint32 getTablespaceNamesLen
(
void
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- The length of the names data, in bytes, as a 32-but unsigned
- iinteger.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ The length of the names data, in bytes, as a 32-but
+ unsigned iinteger.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-getrowgciindicator">
- <title><literal>NdbDictionary::Object::Table::getRowGCIIndicator()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- <remark role="todo">
- [js] No description in sources.
- </remark>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::getRowGCIIndicator()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ <remark role="todo">
+ [js] No description in sources.
+ </remark>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
bool getRowGCIIndicator
(
void
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- A <literal>true</literal>/<literal>false</literal> value.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ A <literal>true</literal>/<literal>false</literal>
+ value.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
-</section><section id="class-table-getrowchecksumindicator">
- <title><literal>NdbDictionary::Object::Table::getRowChecksumIndicator()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
-
- <remark role="todo">
- [js] No description in sources.
- </remark>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-table-getrowchecksumindicator">
+
+ <title><literal>NdbDictionary::Object::Table::getRowChecksumIndicator()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ <remark role="todo">
+ [js] No description in sources.
+ </remark>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
bool getRowChecksumIndicator
(
void
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- A <literal>true</literal>/<literal>false</literal> value.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ A <literal>true</literal>/<literal>false</literal>
+ value.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
-</section>
-
-<section id="class-table-setname">
- <title><literal>NdbDictionary::Object::Table::setName()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method sets the name of the table.
- </para>
- </formalpara>
-
- <note>
- <para>
- This is the only
- <literal>set<replaceable>*</replaceable>()</literal> method of
- <literal>Table</literal> whose effects are visible to MySQL.
- </para>
- </note>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-table-setname">
+
+ <title><literal>NdbDictionary::Object::Table::setName()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method sets the name of the table.
+ </para>
+
+ </formalpara>
+
+ <note>
+ <para>
+ This is the only
+ <literal>set<replaceable>*</replaceable>()</literal>
+ method of <literal>Table</literal> whose effects are
+ visible to MySQL.
+ </para>
+ </note>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
void setName
(
const char* <replaceable>name</replaceable>
)
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <replaceable>name</replaceable> is the (new) name of the table.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <replaceable>name</replaceable> is the (new) name of the
+ table.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
-</section>
-<section id="class-table-addcolumn">
- <title><literal>NdbDictionary::Object::Table::addColumn()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- Adds a column to a table.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-table-addcolumn">
+
+ <title><literal>NdbDictionary::Object::Table::addColumn()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ Adds a column to a table.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
void addColumn(const Column& <replaceable>column</replaceable>)
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- A reference to the column which is to be added to the table.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- <emphasis>None</emphasis>; however, it does create a copy of the
- original <literal>Column</literal> object.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ A reference to the column which is to be added to the
+ table.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>; however, it does create a
+ copy of the original <literal>Column</literal> object.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
-</section>
-<section id="class-table-setlogging">
- <title><literal>NdbDictionary::Object::Table::setLogging()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- Toggles the table's logging state. See
- <xref linkend="class-table-getlogging"/>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-table-setlogging">
+
+ <title><literal>NdbDictionary::Object::Table::setLogging()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ Toggles the table's logging state. See
+ <xref linkend="class-table-getlogging"/>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
void setLogging
(
bool <replaceable>enable</replaceable>
)
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- If <replaceable>enable</replaceable> is <literal>true</literal>,
- then logging for this table is enabled; if it is
- <literal>false</literal>, then logging is disabled.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ If <replaceable>enable</replaceable> is
+ <literal>true</literal>, then logging for this table is
+ enabled; if it is <literal>false</literal>, then logging
+ is disabled.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
-</section>
+ </para>
+ </formalpara>
+
+ </section>
+
<section id="class-table-setlinearflag">
- <title><literal>NdbDictionary::Object::Table::setLinearFlag()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
-
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::setLinearFlag()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para></para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
void setLinearFlag
(
Uint32 <replaceable>flag</replaceable>
)
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- The <replaceable>flag</replaceable> is a 32-bit unsigned integer.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ The <replaceable>flag</replaceable> is a 32-bit unsigned
+ integer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
<section id="class-table-setfragmentcount">
- <title><literal>NdbDictionary::Object::Table::setFragmentCount()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- Sets the number of table fragments.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::setFragmentCount()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ Sets the number of table fragments.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
void setFragmentCount
(
Uint32 <replaceable>count</replaceable>
)
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <replaceable>count</replaceable> is the number of fragments to be
- used for the table.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <replaceable>count</replaceable> is the number of
+ fragments to be used for the table.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
-</section>
+ </para>
+ </formalpara>
+
+ </section>
+
<section id="class-table-setfragmenttype">
- <title><literal>NdbDictionary::Object::Table::setFragmentType()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method sets the table's fragmentation type.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::setFragmentType()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method sets the table's fragmentation type.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
void setFragmentType
(
FragmentType <replaceable>fragmentType</replaceable>
)
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- This method takes one argument, a <literal>FragmentType</literal>
- value. See <xref linkend="class-object-fragmenttype"/>, for more
- information.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ This method takes one argument, a
+ <literal>FragmentType</literal> value. See
+ <xref linkend="class-object-fragmenttype"/>, for more
+ information.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-setkvalue">
- <title><literal>NdbDictionary::Object::Table::setKValue()</literal></title>
-
+
+ <title><literal>NdbDictionary::Object::Table::setKValue()</literal></title>
+
<remark role="todo">
[js] Do we actually need to include getKValue() and
setKValue()? Seem not to be very useful, at least at
present... If were going to leave these in, then we should
explain what KValue actually is and does.
</remark>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This sets the <literal>KValue</literal>, a hashing parameter.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This sets the <literal>KValue</literal>, a hashing
+ parameter.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
void setKValue
(
int <replaceable>kValue</replaceable>
)
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <replaceable>kValue</replaceable> is an integer. Currently the
- only permitted value is <literal>6</literal>. In a future version this may become a
- variable parameter.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <replaceable>kValue</replaceable> is an integer.
+ Currently the only permitted value is
+ <literal>6</literal>. In a future version this may
+ become a variable parameter.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-setminloadfactor">
- <title><literal>NdbDictionary::Object::Table::setMinLoadFactor()</literal></title>
-
+
+ <title><literal>NdbDictionary::Object::Table::setMinLoadFactor()</literal></title>
+
<remark role="todo">
[js] This is another one we need to provide some coherent
explanation for... Like what exactly these load factors
do, and whats meant by shrinking the hash table...
</remark>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method sets the minimum load factor when reduction of the
- hash table bigns.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method sets the minimum load factor when reduction
+ of the hash table bigns.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
void setMinLoadFactor
(
int <replaceable>min</replaceable>
)
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- This maethod takes a single parameter
- <replaceable>min</replaceable>, an integer representation of a
- percentage (for example, <literal>45</literal> represents 45
- percent). For more information, see
- <xref linkend="class-table-getminloadfactor"/>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ This maethod takes a single parameter
+ <replaceable>min</replaceable>, an integer
+ representation of a percentage (for example,
+ <literal>45</literal> represents 45 percent). For more
+ information, see
+ <xref linkend="class-table-getminloadfactor"/>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
-</section>
+ </para>
-
+ </formalpara>
+
+ </section>
+
<section id="class-table-setmaxloadfactor">
- <title><literal>NdbDictionary::Object::Table::setMaxLoadFactor()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method sets the maximum load factor when splitting the
- containers in the local hash tables.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::setMaxLoadFactor()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method sets the maximum load factor when splitting
+ the containers in the local hash tables.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
void setMaxLoadFactor
(
int <replaceable>max</replaceable>
)
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- This maethod takes a single parameter
- <replaceable>max</replaceable>, an integer representation of a
- percentage (for example, <literal>45</literal> represents 45
- percent). For more information, see
- <xref linkend="class-table-getmaxloadfactor"/>.
- </para>
- </formalpara>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ This maethod takes a single parameter
+ <replaceable>max</replaceable>, an integer
+ representation of a percentage (for example,
+ <literal>45</literal> represents 45 percent). For more
+ information, see
+ <xref linkend="class-table-getmaxloadfactor"/>.
+ </para>
+
+ </formalpara>
+
<caution>
<para>
This should never be greater than the minimum load
factor.
</para>
</caution>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-settablespace">
- <title><literal>NdbDictionary::Object::Table::setTablespace()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method sets the tablespace for the table.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signatures</title>
-
- <para>
- Using the name of the tablespace:
+
+ <title><literal>NdbDictionary::Object::Table::setTablespace()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method sets the tablespace for the table.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signatures</title>
+
+ <para>
+ Using the name of the tablespace:
+
<programlisting>
void setTablespace
(
const char* <replaceable>name</replaceable>
)
</programlisting>
- Using a <literal>Tablespace</literal> object:
+
+ Using a <literal>Tablespace</literal> object:
+
<programlisting>
void setTablespace
(
const class Tablespace& <replaceable>tablespace</replaceable>
)
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- This method can be called with a single argument of either of two
- types:
- <orderedlist>
- <listitem>
- <para>
- The <replaceable>name</replaceable> of the tablespace (a
- string).
- </para>
- </listitem>
-
- <listitem>
- <para>
- A reference to an existing <literal>Tablespace</literal>
- instance.
- </para>
- </listitem>
- </orderedlist>
- See <xref linkend="class-tablespace"/>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Examples</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ This method can be called with a single argument of
+ either of two types:
+
+ <orderedlist>
+
+ <listitem>
+ <para>
+ The <replaceable>name</replaceable> of the
+ tablespace (a string).
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ A reference to an existing
+ <literal>Tablespace</literal> instance.
+ </para>
+ </listitem>
+
+ </orderedlist>
+
+ See <xref linkend="class-tablespace"/>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Examples</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-setmaxrows">
- <title><literal>NdbDictionary::Object::Table::setMaxRows()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method sets the maximum number of rows that can be held by
- the table.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::setMaxRows()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method sets the maximum number of rows that can be
+ held by the table.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
void setMaxRows
(
Uint64 <replaceable>maxRows</replaceable>
)
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- <replaceable>maxRows</replaceable> is a 64-bit unsigned integer
- that represents the maximum number of rows to be held in the table.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <replaceable>maxRows</replaceable> is a 64-bit unsigned
+ integer that represents the maximum number of rows to be
+ held in the table.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
-</section>
-
+ </para>
+
+ </formalpara>
+
+ </section>
+
<section id="class-table-setdefaultnopartitionsflag">
- <title><literal>NdbDictionary::Object::Table::setDefaultNoPartitionsFlag()</literal></title>
-
+
+ <title><literal>NdbDictionary::Object::Table::setDefaultNoPartitionsFlag()</literal></title>
+
<remark role="todo">
[js] Shouldn't this use a true/false value?
</remark>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method sets an indicator that determines whether the default number of
- partitions is used for the table.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method sets an indicator that determines whether
+ the default number of partitions is used for the table.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
void setDefaultNoPartitionsFlag
(
Uint32 <replaceable>indicator</replaceable>
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- This method takes a single argument
- <replaceable>indicator</replaceable>, a 32-bit unsigned integer.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ This method takes a single argument
+ <replaceable>indicator</replaceable>, a 32-bit unsigned
+ integer.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-setfrm">
- <title><literal>NdbDictionary::Object::Table::setFrm()</literal></title>
-
+
+ <title><literal>NdbDictionary::Object::Table::setFrm()</literal></title>
+
<remark role="todo">
[js] The description in Dictionary.hpp reads: "Set frm
file to store with this table" which makes no sense
whatsoever, given this method's parameters...
</remark>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method is used to write data to this table's <filename>.FRM</filename> file.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to write data to this table's
+ <filename>.FRM</filename> file.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
void setFrm
(
@@ -10712,72 +11207,104 @@
Uint32 <replaceable>len</replaceable>
)
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- This method takes two arguments:
- <itemizedlist>
- <listitem>
- <para>
- A pointer to the <replaceable>data</replaceable> to be written.
- </para>
- </listitem>
-
- <listitem>
- <para>
- The length (<replaceable>len</replaceable>) of the data.
- </para>
- </listitem>
- </itemizedlist>
-
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ This method takes two arguments:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ A pointer to the <replaceable>data</replaceable>
+ to be written.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The length (<replaceable>len</replaceable>) of the
+ data.
+ </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 written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-setfragmentdata">
- <title><literal>NdbDictionary::Object::Table::setFragmentData()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method writes an array of fragment information containing the
- following information:
-<itemizedlist> <listitem><para>Fragment ID</para></listitem>
-<listitem> <para>Node group ID</para></listitem>
-<listitem> <para>Fragment State</para></listitem></itemizedlist>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::setFragmentData()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method writes an array of fragment information
+ containing the following information:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ Fragment ID
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Node group ID
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Fragment State
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
void setFragmentData
(
@@ -10785,75 +11312,86 @@
Uint32 <replaceable>len</replaceable>
)
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- This method takes two parameters:
- <itemizedlist>
- <listitem>
- <para>
- A pointer to the fragment <replaceable>data</replaceable> to
- be written
- </para>
- </listitem>
-
- <listitem>
- <para>
- The length (<replaceable>len</replaceable>) of this data, in
- bytes, as a 32-bit unsigned integer
- </para>
- </listitem>
- </itemizedlist>
-
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ This method takes two parameters:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ A pointer to the fragment
+ <replaceable>data</replaceable> to be written
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The length (<replaceable>len</replaceable>) of
+ this data, in bytes, as a 32-bit unsigned integer
+ </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 written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
-
+
<section id="class-table-settablespacenames">
- <title><literal>NdbDictionary::Object::Table::setTablespaceNames()</literal></title>
-
+
+ <title><literal>NdbDictionary::Object::Table::setTablespaceNames()</literal></title>
+
<remark role="todo">
[js] This description is also clear as mud...
</remark>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- Sets the names of the tablespaces used by the table fragments.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ Sets the names of the tablespaces used by the table
+ fragments.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
void setTablespaceNames
(
@@ -10861,69 +11399,83 @@
Uint32 <replaceable>len</replaceable>
)
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- This method takes two parameters:
- <itemizedlist>
- <listitem>
- <para>
- A pointer to the tablespace names <replaceable>data</replaceable>
- </para>
- </listitem>
- <listitem>
- <para>
- The length (<replaceable>len</replaceable>) of the names
- data, as a 32-bit unsigned integer.
- </para>
- </listitem>
- </itemizedlist>
-
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ This method takes two parameters:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ A pointer to the tablespace names
+ <replaceable>data</replaceable>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The length (<replaceable>len</replaceable>) of the
+ names data, as a 32-bit unsigned integer.
+ </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 written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-settablespacedata">
- <title><literal>NdbDictionary::Object::Table::setTablespaceData()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method sets the tablespace information for each fragment, and
- includes a tablespace ID and a tablespace version.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::setTablespaceData()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method sets the tablespace information for each
+ fragment, and includes a tablespace ID and a tablespace
+ version.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
void setTablespaceData
(
@@ -10931,75 +11483,87 @@
Uint32 <replaceable>len</replaceable>
)
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- This method requires two parameters:
- <itemizedlist>
- <listitem>
- <para>
- A pointer to the <replaceable>data</replaceable> containing the tablespace ID and
- version
- </para>
- </listitem>
-
- <listitem>
- <para>
- The length (<replaceable>len</replaceable>) of this data, as
- a 32-bit unsigned integer.
- </para>
- </listitem>
- </itemizedlist>
-
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ This method requires two parameters:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ A pointer to the <replaceable>data</replaceable>
+ containing the tablespace ID and version
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The length (<replaceable>len</replaceable>) of
+ this data, as a 32-bit unsigned integer.
+ </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 written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-setrangelistdata">
- <title><literal>NdbDictionary::Object::Table::setRangeListData()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method sets an array containing information that maps range
- values and list values to fragments. This is essentially a
- sorted map consisting of fragment ID/value pairs. For range
- partitions there is one pair per fragment. For list partitions it
- could be any number of pairs, but at least as many pairs as there are
- fragments.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::setRangeListData()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method sets an array containing information that
+ maps range values and list values to fragments. This is
+ essentially a sorted map consisting of fragment ID/value
+ pairs. For range partitions there is one pair per
+ fragment. For list partitions it could be any number of
+ pairs, but at least as many pairs as there are
+ fragments.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
void setRangeListData
(
@@ -11007,225 +11571,261 @@
Uint32 <replaceable>len</replaceable>
)
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- This method requires two parameters:
- <itemizedlist>
- <listitem>
- <para>
- A pointer to the range or list <replaceable>data</replaceable>
- containing the ID/value pairs
- </para>
- </listitem>
-
- <listitem>
- <para>
- The length (<replaceable>len</replaceable>) of this data, as
- a 32-bit unsigned integer.
- </para>
- </listitem>
- </itemizedlist>
-
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ This method requires two parameters:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ A pointer to the range or list
+ <replaceable>data</replaceable> containing the
+ ID/value pairs
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The length (<replaceable>len</replaceable>) of
+ this data, as a 32-bit unsigned integer.
+ </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 written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
+ </para>
+
+ </formalpara>
+
</section>
-
+
<section id="class-table-setobjecttype">
- <title><literal>NdbDictionary::Object::Table::setObjectType()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- This method sets the table's object type.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::setObjectType()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method sets the table's object type.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
void setObjectType
(
Object::Type <replaceable>type</replaceable>
)
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- The desired object <replaceable>type</replaceable>. This must be
- one of the <literal>Type</literal> values listed in
- <xref linkend="class-object-type"/>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ The desired object <replaceable>type</replaceable>. This
+ must be one of the <literal>Type</literal> values listed
+ in <xref linkend="class-object-type"/>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
-</section>
+ </para>
+
+ </formalpara>
+
+ </section>
+
<section id="class-table-setrowgciindicator">
- <title><literal>NdbDictionary::Object::Table::setRowGCIIndicator()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
- <remark role="todo">
- [js] No description in sources.
- </remark>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+
+ <title><literal>NdbDictionary::Object::Table::setRowGCIIndicator()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ <remark role="todo">
+ [js] No description in sources.
+ </remark>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
void setRowGCIIndicator
(
bool <replaceable>value</replaceable>
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- A <literal>true</literal>/<literal>false</literal> <replaceable>value</replaceable>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ A <literal>true</literal>/<literal>false</literal>
+ <replaceable>value</replaceable>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
-</section><section id="class-table-setrowchecksumindicator">
- <title><literal>NdbDictionary::Object::Table::setRowChecksumIndicator()</literal></title>
-
- <formalpara>
- <title>Description</title>
-
- <para>
-
- <remark role="todo">
- [js] No description in sources.
- </remark>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Signature</title>
-
- <para>
+ </para>
+
+ </formalpara>
+
+ </section>
+
+ <section id="class-table-setrowchecksumindicator">
+
+ <title><literal>NdbDictionary::Object::Table::setRowChecksumIndicator()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ <remark role="todo">
+ [js] No description in sources.
+ </remark>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
void setRowChecksumIndicator
(
bool <replaceable>value</replaceable>
) const
</programlisting>
- </para>
- </formalpara>
-
- <formalpara>
- <title>Parameters</title>
-
- <para>
- A <literal>true</literal>/<literal>false</literal> <replaceable>value</replaceable>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Return Value</title>
-
- <para>
- <emphasis>None</emphasis>.
- </para>
- </formalpara>
-
- <formalpara>
- <title>Example</title>
-
- <para>
-
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ A <literal>true</literal>/<literal>false</literal>
+ <replaceable>value</replaceable>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
- </para>
- </formalpara>
-
-
-</section>
-
-
+ </para>
+
+ </formalpara>
+
+ </section>
+
</section>
-
-
</section>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r2390 - trunk/ndbapi | jon | 15 Jun |
