Author: jstephens
Date: 2006-06-14 09:03:51 +0200 (Wed, 14 Jun 2006)
New Revision: 2373
Log:
More Table class members...
Modified:
trunk/ndbapi/ndb-classes.xml
Modified: trunk/ndbapi/ndb-classes.xml
===================================================================
--- trunk/ndbapi/ndb-classes.xml 2006-06-14 04:57:53 UTC (rev 2372)
+++ trunk/ndbapi/ndb-classes.xml 2006-06-14 07:03:51 UTC (rev 2373)
@@ -8346,7 +8346,8 @@
<para>
This method gets the KValue, a hashing parameter which is
currently restricted to the value <literal>6</literal>. In a
- future release, this may become variable.
+ future release, it may become feasible to set this parameter to
+ other values.
</para>
</formalpara>
@@ -8570,7 +8571,7 @@
<title>Description</title>
<para>
-
+ This method finds the number of primary key columns in the table.
</para>
</formalpara>
@@ -8599,6 +8600,614 @@
<title>Return Value</title>
<para>
+ An integer.
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Example</title>
+
+ <para>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </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
+ (
+ int <replaceable>no</replaceable>
+ ) 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>
+<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>
+
+<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>
+<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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </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>
+<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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </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>
+<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>
+
+<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>
+<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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </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>
+<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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </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>
+<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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </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>
+
+<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>
+<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>
Does not return a value.
</para>
</formalpara>
@@ -8616,7 +9225,166 @@
</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>
+ Does not return a value; 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>
+<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>
+ Does not return a value.
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Example</title>
+
+ <para>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </para>
+ </formalpara>
+
+
+</section>
+
+ <section role="class-member">
+ <title><literal></literal></title>
+
+ <formalpara>
+ <title>Description</title>
+
+ <para>
+
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+
+</programlisting>
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Return Value</title>
+
+ <para>
+ Does not return a value.
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Example</title>
+
+ <para>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </para>
+ </formalpara>
+
+
+</section>
+
+
</section>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r2373 - trunk/ndbapi | jon | 14 Jun |
