Author: jstephens
Date: 2006-11-26 11:57:04 +0100 (Sun, 26 Nov 2006)
New Revision: 4033
Log:
Preliminary documentation for new NdbDictionary::Object::Table methods
aggregate() and validate().
Updated affected class diagrams.
Fixes Docs Bug #21690.
Modified:
trunk/ndbapi/images/NdbDictionary-Object-Table-class.png
trunk/ndbapi/ndb-classes.xml
trunk/ndbapi/xmi/Dictionary.xmi.tgz
trunk/ndbapi/xmi/Table.xmi.tgz
Modified: trunk/ndbapi/images/NdbDictionary-Object-Table-class.png
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 154 bytes
Modified: trunk/ndbapi/ndb-classes.xml
===================================================================
--- trunk/ndbapi/ndb-classes.xml 2006-11-26 08:58:38 UTC (rev 4032)
+++ trunk/ndbapi/ndb-classes.xml 2006-11-26 10:57:04 UTC (rev 4033)
Changed blocks: 5, Lines Added: 177, Lines Deleted: 18; 6631 bytes
@@ -17873,12 +17873,7 @@
</row>
<row>
<entry><literal>getNoOfPrimaryKeys()</literal></entry>
- <entry>Gets the number of primary keys in the table
-
- <remark role="todo">
- [js] Do we mean "gets the number of columns in the
- PK here...?"
- </remark></entry>
+ <entry>Gets the number of columns in the table's primary key.</entry>
</row>
<row>
<entry><literal>getPrimaryKey()</literal></entry>
@@ -18059,16 +18054,20 @@
</row>
<row>
<entry><literal>setRowGCIIndicator()</literal></entry>
- <entry><remark role="todo">
- Not documented in NdbDictionary.hpp
- </remark></entry>
+ <entry><emphasis>Documentation not yet available.</emphasis></entry>
</row>
<row>
<entry><literal>setRowChecksumIndicator()</literal></entry>
- <entry><remark role="todo">
- Not documented in NdbDictionary.hpp
- </remark></entry>
+ <entry><emphasis>Documentation not yet available.</emphasis></entry>
</row>
+ <row>
+ <entry><literal>aggregate()</literal></entry>
+ <entry>Computes aggregate data for the table</entry>
+ </row>
+ <row>
+ <entry><literal>validate()</literal></entry>
+ <entry>Validates the definition for a new table prior to creating it</entry>
+ </row>
</tbody>
</tgroup>
</informaltable>
@@ -22425,9 +22424,7 @@
<title>Description</title>
<para>
- <remark role="todo">
- [js] No description in sources.
- </remark>
+ <emphasis>Documentation not yet available</emphasis>
</para>
</formalpara>
@@ -22502,9 +22499,7 @@
<title>Description</title>
<para>
- <remark role="todo">
- [js] No description in sources.
- </remark>
+ <emphasis>Documentation not yet available</emphasis>
</para>
</formalpara>
@@ -22561,6 +22556,170 @@
</section>
+ <section id="class-table-aggregate">
+
+ <title><literal>Table::aggregate()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method computes aggregate data for the table. It is
+ required in order for aggregate methods such as
+ <literal>getNoOfPrimaryKeys()</literal> to work properly
+ before the table has been created and retrieved via
+ <literal>getTable()</literal>.
+ </para>
+
+ </formalpara>
+
+ <note>
+ <para>
+ This method was added in MySQL 5.1.13.
+ </para>
+ </note>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+int aggregate
+ (
+ struct NdbError& <replaceable>error</replaceable>
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ A reference to an <literal>NdbError</literal> object.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ An integer, whose value is <literal>0</literal> on
+ success, and <literal>-1</literal> if the table is in an
+ inconsistent state. In the latter case, the
+ <replaceable>error</replaceable> is also set.
+ </para>
+
+ </formalpara>
+
+<!--
+ <formalpara>
+ <title>Example</title>
+
+ <para>
+
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+ </formalpara>
+ -->
+
+ </section>
+
+ <section id="class-table-validate">
+
+ <title><literal>Table::validate()</literal></title>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method validates the definition for a new table
+ prior to its being created, and executes the
+ <literal>Table::aggregate()</literal> method, as well as
+ performing additional checks.
+ <literal>validate()</literal> is called automatically
+ when a table is created or retrieved.
+ </para>
+
+ </formalpara>
+
+ <warning>
+ <para>
+ Even after the validate() method is called, there may
+ still exist errors which can be detected only by the
+ <literal>NDB</literal> kernel when the table is actually
+ created.
+ </para>
+ </warning>
+
+ <note>
+ <para>
+ This method was added in MySQL 5.1.13.
+ </para>
+ </note>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+int validate
+ (
+ struct NdbError& <replaceable>error</replaceable>
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ A reference to an <literal>NdbError</literal> object.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ An integer, whose value is <literal>0</literal> on
+ success, and <literal>-1</literal> if the table is in an
+ inconsistent state. In the latter case, the
+ <replaceable>error</replaceable> is also set.
+ </para>
+
+ </formalpara>
+
+<!--
+ <formalpara>
+ <title>Example</title>
+
+ <para>
+
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+ </formalpara>
+-->
+
+ </section>
+
</section>
</section>
Modified: trunk/ndbapi/xmi/Dictionary.xmi.tgz
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 133 bytes
Modified: trunk/ndbapi/xmi/Table.xmi.tgz
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 128 bytes
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r4033 - in trunk/ndbapi: . images xmi | jon | 26 Nov |
