From: Date: November 26 2006 11:57am
Subject: svn commit - mysqldoc@docsrva: r4033 - in trunk/ndbapi: . images xmi
List-Archive: http://lists.mysql.com/commits/15822
Message-Id: <200611261057.kAQAvBbD029646@docsrva.mysql.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
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 @@
getNoOfPrimaryKeys()
- Gets the number of primary keys in the table
-
-
- [js] Do we mean "gets the number of columns in the
- PK here...?"
-
+ Gets the number of columns in the table's primary key.
getPrimaryKey()
@@ -18059,16 +18054,20 @@
setRowGCIIndicator()
-
- Not documented in NdbDictionary.hpp
-
+ Documentation not yet available.
setRowChecksumIndicator()
-
- Not documented in NdbDictionary.hpp
-
+ Documentation not yet available.
+
+ aggregate()
+ Computes aggregate data for the table
+
+
+ validate()
+ Validates the definition for a new table prior to creating it
+
@@ -22425,9 +22424,7 @@
Description
-
- [js] No description in sources.
-
+ Documentation not yet available
@@ -22502,9 +22499,7 @@
Description
-
- [js] No description in sources.
-
+ Documentation not yet available
@@ -22561,6 +22556,170 @@
+
+
+ <literal>Table::aggregate()</literal>
+
+
+
+ Description
+
+
+ This method computes aggregate data for the table. It is
+ required in order for aggregate methods such as
+ getNoOfPrimaryKeys() to work properly
+ before the table has been created and retrieved via
+ getTable().
+
+
+
+
+
+
+ This method was added in MySQL 5.1.13.
+
+
+
+
+
+ Signature
+
+
+
+int aggregate
+ (
+ struct NdbError& error
+ )
+
+
+
+
+
+
+
+ Parameters
+
+
+ A reference to an NdbError object.
+
+
+
+
+
+
+ Return Value
+
+
+ An integer, whose value is 0 on
+ success, and -1 if the table is in an
+ inconsistent state. In the latter case, the
+ error is also set.
+
+
+
+
+
+
+
+
+
+
+ <literal>Table::validate()</literal>
+
+
+
+ Description
+
+
+ This method validates the definition for a new table
+ prior to its being created, and executes the
+ Table::aggregate() method, as well as
+ performing additional checks.
+ validate() is called automatically
+ when a table is created or retrieved.
+
+
+
+
+
+
+ Even after the validate() method is called, there may
+ still exist errors which can be detected only by the
+ NDB kernel when the table is actually
+ created.
+
+
+
+
+
+ This method was added in MySQL 5.1.13.
+
+
+
+
+
+ Signature
+
+
+
+int validate
+ (
+ struct NdbError& error
+ )
+
+
+
+
+
+
+
+ Parameters
+
+
+ A reference to an NdbError object.
+
+
+
+
+
+
+ Return Value
+
+
+ An integer, whose value is 0 on
+ success, and -1 if the table is in an
+ inconsistent state. In the latter case, the
+ error is also set.
+
+
+
+
+
+
+
+
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