MySQL Lists: commits: svn commit - mysqldoc@docsrva: r11564

List:	Commits	« Previous Message Next Message »
From:	jon	Date:	August 15 2008 2:32pm
Subject:	svn commit - mysqldoc@docsrva: r11564 - trunk/ndbapi
View as plain text
Author: jstephens
Date: 2008-08-15 14:32:53 +0200 (Fri, 15 Aug 2008)
New Revision: 11564

Log:

NdbInterpretedCode - Short descriptions



Modified:
   trunk/ndbapi/class-ndb-interpretedcode.xml


Modified: trunk/ndbapi/class-ndb-interpretedcode.xml
===================================================================
--- trunk/ndbapi/class-ndb-interpretedcode.xml	2008-08-15 09:13:58 UTC (rev 11563)
+++ trunk/ndbapi/class-ndb-interpretedcode.xml	2008-08-15 12:32:53 UTC (rev 11564)
Changed blocks: 5, Lines Added: 92, Lines Deleted: 49; 10479 bytes

@@ -3,7 +3,7 @@
 <!ENTITY % all.entities SYSTEM "all-entities.ent">
 %all.entities;
 ]>
-<section role="class" id="class-ndbinterpetedcode">
+<section role="class" id="class-ndb-interpetedcode">
 
   <title>The <literal>NdbInterpretedCode</literal> Class</title>
 

@@ -144,172 +144,170 @@
       <tbody>
         <row>
           <entry><literal>NdbInterpretedCode()</literal></entry>
-          <entry></entry>
+          <entry>Class constructor</entry>
         </row>
         <row>
           <entry><literal>load_const_null()</literal></entry>
-          <entry></entry>
+          <entry>Load a <literal>NULL</literal> value into a
register</entry>
         </row>
         <row>
           <entry><literal>load_const_u16()</literal></entry>
-          <entry></entry>
+          <entry>Load a 16-bit numeric value into a register</entry>
         </row>
         <row>
           <entry><literal>load_const_u32()</literal></entry>
-          <entry></entry>
+          <entry>Load a 32-bit numeric value into a register</entry>
         </row>
         <row>
           <entry><literal>load_const_u64()</literal></entry>
-          <entry></entry>
+          <entry>Load a 64-bit numeric value into a register</entry>
         </row>
         <row>
           <entry><literal>read_attr()</literal></entry>
-          <entry></entry>
+          <entry>Read a register value into a table column</entry>
         </row>
         <row>
           <entry><literal>write_attr()</literal></entry>
-          <entry></entry>
+          <entry>Write a table column value into a register</entry>
         </row>
         <row>
           <entry><literal>add_reg()</literal></entry>
-          <entry></entry>
+          <entry>Add two register values and store the result in a third
register</entry>
         </row>
         <row>
           <entry><literal>sub_reg()</literal></entry>
-          <entry></entry>
+          <entry>Subtract two register values and store the result in a third
register</entry>
         </row>
         <row>
           <entry><literal>def_label()</literal></entry>
-          <entry></entry>
+          <entry>Create a label for use within the interpreted
program</entry>
         </row>
         <row>
           <entry><literal>branch_label()</literal></entry>
-          <entry></entry>
+          <entry>Unconditional jump to a label</entry>
         </row>
         <row>
           <entry><literal>branch_ge()</literal></entry>
-          <entry></entry>
+          <entry>Jump if one register value is greater than or equal to
another</entry>
         </row>
         <row>
           <entry><literal>branch_gt()</literal></entry>
-          <entry></entry>
+          <entry>Jump if one register value is greater than another</entry>
         </row>
         <row>
           <entry><literal>branch_le()</literal></entry>
-          <entry></entry>
+          <entry>Jump if one register value is less than or equal to
another</entry>
         </row>
         <row>
           <entry><literal>branch_lt()</literal></entry>
-          <entry></entry>
+          <entry>Jump if one register value is less than another</entry>
         </row>
         <row>
           <entry><literal>branch_eq()</literal></entry>
-          <entry></entry>
+          <entry>Jump if one register value is equal to another</entry>
         </row>
         <row>
           <entry><literal>branch_ne()</literal></entry>
-          <entry></entry>
+          <entry>Jump if one register value is not equal to another</entry>
         </row>
         <row>
           <entry><literal>branch_ne_null()</literal></entry>
-          <entry></entry>
+          <entry>Jump if a register value is not
<literal>NULL</literal></entry>
         </row>
         <row>
           <entry><literal>branch_eq_null()</literal></entry>
-          <entry></entry>
+          <entry>Jump if a register value is
<literal>NULL</literal></entry>
         </row>
         <row>
           <entry><literal>branch_col_eq()</literal></entry>
-          <entry></entry>
+          <entry>Jump if a column value is equal to another</entry>
         </row>
         <row>
           <entry><literal>branch_col_ne()</literal></entry>
-          <entry></entry>
+          <entry>Jump if a column value is not equal to another</entry>
         </row>
         <row>
           <entry><literal>branch_col_lt()</literal></entry>
-          <entry></entry>
+          <entry>Jump if a column value is less than another</entry>
         </row>
         <row>
           <entry><literal>branch_col_le()</literal></entry>
-          <entry></entry>
+          <entry>Jump if a column value is less than or equal to
another</entry>
         </row>
         <row>
           <entry><literal>branch_col_gt()</literal></entry>
-          <entry></entry>
+          <entry>Jump if a column value is greater than another</entry>
         </row>
         <row>
           <entry><literal>branch_col_ge()</literal></entry>
-          <entry></entry>
+          <entry>Jump if a column value is greater than or equal to
another</entry>
         </row>
         <row>
           <entry><literal>branch_col_eq_null()</literal></entry>
-          <entry></entry>
+          <entry>Jump if a column value is
<literal>NULL</literal></entry>
         </row>
         <row>
           <entry><literal>branch_col_ne_null()</literal></entry>
-          <entry></entry>
+          <entry>Jump if a column value is not
<literal>NULL</literal></entry>
         </row>
         <row>
           <entry><literal>branch_col_like()</literal></entry>
-          <entry></entry>
+          <entry>Jump if a column value matches a pattern</entry>
         </row>
         <row>
           <entry><literal>branch_col_notlike()</literal></entry>
-          <entry></entry>
+          <entry>Jump if a column value does not match a pattern</entry>
         </row>
         <row>
           <entry><literal>interpret_exit_ok()</literal></entry>
-          <entry></entry>
+          <entry>Return a row as part of the result</entry>
         </row>
         <row>
           <entry><literal>interpret_exit_nok()</literal></entry>
-          <entry></entry>
+          <entry>Do not return a row as part of the result</entry>
         </row>
         <row>
           <entry><literal>interpret_last_row()</literal></entry>
-          <entry></entry>
+          <entry>Return a row as part of the result, and do not check any more rows
in
+            this fragment</entry>
         </row>
         <row>
           <entry><literal>add_val()</literal></entry>
-          <entry></entry>
+          <entry>Add a value to a table column value</entry>
         </row>
         <row>
           <entry><literal>sub_val()</literal></entry>
-          <entry></entry>
+          <entry>Subtract a value from a table column value</entry>
         </row>
         <row>
           <entry><literal>def_sub()</literal></entry>
-          <entry></entry>
+          <entry>Define a subroutine</entry>
         </row>
         <row>
           <entry><literal>call_sub()</literal></entry>
-          <entry></entry>
+          <entry>Call a subroutine</entry>
         </row>
         <row>
           <entry><literal>ret_sub()</literal></entry>
-          <entry></entry>
+          <entry>Return from a subroutine</entry>
         </row>
         <row>
           <entry><literal>finalise()</literal></entry>
-          <entry></entry>
+          <entry>Completes interpreted program and prepares it for
use</entry>
         </row>
         <row>
           <entry><literal>getTable()</literal></entry>
-          <entry></entry>
+          <entry>Gets the table on which the program is defined</entry>
         </row>
         <row>
           <entry><literal>getNdbError()</literal></entry>
-          <entry></entry>
+          <entry>Gets the most recent error associated with this
+            <literal>NdbInterpretedCode</literal> object</entry>
         </row>
         <row>
           <entry><literal>getWordsUsed()</literal></entry>
-          <entry></entry>
+          <entry>Gets the number of words used in the buffer</entry>
         </row>
-        <row>
-          <entry><literal></literal></entry>
-          <entry></entry>
-        </row>
       </tbody>
     </tgroup>
   </informaltable>

@@ -369,7 +367,10 @@
 
         <title>Description</title>
 
-        <para></para>
+        <para>
+          This is the <emphasis>NdbInterpretedCode</emphasis> class
+          constuctor.
+        </para>
 
       </formalpara>
 

@@ -379,7 +380,12 @@
 
         <para>
 <programlisting>
-
+NdbInterpretedCode
+    (
+      const NdbDictionary::Table* <replaceable>table</replaceable> = 0,
+      Uint32* <replaceable>buffer</replaceable> = 0,
+      Uint32 <replaceable>buffer_word_size</replaceable> = 0
+    )
 </programlisting>
         </para>
 

@@ -390,7 +396,44 @@
         <title>Parameters</title>
 
         <para>
-          <emphasis>None</emphasis>.
+          The <literal>NdbInterpretedCode</literal> constructor takes
+          three parameters, as described here:
+
+          <itemizedlist>
+
+            <listitem>
+              <para>
+                The <replaceable>table</replaceable> against which which
+                this program is to be be run. This parameter must be
+                supplied if the program is table-specific &mdash; that
+                is, if it reads from or writes to columns in a table.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                A pointer to a <replaceable>buffer</replaceable> of
+                32-bit words used to store the program.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <replaceable>buffer_word_size</replaceable> is the
+                length of the buffer passed in. If the program exceeds
+                this length then adding new instructions will fail with
+                error 4518 <errortext>Too many instructions in
+                interpreted program</errortext>.
+              </para>
+
+              <para>
+                Alternatively, if no buffer is passed, a buffer will be
+                dynamically allocated internally and extended to cope as
+                instructions are added.
+              </para>
+            </listitem>
+
+          </itemizedlist>
         </para>
 
       </formalpara>
Thread
• svn commit - mysqldoc@docsrva: r11564 - trunk/ndbapi	jon	15 Aug