svn commit - mysqldoc@docsrva: r2371 - trunk/ndbapi

[jon]

Author: jstephens
Date: 2006-06-14 04:14:39 +0200 (Wed, 14 Jun 2006)
New Revision: 2371

Log:

Table class members (partial).



Modified:
   trunk/ndbapi/ndb-classes.xml

Modified: trunk/ndbapi/ndb-classes.xml
===================================================================
--- trunk/ndbapi/ndb-classes.xml	2006-06-14 01:31:36 UTC (rev 2370)
+++ trunk/ndbapi/ndb-classes.xml	2006-06-14 02:14:39 UTC (rev 2371)
@@ -7958,13 +7958,668 @@
               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 columns is that you can change the
+              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>
+            
+            <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:
+<programlisting>
+Table
+    (
+      const char* <replaceable>name</replaceable> = ""
+    )
+</programlisting>
+      Copy constructor:
+<programlisting>
+Table
+    (
+      const Table&amp; <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>
+      
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+    </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>
+<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>
+      
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+    </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>
+<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>
+      
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+    </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:
+<programlisting>
+Column* getColumn
+    (
+      const int <replaceable>AttributeId</replaceable>
+    )
+</programlisting>
+      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>
+      
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+    </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 &mdash; 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>
+      
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+    </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>
+<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>
+      
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+    </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, this may become variable.
+    </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>
+      
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+    </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>
+<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 &mdash;
+      see <xref linkend="class-table-getmaxloadfactor"/>).
+    </para>
+  </formalpara>
+  
+  <formalpara>
+    <title>Example</title>
+    
+    <para>
+      
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+    </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>
+<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>
+      
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+    </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>
+<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 &mdash; the number of columns in the table.
+    </para>
+  </formalpara>
+  
+  <formalpara>
+    <title>Example</title>
+    
+    <para>
+      
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+    </para>
+  </formalpara>
+  
+  
+          </section>
+          
+          <section id="class-table-getnoofprimarykeys">
+ 
<title><literal>NdbDictionary::Object::Table::getNoOfPrimaryKeys()</literal></title>
+  
+  <formalpara>
+    <title>Description</title>
+    
+    <para>
+      
+    </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>
+      Does not return a value.
+    </para>
+  </formalpara>
+  
+  <formalpara>
+    <title>Example</title>
+    
+    <para>
+      
+<programlisting>
+[<emphasis>To be written...</emphasis>]
+</programlisting>
+    </para>
+  </formalpara>
+  
+  
+</section>
+          
         </section>
+        
+        
 
       </section>