Author: jstephens
Date: 2007-03-13 10:59:03 +0100 (Tue, 13 Mar 2007)
New Revision: 5322
Log:
More additions for MCCGE/6.2.0.
Added:
trunk/ndbapi/xmi/Ndb-cluster-connection.xmi.tgz
Modified:
branches/telcos/refman-5.1/news-5.1.xml
trunk/common/phrases.ent
trunk/ndbapi/images/Ndb-cluster-connection-class.png
trunk/ndbapi/ndb-classes.xml
trunk/ndbapi/ndb-internals-ndb-protocol.xml
trunk/ndbapi/ndb.en.ent
Property changes on: trunk/ndbapi/xmi/Ndb-cluster-connection.xmi.tgz
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Modified: branches/telcos/refman-5.1/news-5.1.xml
===================================================================
--- branches/telcos/refman-5.1/news-5.1.xml 2007-03-13 04:10:38 UTC (rev 5321)
+++ branches/telcos/refman-5.1/news-5.1.xml 2007-03-13 09:59:03 UTC (rev 5322)
Changed blocks: 2, Lines Added: 24, Lines Deleted: 5; 1674 bytes
@@ -77,11 +77,6 @@
<xref linkend="news-5-1-16"/>.
</para>
- <remark role="TODO">
- [js] Update and uncomment following when release is available and
- devs have provided appropriate info.
- </remark>
-
<important>
<formalpara>
<title>Upgrading to MySQL 5.1.16/NDB-6.2.0 from a previous release</title>
@@ -123,6 +118,30 @@
</para>
<itemizedlist>
+
+ <listitem>
+ <para>
+ <emphasis role="bold">NDB API</emphasis>: It is now possible
+ to specify the transaction coordinator when starting a
+ transaction. See <xref linkend="class-ndb-starttransaction"/>,
+ for more information.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis role="bold">NDB API</emphasis>: It is now possible
+ to iterate over all existing <literal>Ndb</literal> objects
+ using three new methods of the
+ <literal>Ndb_cluster_connection</literal> class:
+ <literal>lock_ndb_objects()</literal>,
+ <literal>get_next_ndb_object()</literal>, and
+ <literal>unlock_ndb_objects()</literal>. For more information
+ about these methods and their use, see
+ <xref linkend="class-ndb-cluster-connection-get-next-ndb-object"/>,
+ in the MySQL Cluster API Guide.
+ </para>
+ </listitem>
<listitem>
<para>
Modified: trunk/common/phrases.ent
===================================================================
--- trunk/common/phrases.ent 2007-03-13 04:10:38 UTC (rev 5321)
+++ trunk/common/phrases.ent 2007-03-13 09:59:03 UTC (rev 5322)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 1; 1466 bytes
@@ -12,4 +12,4 @@
<!ENTITY falcon-warning '<para role="deprecated"><emphasis role="bold">Falcon support is not available in the standard MySQL 5.1 release. Falcon is available only in a specially forked release of MySQL 5.1. Information is provided here for evaluation purposes only.</emphasis></para>'>
<!ENTITY questions 'Questions'>
<!ENTITY questionsandanswers 'Questions and Answers'>
-<!ENTITY warning-5-1-12 '<para role="deprecated"><emphasis role="bold">Due to a build slippage, binary distributions of MySQL 5.1.12 contained neither NDB Cluster nor Partitioning. We apologize for any inconvenience. Please upgrade to 5.1.14. if you build from source, you can execute <command>configure</command> with the <option>--with-ndbcluster</option> and <option>--with-partition</option> options.</emphasis></para>'>
+<!ENTITY warning-5-1-12 '<para role="deprecated"><emphasis role="bold">Due to a build slippage, binary distributions of MySQL 5.1.12 contained neither NDB Cluster nor Partitioning. We apologize for any inconvenience. Please upgrade to 5.1.14. If you build from source, you can execute <command>configure</command> with the <option>--with-ndbcluster</option> and <option>--with-partition</option> options.</emphasis></para>'>
Modified: trunk/ndbapi/images/Ndb-cluster-connection-class.png
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 150 bytes
Modified: trunk/ndbapi/ndb-classes.xml
===================================================================
--- trunk/ndbapi/ndb-classes.xml 2007-03-13 04:10:38 UTC (rev 5321)
+++ trunk/ndbapi/ndb-classes.xml 2007-03-13 09:59:03 UTC (rev 5322)
Changed blocks: 3, Lines Added: 353, Lines Deleted: 7; 12075 bytes
@@ -960,10 +960,9 @@
<para>
<replaceable>table</replaceable>: A pointer to a
<literal>Table</literal> object. (See
- <xref
- linkend="class-table"/>.) This
- is used to determine on which node the Transaction
- Coordinator should run.
+ <xref linkend="class-table"/>.) This is used to
+ determine on which node the transaction coordinator
+ should run.
</para>
</listitem>
@@ -986,15 +985,107 @@
</para>
</formalpara>
+
+ &telco-warning-begin;
+
+ <para>
+ Beginning with MySQL 5.1.16/NDB-6.2.0, it is possible to
+ suggest which node node should be used to act as the
+ transaction coordinator.
+ </para>
+
+ <formalpara>
+ <title>Signature</title>
+ <para>
+<programlisting>
+NdbTransaction* startTransaction
+ (
+ const NdbDictionary::Table *<replaceable>table</replaceable>,
+ const struct Key_part_ptr *<replaceable>keyData</replaceable>,
+ void *<replaceable>xfrmbuf</replaceable> = 0,
+ Uint32 <replaceable>xfrmbuflen</replaceable> = 0
+ )
+</programlisting>
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Parameters</title>
+ <para>
+ When specifying the transactioncoordinator, this method
+ takes four parameters:
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ A pointer to a <replaceable>table</replaceable>
+ (<literal>NdbDictionary::Table</literal> object) used
+ for deciding which node should act as the transaction
+ coordinator.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A null-terminated array of pointers to a
+ <literal>Key_part_ptr</literal> structure that is part
+ of the distribution key. The length of the key part is
+ read from metadata and checked against the passed
+ value.
+ </para>
+
+ <para>
+ A <literal>Key_part_ptr</literal> is defined as shown
+ here:
+
+<programlisting>
+struct Key_part_ptr
+ {
+ const void * <replaceable>ptr</replaceable>;
+ unsigned <replaceable>len</replaceable>;
+ }
+</programlisting>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A pointer to a temporary buffer be used to calculate
+ the hash value.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ The length of the buffer.
+ </para>
+ </listitem>
+ </itemizedlist>
+ If <replaceable>xfrmbuf</replaceable> is
+ <literal>NULL</literal> (the default), then a call to
+ <literal>malloc()</literal> or <literal>free()</literal> is
+ made automatically, as appropriate.
+ <literal>startTransaction()</literal> fails if
+ <literal>xfrmbuf</literal> is not <literal>NULL</literal>
+ and <replaceable>xfrmbuflen</replaceable> is too small.
+ </para>
+ </formalpara>
+
+ <para>
+ It is still possible to use this method as before, without
+ specifying the transaction coordinator. In either case, you
+ must still explicitly close the transaction, whether or not
+ the call to <literal>startTransaction()</literal> was
+ successful.
+ </para>
+
+ &telco-warning-end;
<formalpara>
<title>Return Value</title>
<para>
- An <literal>NdbTransaction</literal> object. See
- <xref
- linkend="class-ndbtransaction"/>.
+ On success, an <literal>NdbTransaction</literal> object (see
+ <xref linkend="class-ndbtransaction"/>). In the event of
+ failure, <literal>NULL</literal> is returned.
</para>
</formalpara>
@@ -2246,6 +2337,261 @@
-->
</section>
+
+ <section id="class-ndb-cluster-connection-get-next-ndb-object">
+ <title><literal>ndb_cluster_connection::get_next_ndb_object()</literal></title>
+
+ <indexterm>
+ <primary>ndb_cluster_connection</primary>
+ <secondary>get_next_ndb_object() method</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>get_next_ndb_object() (method of ndb_cluster_connection)</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>iteration</primary>
+ <secondary>Ndb objects</secondary>
+ </indexterm>
+
+ &telco-warning-section;
+
+ <formalpara>
+ <title>Description</title>
+
+ <para>
+ This method is used to iterate over a set of
+ <literal>Ndb</literal> objects.
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+const Ndb* get_next_ndb_object
+ (
+ const Ndb* <replaceable>p</replaceable>
+ )
+</programlisting>
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Parameters</title>
+
+ <para>
+ This method takes a single parameter, a pointer to the last
+ <literal>Ndb</literal> object to have been retrieved or
+ <literal>NULL</literal>.
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Return Value</title>
+
+ <para>
+ Returns the next <literal>Ndb</literal> object, or
+ <literal>NULL</literal> if no more <literal>Ndb</literal>
+ objects are available.
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Iterating over <literal>Ndb</literal> objects</title>
+ <para>
+ To retrieve all existing <literal>Ndb</literal> objects:
+
+ <orderedlist>
+ <listitem>
+ <para>Invoke the <literal>lock_ndb_objects()</literal>
+ method. This prevents the creation of any new
+ instances of <literal>Ndb</literal> until the
+ <literal>unlock_ndb_objects()</literal> method is
+ called.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Retrieve the first available <literal>Ndb</literal>
+ object by passing <literal>NULL</literal> to
+ <literal>get_next_ndb_object()</literal>. You can
+ retrieve the second <literal>Ndb</literal> object by
+ passing the pointer retrieved by the first call to the
+ next <literal>get_next_ndb_object()</literal> call,
+ and so on. When a pointer to the last available
+ <literal>Ndb</literal> instance is used, the method
+ returns <literal>NULL</literal>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ After you have retrieved all desired
+ <literal>Ndb</literal> objects, you should re-enable
+ <literal>Ndb</literal> object creation by calling the
+ <literal>unlock_ndb_objects()</literal> method.
+ </para>
+ </listitem>
+ </orderedlist>
+ </para>
+ </formalpara>
+
+ <para>
+ See also <xref linkend="class-ndb-cluster-connection-lock-ndb-objects"/>,
+ and <xref linkend="class-ndb-cluster-connection-unlock-ndb-objects"/>.
+ </para>
+
+ <!--
+ <formalpara>
+ <title>Example</title>
+
+ <para>
+
+ <programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+ </formalpara>
+ -->
+
+ </section>
+
+ <section id="class-ndb-cluster-connection-lock-ndb-objects">
+ <title><literal>ndb_cluster_connection::lock_ndb_objects()</literal></title>
+
+ &telco-warning-section;
+
+ <formalpara>
+ <title>Description</title>
+
+ <para>
+ Calling this method prevents the creation of new instances
+ of the <literal>Ndb</literal> class. This method must be
+ called prior to iterating over multiple
+ <literal>Ndb</literal> objects using
+ <literal>get_next_ndb_object()</literal>.
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+void lock_ndb_objects
+ (
+ void
+ )
+</programlisting>
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+ </formalpara>
+
+ <para>
+ This method was added in MySQL 5.1.16/NDB-6.2.0. For more
+ information, see
+ <xref linkend="class-ndb-cluster-connection-get-next-ndb-object"/>.
+ </para>
+
+<!--
+ <formalpara>
+ <title>Example</title>
+
+ <para>
+
+ <programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+ </formalpara>
+-->
+
+ </section>
+
+ <section id="class-ndb-cluster-connection-unlock-ndb-objects">
+ <title><literal>ndb_cluster_connection::unlock_ndb_objects()</literal></title>
+
+ &telco-warning-section;
+
+ <formalpara>
+ <title>Description</title>
+
+ <para>
+ This method undoes the effects of the
+ <literal>lock_ndb_objects()</literal> method, making it
+ possible to create new instances of <literal>Ndb</literal>.
+ <literal>unlock_ndb_objects()</literal> should be called
+ after you have finished retrieving <literal>Ndb</literal>
+ objects using the <literal>get_next_ndb_object()</literal>
+ method.
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+void unlock_ndb_objects
+ (
+ void
+ )
+</programlisting>
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title>Return Value</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+ </formalpara>
+
+ <para>
+ For more information, see
+ <xref linkend="class-ndb-cluster-connection-get-next-ndb-object"/>.
+ </para>
+
+<!--
+ <formalpara>
+ <title>Example</title>
+
+ <para>
+
+ <programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+ </formalpara>
+-->
+
+ </section>
</section>
Modified: trunk/ndbapi/ndb-internals-ndb-protocol.xml
===================================================================
--- trunk/ndbapi/ndb-internals-ndb-protocol.xml 2007-03-13 04:10:38 UTC (rev 5321)
+++ trunk/ndbapi/ndb-internals-ndb-protocol.xml 2007-03-13 09:59:03 UTC (rev 5322)
Changed blocks: 4, Lines Added: 10, Lines Deleted: 6; 1577 bytes
@@ -203,7 +203,7 @@
<entry><literal>TCINDXREF</literal></entry>
</row>
<row>
- <entry><emphasis role="bold">Table or Index Scan (SCANTAB)</emphasis></entry>
+ <entry><emphasis role="bold">Table or Index Scan (<literal>SCANTAB</literal>)</emphasis></entry>
<entry><literal>SCANTABREQ</literal></entry>
<entry><literal>SCANTABCONF</literal></entry>
<entry><literal>SCANTABREF</literal></entry>
@@ -219,7 +219,7 @@
Three additional types of messages are sometimes used in internode
communication. These are:
- <itemizedlist>
+ <orderedlist>
<listitem>
<para>
@@ -268,12 +268,12 @@
<listitem>
<para>
A <literal>TRANSID_AI</literal> message contains the data
- returned from a red operation — in other words, it
- functions as a result set.
+ returned from a read operation — in other words, a
+ result set.
</para>
</listitem>
- </itemizedlist>
+ </orderedlist>
</para>
<formalpara>
@@ -329,7 +329,11 @@
<title>Signals and Transactions</title>
- <para></para>
+ <para>
+
+ </para>
+
+
</section>
Modified: trunk/ndbapi/ndb.en.ent
===================================================================
--- trunk/ndbapi/ndb.en.ent 2007-03-13 04:10:38 UTC (rev 5321)
+++ trunk/ndbapi/ndb.en.ent 2007-03-13 09:59:03 UTC (rev 5322)
Changed blocks: 1, Lines Added: 3, Lines Deleted: 2; 1418 bytes
@@ -13,6 +13,7 @@
<!ENTITY mdash "—">
<!ENTITY telco-series "MySQL Cluster 5.1 Carrier Grade Edition"><!-- MCCGE -->
-<!ENTITY telco-warning-begin '<formalpara
-role="telco-warning"><title>&telco-series;</title><para>The following information applies to users of &telco-series; only. For more information about &telco-series;, see <ulink url="http://www.mysql.com/products/database/clustercge/"/>.</para></formalpara>'>
+<!ENTITY telco-warning-section '<formalpara
+role="telco-warning"><title>&telco-series;</title><para>The information in this section applies to users of &telco-series; only. For more information about &telco-series;, see <ulink url="http://www.mysql.com/products/database/clustercge/"/>.</para></formalpara>'>
+<!ENTITY telco-warning-begin '<formalpara role="telco-warning"><title>&telco-series;</title><para>The following information applies to users of &telco-series; only. For more information about &telco-series;, see <ulink url="http://www.mysql.com/products/database/clustercge/"/>.</para></formalpara>'>
<!ENTITY telco-warning-end '<para role="telco-warning">The following information applies to all MySQL Cluster API users.</para>'>
\ No newline at end of file
Added: trunk/ndbapi/xmi/Ndb-cluster-connection.xmi.tgz
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 325 bytes
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r5322 - branches/telcos/refman-5.1 trunk/common trunk/ndbapi trunk/ndbapi/images trunk/ndbapi/xmi | jon | 13 Mar |
