Author: jstephens
Date: 2009-01-22 21:51:53 +0100 (Thu, 22 Jan 2009)
New Revision: 13351
Log:
Reverted changes made in r 13128-13129 - caused problems with refs to
Ndb class vs NDB SE
Modified:
trunk/ndbapi/class-column.xml
trunk/ndbapi/class-datafile.xml
trunk/ndbapi/class-dictionary.xml
trunk/ndbapi/class-event.xml
trunk/ndbapi/class-index.xml
trunk/ndbapi/class-logfilegroup.xml
trunk/ndbapi/class-ndb-cluster-connection.xml
trunk/ndbapi/class-ndb.xml
trunk/ndbapi/class-ndbblob.xml
trunk/ndbapi/class-ndbdictionary.xml
trunk/ndbapi/class-ndbeventoperation.xml
trunk/ndbapi/class-ndboperation.xml
trunk/ndbapi/class-ndbrecattr.xml
trunk/ndbapi/class-ndbscanoperation.xml
trunk/ndbapi/class-ndbtransaction.xml
trunk/ndbapi/class-object.xml
trunk/ndbapi/class-table.xml
trunk/ndbapi/class-tablespace.xml
trunk/ndbapi/class-undofile.xml
trunk/ndbapi/getting-started.xml
trunk/ndbapi/interface-ndbrecord.xml
trunk/ndbapi/mgm-api.xml
trunk/ndbapi/ndb-classes.xml
trunk/ndbapi/ndb-errors.xml
trunk/ndbapi/ndb-examples.xml
trunk/ndbapi/ndb-hierarchy.xml
trunk/ndbapi/ndb-internals.xml
trunk/ndbapi/ndbapi.xml
trunk/ndbapi/overview.xml
trunk/ndbapi/struct-ndberror.xml
Modified: trunk/ndbapi/class-column.xml
===================================================================
--- trunk/ndbapi/class-column.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/class-column.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 7, Lines Added: 14, Lines Deleted: 16; 3485 bytes
@@ -86,9 +86,9 @@
These types in general correspond to MySQL datatypes and their
variants. The data formats are same as in MySQL. The
- <literal role="se">NDB</literal> API provides no support for
- constructing such formats; however, they are checked by the
- <literal role="se">NDB</literal> kernel.
+ <literal>NDB</literal> API provides no support for constructing
+ such formats; however, they are checked by the
+ <literal>NDB</literal> kernel.
</para>
</formalpara>
@@ -303,8 +303,8 @@
</row>
<row>
<entry><literal>Type</literal></entry>
- <entry>The column's datatype. <literal role="se">NDB</literal> columns have the
- datatypes as found in MySQL</entry>
+ <entry>The column's datatype. <literal>NDB</literal> columns have the datatypes
+ as found in MySQL</entry>
</row>
</tbody>
</tgroup>
@@ -722,8 +722,8 @@
<para>
As with other database objects, <literal>Column</literal> object
creation and attribute changes to existing columns done using
- the <literal role="se">NDB</literal> API are not visible from
- MySQL. For example, if you change a column's datatype using
+ the <literal>NDB</literal> API are not visible from MySQL. For
+ example, if you change a column's datatype using
<literal>Column::setType()</literal>, MySQL will regard the type
of column as being unchanged. The only exception to this rule
with regard to columns is that you can change the name of an
@@ -754,8 +754,8 @@
<warning>
<para>
A <literal>Column</literal> created using the
- <literal role="se">NDB</literal> API will
- <emphasis>not</emphasis> be visible to a MySQL server.
+ <literal>NDB</literal> API will <emphasis>not</emphasis> be
+ visible to a MySQL server.
</para>
<para>
@@ -2044,9 +2044,8 @@
<para>
A <firstterm>partitioning key</firstterm> is a set of
attributes used to distribute the tuples onto the
- <literal role="se">NDB</literal> nodes. This key a hashing
- function specific to the
- <literal role="se">NDBCLUSTER</literal> storage engine.
+ <literal>NDB</literal> nodes. This key a hashing function
+ specific to the <literal>NDBCLUSTER</literal> storage engine.
</para>
<para>
@@ -2069,8 +2068,8 @@
<important>
<para>
The only type of user-defined partitioning that is supported
- for use with the <literal role="se">NDBCLUSTER</literal>
- storage engine in MySQL 5.1 is key partitioning.
+ for use with the <literal>NDBCLUSTER</literal> storage engine
+ in MySQL 5.1 is key partitioning.
</para>
</important>
@@ -2303,8 +2302,7 @@
<literal>setName()</literal> is the only
<literal>Column</literal> method whose result is visible from
a MySQL Server. MySQL cannot see any other changes made to
- existing columns using the <literal role="se">NDB</literal>
- API.
+ existing columns using the <literal>NDB</literal> API.
</para>
</important>
Modified: trunk/ndbapi/class-datafile.xml
===================================================================
--- trunk/ndbapi/class-datafile.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/class-datafile.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 1, Lines Added: 2, Lines Deleted: 2; 657 bytes
@@ -61,8 +61,8 @@
Versions of MySQL prior to 5.1 do not support Disk Data storage
and so do not support datafiles; thus the
<literal>Datafile</literal> class is unavailable for
- <literal role="se">NDB</literal> API applications written against
- these MySQL versions.
+ <literal>NDB</literal> API applications written against these
+ MySQL versions.
</para>
</note>
Modified: trunk/ndbapi/class-dictionary.xml
===================================================================
--- trunk/ndbapi/class-dictionary.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/class-dictionary.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 2, Lines Added: 3, Lines Deleted: 3; 788 bytes
@@ -305,7 +305,7 @@
<title>Parameters</title>
<para>
- An <literal role="se">NDB</literal> object. See
+ An <literal>Ndb</literal> object. See
<xref linkend="class-ndb"/>.
</para>
@@ -993,8 +993,8 @@
<title>Description</title>
<para>
- This method retrieves the most recent
- <literal role="se">NDB</literal> API error.
+ This method retrieves the most recent <literal>NDB</literal>
+ API error.
</para>
</formalpara>
Modified: trunk/ndbapi/class-event.xml
===================================================================
--- trunk/ndbapi/class-event.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/class-event.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 1; 530 bytes
@@ -276,7 +276,7 @@
<para>
<literal>TableEvent</literal> is used to classify the types of
events that may be associated with tables in the
- <literal role="se">NDB</literal> API.
+ <literal>NDB</literal> API.
</para>
</formalpara>
Modified: trunk/ndbapi/class-index.xml
===================================================================
--- trunk/ndbapi/class-index.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/class-index.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 2, Lines Added: 6, Lines Deleted: 6; 1129 bytes
@@ -281,10 +281,10 @@
<important>
<para>
- If you create or change indexes using the
- <literal role="se">NDB</literal> API, these modifications cannot
- be seen by MySQL. The only exception to this is renaming the
- index using <literal>Index::setName()</literal>.
+ If you create or change indexes using the <literal>NDB</literal>
+ API, these modifications cannot be seen by MySQL. The only
+ exception to this is renaming the index using
+ <literal>Index::setName()</literal>.
</para>
</important>
@@ -305,8 +305,8 @@
<important>
<para>
- Indexes created using the <literal role="se">NDB</literal> API
- cannot be seen by the MySQL Server.
+ Indexes created using the <literal>NDB</literal> API cannot be
+ seen by the MySQL Server.
</para>
</important>
Modified: trunk/ndbapi/class-logfilegroup.xml
===================================================================
--- trunk/ndbapi/class-logfilegroup.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/class-logfilegroup.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 1, Lines Added: 2, Lines Deleted: 2; 678 bytes
@@ -64,8 +64,8 @@
Versions of MySQL prior to 5.1 do not support Disk Data storage
and so do not support logfile groups; thus the
<literal>LogfileGroup</literal> class is unavailable for
- <literal role="se">NDB</literal> API applications written against
- these MySQL versions.
+ <literal>NDB</literal> API applications written against these
+ MySQL versions.
</para>
</note>
Modified: trunk/ndbapi/class-ndb-cluster-connection.xml
===================================================================
--- trunk/ndbapi/class-ndb-cluster-connection.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/class-ndb-cluster-connection.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 14, Lines Added: 46, Lines Deleted: 56; 10367 bytes
@@ -70,10 +70,10 @@
<literal>Ndb_cluster_connection</literal> objects representing
connections to different management servers in a single
application, nor against using these for creating multiple
- instances of the <literal role="se">NDB</literal> class. Such
+ instances of the <literal>Ndb</literal> class. Such
<literal>Ndb_cluster_connection</literal> objects (and the
- <literal role="se">NDB</literal> instances based on them) are not
- required even to connect to the same cluster.
+ <literal>Ndb</literal> instances based on them) are not required
+ even to connect to the same cluster.
</para>
<para>
@@ -81,7 +81,7 @@
<firstterm>application-level partitioning</firstterm> of data in
such a manner that data meeting one set of criteria are
<quote>handed off</quote> to one cluster via an
- <literal role="se">NDB</literal> object that makes use of an
+ <literal>Ndb</literal> object that makes use of an
<literal>Ndb_cluster_connection</literal> object representing a
connection to that cluster, while data not meeting those criteria
(or perhaps a different set of criteria) can be sent to a
@@ -127,12 +127,12 @@
<listitem>
<para>
- An <literal role="se">NDB</literal> object making use of
- this connection (<literal>Ndb_cluster_connection</literal>)
+ An <literal>Ndb</literal> object making use of this
+ connection (<literal>Ndb_cluster_connection</literal>)
cannot be re-used to connect to a different cluster
management server (and thus to a different collection of
data nodes making up a cluster). Any given instance of
- <literal role="se">NDB</literal> is bound to a specific
+ <literal>Ndb</literal> is bound to a specific
<literal>Ndb_cluster_connection</literal> when created, and
that <literal>Ndb_cluster_connection</literal> is in turn
bound to a single and unique management server when it is
@@ -147,7 +147,7 @@
<listitem>
<para>
The bindings described above persist for the lifetimes of
- the <literal role="se">NDB</literal> and
+ the <literal>Ndb</literal> and
<literal>Ndb_cluster_connection</literal> objects in
question.
</para>
@@ -158,10 +158,9 @@
Therefore, it is imperative in designing and implementing any
application that accesses multiple clusters in a single session,
that a separate set of <literal>Ndb_cluster_connection</literal>
- and <literal role="se">NDB</literal> objects be instantiated for
- connecting to each cluster management server, and that no
- confusion arises as to which of these is used to access which
- MySQL Cluster.
+ and <literal>Ndb</literal> objects be instantiated for connecting
+ to each cluster management server, and that no confusion arises as
+ to which of these is used to access which MySQL Cluster.
</para>
<para>
@@ -229,22 +228,22 @@
<row>
<entry><literal><link linkend="class-ndb-cluster-connection-lock-ndb-objects">lock_ndb_objects()</link></literal></entry>
<entry><para>
- Disables the creation of new
- <literal role="se">NDB</literal> objects.
+ Disables the creation of new <literal>Ndb</literal>
+ objects.
</para></entry>
</row>
<row>
<entry><literal><link linkend="class-ndb-cluster-connection-unlock-ndb-objects">unlock_ndb_objects()</link></literal></entry>
<entry><para>
- Enables the creation of new
- <literal role="se">NDB</literal> objects.
+ Enables the creation of new <literal>Ndb</literal>
+ objects.
</para></entry>
</row>
<row>
<entry><literal><link linkend="class-ndb-cluster-connection-get-next-ndb-object">get_next_ndb_object()</link></literal></entry>
<entry><para>
- Used to iterate through multiple
- <literal role="se">NDB</literal> objects.
+ Used to iterate through multiple <literal>Ndb</literal>
+ objects.
</para></entry>
</row>
</tbody>
@@ -293,11 +292,10 @@
<para>
This method creates a connection to a MySQL cluster, that is,
to a cluster of data nodes. The object returned by this method
- is required in order to instantiate an
- <literal role="se">NDB</literal> object. (See
- <xref linkend="class-ndb"/>.) Thus, every
- <literal role="se">NDB</literal> API application requires the
- use of an <literal>Ndb_cluster_connection</literal>.
+ is required in order to instantiate an <literal>Ndb</literal>
+ object. (See <xref linkend="class-ndb"/>.) Thus, every
+ <literal>NDB</literal> API application requires the use of an
+ <literal>Ndb_cluster_connection</literal>.
</para>
</formalpara>
@@ -876,8 +874,7 @@
<para>
This method is used to iterate over a set of
- <literal role="se">NDB</literal> objects, retrieving them one
- at a time.
+ <literal>Ndb</literal> objects, retrieving them one at a time.
</para>
</formalpara>
@@ -903,8 +900,8 @@
<para>
This method takes a single parameter, a pointer to the last
- <literal role="se">NDB</literal> object to have been retrieved
- or <literal>NULL</literal>.
+ <literal>Ndb</literal> object to have been retrieved or
+ <literal>NULL</literal>.
</para>
</formalpara>
@@ -914,20 +911,19 @@
<title>Return Value</title>
<para>
- Returns the next <literal role="se">NDB</literal> object, or
- <literal>NULL</literal> if no more
- <literal role="se">NDB</literal> objects are available.
+ 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 role="se">NDB</literal> objects</title>
+ <title>Iterating over <literal>Ndb</literal> objects</title>
<para>
- To retrieve all existing <literal role="se">NDB</literal>
- objects:
+ To retrieve all existing <literal>Ndb</literal> objects:
<orderedlist>
@@ -935,7 +931,7 @@
<para>
Invoke the <literal>lock_ndb_objects()</literal> method.
This prevents the creation of any new instances of
- <literal role="se">NDB</literal> until the
+ <literal>Ndb</literal> until the
<literal>unlock_ndb_objects()</literal> method is
called.
</para>
@@ -943,26 +939,23 @@
<listitem>
<para>
- Retrieve the first available
- <literal role="se">NDB</literal> object by passing
- <literal>NULL</literal> to
+ 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 role="se">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 role="se">NDB</literal> instance is used, the
- method returns <literal>NULL</literal>.
+ 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 role="se">NDB</literal> objects, you should
- re-enable <literal role="se">NDB</literal> object
- creation by calling the
+ <literal>Ndb</literal> objects, you should re-enable
+ <literal>Ndb</literal> object creation by calling the
<literal>unlock_ndb_objects()</literal> method.
</para>
</listitem>
@@ -1004,10 +997,9 @@
<para>
Calling this method prevents the creation of new instances of
- the <literal role="se">NDB</literal> class. This method must
- be called prior to iterating over multiple
- <literal role="se">NDB</literal> objects using
- <literal>get_next_ndb_object()</literal>.
+ 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>
@@ -1079,12 +1071,10 @@
<para>
This method undoes the effects of the
<literal>lock_ndb_objects()</literal> method, making it
- possible to create new instances of
- <literal role="se">NDB</literal>.
+ possible to create new instances of <literal>Ndb</literal>.
<literal>unlock_ndb_objects()</literal> should be called after
- you have finished retrieving <literal role="se">NDB</literal>
- objects using the <literal>get_next_ndb_object()</literal>
- method.
+ you have finished retrieving <literal>Ndb</literal> objects
+ using the <literal>get_next_ndb_object()</literal> method.
</para>
</formalpara>
Modified: trunk/ndbapi/class-ndb.xml
===================================================================
--- trunk/ndbapi/class-ndb.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/class-ndb.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 24, Lines Added: 59, Lines Deleted: 64; 12563 bytes
@@ -5,7 +5,7 @@
]>
<section id="class-ndb">
- <title>The <literal role="se">NDB</literal> Class</title>
+ <title>The <literal>Ndb</literal> Class</title>
<indexterm>
<primary>Ndb class</primary>
@@ -14,9 +14,8 @@
<abstract>
<para>
- This class represents the <literal role="se">NDB</literal> kernel;
- it is the primary class of the <literal role="se">NDB</literal>
- API.
+ This class represents the <literal>NDB</literal> kernel; it is the
+ primary class of the <literal>NDB</literal> API.
</para>
</abstract>
@@ -46,15 +45,14 @@
<title>Description</title>
<para>
- Any non-trivial <literal role="se">NDB</literal> API program makes
- use of at least one instance of <literal role="se">NDB</literal>.
- By using several <literal role="se">NDB</literal> objects, it is
- possible to implement a multi-threaded application. You should
- remember that one <literal role="se">NDB</literal> object cannot
- be shared between threads; however, it is possible for a single
- thread to use multiple <literal role="se">NDB</literal> objects. A
- single application process can support a maximum of 128
- <literal role="se">NDB</literal> objects.
+ Any non-trivial <literal>NDB</literal> API program makes use of at
+ least one instance of <literal>Ndb</literal>. By using several
+ <literal>Ndb</literal> objects, it is possible to implement a
+ multi-threaded application. You should remember that one
+ <literal>Ndb</literal> object cannot be shared between threads;
+ however, it is possible for a single thread to use multiple
+ <literal>Ndb</literal> objects. A single application process can
+ support a maximum of 128 <literal>Ndb</literal> objects.
</para>
</formalpara>
@@ -62,11 +60,11 @@
<note>
<para>
The Ndb object is multi-thread safe in that each
- <literal role="se">NDB</literal> object can be handled by one
- thread at a time. If an <literal role="se">NDB</literal> object is
- handed over to another thread, then the application must ensure
- that a memory barrier is used to ensure that the new thread sees
- all updates performed by the previous thread.
+ <literal>Ndb</literal> object can be handled by one thread at a
+ time. If an <literal>Ndb</literal> object is handed over to
+ another thread, then the application must ensure that a memory
+ barrier is used to ensure that the new thread sees all updates
+ performed by the previous thread.
</para>
<para>
@@ -77,10 +75,9 @@
</note>
<para>
- It is also possible to use multiple <literal role="se">NDB</literal>
- objects to perform operations on different clusters in a single
- application. See the
- <link linkend="ndb-application-level-partitioning">Note on
+ It is also possible to use multiple <literal>Ndb</literal> objects
+ to perform operations on different clusters in a single application.
+ See the <link linkend="ndb-application-level-partitioning">Note on
Application-Level Partitioning</link> for conditions and
restrictions applying to such usage.
</para>
@@ -118,8 +115,7 @@
</row>
<row>
<entry><literal><link linkend="class-ndb-init">init()</link></literal></entry>
- <entry>Initialises an <literal role="se">NDB</literal> object and makes it
- ready for use.</entry>
+ <entry>Initialises an <literal>Ndb</literal> object and makes it ready for use.</entry>
</row>
<row>
<entry><literal><link linkend="class-ndb-getdictionary">getDictionary()</link></literal></entry>
@@ -169,8 +165,8 @@
</row>
<row>
<entry><literal><link linkend="class-ndb-getreference">getReference()</link></literal></entry>
- <entry>Retrieves a reference or identifier for the
- <literal role="se">NDB</literal> object instance.</entry>
+ <entry>Retrieves a reference or identifier for the <literal>Ndb</literal>
+ object instance.</entry>
</row>
</tbody>
</tgroup>
@@ -187,15 +183,15 @@
<para>
This diagram shows all the available methods of the
- <literal role="se">NDB</literal> class:
+ <literal>Ndb</literal> class:
<mediaobject>
<imageobject>
<imagedata contentwidth="540" contentdepth="360" fileref="images/published/Ndb-class.png" format="PNG"/>
</imageobject>
<textobject>
- <phrase lang="en">Public methods of the
- <literal role="se">NDB</literal> class.</phrase>
+ <phrase lang="en">Public methods of the <literal>Ndb</literal>
+ class.</phrase>
</textobject>
</mediaobject>
</para>
@@ -204,32 +200,31 @@
<section id="class-ndb-methods">
- <title><literal role="se">NDB</literal> Methods</title>
+ <title><literal>Ndb</literal> Methods</title>
<abstract>
<para>
The sections that follow discuss the public methods of the
- <literal role="se">NDB</literal> class.
+ <literal>Ndb</literal> class.
</para>
</abstract>
<section id="class-ndb-constructor">
- <title><literal role="se">NDB</literal> Class Constructor</title>
+ <title><literal>Ndb</literal> Class Constructor</title>
<formalpara>
<title>Description</title>
<para>
- This creates an instance of <literal role="se">NDB</literal>,
- which represents a connection to the MySQL Cluster. All
- <literal role="se">NDB</literal> API applications should begin
- with the creation of at least one
- <literal role="se">NDB</literal> object. This requires the
- creation of at least one instance of
+ This creates an instance of <literal>Ndb</literal>, which
+ represents a connection to the MySQL Cluster. All
+ <literal>NDB</literal> API applications should begin with the
+ creation of at least one <literal>Ndb</literal> object. This
+ requires the creation of at least one instance of
<literal>Ndb_cluster_connection</literal>, which serves as a
container for a cluster connectstring.
</para>
@@ -258,8 +253,8 @@
<title>Parameters</title>
<para>
- The <literal role="se">NDB</literal> class constructor can
- take up to 3 parameters, of which only the first is required:
+ The <literal>Ndb</literal> class constructor can take up to 3
+ parameters, of which only the first is required:
<itemizedlist>
@@ -277,7 +272,7 @@
<replaceable>catalogName</replaceable> is an optional
parameter providing a namespace for the tables and
indexes created in any connection from the
- <literal role="se">NDB</literal> object.
+ <literal>Ndb</literal> object.
</para>
<para>
@@ -313,7 +308,7 @@
<title>Return Value</title>
<para>
- An <literal role="se">NDB</literal> object.
+ An <literal>Ndb</literal> object.
</para>
</formalpara>
@@ -324,7 +319,7 @@
<title>Example</title>
<para>
- This example shows how to create an <literal role="se">NDB</literal>
+ This example shows how to create an <literal>Ndb</literal>
object:
<programlisting>
@@ -340,10 +335,10 @@
<title><literal>~Ndb()</literal> (Class Destructor)</title>
<para>
- The destructor for the <literal role="se">NDB</literal> class
- should be called in order to terminate an instance of
- <literal role="se">NDB</literal>. It requires no arguments,
- nor any special handling.
+ The destructor for the <literal>Ndb</literal> class should be
+ called in order to terminate an instance of
+ <literal>Ndb</literal>. It requires no arguments, nor any
+ special handling.
</para>
</formalpara>
@@ -367,8 +362,8 @@
<title>Description</title>
<para>
- This method is used to initialise an
- <literal role="se">NDB</literal> object.
+ This method is used to initialise an <literal>Ndb</literal>
+ object.
</para>
</formalpara>
@@ -397,8 +392,8 @@
<replaceable>maxNoOfTransactions</replaceable> of type
integer. This parameter specifies the maximum number of
parallel <literal>NdbTransaction</literal> objects that can be
- handled by this instance of <literal role="se">NDB</literal>.
- The maximum permitted value for
+ handled by this instance of <literal>Ndb</literal>. The
+ maximum permitted value for
<replaceable>maxNoOfTransactions</replaceable> is 1024; if not
specified, it defaults to 4.
</para>
@@ -426,7 +421,7 @@
<listitem>
<para>
<emphasis role="bold">0</emphasis>: indicates that the
- <literal role="se">NDB</literal> object was initialised
+ <literal>Ndb</literal> object was initialised
successfully.
</para>
</listitem>
@@ -449,7 +444,7 @@
<para>
This example shows how to use the <literal>init()</literal>
- method to initialise an <literal role="se">NDB</literal> object:
+ method to initialise an <literal>Ndb</literal> object:
<programlisting>
[<emphasis>To be supplied...</emphasis>]
@@ -1187,8 +1182,8 @@
<title>Description</title>
<para>
- This is one of two <literal role="se">NDB</literal> API
- methods provided for closing a transaction (the other being
+ This is one of two <literal>NDB</literal> API methods provided
+ for closing a transaction (the other being
<literal>NdbTransaction::close()</literal> — see
<xref linkend="class-ndbtransaction-close"/>). You must call
one of these two methods to close the transaction once it has
@@ -1651,7 +1646,7 @@
This method provides you with two different ways to obtain an
<literal>NdbError</literal> object representing an error
condition. For more detailed information about error handling
- in the <literal role="se">NDB</literal> API, see
+ in the <literal>NDB</literal> API, see
<xref linkend="ndb-errors"/>.
</para>
@@ -1685,7 +1680,7 @@
Regardless of which version of the method is used, the
<literal>NdbError</literal> object returned persists until the
- next <literal role="se">NDB</literal> API method is invoked.
+ next <literal>NDB</literal> API method is invoked.
</para>
</formalpara>
@@ -1700,8 +1695,8 @@
obtain the error matching a specific
<replaceable>errorCode</replaceable>, invoke the method
passing the code (an <literal>int</literal>) to it as a
- parameter. For a listing of <literal role="se">NDB</literal>
- API error codes and corresponding error messages, see
+ parameter. For a listing of <literal>NDB</literal> API error
+ codes and corresponding error messages, see
<xref linkend="ndb-error-messages"/>.
</para>
@@ -1728,7 +1723,7 @@
<para>
This example shows how to use
<literal>getNdbError()</literal> to retrieve the most recent
- <literal role="se">NDB</literal> API error:
+ <literal>NDB</literal> API error:
<programlisting>
[<emphasis>To be supplied...</emphasis>]
@@ -1759,10 +1754,10 @@
<para>
This method can be used to obtain a reference to a given
- <literal role="se">NDB</literal> object. This is the same
- value that is returned for a given operation corresponding to
- this object in the output of <literal>DUMP 2350</literal>.
- (See <xref linkend="ndb-internals-dump-command-2350"/>, for an
+ <literal>Ndb</literal> object. This is the same value that is
+ returned for a given operation corresponding to this object in
+ the output of <literal>DUMP 2350</literal>. (See
+ <xref linkend="ndb-internals-dump-command-2350"/>, for an
example.)
</para>
Modified: trunk/ndbapi/class-ndbblob.xml
===================================================================
--- trunk/ndbapi/class-ndbblob.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/class-ndbblob.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 2, Lines Added: 2, Lines Deleted: 2; 801 bytes
@@ -2144,7 +2144,7 @@
<listitem>
<para>
<replaceable>ndb</replaceable>: The relevant
- <literal role="se">NDB</literal> object.
+ <literal>Ndb</literal> object.
</para>
</listitem>
@@ -2259,7 +2259,7 @@
<listitem>
<para>
<replaceable>ndb</replaceable>: The relevant
- <literal role="se">NDB</literal> object.
+ <literal>Ndb</literal> object.
</para>
</listitem>
Modified: trunk/ndbapi/class-ndbdictionary.xml
===================================================================
--- trunk/ndbapi/class-ndbdictionary.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/class-ndbdictionary.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 2, Lines Added: 8, Lines Deleted: 9; 1636 bytes
@@ -22,7 +22,7 @@
While the preferred method of database object creation and
deletion is through the MySQL Server,
<literal>NdbDictionary</literal> also permits the developer to
- perform these tasks via the <literal role="se">NDB</literal> API.
+ perform these tasks via the <literal>NDB</literal> API.
</para>
</abstract>
@@ -114,14 +114,13 @@
</para>
<para>
- Dropping indexes via the <literal role="se">NDB</literal> API that
- were created originally from a MySQL Cluster causes
- inconsistencies. It is possible that a table from which one or
- more indexes have been dropped using the
- <literal role="se">NDB</literal> API will no longer be usable by
- MySQL following such operations. In this event, the table must be
- dropped, and then re-created using MySQL to make it accessible to
- MySQL once more.
+ Dropping indexes via the <literal>NDB</literal> API that were
+ created originally from a MySQL Cluster causes inconsistencies. It
+ is possible that a table from which one or more indexes have been
+ dropped using the <literal>NDB</literal> API will no longer be
+ usable by MySQL following such operations. In this event, the
+ table must be dropped, and then re-created using MySQL to make it
+ accessible to MySQL once more.
</para>
</warning>
Modified: trunk/ndbapi/class-ndbeventoperation.xml
===================================================================
--- trunk/ndbapi/class-ndbeventoperation.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/class-ndbeventoperation.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 4, Lines Added: 4, Lines Deleted: 4; 1515 bytes
@@ -59,7 +59,7 @@
<para>
This class has no public constructor or destructor. Instead,
instances of <literal>NdbEventOperation</literal> are created as
- the result of method calls on <literal role="se">NDB</literal> and
+ the result of method calls on <literal>Ndb</literal> and
<literal>NdbDictionary</literal> objects:
<orderedlist>
@@ -110,7 +110,7 @@
<para>
The following issues may be encountered when working with event
- operations in the <literal role="se">NDB</literal> API:
+ operations in the <literal>NDB</literal> API:
<itemizedlist>
@@ -158,7 +158,7 @@
<para>
We intend to remedy this issue in a future release of MySQL
- Cluster and the <literal role="se">NDB</literal> API.
+ Cluster and the <literal>NDB</literal> API.
</para>
</listitem>
@@ -585,7 +585,7 @@
<para>
This method defines the retrieval of an attribute value. The
- <literal role="se">NDB</literal> API allocates memory for the
+ <literal>NDB</literal> API allocates memory for the
<literal>NdbRecAttr</literal> object that is to hold the
returned attribute value.
</para>
Modified: trunk/ndbapi/class-ndboperation.xml
===================================================================
--- trunk/ndbapi/class-ndboperation.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/class-ndboperation.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 3, Lines Added: 10, Lines Deleted: 10; 2064 bytes
@@ -536,8 +536,8 @@
<para>
This method prepares for the retrieval of an attribute value.
- The <literal role="se">NDB</literal> API allocates memory for
- an <literal>NdbRecAttr</literal> object that is later used to
+ The <literal>NDB</literal> API allocates memory for an
+ <literal>NdbRecAttr</literal> object that is later used to
hold the returned attribute value.
</para>
@@ -1611,12 +1611,12 @@
</para>
<para>
- However, the <literal role="se">NDB</literal> API does check
- that the application sends a correct length to the interface
- as given in the length parameter. A <literal>char*</literal>
- value can contain any datatype or any type of array. If the
- length is not provided, or if it is set to zero, then the API
- assumes that the pointer is correct, and does not check it.
+ However, the <literal>NDB</literal> API does check that the
+ application sends a correct length to the interface as given
+ in the length parameter. A <literal>char*</literal> value can
+ contain any datatype or any type of array. If the length is
+ not provided, or if it is set to zero, then the API assumes
+ that the pointer is correct, and does not check it.
</para>
</important>
@@ -1634,8 +1634,8 @@
<note>
<para>
When you use <literal>insertTuple()</literal>, the
- <literal role="se">NDB</literal> API will automatically detect
- that it is supposed to use <literal>equal()</literal> instead.
+ <literal>NDB</literal> API will automatically detect that it
+ is supposed to use <literal>equal()</literal> instead.
</para>
<para>
Modified: trunk/ndbapi/class-ndbrecattr.xml
===================================================================
--- trunk/ndbapi/class-ndbrecattr.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/class-ndbrecattr.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 2, Lines Added: 4, Lines Deleted: 4; 1378 bytes
@@ -48,10 +48,10 @@
<literal>NdbRecAttr</literal> contains the value of an attribute.
An <literal>NdbRecAttr</literal> object is used to store an
attribute value after it has been retrieved the
- <literal role="se">NDB</literal> Cluster using the
+ <literal>NDB</literal> Cluster using the
<literal>NdbOperation::getValue()</literal>. This object is
- allocated by the <literal role="se">NDB</literal> API. A brief
- example is shown here:
+ allocated by the <literal>NDB</literal> API. A brief example is
+ shown here:
<programlisting>
MyRecAttr = MyOperation->getValue("ATTR2", NULL);
@@ -1675,7 +1675,7 @@
This method is used to obtain a reference to an attribute
value, as a <literal>char</literal> pointer. This pointer is
aligned appropriately for the datatype. The memory is released
- by the <literal role="se">NDB</literal> API when
+ by the <literal>NDB</literal> API when
<literal>NdbTransaction::closeTransaction()</literal> is
executed on the transaction which read the value.
</para>
Modified: trunk/ndbapi/class-ndbscanoperation.xml
===================================================================
--- trunk/ndbapi/class-ndbscanoperation.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/class-ndbscanoperation.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 4, Lines Added: 14, Lines Deleted: 15; 3370 bytes
@@ -487,9 +487,9 @@
<listitem>
<para>
- Normally, the <literal role="se">NDB</literal> API
- contacts the <literal role="se">NDB</literal> kernel for
- more tuples whenever it is necessary; setting
+ Normally, the <literal>NDB</literal> API contacts the
+ <literal>NDB</literal> kernel for more tuples whenever
+ it is necessary; setting
<replaceable>fetchAllowed</replaceable> to
<literal>false</literal> keeps this from happening.
</para>
@@ -497,13 +497,13 @@
<para>
Disabling <replaceable>fetchAllowed</replaceable> by
setting it to <literal>false</literal> forces
- <literal role="se">NDB</literal> to process any records
- it already has in its caches. When there are no more
- cached records it returns <literal>2</literal>. You must
- then call <literal>nextResult()</literal> with
+ <literal>NDB</literal> to process any records it already
+ has in its caches. When there are no more cached records
+ it returns <literal>2</literal>. You must then call
+ <literal>nextResult()</literal> with
<replaceable>fetchAllowed</replaceable> equal to
<literal>true</literal> in order to contact
- <literal role="se">NDB</literal> for more records.
+ <literal>NDB</literal> for more records.
</para>
<para>
@@ -517,16 +517,15 @@
to be made, and then, the locks to be released.
Following this, call <literal>nextResult(true)</literal>
— this fetches more records and caches them in the
- <literal role="se">NDB</literal> API.
+ <literal>NDB</literal> API.
</para>
<note>
<para>
If you do not transfer the records to another
transaction, the locks on those records will be
- released the next time that the
- <literal role="se">NDB</literal> Kernel is contacted
- for more records.
+ released the next time that the <literal>NDB</literal>
+ Kernel is contacted for more records.
</para>
</note>
@@ -583,9 +582,9 @@
<listitem>
<para>
When false, <replaceable>fetchAllowed</replaceable>
- forces <literal role="se">NDB</literal> to process any
- records it already has in its caches. See the
- description for this parameter in the previous
+ forces <literal>NDB</literal> to process any records it
+ already has in its caches. See the description for this
+ parameter in the previous
<citetitle>Parameters</citetitle> subsection for more
details.
</para>
Modified: trunk/ndbapi/class-ndbtransaction.xml
===================================================================
--- trunk/ndbapi/class-ndbtransaction.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/class-ndbtransaction.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 4, Lines Added: 11, Lines Deleted: 13; 2871 bytes
@@ -45,10 +45,9 @@
<title>Description</title>
<para>
- A transaction is represented in the
- <literal role="se">NDB</literal> API by an
- <literal>NdbTransaction</literal> object, which belongs to an
- <literal role="se">NDB</literal> object and is created using
+ A transaction is represented in the <literal>NDB</literal> API by
+ an <literal>NdbTransaction</literal> object, which belongs to an
+ <literal>Ndb</literal> object and is created using
<literal>Ndb::startTransaction()</literal>. A transaction consists
of a list of operations represented by the
<literal>NdbOperation</literal> class, or by one of its subclasses
@@ -109,15 +108,15 @@
<literal>NdbTransaction</literal> object, in which case they
are executed in parallel. When all operations are defined,
the <literal>execute()</literal> method sends them to the
- <literal role="se">NDB</literal> kernel for execution.
+ <literal>NDB</literal> kernel for execution.
</para>
</listitem>
<listitem>
<para>
The <literal>execute()</literal> method returns when the
- <literal role="se">NDB</literal> kernel has completed
- execution of all operations previously defined.
+ <literal>NDB</literal> kernel has completed execution of all
+ operations previously defined.
</para>
<important>
@@ -477,11 +476,10 @@
Beginning with MySQL Cluster NDB 6.2.0, this type belongs to
the <literal>NdbOperation</literal> class and its possible
values and default behavior have changed.
- <literal role="se">NDB</literal> API application code written
- against previous versions of MySQL Cluster that refers
- explicitly to <literal>NdbTransaction::AbortOption</literal>
- values must be modified to work with MySQL Cluster NDB 6.2.0
- or later.
+ <literal>NDB</literal> API application code written against
+ previous versions of MySQL Cluster that refers explicitly to
+ <literal>NdbTransaction::AbortOption</literal> values must be
+ modified to work with MySQL Cluster NDB 6.2.0 or later.
</para>
<para>
@@ -1075,7 +1073,7 @@
<para>
A <replaceable>force</replaceable> parameter, which
determines when operations should be sent to the
- <literal role="se">NDB</literal> Kernel:
+ <literal>NDB</literal> Kernel:
<itemizedlist>
Modified: trunk/ndbapi/class-object.xml
===================================================================
--- trunk/ndbapi/class-object.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/class-object.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 3, Lines Added: 7, Lines Deleted: 8; 2210 bytes
@@ -359,8 +359,7 @@
<para>
Reading an object's <literal>Status</literal> tells whether or
- not it is available in the <literal role="se">NDB</literal>
- kernel.
+ not it is available in the <literal>NDB</literal> kernel.
</para>
</formalpara>
@@ -384,18 +383,18 @@
<row>
<entry><literal>New</literal></entry>
<entry>The object exists only in memory, and has not yet been created in the
- <literal role="se">NDB</literal> kernel</entry>
+ <literal>NDB</literal> kernel</entry>
</row>
<row>
<entry><literal>Changed</literal></entry>
<entry>The object has been modified in memory, and must be committed in the
- <literal role="se">NDB</literal> Kernel for changes
- to take effect</entry>
+ <literal>NDB</literal> Kernel for changes to take
+ effect</entry>
</row>
<row>
<entry><literal>Retrieved</literal></entry>
<entry>The object exists, and has been read into main memory from the
- <literal role="se">NDB</literal> Kernel</entry>
+ <literal>NDB</literal> Kernel</entry>
</row>
<row>
<entry><literal>Invalid</literal></entry>
@@ -403,8 +402,8 @@
</row>
<row>
<entry><literal>Altered</literal></entry>
- <entry>The table has been altered in the <literal role="se">NDB</literal>
- kernel, but is still available for use</entry>
+ <entry>The table has been altered in the <literal>NDB</literal> kernel, but is
+ still available for use</entry>
</row>
</tbody>
</tgroup>
Modified: trunk/ndbapi/class-table.xml
===================================================================
--- trunk/ndbapi/class-table.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/class-table.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 5, Lines Added: 14, Lines Deleted: 15; 2834 bytes
@@ -15,8 +15,7 @@
<para>
This section describes the <literal>Table</literal> class, which
- models a database table in the <literal role="se">NDB</literal>
- API.
+ models a database table in the <literal>NDB</literal> API.
</para>
</abstract>
@@ -56,13 +55,13 @@
<important>
<para>
- It is possible using the <literal role="se">NDB</literal> API to
- create tables independently of the MySQL server. However, it is
- usually not advisable to do so, since tables created in this
- fashion cannot be seen by the MySQL server. Similarly, it is
- possible using <literal>Table</literal> methods to modify existing
- tables, but these changes (except for renaming tables) are not
- visible to MySQL.
+ It is possible using the <literal>NDB</literal> API to create
+ tables independently of the MySQL server. However, it is usually
+ not advisable to do so, since tables created in this fashion
+ cannot be seen by the MySQL server. Similarly, it is possible
+ using <literal>Table</literal> methods to modify existing tables,
+ but these changes (except for renaming tables) are not visible to
+ MySQL.
</para>
</important>
@@ -514,8 +513,8 @@
<para>
As with other database objects, <literal>Table</literal> object
creation and attribute changes to existing tables done using the
- <literal role="se">NDB</literal> API are not visible from MySQL.
- For example, if you add a new column to a table using
+ <literal>NDB</literal> API are not visible 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
tables is that you can change the name of an existing table
@@ -541,8 +540,8 @@
<important>
<para>
- Tables created in the <literal role="se">NDB</literal> API
- using this method are not accessible from MySQL.
+ Tables created in the <literal>NDB</literal> API using this
+ method are not accessible from MySQL.
</para>
</important>
@@ -5065,8 +5064,8 @@
<para>
Even after the <literal>validate()</literal> method is called,
there may still exist errors which can be detected only by the
- <literal role="se">NDB</literal> kernel when the table is
- actually created.
+ <literal>NDB</literal> kernel when the table is actually
+ created.
</para>
</warning>
Modified: trunk/ndbapi/class-tablespace.xml
===================================================================
--- trunk/ndbapi/class-tablespace.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/class-tablespace.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 2, Lines Added: 4, Lines Deleted: 4; 972 bytes
@@ -65,8 +65,8 @@
Versions of MySQL prior to 5.1 do not support Disk Data storage
and so do not support tablespaces; thus the
<literal>Tablespace</literal> class is unavailable for
- <literal role="se">NDB</literal> API applications written against
- these MySQL versions.
+ <literal>NDB</literal> API applications written against these
+ MySQL versions.
</para>
</note>
@@ -204,8 +204,8 @@
<para>
This section provides details of the public members of the
- <literal role="se">NDB</literal> API's
- <literal>Tablespace</literal> class.
+ <literal>NDB</literal> API's <literal>Tablespace</literal>
+ class.
</para>
</abstract>
Modified: trunk/ndbapi/class-undofile.xml
===================================================================
--- trunk/ndbapi/class-undofile.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/class-undofile.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 1, Lines Added: 2, Lines Deleted: 2; 656 bytes
@@ -62,8 +62,8 @@
Versions of MySQL prior to 5.1 do not support Disk Data storage
and so do not support undofile; thus the
<literal>Undofile</literal> class is unavailable for
- <literal role="se">NDB</literal> API applications written against
- these MySQL versions.
+ <literal>NDB</literal> API applications written against these
+ MySQL versions.
</para>
</note>
Modified: trunk/ndbapi/getting-started.xml
===================================================================
--- trunk/ndbapi/getting-started.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/getting-started.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 17, Lines Added: 57, Lines Deleted: 64; 10905 bytes
@@ -16,27 +16,27 @@
-->
<chapter id="getting-started">
- <title>Getting Started with the <literal role="se">NDB</literal> API</title>
+ <title>Getting Started with the <literal>NDB</literal> API</title>
<abstract>
<para>
This chapter discusses preparations for writing an
- <literal role="se">NDB</literal> API application.
+ <literal>NDB</literal> API application.
</para>
</abstract>
<section id="getting-started-compiling">
- <title>Compiling and Linking <literal role="se">NDB</literal> API Programs</title>
+ <title>Compiling and Linking <literal>NDB</literal> API Programs</title>
<abstract>
<para>
This section provides information on compiling and linking
- <literal role="se">NDB</literal> API applications, including
- requirements and compiler and linker options.
+ <literal>NDB</literal> API applications, including requirements
+ and compiler and linker options.
</para>
</abstract>
@@ -46,23 +46,23 @@
<title>General Requirements</title>
<para>
- To use the <literal role="se">NDB</literal> API with MySQL, you
- must have the <literal role="se">NDB</literal> client library
- and its header files installed alongside the regular MySQL
- client libraries and headers. These are automatically installed
- when you build MySQL using the
- <option>--with-ndbcluster</option> <command>configure</command>
- option or when using a MySQL binary package that supports the
- <literal role="se">NDBCLUSTER</literal> storage engine.
+ To use the <literal>NDB</literal> API with MySQL, you must have
+ the <literal>NDB</literal> client library and its header files
+ installed alongside the regular MySQL client libraries and
+ headers. These are automatically installed when you build MySQL
+ using the <option>--with-ndbcluster</option>
+ <command>configure</command> option or when using a MySQL binary
+ package that supports the <literal>NDBCLUSTER</literal> storage
+ engine.
</para>
<note>
<para>
MySQL 4.1 does not install the required
- <literal role="se">NDB</literal>-specific header files. You
- should use MySQL 5.0 or later when writing
- <literal role="se">NDB</literal> API applications, and this
- Guide is targeted for use with MySQL 5.1.
+ <literal>NDB</literal>-specific header files. You should use
+ MySQL 5.0 or later when writing <literal>NDB</literal> API
+ applications, and this Guide is targeted for use with MySQL
+ 5.1.
</para>
<para>
@@ -86,11 +86,11 @@
<para>
In order to compile source files that use the
- <literal role="se">NDB</literal> API, you must ensure that the
- necessary header files can be found. Header files specific to
- the <literal role="se">NDB</literal> API are installed in the
- following subdirectories of the MySQL
- <filename>include</filename> directory:
+ <literal>NDB</literal> API, you must ensure that the necessary
+ header files can be found. Header files specific to the
+ <literal>NDB</literal> API are installed in the following
+ subdirectories of the MySQL <filename>include</filename>
+ directory:
<itemizedlist>
@@ -127,8 +127,8 @@
</programlisting>
This sets the include path for the MySQL header files but not
- for those specific to the <literal role="se">NDB</literal>
- API. The <option>--include</option> option to
+ for those specific to the <literal>NDB</literal> API. The
+ <option>--include</option> option to
<command>mysql_config</command> returns the generic include
path switch:
@@ -170,12 +170,11 @@
<title>Linker Options</title>
<para>
- <literal role="se">NDB</literal> API applications must be linked
- against both the MySQL and <literal role="se">NDB</literal>
- client libraries. The <literal role="se">NDB</literal> client
- library also requires some functions from the
- <literal>mystrings</literal> library, so this must be linked in
- as well.
+ <literal>NDB</literal> API applications must be linked against
+ both the MySQL and <literal>NDB</literal> client libraries. The
+ <literal>NDB</literal> client library also requires some
+ functions from the <literal>mystrings</literal> library, so this
+ must be linked in as well.
</para>
<para>
@@ -397,9 +396,8 @@
<abstract>
<para>
- This section covers connecting an
- <literal role="se">NDB</literal> API application to a MySQL
- cluster.
+ This section covers connecting an <literal>NDB</literal> API
+ application to a MySQL cluster.
</para>
</abstract>
@@ -409,24 +407,23 @@
<title>Include Files</title>
<para>
- <literal role="se">NDB</literal> API applications require one or
- more of the following include files:
+ <literal>NDB</literal> API applications require one or more of
+ the following include files:
<itemizedlist>
<listitem>
<para>
Applications accessing Cluster data via the
- <literal role="se">NDB</literal> API must include the file
+ <literal>NDB</literal> API must include the file
<filename>NdbApi.hpp</filename>.
</para>
</listitem>
<listitem>
<para>
- Applications making use of both the
- <literal role="se">NDB</literal> API and the regular MySQL
- client API also need to include
+ Applications making use of both the <literal>NDB</literal>
+ API and the regular MySQL client API also need to include
<filename>mysql.h</filename>.
</para>
</listitem>
@@ -448,11 +445,11 @@
<title>API Initialisation and Cleanup</title>
<para>
- Before using the <literal role="se">NDB</literal> API, it must
- first be initialised by calling the
- <literal>ndb_init()</literal> function. Once an
- <literal role="se">NDB</literal> API application is complete,
- call <literal>ndb_end(0)</literal> to perform a cleanup.
+ Before using the <literal>NDB</literal> API, it must first be
+ initialised by calling the <literal>ndb_init()</literal>
+ function. Once an <literal>NDB</literal> API application is
+ complete, call <literal>ndb_end(0)</literal> to perform a
+ cleanup.
</para>
</section>
@@ -575,8 +572,7 @@
<section id="getting-started-mysql-ndb-mapping">
- <title>Mapping MySQL Database Object Names and Types to
- <literal role="se">NDB</literal></title>
+ <title>Mapping MySQL Database Object Names and Types to <literal>NDB</literal></title>
<abstract>
@@ -593,8 +589,8 @@
<para>
Databases and schemas are not represented by objects as such in
- the <literal role="se">NDB</literal> API. Instead, they are
- modelled as attributes of <literal>Table</literal> and
+ the <literal>NDB</literal> API. Instead, they are modelled as
+ attributes of <literal>Table</literal> and
<literal>Index</literal> objects. The value of the
<literal>database</literal> attribute of one of these objects is
always the same as the name of the MySQL database to which the
@@ -611,9 +607,8 @@
<title>Tables</title>
<para>
- MySQL table names are directly mapped to
- <literal role="se">NDB</literal> table names without
- modification. Table names starting with
+ MySQL table names are directly mapped to <literal>NDB</literal>
+ table names without modification. Table names starting with
'<literal>NDB$</literal>' are reserved for internal use>, as
is the <literal>SYSTAB_0</literal> table in the
<literal>sys</literal> database.
@@ -666,8 +661,7 @@
This index is given the name <literal>PRIMARY</literal>.
There is no extra hash; however, the uniqueness of the
primary key is guaranteed by making the MySQL key the
- internal primary key of the
- <literal role="se">NDB</literal> table.
+ internal primary key of the <literal>NDB</literal> table.
</para>
</listitem>
@@ -681,8 +675,8 @@
<title>Column Names and Values</title>
<para>
- <literal role="se">NDB</literal> column names are the same as
- their MySQL names.
+ <literal>NDB</literal> column names are the same as their MySQL
+ names.
</para>
</formalpara>
@@ -692,8 +686,8 @@
<title>Datatypes</title>
<para>
- MySQL datatypes are stored in <literal role="se">NDB</literal>
- columns as follows:
+ MySQL datatypes are stored in <literal>NDB</literal> columns as
+ follows:
<itemizedlist>
@@ -702,9 +696,8 @@
The MySQL <literal>TINYINT</literal>,
<literal>SMALLINT</literal>, <literal>INT</literal>, and
<literal>BIGINT</literal> datatypes map to
- <literal role="se">NDB</literal> types having the same
- names and storage requirements as their MySQL
- counterparts.
+ <literal>NDB</literal> types having the same names and
+ storage requirements as their MySQL counterparts.
</para>
</listitem>
@@ -712,8 +705,8 @@
<para>
The MySQL <literal>FLOAT</literal> and
<literal>DOUBLE</literal> datatypes are mapped to
- <literal role="se">NDB</literal> types having the same
- names and storage requirements.
+ <literal>NDB</literal> types having the same names and
+ storage requirements.
</para>
</listitem>
@@ -743,8 +736,8 @@
<listitem>
<para>
For in-memory columns, the
- <literal role="se">NDBCLUSTER</literal> storage
- engine supports variable-width columns with 4-byte
+ <literal>NDBCLUSTER</literal> storage engine
+ supports variable-width columns with 4-byte
alignment. This means that (for example) a the
string <literal>'abcde'</literal> stored in a
<literal>VARCHAR(50)</literal> column using the
Modified: trunk/ndbapi/interface-ndbrecord.xml
===================================================================
--- trunk/ndbapi/interface-ndbrecord.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/interface-ndbrecord.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 2, Lines Added: 6, Lines Deleted: 7; 1536 bytes
@@ -10,8 +10,8 @@
<para>
<literal>NdbRecord</literal> is an interface which provides a
mapping to a full or a partial record stored in
- <literal role="se">NDB</literal>. In the latter case, it can be used
- in conjunction with a bitmap to assist in access.
+ <literal>NDB</literal>. In the latter case, it can be used in
+ conjunction with a bitmap to assist in access.
<literal>NdbRecord</literal> is available beginning with MySQL
Cluster NDB 6.2.3.
</para>
@@ -55,13 +55,12 @@
<para>
An <literal>NdbRecord</literal> can be created in
- <literal role="se">NDB</literal> API programs by calling the
+ <literal>NDB</literal> API programs by calling the
<literal>createRecord()</literal> method of the
<literal>NdbDictionary</literal> class. In addition, a number of
- <literal role="se">NDB</literal> API methods have additional
- declarations in MySQL Cluster NDB 6.2.3 and later MySQL Cluster NDB
- 6.x releases that allow the programmer to leverage
- <literal>NdbRecord</literal>:
+ <literal>NDB</literal> API methods have additional declarations in
+ MySQL Cluster NDB 6.2.3 and later MySQL Cluster NDB 6.x releases
+ that allow the programmer to leverage <literal>NdbRecord</literal>:
<itemizedlist>
Modified: trunk/ndbapi/mgm-api.xml
===================================================================
--- trunk/ndbapi/mgm-api.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/mgm-api.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 1; 545 bytes
@@ -1588,7 +1588,7 @@
<para>
This section discusses MGM API functions that are used to
initiate, configure, and terminate connections to an
- <literal role="se">NDB</literal> management server.
+ <literal>NDB</literal> management server.
</para>
</abstract>
Modified: trunk/ndbapi/ndb-classes.xml
===================================================================
--- trunk/ndbapi/ndb-classes.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/ndb-classes.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 1, Lines Added: 3, Lines Deleted: 3; 747 bytes
@@ -5,14 +5,14 @@
]>
<chapter id="ndb-classes">
- <title><literal role="se">NDB</literal> API Classes, Interfaces, and Structures</title>
+ <title><literal>NDB</literal> API Classes, Interfaces, and Structures</title>
<abstract>
<para>
This chapter provides a detailed listing of all classes,
- interfaces, and stuctures defined in the
- <literal role="se">NDB</literal> API.
+ interfaces, and stuctures defined in the <literal>NDB</literal>
+ API.
</para>
</abstract>
Modified: trunk/ndbapi/ndb-errors.xml
===================================================================
--- trunk/ndbapi/ndb-errors.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/ndb-errors.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 15, Lines Added: 34, Lines Deleted: 40; 8377 bytes
@@ -13,7 +13,7 @@
potentially generated in MySQL Cluster API applications. It
includes information about error codes, classifications, and
messages for the MGM API (see <xref linkend="ndb-mgm-error"/>) and
- <literal role="se">NDB</literal> API (see
+ <literal>NDB</literal> API (see
<xref linkend="ndb-error-messages"/>). Also provided in this
chapter is a listing of exit codes and messages returned by a
failed <command>ndbd</command> process, in
@@ -307,17 +307,16 @@
<section id="ndb-error-messages">
- <title><literal role="se">NDB</literal> API Errors and Error Handling</title>
+ <title><literal>NDB</literal> API Errors and Error Handling</title>
<abstract>
<para>
This section contains a discussion of error handling in
- <literal role="se">NDB</literal> API applications as well as
- listing listings of the most common
- <literal role="se">NDB</literal> error codes and messages, along
- with their classifications and likely causes for which they
- might be raised.
+ <literal>NDB</literal> API applications as well as listing
+ listings of the most common <literal>NDB</literal> error codes
+ and messages, along with their classifications and likely causes
+ for which they might be raised.
</para>
</abstract>
@@ -325,19 +324,18 @@
<para>
For information about the <literal>NdbError</literal> structure,
which is used to convey error information to
- <literal role="se">NDB</literal> API applications, see
+ <literal>NDB</literal> API applications, see
<xref linkend="struct-ndberror"/>.
</para>
<important>
<para>
It is strongly recommended that you <emphasis>not</emphasis>
- depend on specific error codes in your
- <literal role="se">NDB</literal> API applications, as they are
- subject to change over time. Instead, you should use the
- <literal>NdbError::Status</literal> and error classification in
- your source code, or consult the output of <literal>perror
- <option>--ndb</option>
+ depend on specific error codes in your <literal>NDB</literal>
+ API applications, as they are subject to change over time.
+ Instead, you should use the <literal>NdbError::Status</literal>
+ and error classification in your source code, or consult the
+ output of <literal>perror <option>--ndb</option>
<replaceable>error_code</replaceable></literal> to obtain
information about a specific error code.
</para>
@@ -352,14 +350,13 @@
<section id="ndb-errors-handling">
- <title>Handling <literal role="se">NDB</literal> API Errors</title>
+ <title>Handling <literal>NDB</literal> API Errors</title>
<abstract>
<para>
- This section describes how <literal role="se">NDB</literal>
- API errors can be detected and mapped onto particular
- operations.
+ This section describes how <literal>NDB</literal> API errors
+ can be detected and mapped onto particular operations.
</para>
</abstract>
@@ -411,8 +408,8 @@
<important>
<para>
If you have worked with older versions of the
- <literal role="se">NDB</literal> API, you should be aware
- that, beginning with MySQL Cluster NDB 6.2.0, the
+ <literal>NDB</literal> API, you should be aware that,
+ beginning with MySQL Cluster NDB 6.2.0, the
<literal>AbortOption</literal> type is a member of
<literal>NdbOperation</literal>. See
<xref linkend="class-ndboperation-abortoption"/>, for more
@@ -827,14 +824,14 @@
</formalpara>
<para>
- For information about <literal role="se">NDB</literal> API error
+ For information about <literal>NDB</literal> API error
classification and status codes, see
<xref linkend="ndb-error-classifications"/>. While you should
not not rely on a specific error code or message text in your
- <literal role="se">NDB</literal> API applications — since
- error codes and messages are both subject to change over time
- — it can be useful to check error codes and messages to
- help determine why a particular failure occurred. For more
+ <literal>NDB</literal> API applications — since error
+ codes and messages are both subject to change over time —
+ it can be useful to check error codes and messages to help
+ determine why a particular failure occurred. For more
information about these, see <xref linkend="ndb-error-codes"/>.
For more about <literal>NdbError</literal> and the types of
information which can be obtained from
@@ -1002,8 +999,8 @@
<para>
This section lists all the error messages that can be returned
when a data node process halts due to an error, arranged in most
- cases according to the affected <literal role="se">NDB</literal>
- kernel block.
+ cases according to the affected <literal>NDB</literal> kernel
+ block.
</para>
<para>
@@ -1025,7 +1022,7 @@
<para>
This section contains <command>ndbd</command> error codes that
are either generic in nature or otherwise not associated with
- a specific <literal role="se">NDB</literal> kernel block.
+ a specific <literal>NDB</literal> kernel block.
</para>
<informaltable>
@@ -1226,8 +1223,7 @@
<para>
This section contains <command>ndbd</command> error codes that
are associated with problems in the <literal>VM</literal>
- (virtal machine) <literal role="se">NDB</literal> kernel
- block.
+ (virtal machine) <literal>NDB</literal> kernel block.
</para>
<informaltable>
@@ -1289,8 +1285,8 @@
<para>
This section contains <command>ndbd</command> error codes that
are associated with problems in the <literal>NDBCNTR</literal>
- (initialization and configuration)
- <literal role="se">NDB</literal> kernel block.
+ (initialization and configuration) <literal>NDB</literal>
+ kernel block.
</para>
<informaltable>
@@ -1333,8 +1329,7 @@
<para>
This section contains <command>ndbd</command> error codes that
are associated with problems in the <literal>DIH</literal>
- (distribution handler) <literal role="se">NDB</literal> kernel
- block.
+ (distribution handler) <literal>NDB</literal> kernel block.
</para>
<informaltable>
@@ -1384,8 +1379,8 @@
<para>
This section contains <command>ndbd</command> error codes that
are associated with problems in the <literal>ACC</literal>
- (access control and lock management)
- <literal role="se">NDB</literal> kernel block.
+ (access control and lock management) <literal>NDB</literal>
+ kernel block.
</para>
<informaltable>
@@ -1420,8 +1415,7 @@
<para>
This section contains <command>ndbd</command> error codes that
are associated with problems in the <literal>TUP</literal>
- (tuple management) <literal role="se">NDB</literal> kernel
- block.
+ (tuple management) <literal>NDB</literal> kernel block.
</para>
<informaltable>
@@ -1456,7 +1450,7 @@
<para>
This section contains <command>ndbd</command> error codes that
are associated with problems in the <literal>NDBFS</literal>
- (file system) <literal role="se">NDB</literal> kernel block.
+ (filesystem) <literal>NDB</literal> kernel block.
</para>
<para>
@@ -1701,7 +1695,7 @@
<section id="ndb-transporter-errors">
- <title><literal role="se">NDB</literal> Transporter Errors</title>
+ <title><literal>NDB</literal> Transporter Errors</title>
<para>
This section lists error codes, names, and messages that are
Modified: trunk/ndbapi/ndb-examples.xml
===================================================================
--- trunk/ndbapi/ndb-examples.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/ndb-examples.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 5, Lines Added: 14, Lines Deleted: 14; 2710 bytes
@@ -1100,7 +1100,7 @@
<listitem>
<para>
- <literal role="se">NDB</literal>:
+ <literal>Ndb</literal>:
</para>
<itemizedlist>
@@ -2388,8 +2388,8 @@
<para>
This program illustrates how to use secondary indexes in the
- <literal role="se">NDB</literal> API with the aid of the
- NdbRecord interface introduced in MySQL-5.1.18-6.2.3..
+ <literal>NDB</literal> API with the aid of the NdbRecord
+ interface introduced in MySQL-5.1.18-6.2.3..
</para>
<para>
@@ -2735,7 +2735,7 @@
<section id="ndb-examples-event-handling">
- <title><literal role="se">NDB</literal> API Event Handling Example</title>
+ <title><literal>NDB</literal> API Event Handling Example</title>
<indexterm>
<primary>events</primary>
@@ -3332,10 +3332,10 @@
<para>
This example illustrates the manipulation of a
- <literal>BLOB</literal> column in the
- <literal role="se">NDB</literal> API. It demonstrates how to
- perform insert, read, and update operations, using both inline
- value buffers as well as read and write methods.
+ <literal>BLOB</literal> column in the <literal>NDB</literal>
+ API. It demonstrates how to perform insert, read, and update
+ operations, using both inline value buffers as well as read and
+ write methods.
</para>
<para>
@@ -3863,12 +3863,12 @@
<para>
This example illustrates the manipulation of a
- <literal>BLOB</literal> column in the
- <literal role="se">NDB</literal> API using the
- <literal>NdbRecord</literal> interface available beginning with
- MySQL Cluster NDB 6.2.3. It demonstrates how to perform insert,
- read, and update operations, using both inline value buffers as
- well as read and write methods. It can be found in the file
+ <literal>BLOB</literal> column in the <literal>NDB</literal> API
+ using the <literal>NdbRecord</literal> interface available
+ beginning with MySQL Cluster NDB 6.2.3. It demonstrates how to
+ perform insert, read, and update operations, using both inline
+ value buffers as well as read and write methods. It can be found
+ in the file
<filename>storage/ndb/ndbapi-examples/ndbapi_blob_ndbrecord/main.cpp</filename>
in the <literal>mysql-5.1-telco</literal> and
<literal>mysql-5.1-telco-6.2</literal> source trees.
Modified: trunk/ndbapi/ndb-hierarchy.xml
===================================================================
--- trunk/ndbapi/ndb-hierarchy.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/ndb-hierarchy.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 2, Lines Added: 3, Lines Deleted: 3; 893 bytes
@@ -5,11 +5,11 @@
]>
<chapter id="ndb-hierarchy">
- <title>The <literal role="se">NDB</literal> Object Hierarachy</title>
+ <title>The <literal>NDB</literal> Object Hierarachy</title>
<para>
Here we provide a hierarchical listing of all classes, interfaces,
- and structures exposed by the <literal role="se">NDB</literal> API.
+ and structures exposed by the <literal>NDB</literal> API.
</para>
<para>
@@ -17,7 +17,7 @@
<listitem>
<para>
- <link linkend="class-ndb"><literal role="se">NDB</literal></link>
+ <link linkend="class-ndb"><literal>Ndb</literal></link>
</para>
</listitem>
Modified: trunk/ndbapi/ndb-internals.xml
===================================================================
--- trunk/ndbapi/ndb-internals.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/ndb-internals.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 32, Lines Added: 77, Lines Deleted: 84; 18097 bytes
@@ -430,12 +430,11 @@
</programlisting>
<para>
- This causes the contents of one or more
- <literal role="se">NDB</literal> registers on the node with ID
- <replaceable>node_id</replaceable> to be dumped to the Cluster
- log. The registers affected are determined by the value of
- <replaceable>code</replaceable>. Some (but not all)
- <literal>DUMP</literal> commands accept additional
+ This causes the contents of one or more <literal>NDB</literal>
+ registers on the node with ID <replaceable>node_id</replaceable>
+ to be dumped to the Cluster log. The registers affected are
+ determined by the value of <replaceable>code</replaceable>. Some
+ (but not all) <literal>DUMP</literal> commands accept additional
<replaceable>arguments</replaceable>; these are noted and
described where applicable.
</para>
@@ -460,9 +459,8 @@
<listitem>
<para>
- The relevant <literal role="se">NDB</literal> kernel block
- or blocks (see
- <xref linkend="ndb-internals-kernel-blocks"/>, for
+ The relevant <literal>NDB</literal> kernel block or blocks
+ (see <xref linkend="ndb-internals-kernel-blocks"/>, for
information about these)
</para>
</listitem>
@@ -1665,7 +1663,7 @@
<title>Description</title>
<para>
- Provides <literal role="se">NDB</literal> file system
+ Provides <literal>NDB</literal> file system
statistics.
</para>
@@ -1727,7 +1725,7 @@
<title>Description</title>
<para>
- Prints <literal role="se">NDB</literal> file system file
+ Prints <literal>NDB</literal> file system file
handles and states (<literal>OPEN</literal> or
<literal>CLOSED</literal>).
</para>
@@ -1814,7 +1812,7 @@
<title>Description</title>
<para>
- Prints list of <literal role="se">NDB</literal> file system
+ Prints list of <literal>NDB</literal> file system
open files.
</para>
@@ -1883,7 +1881,7 @@
<title>Description</title>
<para>
- Prints list of <literal role="se">NDB</literal> file system
+ Prints list of <literal>NDB</literal> file system
idle file handles.
</para>
@@ -3405,14 +3403,14 @@
<listitem>
<formalpara>
- <title>Relation to <literal role="se">NDB</literal> API</title>
+ <title>Relation to <literal>NDB</literal> API</title>
<para>
It is possible to match the output of <literal>DUMP
2350</literal> to specific threads or
- <literal role="se">NDB</literal> objects. First
- suppose that you dump all operations on data node 2
- from API node 5, using table 4 only, like this:
+ <literal>Ndb</literal> objects. First suppose that
+ you dump all operations on data node 2 from API node
+ 5, using table 4 only, like this:
<programlisting>
ndb_mgm> <userinput>2 DUMP 2350 1 5 0 4</userinput>
@@ -3423,12 +3421,11 @@
</programlisting>
Suppose you are working with an
- <literal role="se">NDB</literal> instance named
+ <literal>Ndb</literal> instance named
<literal>MyNdb</literal>, to which this operation
belongs. You can see that this is the case by
- calling the <literal role="se">NDB</literal>
- object's <literal>getReference()</literal> method,
- like this:
+ calling the <literal>Ndb</literal> object's
+ <literal>getReference()</literal> method, like this:
<programlisting>
printf("MyNdb.getReference(): 0x%x\n", MyNdb.getReference());
@@ -8349,21 +8346,20 @@
<section id="ndb-internals-ndb-protocol-overview">
- <title><literal role="se">NDB</literal> Protocol Overview</title>
+ <title><literal>NDB</literal> Protocol Overview</title>
<para>
MySQL Cluster data and API nodes communicate with one another by
passing messages to one another. The sending of a message from
one node and its reception by another node is referred to as a
- <firstterm>signal</firstterm>; the
- <literal role="se">NDB</literal> Protocol is the set of rules
- governing the format of these messages and the manner in which
- they are passed.
+ <firstterm>signal</firstterm>; the <literal>NDB</literal>
+ Protocol is the set of rules governing the format of these
+ messages and the manner in which they are passed.
</para>
<para>
- An <literal role="se">NDB</literal> message is typically either
- a <firstterm>request</firstterm> or a
+ An <literal>NDB</literal> message is typically either a
+ <firstterm>request</firstterm> or a
<firstterm>response</firstterm>. A request indicates that an API
node wants to perform an operation involving cluster data (such
as retrieval, insertion, updating, or deletion) or transactions
@@ -8541,8 +8537,8 @@
<title>Message Naming Conventions and Structure</title>
<para>
- This section describes the <literal role="se">NDB</literal>
- Protocol message types and their structures.
+ This section describes the <literal>NDB</literal> Protocol
+ message types and their structures.
</para>
<formalpara>
@@ -9123,12 +9119,12 @@
<section id="ndb-internals-kernel-blocks">
- <title><literal role="se">NDB</literal> Kernel Blocks</title>
+ <title><literal>NDB</literal> Kernel Blocks</title>
<para>
The following sections list and describe the major kernel blocks
- found in the <literal role="se">NDB</literal> source code. These
- are found under the directory
+ found in the <literal>NDB</literal> source code. These are found
+ under the directory
<filename>storage/ndb/src/kernel/blocks/</filename> in the MySQL
source code tree.
</para>
@@ -9250,8 +9246,8 @@
<para>
This block is responsible for configuration management between
- the kernel blocks and the <literal role="se">NDB</literal>
- virtual machine, as well as the cluster job que and cluster
+ the kernel blocks and the <literal>NDB</literal> virtual
+ machine, as well as the cluster job que and cluster
transporters. It is found in
<filename>storage/ndb/src/kernel/blocks/cmvmi</filename>, and
contains these files:
@@ -9693,10 +9689,9 @@
<para>
Contains the definition of the
<literal>Sysfile</literal> structure; in other words,
- the format of an <literal role="se">NDB</literal> system
- file. See <xref linkend="ndb-internals-filesystems"/>,
- for more information about
- <literal role="se">NDB</literal> system files.
+ the format of an <literal>NDB</literal> system file. See
+ <xref linkend="ndb-internals-filesystems"/>, for more
+ information about <literal>NDB</literal> system files.
</para>
</formalpara>
@@ -10711,7 +10706,7 @@
<para>
The routines contained in this file perform handling of
- <literal role="se">NDB</literal> internal triggers.
+ <literal>NDB</literal> internal triggers.
</para>
</formalpara>
@@ -11159,7 +11154,7 @@
<title>The <literal>NDBFS</literal> Block</title>
<para>
- This block provides the <literal role="se">NDB</literal> file
+ This block provides the <literal>NDB</literal> file
system abstraction layer, and is located in the directory
<filename>storage/ndb/src/kernel/blocks/ndbfs</filename>, which
contains the following files:
@@ -11337,8 +11332,8 @@
<title><filename>Ndbfs.hpp</filename></title>
<para>
- Because an <literal role="se">NDB</literal> signal
- request can result in multiple requests to
+ Because an <literal>NDB</literal> signal request can
+ result in multiple requests to
<literal>AsyncFile</literal>, one class (defined in this
file) is responsible for keeping track of all
outstanding requests, and when all are finished,
@@ -11563,8 +11558,8 @@
<para>
Defines the <literal>Timer</literal> class, used by
- <literal role="se">NDB</literal> to keep strict
- timekeeping independent of the system clock.
+ <literal>NDB</literal> to keep strict timekeeping
+ independent of the system clock.
</para>
</formalpara>
@@ -12030,7 +12025,7 @@
<note>
<para>
Connections between the kernel blocks and the
- <literal role="se">NDB</literal> file system are also set up
+ <literal>NDB</literal> file system are also set up
during Phase 0. This is necessary to enable the blocks to
communicate easily which parts of a table structure are to be
written to disk.
@@ -12038,8 +12033,8 @@
</note>
<para>
- <literal role="se">NDB</literal> performs memory allocations in
- two different ways. The first of these is by using the
+ <literal>NDB</literal> performs memory allocations in two
+ different ways. The first of these is by using the
<literal>allocRecord()</literal> method (defined in
<filename>storage/ndb/src/kernel/vm/SimulatedBlock.hpp</filename>).
This is the traditional method whereby records are accessed
@@ -12082,12 +12077,12 @@
<title><literal>STTOR</literal> Phase 0</title>
<para>
- Most <literal role="se">NDB</literal> kernel blocks begin their
- start phases at <literal>STTOR</literal> Phase 1, with the
- exception of <literal>NDBFS</literal> and
- <literal>NDBCNTR</literal>, which begin with Phase 0, as can be
- seen by inspecting the first value for each element in the
- <literal>ALL_BLOCKS</literal> array (defined in
+ Most <literal>NDB</literal> kernel blocks begin their start
+ phases at <literal>STTOR</literal> Phase 1, with the exception
+ of <literal>NDBFS</literal> and <literal>NDBCNTR</literal>,
+ which begin with Phase 0, as can be seen by inspecting the first
+ value for each element in the <literal>ALL_BLOCKS</literal>
+ array (defined in
<filename>src/kernel/blocks/ndbcntr/NdbcntrMain.cpp</filename>).
In addition, when the <literal>STTOR</literal> signal is sent to
a block, the return signal <literal>STTORRY</literal> always
@@ -12106,7 +12101,7 @@
<para>
Both activities in Phase 0 have to do with initialization of the
- <literal role="se">NDB</literal> file system. First, if
+ <literal>NDB</literal> file system. First, if
necessary, <literal>NDBFS</literal> creates the file system
directory for the data node. In the case of an initial start,
<literal>NDBCNTR</literal> clears any existing files from the
@@ -12552,10 +12547,10 @@
<literal>DBACC</literal>, while <literal>DBTC</literal> allows
its internal records to be exchanged with
<literal>DBDIH</literal>. The <literal>DBDIH</literal> kernel
- block creates the mutexes used by the
- <literal role="se">NDB</literal> kernel and reads nodes using
- the <literal>READ_NODESREQ</literal> signal. With the data from
- the response to this signal, <literal>DBDIH</literal> can create
+ block creates the mutexes used by the <literal>NDB</literal>
+ kernel and reads nodes using the
+ <literal>READ_NODESREQ</literal> signal. With the data from the
+ response to this signal, <literal>DBDIH</literal> can create
node lists, node groups, and so forth. For node restarts and
initial node restarts, <literal>DBDIH</literal> also asks the
master for permission to perform the restart. The master will
@@ -13280,12 +13275,11 @@
<section id="ndb-internals-glossary">
- <title><literal role="se">NDB</literal> Internals Glossary</title>
+ <title><literal>NDB</literal> Internals Glossary</title>
<para>
This section contains terms and abbreviations that are found in or
- useful to understanding the <literal role="se">NDB</literal>
- source code.
+ useful to understanding the <literal>NDB</literal> source code.
</para>
<itemizedlist>
@@ -13312,13 +13306,12 @@
<title>API node</title>
<para>
- In <literal role="se">NDB</literal> terms, this is any
- application that accesses cluster data using the
- <literal role="se">NDB</literal> API, including
- <command>mysqld</command> when functioning as an API node.
- (MySQL servers acting in this capacity are also referred to
- as <quote>SQL nodes</quote>). Often abbreviated to
- <quote>API</quote>.
+ In <literal>NDB</literal> terms, this is any application
+ that accesses cluster data using the <literal>NDB</literal>
+ API, including <command>mysqld</command> when functioning as
+ an API node. (MySQL servers acting in this capacity are also
+ referred to as <quote>SQL nodes</quote>). Often abbreviated
+ to <quote>API</quote>.
</para>
</formalpara>
@@ -13335,11 +13328,11 @@
<emphasis role="bold">V</emphasis>irtual
<emphasis role="bold">M</emphasis>achine
<emphasis role="bold">I</emphasis>nterface. An
- <literal role="se">NDB</literal> kernel handling non-signal
- requests to the operating system, as well as configuration
+ <literal>NDB</literal> kernel handling non-signal requests
+ to the operating system, as well as configuration
management, interaction with the cluster management server,
and interaction between various kernel blocks and the
- <literal role="se">NDB</literal> virtual machine. See
+ <literal>NDB</literal> virtual machine. See
<xref linkend="ndb-internals-kernel-blocks-cmvmi"/>, for
more information.
</para>
@@ -13383,7 +13376,7 @@
<title>DICT</title>
<para>
- The <literal role="se">NDB</literal> data
+ The <literal>NDB</literal> data
<emphasis role="bold">DICT</emphasis>ionary kernel block.
Also <emphasis role="bold">DBDICT</emphasis>. See
<xref linkend="ndb-internals-kernel-blocks-dbdict"/>.
@@ -13400,7 +13393,7 @@
<para>
<emphasis role="bold">DI</emphasis>stribution
<emphasis role="bold">H</emphasis>andler. An
- <literal role="se">NDB</literal> kernel block. See
+ <literal>NDB</literal> kernel block. See
<xref linkend="ndb-internals-kernel-blocks-dbdih"/>.
</para>
@@ -13416,8 +13409,8 @@
The <emphasis role="bold">L</emphasis>og
<emphasis role="bold">G</emphasis>roup
<emphasis role="bold">MAN</emphasis>ager
- <literal role="se">NDB</literal> kernel block, used for
- MySQL Cluster Disk Data tables. See
+ <literal>NDB</literal> kernel block, used for MySQL Cluster
+ Disk Data tables. See
<xref linkend="ndb-internals-kernel-blocks-lgman"/>.
</para>
@@ -13433,7 +13426,7 @@
<emphasis role="bold">L</emphasis>ocal
<emphasis role="bold">Q</emphasis>uery
<emphasis role="bold">H</emphasis>andler.
- <literal role="se">NDB</literal> kernel block, discussed in
+ <literal>NDB</literal> kernel block, discussed in
<xref linkend="ndb-internals-kernel-blocks-dblqh"/>.
</para>
@@ -13466,9 +13459,9 @@
<title>QMGR</title>
<para>
- The cluster management block in the
- <literal role="se">NDB</literal> kernel. It responsibilities
- include monitoring heartbeats from data and API nodes. See
+ The cluster management block in the <literal>NDB</literal>
+ kernel. It responsibilities include monitoring heartbeats
+ from data and API nodes. See
<xref linkend="ndb-internals-kernel-blocks-qmgr"/>, for more
information.
</para>
@@ -13545,8 +13538,8 @@
<para>
Stands for <emphasis role="bold">TR</emphasis>ansactions and
<emphasis role="bold">I</emphasis>nde<emphasis role="bold">X</emphasis>es,
- which are managed by the <literal role="se">NDB</literal>
- kernel block having this name. See
+ which are managed by the <literal>NDB</literal> kernel block
+ having this name. See
<xref linkend="ndb-internals-kernel-blocks-trix"/>.
</para>
@@ -13579,8 +13572,8 @@
<emphasis role="bold">TUP</emphasis>le. Unit of data
storage. Also used (along with
<emphasis role="bold">DBTUP</emphasis>) to refer to the
- <literal role="se">NDB</literal> kernel's tuple management
- block, which is discussed in
+ <literal>NDB</literal> kernel's tuple management block,
+ which is discussed in
<xref linkend="ndb-internals-kernel-blocks-dbtup"/>.
</para>
Modified: trunk/ndbapi/ndbapi.xml
===================================================================
--- trunk/ndbapi/ndbapi.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/ndbapi.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 1, Lines Added: 4, Lines Deleted: 4; 897 bytes
@@ -26,10 +26,10 @@
<para>
Provides information for developers wishing to use the low-level
C/C++-language NDB API for the MySQL®
- <literal role="se">NDBCLUSTER</literal> storage engine. Includes
- concepts, terminology, programming class and structure
- references, practical examples, common problems, and tips for
- using the NDB API in applications.
+ <literal>NDBCLUSTER</literal> storage engine. Includes concepts,
+ terminology, programming class and structure references,
+ practical examples, common problems, and tips for using the NDB
+ API in applications.
</para>
<para>
Modified: trunk/ndbapi/overview.xml
===================================================================
--- trunk/ndbapi/overview.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/overview.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 16, Lines Added: 46, Lines Deleted: 51; 9198 bytes
@@ -79,7 +79,7 @@
<para>
The NDB API provides a number of classes implementing the
functionality described above. The most important of these
- include the <literal role="se">NDB</literal>,
+ include the <literal>Ndb</literal>,
<literal>Ndb_cluster_connection</literal>,
<literal>NdbTransaction</literal>, and
<literal>NdbOperation</literal> classes. These model
@@ -179,9 +179,9 @@
<emphasis role="bold">Checkpoint</emphasis>: Generally
speaking, when data is saved to disk, it is said that a
checkpoint has been reached. When working with the
- <literal role="se">NDB</literal> storage engine, there are two
- sorts of checkpoints which work together in order to ensure
- that a consistent view of the cluster's data is maintained:
+ <literal>NDB</literal> storage engine, there are two sorts of
+ checkpoints which work together in order to ensure that a
+ consistent view of the cluster's data is maintained:
</para>
<itemizedlist>
@@ -413,10 +413,10 @@
<emphasis role="bold">Fragment</emphasis>: Contains a portion
of a database table; in other words, in the
- <literal role="se">NDB</literal> storage engine, a table is
- broken up into and stored as a number of subsets, usually
- referred to as fragments. A fragment is sometimes also called
- a <firstterm>partition</firstterm>.
+ <literal>NDB</literal> storage engine, a table is broken up
+ into and stored as a number of subsets, usually referred to as
+ fragments. A fragment is sometimes also called a
+ <firstterm>partition</firstterm>.
</para>
</listitem>
@@ -428,9 +428,8 @@
</indexterm>
<emphasis role="bold">Replica</emphasis>: Under the
- <literal role="se">NDB</literal> storage engine, each table
- fragment has number of replicas in order to provide
- redundancy.
+ <literal>NDB</literal> storage engine, each table fragment has
+ number of replicas in order to provide redundancy.
</para>
</listitem>
@@ -463,7 +462,7 @@
<secondary>defined</secondary>
</indexterm>
- <literal role="se">NDB</literal>: This originally stood for
+ <literal>NDB</literal>: This originally stood for
<quote>Network Database</quote>. It now refers to the storage
engine used by MySQL AB to enable its MySQL Cluster
distributed database.
@@ -531,7 +530,7 @@
<section id="overview-ndb-transaction-scanning">
- <title>The <literal role="se">NDBCLUSTER</literal> Transaction and Scanning API</title>
+ <title>The <literal>NDBCLUSTER</literal> Transaction and Scanning API</title>
<abstract>
@@ -580,8 +579,8 @@
<listitem>
<para>
- <literal role="se">NDB</literal> is the main class, and
- represents a connection to a database.
+ <literal>Ndb</literal> is the main class, and represents a
+ connection to a database.
</para>
<para>
@@ -679,8 +678,8 @@
<important>
<para>
- The <literal role="se">NDB</literal> event notification API is
- not supported prior to MySQL 5.1. (Bug #19719)
+ The <literal>NDB</literal> event notification API is not
+ supported prior to MySQL 5.1. (Bug #19719)
</para>
</important>
@@ -717,8 +716,7 @@
<listitem>
<para>
Initiate a database connection by constructing and
- initialising one or more <literal role="se">NDB</literal>
- objects.
+ initialising one or more <literal>Ndb</literal> objects.
</para>
</listitem>
@@ -739,7 +737,7 @@
<listitem>
<para>
- Delete <literal role="se">NDB</literal> objects.
+ Delete <literal>Ndb</literal> objects.
</para>
</listitem>
@@ -942,9 +940,8 @@
<para>
To execute several synchronous transactions in parallel, you
- can either use multiple <literal role="se">NDB</literal>
- objects in several threads, or start multiple application
- programs.
+ can either use multiple <literal>Ndb</literal> objects in
+ several threads, or start multiple application programs.
</para>
</section>
@@ -2017,15 +2014,14 @@
</indexterm>
<para>
- The <literal role="se">NDBCLUSTER</literal> storage engine
- used by MySQL Cluster is a relational database engine storing
- records in tables as with other relational database systems.
- Table rows represent records as tuples of relational data.
- When a new table is created, its attribute schema is specified
- for the table as a whole, and thus each table row has the same
+ The <literal>NDBCLUSTER</literal> storage engine used by MySQL
+ Cluster is a relational database engine storing records in
+ tables as with other relational database systems. Table rows
+ represent records as tuples of relational data. When a new
+ table is created, its attribute schema is specified for the
+ table as a whole, and thus each table row has the same
structure. Again, this is typical of relational databases, and
- <literal role="se">NDB</literal> is no different in this
- regard.
+ <literal>NDB</literal> is no different in this regard.
</para>
<formalpara>
@@ -2070,11 +2066,11 @@
</indexterm>
<para>
- <literal role="se">NDBCLUSTER</literal> uses
- <firstterm>pessimistic concurrency control</firstterm> based
- on locking. If a requested lock (implicit and depending on
- database operation) cannot be attained within a specified
- time, then a timeout error results.
+ <literal>NDBCLUSTER</literal> uses <firstterm>pessimistic
+ concurrency control</firstterm> based on locking. If a
+ requested lock (implicit and depending on database
+ operation) cannot be attained within a specified time, then
+ a timeout error results.
</para>
</formalpara>
@@ -2172,9 +2168,9 @@
<literal>NdbTransaction::execute()</literal>, they are not
immediately transferred to the NDB Kernel. Instead, transactions
are kept in a special send list (buffer) in the
- <literal role="se">NDB</literal> object to which they belong.
- The adaptive send algorithm decides when transactions should
- actually be transferred to the NDB kernel.
+ <literal>Ndb</literal> object to which they belong. The adaptive
+ send algorithm decides when transactions should actually be
+ transferred to the NDB kernel.
</para>
<indexterm>
@@ -2185,19 +2181,18 @@
The NDB API is designed as a multi-threaded interface, and so it
is often desirable to transfer database operations from more
than one thread at a time. The NDB API keeps track of which
- <literal role="se">NDB</literal> objects are active in
- transferring information to the NDB kernel and the expected
- number of threads to interact with the NDB kernel. Note that a
- given instance of <literal role="se">NDB</literal> should be
- used in at most one thread; different threads should
- <emphasis>not</emphasis> share the same
- <literal role="se">NDB</literal> object.
+ <literal>Ndb</literal> objects are active in transferring
+ information to the NDB kernel and the expected number of threads
+ to interact with the NDB kernel. Note that a given instance of
+ <literal>Ndb</literal> should be used in at most one thread;
+ different threads should <emphasis>not</emphasis> share the same
+ <literal>Ndb</literal> object.
</para>
<para>
There are four conditions leading to the transfer of database
- operations from <literal role="se">NDB</literal> object buffers
- to the NDB kernel:
+ operations from <literal>Ndb</literal> object buffers to the NDB
+ kernel:
</para>
<orderedlist>
@@ -2209,9 +2204,9 @@
implementation-dependent and may change between MySQL
Cluster releases. When TCP/IP is the transporter, the buffer
size is usually around 64 KB. Since each
- <literal role="se">NDB</literal> object provides a single
- buffer per data node, the notion of a <quote>full</quote>
- buffer is local to each data node.
+ <literal>Ndb</literal> object provides a single buffer per
+ data node, the notion of a <quote>full</quote> buffer is
+ local to each data node.
</para>
</listitem>
Modified: trunk/ndbapi/struct-ndberror.xml
===================================================================
--- trunk/ndbapi/struct-ndberror.xml 2009-01-22 20:10:44 UTC (rev 13350)
+++ trunk/ndbapi/struct-ndberror.xml 2009-01-22 20:51:53 UTC (rev 13351)
Changed blocks: 3, Lines Added: 5, Lines Deleted: 5; 1884 bytes
@@ -442,8 +442,8 @@
<entry>This is a temporary failure which was likely caused by a node recovery
in progress, some examples being when information
sent between an application and
- <literal role="se">NDB</literal> is lost, or when
- there is a distribution change.</entry>
+ <literal>NDB</literal> is lost, or when there is a
+ distribution change.</entry>
</row>
<row>
<entry><literal>OverloadError</literal></entry>
@@ -460,7 +460,7 @@
</row>
<row>
<entry><literal>InternalError</literal></entry>
- <entry>A serious error has occurred in <literal role="se">NDB</literal> itself.</entry>
+ <entry>A serious error has occurred in <literal>NDB</literal> itself.</entry>
</row>
<row>
<entry><literal>FunctionNotImplemented</literal></entry>
@@ -469,8 +469,8 @@
</row>
<row>
<entry><literal>UnknownErrorCode</literal></entry>
- <entry>This is seen where the <literal role="se">NDB</literal> error handler
- cannot determine the correct error code to report.</entry>
+ <entry>This is seen where the <literal>NDB</literal> error handler cannot
+ determine the correct error code to report.</entry>
</row>
<row>
<entry><literal>NodeShutdown</literal></entry>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r13351 - trunk/ndbapi | jon | 22 Jan |
