Author: jstephens
Date: 2006-07-03 05:58:59 +0200 (Mon, 03 Jul 2006)
New Revision: 2601
Log:
Spellcheck + reformat all chapter files.
Modified:
trunk/ndbapi/errors.xml
trunk/ndbapi/examples.xml
trunk/ndbapi/getting-started.xml
trunk/ndbapi/mgm-api.xml
trunk/ndbapi/ndb-classes.xml
trunk/ndbapi/ndbapi.xml
trunk/ndbapi/overview.xml
Modified: trunk/ndbapi/errors.xml
===================================================================
--- trunk/ndbapi/errors.xml 2006-07-03 01:45:55 UTC (rev 2600)
+++ trunk/ndbapi/errors.xml 2006-07-03 03:58:59 UTC (rev 2601)
@@ -68,7 +68,7 @@
<para>
The error classification is described by a value of the
- <literal>Classificaton</literal> type. See
+ <literal>Classification</literal> type. See
<xref linkend="struct-ndberror-classification"/>, for
possible classifications and their interpretation.
Additional information is provided in
@@ -426,7 +426,7 @@
</row>
<row>
<entry><literal>OverloadError</literal></entry>
- <entry>This type of error is often caused when there is insufficent logfile
+ <entry>This type of error is often caused when there is insufficient logfile
space.</entry>
</row>
<row>
Modified: trunk/ndbapi/examples.xml
===================================================================
--- trunk/ndbapi/examples.xml 2006-07-03 01:45:55 UTC (rev 2600)
+++ trunk/ndbapi/examples.xml 2006-07-03 03:58:59 UTC (rev 2601)
@@ -371,8 +371,8 @@
<listitem>
<para>
<emphasis role="bold">Transaction failures</emphasis>: If
- non-permanent, these can be handled handled by re-executing
- the transaction.
+ non-permanent, these can be handled by re-executing the
+ transaction.
</para>
</listitem>
@@ -387,14 +387,12 @@
</orderedlist>
<important>
-
<para>
Before executing this program, you should first run
<command>ndbapi_simple</command> (see
<xref linkend="example-synchronous-transactions"/>), in order to
create the table <literal>MYTABLENAME</literal>.
</para>
-
</important>
<programlisting>
@@ -515,7 +513,7 @@
}
/**********************************
- * On failure: analyze the error. *
+ * On failure: analyse the error. *
**********************************/
if (result == -1) {
switch (ndberror.status) {
@@ -1017,7 +1015,7 @@
{
- // Perform an exclusive scan on all records,
+ // Perform an exclusive scan on all records,
// then delete them one by one.
int retryAttempt = 0;
const int retryMax = 10;
@@ -1152,7 +1150,7 @@
{
- // Perform an exclusve scan on all records,
+ // Perform an exclusive scan on all records,
// then update them one by one.
int retryAttempt = 0;
const int retryMax = 10;
@@ -1292,7 +1290,7 @@
int scan_print(Ndb * myNdb)
{
- // Perform an exclusve scan on all records,
+ // Perform an exclusive scan on all records,
// then update them one by one.
int retryAttempt = 0;
const int retryMax = 10;
@@ -1436,7 +1434,7 @@
exit(-1);
}
// (Optional:) Connect and wait
- // for the storage nodes (ndbd processess).
+ // for the storage nodes (ndbd processes).
if (cluster_connection.wait_until_ready(30,0) < 0)
{
std::cout << "Cluster was not ready within 30 secs.\n";
Modified: trunk/ndbapi/getting-started.xml
===================================================================
--- trunk/ndbapi/getting-started.xml 2006-07-03 01:45:55 UTC (rev 2600)
+++ trunk/ndbapi/getting-started.xml 2006-07-03 03:58:59 UTC (rev 2601)
@@ -37,7 +37,7 @@
<para>
This section provides information on compiling and linking
- <literal>NDB</literal> API applications, ioncluding requirements
+ <literal>NDB</literal> API applications, including requirements
and compiler and linker options.
</para>
@@ -82,7 +82,7 @@
In order to compile source files that use the
<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 follwoing
+ <literal>NDB</literal> API are installed in the following
subdirectories of the MySQL <filename>include</filename>
directory:
@@ -168,7 +168,7 @@
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 belinked in as well.
+ must be linked in as well.
</para>
<para>
@@ -186,7 +186,7 @@
</para>
<para>
- To link a NdbAPI application you have to add
+ To link an NDB API application, it is necessary to add
<option>-lndbclient</option> and <option>-lmystrings</option> to
these options. Adding all the required linker flags to the
<literal>LDFLAGS</literal> variable should look something like
@@ -217,7 +217,7 @@
All of the examples in this chapter include a common
<filename>mysql.m4</filename> file defining
<literal>WITH_MYSQL</literal>. A typical complete example
- consists of the actual source file and the the following helper
+ consists of the actual source file and the following helper
files:
<itemizedlist>
@@ -259,7 +259,7 @@
</programlisting>
Normally, this needs to be done only once, after which
- <command>make</command> will accomodate any file changes.
+ <command>make</command> will accommodate any file changes.
</para>
<formalpara>
@@ -344,7 +344,7 @@
# add regular MySQL C flags
ADDFLAGS=`$MYSQL_CONFIG --cflags`
- # add NdbAPI specific C flags
+ # add NDB API specific C flags
IBASE=`$MYSQL_CONFIG --include`
ADDFLAGS="$ADDFLAGS $IBASE/ndb"
ADDFLAGS="$ADDFLAGS $IBASE/ndb/ndbapi"
@@ -377,7 +377,7 @@
<para>
This section covers connecting an <literal>NDB</literal> API
- application to a MySQL CLuster.
+ application to a MySQL cluster.
</para>
</abstract>
@@ -504,7 +504,7 @@
{
Ndb_cluster_connection* conn;
- // initialize MySQL and Ndb client libraries
+ // initialise MySQL and Ndb client libraries
if( ndb_init() )
{
exit(EXIT_FAILURE);
@@ -580,7 +580,7 @@
<para>
Databases and schemas are not represented by objects as such in
- the <literal>NDB</literal> API. Instead, they are modeled as
+ 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
@@ -650,7 +650,7 @@
<para>
For a MySQL primary key only a B-tree index is created.
This index is given the name <literal>PRIMARY</literal>.
- There is no extra hash; however, the uniquneess of the
+ 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>NDB</literal> table.
</para>
@@ -736,9 +736,9 @@
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 MySQL 5.0 and 4.1, where
- a column having the same definition required 52
- bytes storage per row regardless of the length of
+ in behaviour from Cluster in MySQL 5.0 and 4.1,
+ where a column having the same definition required
+ 52 bytes storage per row regardless of the length of
the string being stored in the row.)
</para>
</listitem>
Modified: trunk/ndbapi/mgm-api.xml
===================================================================
--- trunk/ndbapi/mgm-api.xml 2006-07-03 01:45:55 UTC (rev 2600)
+++ trunk/ndbapi/mgm-api.xml 2006-07-03 03:58:59 UTC (rev 2601)
@@ -33,7 +33,7 @@
<para>
See <xref linkend="ndb-mgm-create-handle"/>, and
- <xref linkend="ndb-mgm-destroy-handle"/>, for more informaiton
+ <xref linkend="ndb-mgm-destroy-handle"/>, for more information
about these two functions.
</para>
@@ -626,7 +626,7 @@
<listitem>
<para>
The number of milliseconds to wait for the event
- before toming out
+ before timing out
</para>
</listitem>
@@ -1011,7 +1011,7 @@
<programlisting>
const char* ndb_mgm_get_latest_error_desc
(
- constNdbMgmHandle <replaceable>handle</replaceable>
+ const NdbMgmHandle <replaceable>handle</replaceable>
)
</programlisting>
</para>
@@ -1099,8 +1099,7 @@
<listitem>
<para>
- A pointer to the file to which which errors are to be
- sent.
+ A pointer to the file to which errors are to be sent.
</para>
</listitem>
@@ -2017,7 +2016,7 @@
<para>
The number of <literal>retries</literal> to make when
attempting to connect. <literal>0</literal> for this
- value means that one one connection attempt is made.
+ value means that one connection attempt is made.
</para>
</listitem>
@@ -2302,7 +2301,7 @@
<para>
This function can be used to start one or more Cluster
nodes. The nodes to be started must have been started with
- the nostart option (<option>-n</option>), meaning that the
+ the no-start option (<option>-n</option>), meaning that the
data node binary was started and is waiting for a
<literal>START</literal> management command which actually
enables the node.
@@ -2552,7 +2551,7 @@
<para>
The value of <replaceable>abort</replaceable>
determines how the nodes will be shut down.
- <literal>1</literal> indicates the the nodes will shut
+ <literal>1</literal> indicates the nodes will shut
down immediately; <literal>0</literal> indicates that
the nodes will stop gracefully.
</para>
@@ -2661,7 +2660,7 @@
<para>
The value of <replaceable>abort</replaceable>
determines how the nodes will be shut down.
- <literal>1</literal> indicates the the nodes will shut
+ <literal>1</literal> indicates the nodes will shut
down immediately; <literal>0</literal> indicates that
the nodes will stop gracefully.
</para>
@@ -2672,7 +2671,7 @@
If <replaceable>disconnect</replaceable> returns
<literal>1</literal> (<literal>true</literal>), this
means the you must disconnect before you can apply the
- command to stop. For example, donnecting is required
+ command to stop. For example, connecting is required
when stopping the management server to which the
handle is connected.
</para>
@@ -3197,8 +3196,7 @@
<listitem>
<para>
- A amanagement server
- <replaceable>handle</replaceable>.
+ A management server <replaceable>handle</replaceable>.
</para>
</listitem>
@@ -3476,7 +3474,7 @@
<listitem>
<para>
A pointer to an <literal>ndb_mgm_reply</literal>
- structure to accomodate a
+ structure to accommodate a
<replaceable>reply</replaceable>. See
<xref linkend="struct-ndb-mgm-reply"/>.
</para>
@@ -4036,7 +4034,7 @@
<row>
<entry/>
<entry><literal>NDB_MGM_ALLOCID_ERROR</literal></entry>
- <entry>Generic error; may be posssible to retry and recover</entry>
+ <entry>Generic error; may be possible to retry and recover</entry>
</row>
<row>
<entry/>
@@ -4573,7 +4571,7 @@
</row>
<row>
<entry><literal>NDB_MGM_EVENT_SEVERITY_ALERT</literal></entry>
- <entry>Conditiona that require immediate attention, such as corruption of the
+ <entry>Conditions that require immediate attention, such as corruption of the
cluster</entry>
</row>
<row>
@@ -4604,7 +4602,7 @@
<title>Description</title>
<para>
- This type is used to describe logevent errors.
+ This type is used to describe log event errors.
</para>
</formalpara>
@@ -4702,7 +4700,7 @@
</row>
<row>
<entry><literal>NDB_MGM_EVENT_CATEGORY_SHUTDOWN</literal></entry>
- <entry>Log events accurring during shutdown</entry>
+ <entry>Log events occurring during shutdown</entry>
</row>
<row>
<entry><literal>NDB_MGM_EVENT_CATEGORY_STATISTIC</literal></entry>
@@ -4734,7 +4732,7 @@
</row>
<row>
<entry><literal>NDB_MGM_EVENT_CATEGORY_ERROR</literal></entry>
- <entry>Uncategorized log events (severity level <literal>WARNING</literal>,
+ <entry>Uncategorised log events (severity level <literal>WARNING</literal>,
<literal>ERROR</literal>,
<literal>CRITICAL</literal>, or
<literal>ALERT</literal>)</entry>
@@ -5718,7 +5716,7 @@
<para>
<literal>char
<replaceable>message[256]</replaceable></literal>:
- COntains the text of the response or error message.
+ contains the text of the response or error message.
</para>
</listitem>
Modified: trunk/ndbapi/ndb-classes.xml
===================================================================
--- trunk/ndbapi/ndb-classes.xml 2006-07-03 01:45:55 UTC (rev 2600)
+++ trunk/ndbapi/ndb-classes.xml 2006-07-03 03:58:59 UTC (rev 2601)
@@ -77,7 +77,7 @@
<title>Description</title>
<para>
- Any non-trivial NDBAPI program makes use of at least one
+ Any non-trivial NDB 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
@@ -235,7 +235,7 @@
<para>
This creates an instance of <literal>Ndb</literal>, which
- represents a connection to the MySQL Cluster. All NDBAPI
+ represents a connection to the MySQL Cluster. All NDB 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
@@ -424,7 +424,7 @@
<para>
<emphasis role="bold">0</emphasis>: indicates that the
<literal>Ndb</literal> object was initialised
- successfuly.
+ successfully.
</para>
</listitem>
@@ -603,7 +603,7 @@
<title>Description</title>
<para>
- This method can be used to obatin the current database
+ This method can be used to obtain the current database
schema name.
</para>
@@ -750,7 +750,7 @@
<literal>NdbTransaction::close()</literal> or
<literal>Ndb::closeTransaction()</literal>. This must be
done regardless of the transaction's final outcome, even if
- fials due to an an error.
+ it fails due to an error.
</para>
<para>
@@ -797,7 +797,7 @@
<xref
linkend="class-table"/>.) This
is used to determine on which node the Transaction
- Co-Ordinator should run.
+ Coordinator should run.
</para>
</listitem>
@@ -939,7 +939,7 @@
<title>Description</title>
<para>
- This method creates a subscription to a datbase event.
+ This method creates a subscription to a database event.
</para>
</formalpara>
@@ -1117,9 +1117,9 @@
<listitem>
<para>
- The maxmimum time to wait, in milliseconds, before
+ The maximum time to wait, in milliseconds, before
<quote>giving up</quote> and reporting that no events
- were available (that is, before the methyod
+ were available (that is, before the method
automatically returns
<emphasis role="bold"
>0</emphasis>).
@@ -1154,7 +1154,7 @@
<listitem>
<para>
<emphasis role="bold">> 0</emphasis>: There are
- events avaialable in the queue.
+ events available in the queue.
</para>
</listitem>
@@ -1290,8 +1290,8 @@
<para>
The <literal>getNdbError()</literal> method actually has two
- variants. The first of these sinply gets the most recent
- error to have occured:
+ variants. The first of these simply gets the most recent
+ error to have occurred:
<programlisting>
const NdbError& getNdbError
@@ -3628,7 +3628,7 @@
<para>
Use the method to obtain the next in a list of blobs that
- was intialised using <literal>blobsFirstBlob()</literal>.
+ was initialised using <literal>blobsFirstBlob()</literal>.
See <xref linkend="class-ndbblob-blobsfirstblob"/>.
</para>
@@ -4745,7 +4745,7 @@
<title>Description</title>
<para>
- This method is used to retreive a
+ This method is used to retrieve a
<literal>Datafile</literal> object, given the node ID of
the data node where a datafile is located and the path to
the datafile on that node's filesystem.
@@ -6609,7 +6609,7 @@
</row>
<row>
<entry><literal>getCharset()</literal></entry>
- <entry>Get the charset used by a string (text) column (not applicable to
+ <entry>Get the character set used by a string (text) column (not applicable to
columns not storing character data)</entry>
</row>
<row>
@@ -8056,7 +8056,7 @@
<title>Description</title>
<para>
- This method is used to get the part size of a blob coumn
+ This method is used to get the part size of a blob column
— that is, the number of bytes that are stored in
each tuple of the blob table.
</para>
@@ -8131,7 +8131,7 @@
<para>
This method gets the stripe size of a blob column —
- that is, thenumber of consecutive parts to store in each
+ that is, the number of consecutive parts to store in each
node group.
</para>
@@ -8268,7 +8268,7 @@
<para>
<literal>true</literal> if the column is part of the
- partitoning key for the table, otherwise
+ partitioning key for the table, otherwise
<literal>false</literal>.
</para>
@@ -8813,7 +8813,7 @@
<title>Description</title>
<para>
- This method can be used to set the sacale of a decimal
+ This method can be used to set the scale of a decimal
column.
</para>
@@ -10066,7 +10066,7 @@
<abstract>
<para>
- Thise section covers the <literal>Datafile</literal> class.
+ This section covers the <literal>Datafile</literal> class.
</para>
</abstract>
@@ -11012,7 +11012,7 @@
<title>Parameters</title>
<para>
- The path to the file, astring (as a character pointer).
+ The path to the file, a string (as a character pointer).
</para>
</formalpara>
@@ -13183,9 +13183,9 @@
<para>
This class represents an index on an <literal>NDB
- Cluster</literal> table column. It is a descandant of the
+ Cluster</literal> table column. It is a descendant of the
<literal>NdbDictionary</literal> class, via the
- <literal>Object</literal> class. For informaiton on these,
+ <literal>Object</literal> class. For information on these,
see <xref linkend="class-ndbdictionary"/>, and
<xref linkend="class-object"/>.
</para>
@@ -13376,7 +13376,7 @@
</row>
<row>
<entry><literal>UniqueHashIndex</literal></entry>
- <entry>Unique un-ordered hash index (only index type currently supported)
+ <entry>Unique unordered hash index (only index type currently supported)
<remark role="todo">
[js] is this still the case?
@@ -14649,7 +14649,7 @@
<title>Description</title>
<para>
- This class represnts a MySQL Cluster Disk Data logfile
+ This class represents a MySQL Cluster Disk Data logfile
group, which is used for storing Disk Data undofiles. For
general information about logfile groups and undofiles, see
the
@@ -14703,7 +14703,7 @@
</row>
<row>
<entry><literal>~LogfileGroup()</literal></entry>
- <entry>Vrtual destructor</entry>
+ <entry>Virtual destructor</entry>
</row>
<row>
<entry><literal>getName()</literal></entry>
@@ -14731,7 +14731,7 @@
</row>
<row>
<entry><literal>getObjectId()</literal></entry>
- <entry>Get the object ID of thelogfile group</entry>
+ <entry>Get the object ID of the logfile group</entry>
</row>
<row>
<entry><literal>setName()</literal></entry>
@@ -15719,7 +15719,7 @@
<entry>Gets the table's <literal>KValue</literal></entry>
</row>
<row>
- <entry><literal>getLinLoadFactor()</literal></entry>
+ <entry><literal>getMinLoadFactor()</literal></entry>
<entry>Gets the table's minimum load factor</entry>
</row>
<row>
@@ -15847,7 +15847,7 @@
</row>
<row>
<entry><literal>setLogging()</literal></entry>
- <entry>Toggle logging ofthe table to disk</entry>
+ <entry>Toggle logging of the table to disk</entry>
</row>
<row>
<entry><literal>setLinearFlag()</literal></entry>
@@ -16285,7 +16285,7 @@
<title>Return Value</title>
<para>
- A pointer to the the column with the specified index or
+ A pointer to the column with the specified index or
name. If there is no such column, then this method
returns <literal>NULL</literal>.
</para>
@@ -16819,7 +16819,7 @@
<title>Return Value</title>
<para>
- The name of the primary key, a string (charracter
+ The name of the primary key, a string (character
pointer).
</para>
@@ -17557,7 +17557,7 @@
<title><literal>NdbDictionary::Object::Table::getTablespace()</literal></title>
<remark role="todo">
- [js] Is this description correct? Im assuming it must be
+ [js] Is this description correct? I'm assuming it must be
something like this, given the method signatures...
</remark>
@@ -18213,7 +18213,7 @@
<para>
The length of the names data, in bytes, as a 32-but
- unsigned iinteger.
+ unsigned integer.
</para>
</formalpara>
@@ -18851,7 +18851,7 @@
<para>
This method sets the minimum load factor when reduction
- of the hash table bigns.
+ of the hash table begins.
</para>
</formalpara>
@@ -18876,7 +18876,7 @@
<title>Parameters</title>
<para>
- This maethod takes a single parameter
+ This method takes a single parameter
<replaceable>min</replaceable>, an integer
representation of a percentage (for example,
<literal>45</literal> represents 45 percent). For more
@@ -18945,7 +18945,7 @@
<title>Parameters</title>
<para>
- This maethod takes a single parameter
+ This method takes a single parameter
<replaceable>max</replaceable>, an integer
representation of a percentage (for example,
<literal>45</literal> represents 45 percent). For more
@@ -22467,11 +22467,11 @@
</row>
<row>
<entry><literal>getGCI()</literal></entry>
- <entry>Retrieves the CGI of the most recently retrieved event</entry>
+ <entry>Retrieves the GCI of the most recently retrieved event</entry>
</row>
<row>
<entry><literal>getLatestGCI()</literal></entry>
- <entry>Retrieves the most recent CGI (whether or not the corresponding event
+ <entry>Retrieves the most recent GCI (whether or not the corresponding event
has been retrieved)</entry>
</row>
<row>
@@ -23260,7 +23260,7 @@
<note>
<para>
- The CGI obtained using this method is not necessarily
+ The GCI obtained using this method is not necessarily
associated with an event.
</para>
</note>
@@ -23387,7 +23387,7 @@
<title>Description</title>
<para>
- Tnis method is used to determine whether event loss has
+ This method is used to determine whether event loss has
taken place following the failure of a node.
</para>
@@ -23491,7 +23491,7 @@
<para>
Returns <literal>true</literal> if the name of the table has
- changed; otherwise, the mothod returns
+ changed; otherwise, the method returns
<literal>false</literal>.
</para>
@@ -23558,9 +23558,9 @@
<title>Return Value</title>
<para>
- Returns <literal>true</literal> if the the table
+ Returns <literal>true</literal> if the table
<filename>.FRM</filename> file has changed; otherwise, the
- mothod returns <literal>false</literal>.
+ method returns <literal>false</literal>.
</para>
</formalpara>
@@ -23625,8 +23625,8 @@
<title>Return Value</title>
<para>
- Returns <literal>true</literal> if the the table's
- fragmentation has changed; otherwise, the method returns
+ Returns <literal>true</literal> if the table's fragmentation
+ has changed; otherwise, the method returns
<literal>false</literal>.
</para>
@@ -24096,7 +24096,7 @@
<title>Description</title>
<para>
- <literal>Type</literal> is used to descibe the operation
+ <literal>Type</literal> is used to describe the operation
access type. Each access type is supported by NdbOperation
or one of its subclasses, as shown in the following table:
</para>
@@ -24803,7 +24803,7 @@
<title>Description</title>
<para>
- Thismethod gets the operation's lock mode.
+ This method gets the operation's lock mode.
</para>
</formalpara>
@@ -25322,7 +25322,7 @@
</itemizedlist>
See <xref linkend="class-ndboperation-equal"/>, for
- important information reagrding the value's format and
+ important information regarding the value's format and
length.
</para>
@@ -25719,7 +25719,7 @@
<para>
<literal>NdbIndexOperation</literal> represents an index
- operation for uze in transactions. This calss inherits from
+ operation for use in transactions. This class inherits from
<literal>NdbOperation</literal>; see
<xref linkend="class-ndboperation"/>, for more information.
</para>
@@ -26631,7 +26631,7 @@
<literal>false</literal>; call
<literal>close()</literal> with this parameter set
to <literal>true</literal> in order to force
- transactioons to be sent.
+ transactions to be sent.
</para>
</listitem>
@@ -27024,7 +27024,7 @@
<tbody>
<row>
<entry><literal>get_range_no()</literal></entry>
- <entry>Gets the rnage number for the current row</entry>
+ <entry>Gets the range number for the current row</entry>
</row>
<row>
<entry><literal>getSorted()</literal></entry>
@@ -27036,7 +27036,7 @@
</row>
<row>
<entry><literal>readTuples()</literal></entry>
- <entry>Readstuples using an ordered index</entry>
+ <entry>Reads tuples using an ordered index</entry>
</row>
<row>
<entry><literal>setBound()</literal></entry>
@@ -27048,7 +27048,7 @@
</row>
<row>
<entry><literal>end_of_bound()</literal></entry>
- <entry>Markes the end of a bound</entry>
+ <entry>Marks the end of a bound</entry>
</row>
</tbody>
</tgroup>
@@ -27354,7 +27354,7 @@
<para>
This method returns <literal>true</literal> if the scan
- is osrted in descending order; otherwise, it returns
+ is sorted in descending order; otherwise, it returns
<literal>false</literal>.
</para>
@@ -29497,7 +29497,7 @@
<section id="class-ndbscanfoliter-constructor">
- <title><literal>NdbScanFilter</literal> Class COnstructor</title>
+ <title><literal>NdbScanFilter</literal> Class Constructor</title>
<formalpara>
@@ -30636,7 +30636,7 @@
</row>
<row>
<entry><literal>close()</literal></entry>
- <entry>CLoses a transaction</entry>
+ <entry>Closes a transaction</entry>
</row>
<row>
<entry><literal>getGCI()</literal></entry>
@@ -30704,7 +30704,7 @@
</row>
<row>
<entry><literal>CommitStatusType</literal></entry>
- <entry>Describes the transaction'scommit status</entry>
+ <entry>Describes the transaction's commit status</entry>
</row>
<row>
<entry><literal>ExecType</literal></entry>
@@ -31537,7 +31537,7 @@
<important>
<para>
- The CGI for a scan transaction is undefined, since no
+ The GCI for a scan transaction is undefined, since no
updates are performed in scan transactions.
</para>
</important>
@@ -31580,7 +31580,7 @@
<note>
<para>
- No CGI is available until <literal>execute()</literal> has
+ No GCI is available until <literal>execute()</literal> has
been called with <literal>ExecType::Commit</literal>.
</para>
</note>
@@ -31608,7 +31608,7 @@
<title>Description</title>
<para>
- This method is used to obatin the transaction ID.
+ This method is used to obtain the transaction ID.
</para>
</formalpara>
@@ -31671,7 +31671,7 @@
<title>Description</title>
<para>
- Thismethod gets the transaction's commit status.
+ This method gets the transaction's commit status.
</para>
</formalpara>
@@ -31874,7 +31874,7 @@
<title>Description</title>
<para>
- This method return theline number where the most recent
+ This method return the line number where the most recent
error occurred.
</para>
@@ -31982,7 +31982,7 @@
<title>Parameters</title>
<para>
- This method requires a singel parameter
+ This method requires a single parameter
<replaceable>op</replaceable>, which is an operation
(<literal>NdbOperation</literal> object), or
<literal>NULL</literal>.
Modified: trunk/ndbapi/ndbapi.xml
===================================================================
--- trunk/ndbapi/ndbapi.xml 2006-07-03 01:45:55 UTC (rev 2600)
+++ trunk/ndbapi/ndbapi.xml 2006-07-03 03:58:59 UTC (rev 2601)
@@ -16,7 +16,7 @@
<abstract>
<title>&title;</title>
-
+
<para>
<remark role="repository.revision"/>
</para>
@@ -32,9 +32,11 @@
<para>
The NDB and MGM APIs as presented in this guide are current for
- MySQL 5.1. The definitions of NDB API classes and MGM API
- functions reflect the state of the MySQL main development tree
- shortly after MySQL 5.1.9 was branched off for release builds.
+ MySQL 5.1 — note that there have been significant changes
+ in the API as implemented in previous MySQL Cluster versions.
+ The definitions of NDB API classes and MGM API functions reflect
+ the state of the MySQL main development tree as of MySQL 5.1.12
+ and later.
</para>
</abstract>
@@ -102,11 +104,10 @@
<xi:include href="ndb-classes.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="errors.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="errors.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="examples.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-
<index/>
</book>
Modified: trunk/ndbapi/overview.xml
===================================================================
--- trunk/ndbapi/overview.xml 2006-07-03 01:45:55 UTC (rev 2600)
+++ trunk/ndbapi/overview.xml 2006-07-03 03:58:59 UTC (rev 2601)
@@ -87,7 +87,7 @@
transactions, and operations. These classes and their subclasses
are listed in <xref linkend="ndb-classes"/>. Error conditions in
the NDB API are handled using <literal>NdbError</literal>, a
- structure which is described in
+ structure which is described in
<xref linkend="struct-ndberror"/>.
</para>
@@ -101,7 +101,7 @@
The <firstterm>MySQL Cluster Management API</firstterm>, also
known as the <firstterm>MGM API</firstterm>, is a C-language
programming interface intended to provide administrative
- services for the cluster. These include starting ansd stopping
+ services for the cluster. These include starting and stopping
Cluster nodes, handling Cluster logging, backups, and
restoration from backups, as well as various other management
tasks. A conceptual overview of MGM and its uses can be found in
@@ -429,12 +429,12 @@
</indexterm>
<indexterm>
- <primary>Transaction Co-ordinator</primary>
+ <primary>Transaction Coordinator</primary>
<secondary>defined</secondary>
</indexterm>
<para>
- <emphasis role="bold">TC</emphasis>: Transaction Co-ordinator.
+ <emphasis role="bold">TC</emphasis>: Transaction Coordinator.
Handles co-ordination of transactions and timeouts; serves as
the interface to the NDB API for indexes and scan operations.
</para>
@@ -558,7 +558,7 @@
database is changed. This is accomplished through the
<literal>NdbEventOperation</literal> class.
</para>
-
+
<important>
<para>
The <literal>NDB</literal> event notification API is not
@@ -700,7 +700,7 @@
<para>
If the operation is of type <literal>Commit</literal>,
then the transaction is immediately committed. The
- transaction must be closed after it has been commited
+ transaction must be closed after it has been committed
(even if the commit fails), and no further operations
can be added to or defined for this transaction.
</para>
@@ -1010,7 +1010,6 @@
</para>
<note>
-
<para>
If you want to define multiple operations within the
same transaction, then you need to call
@@ -1019,7 +1018,6 @@
<literal>NdbTransaction::getNdbIndexOperation()</literal>
for each operation.
</para>
-
</note>
</listitem>
@@ -1085,8 +1083,9 @@
<listitem>
<para>
- Use its own memory (passed through a pointer aValue)
- to <literal>NdbOperation::getValue()</literal>, or
+ Use its own memory (passed through a pointer
+ <replaceable>aValue</replaceable>) to
+ <literal>NdbOperation::getValue()</literal>, or
</para>
</listitem>
@@ -1217,7 +1216,7 @@
<listitem>
<para>
- Traverse the result set by means of succssive calls to
+ Traverse the result set by means of successive calls to
<literal>NdbScanOperation::nextResult()</literal>.
</para>
</listitem>
@@ -1301,7 +1300,6 @@
</para>
<note>
-
<para>
If you want to define multiple scan operations within
the same transaction, then you need to call
@@ -1310,7 +1308,6 @@
<literal>NdbTransaction::getNdbIndexScanOperation()</literal>
separately for each operation.
</para>
-
</note>
</listitem>
@@ -1334,14 +1331,12 @@
</para>
<note>
-
<para>
When NdbScanFilter is used, each row is examined,
whether or not it is actually returned. However, when
using bounds, only rows within the bounds will be
examined.
</para>
-
</note>
</listitem>
@@ -1416,7 +1411,6 @@
</orderedlist>
<important>
-
<para>
The update or delete is not actually performed until the
next call to <literal>NdbTransaction::execute()</literal>
@@ -1426,7 +1420,6 @@
information, see
<xref linkend="overview-scans-lock-handling"/>.
</para>
-
</important>
<para>
@@ -1512,7 +1505,7 @@
}
while((check = MyScanOperation->nextResult(false)) == 0);
- // When there are no more rows in the batch, exeute all defined deletes
+ // When there are no more rows in the batch, execute all defined deletes
MyTransaction->execute(NoCommit);
}
</programlisting>
@@ -1604,14 +1597,12 @@
</para>
<note>
-
<para>
Transactions are <emphasis>not</emphasis> automatically
closed when an error occurs. You must call
<literal>Ndb::closeTransaction()</literal> to close the
transaction.
</para>
-
</note>
<para>
@@ -1654,15 +1645,13 @@
</para>
<important>
-
<para>
Errors can occur even when a commit is reported as
successful. In order to handle such situations, the NDB
API provides an additional
<literal>NdbTransaction::commitStatus()</literal> method
- to check the transactions's commit status.
+ to check the transaction's commit status.
</para>
-
</important>
</section>
@@ -1679,7 +1668,7 @@
<para>
Covers the NDB Kernel; discusses MySQL Cluster transaction
- handling, and transaction co-ordinators. Also describes NDB
+ handling, and transaction coordinators. Also describes NDB
record structures and concurrency issues.
</para>
@@ -1703,7 +1692,7 @@
<para>
<emphasis role="bold">TC</emphasis>: The transaction
- co-ordinator.
+ coordinator.
</para>
</listitem>
@@ -1735,11 +1724,11 @@
<para>
When an application executes a transaction, it connects to one
- transaction co-ordinator on one storage node. Usually, the
+ transaction coordinator on one storage node. Usually, the
programmer does not need to specify which TC should be used, but
in some cases where performance is important, the programmer can
provide <quote>hints</quote> to use a certain TC. (If the node
- with the desired transaction co-ordinator is down, then another
+ with the desired transaction coordinator is down, then another
TC will automatically take its place.)
</para>
@@ -1753,7 +1742,7 @@
<section id="overview-selecting-tc">
- <title>Selecting a Transaction Co-Ordinator</title>
+ <title>Selecting a Transaction Coordinator</title>
<indexterm>
<primary>TC</primary>
@@ -1761,7 +1750,7 @@
</indexterm>
<para>
- The default method is to select the transaction co-ordinator
+ The default method is to select the transaction coordinator
(TC) determined to be the "nearest" storage node, using a
heuristic for proximity based on the type of transporter
connection. In order of nearest to most distant, these are:
@@ -1806,20 +1795,20 @@
</para>
<remark role="todo">
- [js] Turn "For more info" into xrefs to sections we have have
- IDs for these.
+ [js] Turn "For more info" into xrefs to sections we have IDs
+ for these.
</remark>
<para>
As noted in <xref linkend="overview-cluster-concepts"/>, the
application programmer can provide hints to the NDB API as to
- which transaction co-ordinator should be uses. This is done by
+ which transaction coordinator should be uses. This is done by
providing a table and a partition key (usually the primary
key). If the primary key as the partition key, then the
transaction is placed on the node where the primary replica of
that record resides. Note that this is only a hint; the system
can be reconfigured at any time, in which case the NDB API
- chooses a transaction co-ordinator without using the hint. For
+ chooses a transaction coordinator without using the hint. For
more information, see
<literal>NdbDictionary::Column::getPartitionKey()</literal>
and <literal>Ndb::startTransaction()</literal>. The
@@ -1930,7 +1919,7 @@
</indexterm>
<para>
- Placing the transaction co-ordinator in close proximity to the
+ Placing the transaction coordinator in close proximity to the
actual data used in the transaction can in many cases improve
performance significantly. This is particularly true for
systems using TCP/IP. For example, a Solaris system using a
@@ -1955,14 +1944,13 @@
<para>
This means that the efficiency of an SCI system is much less
- dependent on selection of transaction co-ordinators.
- Typically, TCP/IP systems spend 30 to 60% of their working
- time on communication, whereas for SCI systems this figure is
- in the range of 5 to 10%. Thus, employing SCI for data
- transport means that less effort from the NDB API programmer
- is required and greater scalability can be achieved, even for
- applications using data from many different parts of the
- database.
+ dependent on selection of transaction coordinators. Typically,
+ TCP/IP systems spend 30 to 60% of their working time on
+ communication, whereas for SCI systems this figure is in the
+ range of 5 to 10%. Thus, employing SCI for data transport
+ means that less effort from the NDB API programmer is required
+ and greater scalability can be achieved, even for applications
+ using data from many different parts of the database.
</para>
<para>
@@ -2000,7 +1988,7 @@
<para>
When transactions are sent using
<literal>NdbTransaction::execute()</literal>, they are not
- immediately transfered to the NDB Kernel. Instead, transactions
+ immediately transferred to the NDB Kernel. Instead, transactions
are kept in a special send list (buffer) in the
<literal>Ndb</literal> object to which they belong. The adaptive
send algorithm decides when transactions should actually be
@@ -2068,11 +2056,11 @@
<listitem>
<para>
- For methods that are affected by the adaptive send alorithm
+ For methods that are affected by the adaptive send algorithm
(such as <literal>NdbTransaction::execute()</literal>),
there is a <replaceable>force</replaceable> parameter that
overrides its default behaviour in this regard and forces
- immediate transmission to all nodes. See the inidvidual NDB
+ immediate transmission to all nodes. See the individual NDB
API class listings for more information.
</para>
</listitem>
@@ -2080,12 +2068,10 @@
</orderedlist>
<note>
-
<para>
The conditions listed above are subject to change in future
releases of MySQL Cluster.
</para>
-
</note>
</section>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r2601 - trunk/ndbapi | jon | 3 Jul |
