Author: js221926
Date: 2011-06-21 11:08:19 +0200 (Tue, 21 Jun 2011)
New Revision: 26565
Log:
General revisions
Fixed some datedness issues
Fixed spelling in title and ID
Updated renamed-nodes.txt
Modified:
trunk/ndbapi/ndb-getting-started.xml
trunk/ndbapi/renamed-nodes.txt
Modified: trunk/ndbapi/ndb-getting-started.xml
===================================================================
--- trunk/ndbapi/ndb-getting-started.xml 2011-06-21 07:01:29 UTC (rev 26564)
+++ trunk/ndbapi/ndb-getting-started.xml 2011-06-21 09:08:19 UTC (rev 26565)
Changed blocks: 16, Lines Added: 72, Lines Deleted: 81; 12901 bytes
@@ -41,24 +41,11 @@
engine.
</para>
- <note>
- <para>
- MySQL 4.1 does not install the required
- <literal>NDB</literal>-specific header files. You should use
- MySQL 5.0 or later when writing NDB API applications, and this
- Guide is targeted for use with MySQL Cluster in MySQL 5.1,
- MySQL Cluster NDB 6.X, MySQL Cluster NDB 7.X, and later.
- </para>
+ <para>
+ This <citetitle>Guide</citetitle> is targeted for use with MySQL
+ Cluster Cluster NDB 6.X, MySQL Cluster NDB 7.X, and later.
+ </para>
- <para>
- The library and header files were not included in MySQL 5.1
- binary distributions prior to MySQL 5.1.12; beginning with
- 5.1.12, you can find them in
- <filename>/usr/include/storage/ndb</filename>. This issue did
- not occur when compiling MySQL 5.1 from source.
- </para>
- </note>
-
</section>
<section id="ndb-start-compiler-options">
@@ -116,7 +103,7 @@
<para>
This sets the include path for the MySQL header files but not
for those specific to the NDB API. The
- <option>--include</option> option to
+ <option role="mysql_config">--include</option> option to
<command>mysql_config</command> returns the generic include path
switch:
</para>
@@ -193,10 +180,9 @@
</programlisting>
<para>
- Beginning with MySQL 5.1.24-ndb-6.2.16 and MySQL
- 5.1.24-ndb-6.3.14, it is necessary only to add
- <option>-lndbclient</option> to <literal>LD_FLAGS</literal>, as
- shown here:
+ Beginning with MySQL Cluster NDB 6.2.16 and MySQL Cluster NDB
+ 6.3.14, it is necessary only to add <option>-lndbclient</option>
+ to <literal>LD_FLAGS</literal>, as shown here:
</para>
<programlisting>
@@ -217,10 +203,10 @@
<para>
It is often faster and simpler to use GNU autotools than to
write your own makefiles. In this section, we provide an
- autoconf macro <literal>WITH_MYSQL</literal> that can be used to
- add a <option>--with-mysql</option> option to a configure file,
- and that automatically sets the correct compiler and linker
- flags for given MySQL installation.
+ <command>autoconf</command> macro <literal>WITH_MYSQL</literal>
+ that can be used to add a <option>--with-mysql</option> option
+ to a configure file, and that automatically sets the correct
+ compiler and linker flags for given MySQL installation.
</para>
<para>
@@ -416,16 +402,17 @@
<listitem>
<para>
- Applications making use of both the <literal>NDB</literal>
- API and the regular MySQL client API also need to include
- <filename>mysql.h</filename>.
+ Applications making use of the regular MySQL client API as
+ well as the NDB API must also include
+ <filename>mysql.h</filename> (in addition to
+ <filename>NdbApi.hpp</filename>).
</para>
</listitem>
<listitem>
<para>
- Applications that use cluster management functions need the
- include file <filename>mgmapi.h</filename>.
+ Applications that use cluster management functions from the
+ MGM API need the include file <filename>mgmapi.h</filename>.
</para>
</listitem>
@@ -433,15 +420,15 @@
</section>
- <section id="ndb-start-initialisation">
+ <section id="ndb-start-initialization">
- <title>API Initialisation and Cleanup</title>
+ <title>API Initialization and Cleanup</title>
<para>
- Before using the NDB API, it must first be initialised by
+ Before using the NDB API, it must first be initialized by
calling the <literal>ndb_init()</literal> function. Once an NDB
API application is complete, call <literal>ndb_end(0)</literal>
- to perform a cleanup.
+ to perform any necessary cleanup.
</para>
</section>
@@ -451,10 +438,10 @@
<title>Establishing the Connection</title>
<para>
- To establish a connection to the server, it is necessary to
- create an instance of
+ To establish a connection to the server, you must create an
+ instance of
<literal role="ndbapi">Ndb_cluster_connection</literal>, whose
- constructor takes as its argument a cluster connectstring; if no
+ constructor takes as its argument a cluster connectstring. If no
connectstring is given, <literal>localhost</literal> is assumed.
</para>
@@ -462,17 +449,18 @@
The cluster connection is not actually initiated until the
<literal role="ndbapi">Ndb_cluster_connection::connect()</literal>
method is called. When invoked without any arguments, the
- connection attempt is retried each 1 second indefinitely until
- successful, and no reporting is done.
+ connection attempt is retried indefinitely, once per second,
+ until successful. No reporting is done until the connection has
+ been made.
</para>
<para>
By default an API node connects to the <quote>nearest</quote>
- data node—usually a data node running on the same machine,
- due to the fact that shared memory transport can be used instead
- of the slower TCP/IP. This may lead to poor load distribution in
- some cases, so it is possible to enforce a round-robin node
- connection scheme by calling the
+ data node. This is usually a data node running on the same
+ machine as the nearest, due to the fact that shared memory
+ transport can be used instead of the slower TCP/IP. This may
+ lead to poor load distribution in some cases, so it is possible
+ to enforce a round-robin node connection scheme by calling the
<literal role="ndbapi:Ndb_cluster_connection">set_optimized_node_selection()</literal>
method with <literal>0</literal> as its argument prior to
calling
@@ -482,9 +470,9 @@
<para>
The
<literal role="ndbapi:Ndb_cluster_connection">connect()</literal>
- method initiates a connection to a cluster management node
- only—it does not wait for any connections to data nodes to
- be made. This can be accomplished by using
+ method initiates a connection to a cluster management node only,
+ without waiting for any connections to be made to data nodes.
+ You ca override this behavior by using
<literal role="ndbapi:Ndb_cluster_connection">wait_until_ready()</literal>
after calling
<literal role="ndbapi:Ndb_cluster_connection">connect()</literal>.
@@ -495,10 +483,10 @@
</para>
<para>
- In the following example, initialisation and connection are
+ In the following example, initialization and connection are
handled in the two functions <literal>example_init()</literal>
- and <literal>example_end()</literal>, which will be included in
- subsequent examples using the file
+ and <literal>example_end()</literal>, which are included in
+ subsequent examples by means of including the file
<filename>example_connection.h</filename>.
</para>
@@ -695,9 +683,10 @@
<listitem>
<para>
- The MySQL <literal>TINYINT</literal>,
- <literal>SMALLINT</literal>, <literal>INT</literal>, and
- <literal>BIGINT</literal> data types map to
+ The MySQL <literal role="type">TINYINT</literal>,
+ <literal role="type">SMALLINT</literal>,
+ <literal role="type">INT</literal>, and
+ <literal role="type">BIGINT</literal> data types map to
<literal>NDB</literal> types having the same names and storage
requirements as their MySQL counterparts.
</para>
@@ -705,8 +694,8 @@
<listitem>
<para>
- The MySQL <literal>FLOAT</literal> and
- <literal>DOUBLE</literal> data types are mapped to
+ The MySQL <literal role="type">FLOAT</literal> and
+ <literal role="type">DOUBLE</literal> data types are mapped to
<literal>NDB</literal> types having the same names and storage
requirements.
</para>
@@ -714,23 +703,24 @@
<listitem>
<para>
- The storage space required for a MySQL <literal>CHAR</literal>
- column is determined by the maximum number of characters and
- the column's character set. For most (but not all) character
- sets, each character takes one byte of storage. When using
- UTF-8, each character requires three bytes. You can find the
- number of bytes needed per character in a given character set
- by checking the <literal>Maxlen</literal> column in the output
- of <literal>SHOW CHARACTER SET</literal>.
+ The storage space required for a MySQL
+ <literal role="type">CHAR</literal> column is determined by
+ the maximum number of characters and the column's character
+ set. For most (but not all) character sets, each character
+ takes one byte of storage. When using UTF-8, each character
+ requires three bytes. You can find the number of bytes needed
+ per character in a given character set by checking the
+ <literal>Maxlen</literal> column in the output of
+ <literal role="stmt">SHOW CHARACTER SET</literal>.
</para>
</listitem>
<listitem>
<para>
In MySQL 5.1 and later, the storage requirements for a
- <literal>VARCHAR</literal> or <literal>VARBINARY</literal>
- column depend on whether the column is stored in memory or on
- disk:
+ <literal role="type">VARCHAR</literal> or
+ <literal role="type">VARBINARY</literal> column depend on
+ whether the column is stored in memory or on disk:
</para>
<itemizedlist>
@@ -741,8 +731,8 @@
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
- <literal>latin1</literal> character set requires 12
+ <literal role="type">VARCHAR(50)</literal> column using
+ the <literal>latin1</literal> character set requires 12
bytes—in this case, 2 bytes times 5 characters is
10, rounded up to the next even multiple of 4 yields 12.
(This represents a change in behavior from Cluster in
@@ -754,11 +744,12 @@
<listitem>
<para>
- In Disk Data columns, <literal>VARCHAR</literal> and
- <literal>VARBINARY</literal> are stored as fixed-width
- columns. This means that each of these types requires the
- same amount of storage as a <literal>CHAR</literal> of the
- same size.
+ In Disk Data columns,
+ <literal role="type">VARCHAR</literal> and
+ <literal role="type">VARBINARY</literal> are stored as
+ fixed-width columns. This means that each of these types
+ requires the same amount of storage as a
+ <literal role="type">CHAR</literal> of the same size.
</para>
</listitem>
@@ -767,16 +758,16 @@
<listitem>
<para>
- Each row in a Cluster <literal>BLOB</literal> or
- <literal>TEXT</literal> column is made up of two separate
- parts. One of these is of fixed size (256 bytes), and is
- actually stored in the original table. The other consists of
- any data in excess of 256 bytes, which stored in a hidden
+ Each row in a Cluster <literal role="type">BLOB</literal> or
+ <literal role="type">TEXT</literal> column is made up of two
+ separate parts. One of these is of fixed size (256 bytes), and
+ is actually stored in the original table. The other consists
+ of any data in excess of 256 bytes, which stored in a hidden
table. The rows in this second table are always 2000 bytes
long. This means that record of
<replaceable>size</replaceable> bytes in a
- <literal>TEXT</literal> or <literal>BLOB</literal> column
- requires
+ <literal role="type">TEXT</literal> or
+ <literal role="type">BLOB</literal> column requires
</para>
<itemizedlist>
Modified: trunk/ndbapi/renamed-nodes.txt
===================================================================
--- trunk/ndbapi/renamed-nodes.txt 2011-06-21 07:01:29 UTC (rev 26564)
+++ trunk/ndbapi/renamed-nodes.txt 2011-06-21 09:08:19 UTC (rev 26565)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 0; 647 bytes
@@ -608,6 +608,7 @@
ndb-ndb-mgm-cluster-state mgm-ndb-mgm-cluster-state 2011-01-21
ndb-ndb-mgm-node-state mgm-ndb-mgm-node-state 2011-01-21
ndb-ndb-mgm-reply mgm-ndb-mgm-reply 2011-01-21
+ndb-start-initialisation ndb-start-initialization 2011-06-21
struct-autogrowspecification ndb-autogrowspecification 2011-01-20
struct-element ndb-element 2011-01-20
struct-getvaluespec ndb-getvaluespec 2011-01-20
| Thread |
|---|
| • svn commit - mysqldoc@oter02: r26565 - trunk/ndbapi | jon.stephens | 21 Jun |
