Author: jstephens
Date: 2006-06-15 09:47:17 +0200 (Thu, 15 Jun 2006)
New Revision: 2389
Log:
Remaining Table class members.
Modified:
trunk/ndbapi/ndb-classes.xml
Modified: trunk/ndbapi/ndb-classes.xml
===================================================================
--- trunk/ndbapi/ndb-classes.xml 2006-06-15 07:46:03 UTC (rev 2388)
+++ trunk/ndbapi/ndb-classes.xml 2006-06-15 07:47:17 UTC (rev 2389)
@@ -4727,7 +4727,7 @@
<para>
The <literal>Column</literal> class destructor takes no
- arguments and does not return a value.
+ arguments and <emphasis>None</emphasis>.
</para>
</formalpara>
@@ -5929,7 +5929,7 @@
<title>Return Value</title>
<para>
- This method does not return a value.
+ This method <emphasis>None</emphasis>.
</para>
</formalpara>
@@ -9164,6 +9164,801 @@
</section>
+
+ <section id="class-table-getlinearflag">
+ <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>
+<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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </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>
+<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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </para>
+ </formalpara>
+
+
+ </section>
+
+ <section id="class-table-gettablespace">
+ <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:
+<programlisting>
+const char* getTablespace
+ (
+ void
+ ) const
+</programlisting>
+ To determine whether the tablespace is the one indicated by the
+ given ID and version:
+<programlisting>
+bool getTablespace
+ (
+ Uint32* <replaceable>id</replaceable> = 0,
+ Uint32* <replaceable>version</replaceable> = 0
+ ) 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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </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>
+<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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </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>
+<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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </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>
+<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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </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>
+<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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </para>
+ </formalpara>
+
+
+ </section>
+
+ <section id="class-table-getdefaultnopartitionsflag">
+ <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>
+<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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </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>
+<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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </para>
+ </formalpara>
+
+
+ </section>
+
+ <section id="class-table-gettablespacenames">
+ <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>
+<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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </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>
+<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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </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>
+<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>
+
+<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>
+<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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </para>
+ </formalpara>
+
+
+</section>
+
<section id="class-table-setname">
<title><literal>NdbDictionary::Object::Table::setName()</literal></title>
@@ -9208,7 +10003,7 @@
<title>Return Value</title>
<para>
- Does not return a value.
+ <emphasis>None</emphasis>.
</para>
</formalpara>
@@ -9258,7 +10053,7 @@
<title>Return Value</title>
<para>
- Does not return a value; however, it does create a copy of the
+ <emphasis>None</emphasis>; however, it does create a copy of the
original <literal>Column</literal> object.
</para>
</formalpara>
@@ -9315,7 +10110,7 @@
<title>Return Value</title>
<para>
- Does not return a value.
+ <emphasis>None</emphasis>.
</para>
</formalpara>
@@ -9333,8 +10128,8 @@
</section>
- <section role="class-member">
- <title><literal></literal></title>
+ <section id="class-table-setlinearflag">
+ <title><literal>NdbDictionary::Object::Table::setLinearFlag()</literal></title>
<formalpara>
<title>Description</title>
@@ -9349,7 +10144,65 @@
<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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </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>
+<programlisting>
+void setFragmentCount
+ (
+ Uint32 <replaceable>count</replaceable>
+ )
</programlisting>
</para>
</formalpara>
@@ -9358,15 +10211,72 @@
<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>
+
+ <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>
+<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>
- Does not return a value.
+ <emphasis>None</emphasis>.
</para>
</formalpara>
@@ -9382,9 +10292,937 @@
</formalpara>
+ </section>
+
+ <section id="class-table-setkvalue">
+ <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>
+<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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </para>
+ </formalpara>
+
+
+ </section>
+
+ <section id="class-table-setminloadfactor">
+ <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>
+<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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </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>
+<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>
+
+ <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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </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:
+<programlisting>
+void setTablespace
+ (
+ const char* <replaceable>name</replaceable>
+ )
+</programlisting>
+ 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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </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>
+<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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </para>
+ </formalpara>
+
+
+</section>
+
+ <section id="class-table-setdefaultnopartitionsflag">
+ <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>
+<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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </para>
+ </formalpara>
+
+
+ </section>
+
+ <section id="class-table-setfrm">
+ <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>
+<programlisting>
+void setFrm
+ (
+ const void* <replaceable>data</replaceable>,
+ 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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </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>
+<programlisting>
+void setFragmentData
+ (
+ const void* <replaceable>data</replaceable>,
+ 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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </para>
+ </formalpara>
+
+
+ </section>
+
+
+ <section id="class-table-settablespacenames">
+ <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>
+<programlisting>
+void setTablespaceNames
+ (
+ const void* <replaceable>data</replaceable>
+ 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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </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>
+<programlisting>
+void setTablespaceData
+ (
+ const void* <replaceable>data</replaceable>,
+ 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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </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>
+<programlisting>
+void setRangeListData
+ (
+ const void* <replaceable>data</replaceable>,
+ 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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </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>
+<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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </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>
+<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>
+
+<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>
+<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>
+
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+ </para>
+ </formalpara>
+
+
+</section>
+
+
</section>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r2389 - trunk/ndbapi | jon | 15 Jun |
