Author: jstephens
Date: 2006-08-16 13:12:50 +0200 (Wed, 16 Aug 2006)
New Revision: 3033
Log:
Fixed a metric truckload of little issues, mostly having to do with
nomenclature (SQL/API nodes), out-of-date references to supported
platforms, and assorted instances of diff-rot.
Modified:
trunk/refman-4.1/mysql-cluster.xml
trunk/refman-5.0/mysql-cluster.xml
trunk/refman-5.1/mysql-cluster.xml
Modified: trunk/refman-4.1/mysql-cluster.xml
===================================================================
--- trunk/refman-4.1/mysql-cluster.xml 2006-08-16 10:34:23 UTC (rev 3032)
+++ trunk/refman-4.1/mysql-cluster.xml 2006-08-16 11:12:50 UTC (rev 3033)
Changed blocks: 21, Lines Added: 81, Lines Deleted: 33; 11868 bytes
@@ -658,7 +658,7 @@
The data stored by the cluster is divided into four partitions,
numbered 0, 1, 2, and 3. Each partition is stored — in
multiple copies — on the same node group. Partitions are
- stored on alternate node groups: Partition 2 is stored on .
+ stored on alternate node groups:
</para>
<itemizedlist>
@@ -924,7 +924,7 @@
<para>
Although we refer to a Linux operating system in this How-To, the
instructions and procedures that we provide here should be easily
- adaptable to either Solaris or Mac OS X. We also assume that you
+ adaptable to other supported operating systems. We also assume that you
already know how to perform a minimal installation and
configuration of the operating system with networking capability,
or that you are able to obtain assistance in this elsewhere if
@@ -969,18 +969,16 @@
<para>
The software requirements for Cluster are also modest. Host
operating systems do not require any unusual modules, services,
- applications, or configuration to support MySQL Cluster. For Mac
- OS X or Solaris, the standard installation is sufficient. For
- Linux, a standard, <quote>out of the box</quote> installation
- should be all that is necessary. The MySQL software requirements
+ applications, or configuration to support MySQL Cluster. For
+ supported operating systems, a standard
+ installation should be sufficient. The MySQL software requirements
are simple: all that is needed is a production release of
MySQL-max 4.1.3 or newer; you must use the
<literal>-max</literal> version of MySQL to have Cluster
support. (See <xref linkend="mysqld-max"/>.) It is not necessary
to compile MySQL yourself merely to be able to use Cluster. In
this How-To, we assume that you are using the
- <literal>-max</literal> binary appropriate to your Linux,
- Solaris, or Mac OS X operating system, available via the MySQL
+ <literal>-max</literal> binary appropriate to your operating system, available via the MySQL
software downloads page at <ulink url="&base-url-downloads;"/>.
</para>
@@ -1633,10 +1631,11 @@
</programlisting>
<para>
- <emphasis role="bold">Note</emphasis>: If you are using an older
- version of MySQL, you may see the SQL node referenced as
- <literal>[mysqld(API)]</literal>. This reflects an older usage
- that is now deprecated.
+ <emphasis role="bold">Note</emphasis>: The SQL node is
+ referenced here as <literal>[mysqld(API)]</literal>. This is
+ perfectly normal, and reflects the fact that the
+ <command>mysqld</command> process is acting as a cluster API
+ node.
</para>
<para>
@@ -5836,7 +5835,7 @@
<section id="mysql-cluster-api-definition">
- <title>Defining SQL Nodes</title>
+ <title>Defining SQL and Other API Nodes</title>
<indexterm>
<primary>MySQL Cluster</primary>
@@ -6044,6 +6043,30 @@
</itemizedlist>
+ <para>
+ You can obtain some information from a MySQL server running as
+ a Cluster SQL node using <literal>SHOW STATUS</literal> in the
+ <literal>mysql</literal> client, as shown here:
+ </para>
+
+<programlisting>
+mysql> <userinput>SHOW STATUS LIKE 'ndb%';</userinput>
++-----------------------------+---------------+
+| Variable_name | Value |
++-----------------------------+---------------+
+| Ndb_cluster_node_id | 5 |
+| Ndb_config_from_host | 192.168.0.112 |
+| Ndb_config_from_port | 1186 |
+| Ndb_number_of_storage_nodes | 4 |
++-----------------------------+---------------+
+4 rows in set (0.02 sec)
+</programlisting>
+
+ <para>
+ For information about these Cluster system status variables,
+ see <xref linkend="server-status-variables"/>.
+ </para>
+
</section>
<section id="mysql-cluster-tcp-definition">
@@ -6308,8 +6331,7 @@
<para>
Beginning with MySQL 4.1.9-max, MySQL Cluster will attempt to
use the shared memory transporter and configure it
- automatically where possible, chiefly where more than one node
- runs concurrently on the same cluster host. (In previous
+ automatically where possible. (In previous
versions of MySQL Cluster, shared memory segments functioned
only when the <literal>-max</literal> binary was built using
<option>--with-ndb-shm</option>.) <literal>[SHM]</literal>
@@ -7521,7 +7543,7 @@
<section id="mysql-cluster-config-params-api">
- <title>SQL Node Configuration Parameters</title>
+ <title>SQL Node and API Node Configuration Parameters</title>
<indexterm>
<primary>MySQL Cluster</primary>
@@ -7529,14 +7551,18 @@
</indexterm>
<indexterm>
+ <primary><literal>[SQL]</literal> (MySQL Cluster)</primary>
+ </indexterm>
+
+ <indexterm>
<primary><literal>[API]</literal> (MySQL Cluster)</primary>
</indexterm>
<para>
The following table provides information about parameters used
- in the <literal>[API]</literal> sections of a
+ in the <literal>[SQL]</literal> and <literal>[API]</literal> sections of a
<filename>config.ini</filename> file for configuring MySQL
- Cluster SQL nodes. For detailed descriptions and other
+ Cluster SQL nodes and API nodes. For detailed descriptions and other
additional information about each of these parameters, see
<xref linkend="mysql-cluster-api-definition"/>.
</para>
@@ -8848,7 +8874,7 @@
</indexterm>
<indexterm>
- <primary>storage nodes</primary>
+ <primary>storage nodes - see data nodes, <command>ndbd</command></primary>
<!-- <see>data nodes, <command>ndbd</command></see> -->
</indexterm>
@@ -9186,7 +9212,7 @@
the file is renamed to
<filename>ndb_<replaceable>node_id</replaceable>_cluster.log.<replaceable>seq_id</replaceable></filename>
(was
- <filename>cluster.log.<replaceable>seq_id</replaceable></filename>
+ <filename>cluster.log.<replaceable>seq_id</replaceable></filename> in version 4.1.3)
where <replaceable>seq_id</replaceable> is the sequence
number of the cluster log file. (For example: If files with
the sequence numbers 1, 2, and 3 already exist, the next log
@@ -9559,8 +9585,8 @@
<para>
Instructs <command>ndbd</command> to execute as a daemon
process. From MySQL 4.1.5 on, this is the default
- behavior. <option>--nodaemon</option> can be used to not
- start the process as a daemon.
+ behavior, and <option>--nodaemon</option> can be used to prevent
+ the process from running as a daemon.
</para>
</listitem>
@@ -12092,6 +12118,22 @@
</orderedlist>
<para>
+ Cluster backups are created by default in the
+ <filename>BACKUP</filename> subdirectory of the
+ <literal>DataDir</literal> on each data node. This can be
+ overridden for one or more data nodes individually, or for all
+ cluster data nodes in the config.ini file using the
+ <literal>BackupDataDir</literal> configuration parameter as
+ discussed in
+ <link linkend="mysql-cluster-identifying-data-nodes">Identifying
+ Data Nodes</link>. The backup files created for a backup with a
+ given <replaceable>backup_id</replaceable> are stored in a
+ subdirectory named
+ <filename>BACKUP-<replaceable>backup_id</replaceable></filename>
+ in the backup directory.
+ </para>
+
+ <para>
To abort a backup that is already in progress:
</para>
@@ -12543,7 +12585,8 @@
<para>
More detailed information about these parameters can be found in
- <xref linkend="mysql-cluster-ndbd-definition"/>.
+ <link linkend="mysql-cluster-backup-parameters">Backup
+ Parameters</link>.
</para>
</section>
@@ -13661,7 +13704,8 @@
<literal>TRUNCATE</literal> is not transactional
when used on <literal>NDB</literal> tables. If a
<literal>TRUNCATE</literal> fails to empty the
- table, then it is re-run until it is successful.
+ table, then it must be re-run until it is
+ successful.
</para>
</listitem>
@@ -13777,7 +13821,7 @@
pages. As each <literal>DataMemory</literal> page is
used, it is assigned to a specific table; once
allocated, this memory cannot be freed except by
- deleting the table.
+ dropping the table.
</para>
<para>
@@ -14937,7 +14981,7 @@
<para>
Cluster is supported in the MySQL-max binaries from version
- 4.1.3 onward. You can determine whether your server has NDB
+ 4.1.3 onward. You can determine whether your server has <literal>NDB</literal>
support using either the <literal>SHOW VARIABLES LIKE
'have_%'</literal> or <literal>SHOW ENGINES</literal>
statement. (See <xref linkend="mysqld-max"/>, for more
@@ -14951,8 +14995,11 @@
<filename>.tar.gz</filename> archives from
<ulink url="&base-url-downloads;"/> instead. You can also
obtain <literal>NDB</literal> support by compiling the
- <literal>-max</literal> binaries from source, but it is not
- necessary to do so simply to use MySQL Cluster.
+ <literal>-max</literal> binaries
+ from source, but it is not necessary to do so simply to use
+ MySQL Cluster. To download the latest binary, RPM, or source
+ distribution in the MySQL ¤t-series; series, visit
+ <ulink url="&base-url-downloads;mysql/¤t-series;.html"/>.
</para>
</listitem>
@@ -15077,7 +15124,7 @@
</para>
<para>
- <literal>NDB</literal> tables in MySQL 4.1 are subject to the
+ <literal>NDB</literal> tables in MySQL ¤t-series; are subject to the
following limitations:
</para>
@@ -15149,8 +15196,7 @@
</itemizedlist>
<para>
- We expect to lift many of these restrictions in future MySQL
- release series. For additional information, see
+ For additional information on Cluster limitations, see
<xref linkend="mysql-cluster-limitations"/>.
</para>
</listitem>
@@ -15716,9 +15762,11 @@
were sometimes referred to as <quote>database nodes</quote>.
The term <quote>storage nodes</quote> has also been used. In
addition, SQL nodes were sometimes known as <quote>client
- nodes</quote>. They are also often referred to as <quote>API
- nodes</quote>. The older terminology has been deprecated to
+ nodes</quote>. This older terminology has been deprecated to
minimize confusion, and for this reason should be avoided.
+ They are also often referred to as <quote>API nodes</quote>
+ — an SQL node is actually an API node that provides an
+ SQL interface to the cluster.
</para>
</listitem>
Modified: trunk/refman-5.0/mysql-cluster.xml
===================================================================
--- trunk/refman-5.0/mysql-cluster.xml 2006-08-16 10:34:23 UTC (rev 3032)
+++ trunk/refman-5.0/mysql-cluster.xml 2006-08-16 11:12:50 UTC (rev 3033)
Changed blocks: 21, Lines Added: 56, Lines Deleted: 44; 11684 bytes
@@ -658,7 +658,7 @@
The data stored by the cluster is divided into four partitions,
numbered 0, 1, 2, and 3. Each partition is stored — in
multiple copies — on the same node group. Partitions are
- stored on alternate node groups: Partition 2 is stored on .
+ stored on alternate node groups:
</para>
<itemizedlist>
@@ -924,7 +924,7 @@
<para>
Although we refer to a Linux operating system in this How-To, the
instructions and procedures that we provide here should be easily
- adaptable to either Solaris or Mac OS X. We also assume that you
+ adaptable to other supported operating systems. We also assume that you
already know how to perform a minimal installation and
configuration of the operating system with networking capability,
or that you are able to obtain assistance in this elsewhere if
@@ -969,18 +969,16 @@
<para>
The software requirements for Cluster are also modest. Host
operating systems do not require any unusual modules, services,
- applications, or configuration to support MySQL Cluster. For Mac
- OS X or Solaris, the standard installation is sufficient. For
- Linux, a standard, <quote>out of the box</quote> installation
- should be all that is necessary. The MySQL software requirements
+ applications, or configuration to support MySQL Cluster. For
+ supported operating systems, a standard
+ installation should be sufficient. The MySQL software requirements
are simple: all that is needed is a production release of
MySQL-max ¤t-series;; you must use the
<literal>-max</literal> version of MySQL to have Cluster
support. (See <xref linkend="mysqld-max"/>.) It is not necessary
to compile MySQL yourself merely to be able to use Cluster. In
this How-To, we assume that you are using the
- <literal>-max</literal> binary appropriate to your Linux,
- Solaris, or Mac OS X operating system, available via the MySQL
+ <literal>-max</literal> binary appropriate to your operating system, available via the MySQL
software downloads page at <ulink url="&base-url-downloads;"/>.
</para>
@@ -1084,13 +1082,7 @@
<para>
RPMs are also available for both 32-bit and 64-bit Linux
- platforms; as of MySQL 4.1.10a, the <literal>-max</literal>
- binaries installed by the RPMs support the
- <literal>NDBCluster</literal> storage engine. If you choose to
- use these rather than the binary files, be aware that you must
- install <emphasis>both</emphasis> the <literal>-server</literal>
- and <literal>-max</literal> packages on all machines that are to
- host cluster nodes. (See <xref linkend="linux-rpm"/>, for more
+ platforms. (See <xref linkend="linux-rpm"/>, for more
information about installing MySQL using the RPMs.) After
installing from RPM, you will still need to configure the
cluster as discussed in
@@ -1633,10 +1625,11 @@
</programlisting>
<para>
- <emphasis role="bold">Note</emphasis>: If you are using an older
- version of MySQL, you may see the SQL node referenced as
- <literal>[mysqld(API)]</literal>. This reflects an older usage
- that is now deprecated.
+ <emphasis role="bold">Note</emphasis>: The SQL node is
+ referenced here as <literal>[mysqld(API)]</literal>. This is
+ perfectly normal, and reflects the fact that the
+ <command>mysqld</command> process is acting as a cluster API
+ node.
</para>
<para>
@@ -5819,7 +5812,7 @@
<section id="mysql-cluster-api-definition">
- <title>Defining SQL Nodes</title>
+ <title>Defining SQL and Other API Nodes</title>
<indexterm>
<primary>MySQL Cluster</primary>
@@ -6314,8 +6307,7 @@
<para>
MySQL Cluster attempts to use the shared memory transporter
- and configure it automatically where possible, chiefly where
- more than one node runs concurrently on the same cluster host.
+ and configure it automatically where possible.
(In very early versions of MySQL Cluster, shared memory
segments functioned only when the server binary was built
using <option>--with-ndb-shm</option>.)
@@ -7529,7 +7521,7 @@
<section id="mysql-cluster-config-params-api">
- <title>SQL Node Configuration Parameters</title>
+ <title>SQL Node and API Node Configuration Parameters</title>
<indexterm>
<primary>MySQL Cluster</primary>
@@ -7537,14 +7529,18 @@
</indexterm>
<indexterm>
+ <primary><literal>[SQL]</literal> (MySQL Cluster)</primary>
+ </indexterm>
+
+ <indexterm>
<primary><literal>[API]</literal> (MySQL Cluster)</primary>
</indexterm>
<para>
The following table provides information about parameters used
- in the <literal>[API]</literal> sections of a
+ in the <literal>[SQL]</literal> and <literal>[API]</literal> sections of a
<filename>config.ini</filename> file for configuring MySQL
- Cluster SQL nodes. For detailed descriptions and other
+ Cluster SQL nodes and API nodes. For detailed descriptions and other
additional information about each of these parameters, see
<xref linkend="mysql-cluster-api-definition"/>.
</para>
@@ -8854,7 +8850,7 @@
</indexterm>
<indexterm>
- <primary>storage nodes</primary>
+ <primary>storage nodes - see data nodes, <command>ndbd</command></primary>
<!-- <see>data nodes, <command>ndbd</command></see> -->
</indexterm>
@@ -8989,7 +8985,8 @@
<filename>ndb_<replaceable>node_id</replaceable>_out.log</filename>
is a file containing any data output by the
<command>ndbd</command> process. This file is created only
- if <command>ndbd</command> is started as a daemon.
+ if <command>ndbd</command> is started as a daemon, which is
+ the default behavior.
</para>
</listitem>
@@ -9534,8 +9531,8 @@
<para>
Instructs <command>ndbd</command> to execute as a daemon
process. This is the default behavior.
- <option>--nodaemon</option> can be used to not start the
- process as a daemon.
+ <option>--nodaemon</option> can be used to prevent
+ the process from running as a daemon.
</para>
</listitem>
@@ -9743,7 +9740,7 @@
<listitem>
<para>
<option>--config-file=<replaceable>filename</replaceable></option>,
- <option>-f <replaceable>filename</replaceable></option>,
+ <option>-f <replaceable>filename</replaceable></option>
</para>
<para>
@@ -12156,6 +12153,22 @@
</orderedlist>
<para>
+ Cluster backups are created by default in the
+ <filename>BACKUP</filename> subdirectory of the
+ <literal>DataDir</literal> on each data node. This can be
+ overridden for one or more data nodes individually, or for all
+ cluster data nodes in the config.ini file using the
+ <literal>BackupDataDir</literal> configuration parameter as
+ discussed in
+ <link linkend="mysql-cluster-identifying-data-nodes">Identifying
+ Data Nodes</link>. The backup files created for a backup with a
+ given <replaceable>backup_id</replaceable> are stored in a
+ subdirectory named
+ <filename>BACKUP-<replaceable>backup_id</replaceable></filename>
+ in the backup directory.
+ </para>
+
+ <para>
To abort a backup that is already in progress:
</para>
@@ -12607,7 +12620,8 @@
<para>
More detailed information about these parameters can be found in
- <xref linkend="mysql-cluster-ndbd-definition"/>.
+ <link linkend="mysql-cluster-backup-parameters">Backup
+ Parameters</link>.
</para>
</section>
@@ -13574,9 +13588,9 @@
<para>
Geometry datatypes (<literal>WKT</literal> and
- <literal>WKB</literal>) are not supported by the NDB
+ <literal>WKB</literal>) are not supported by the <literal>NDB</literal>
storage engine prior to MySQL 5.0.16. (Note that spatial
- indexes are still not supported in MySQL 5.0.16 and
+ indexes are still not supported for Cluster tables in MySQL 5.0.16 and
newer.)
</para>
</listitem>
@@ -14759,7 +14773,7 @@
We have implemented (asynchronous) replication for Cluster in
MySQL 5.1. This includes the capability to replicate both
between two clusters, and from a MySQL cluster to a
- non-Cluster MySQL server. Howecer, we do not plan to backport
+ non-Cluster MySQL server. However, we do not plan to backport
this functionality to MySQL 5.0.
</para>
</listitem>
@@ -15318,7 +15332,7 @@
Cluster is supported in all MySQL-max binaries in the
¤t-series; release series, except as noted in the
following paragraph. You can determine whether your server has
- NDB support using either the <literal>SHOW VARIABLES LIKE
+ <literal>NDB</literal> support using either the <literal>SHOW VARIABLES LIKE
'have_%'</literal> or <literal>SHOW ENGINES</literal>
statement. (See <xref linkend="mysqld-max"/>, for more
information.)
@@ -15452,7 +15466,8 @@
In a future MySQL Cluster release series, we hope to implement
a <quote>hot</quote> reconfiguration capability for MySQL
Cluster to minimize (if not eliminate) the requirement for
- restarting the cluster when adding new nodes.
+ restarting the cluster when adding new nodes. However, this is
+ not planned for the MySQL 5.0 release series.
</para>
</listitem>
@@ -15463,17 +15478,12 @@
</para>
<para>
- <literal>NDB</literal> tables in MySQL are subject to the
+ <literal>NDB</literal> tables in MySQL ¤t-series; are subject to the
following limitations:
</para>
<itemizedlist>
- <remark role="todo">
- [js] Check this list against mysql-cluster-limitations once
- that section has been reviewed for 5.0.
- </remark>
-
<listitem>
<para>
Not all character sets and collations are supported.
@@ -16104,9 +16114,11 @@
were sometimes referred to as <quote>database nodes</quote>.
The term <quote>storage nodes</quote> has also been used. In
addition, SQL nodes were sometimes known as <quote>client
- nodes</quote>. They are also often referred to as <quote>API
- nodes</quote>. The older terminology has been deprecated to
+ nodes</quote>. This older terminology has been deprecated to
minimize confusion, and for this reason should be avoided.
+ They are also often referred to as <quote>API nodes</quote>
+ — an SQL node is actually an API node that provides an
+ SQL interface to the cluster.
</para>
</listitem>
Modified: trunk/refman-5.1/mysql-cluster.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster.xml 2006-08-16 10:34:23 UTC (rev 3032)
+++ trunk/refman-5.1/mysql-cluster.xml 2006-08-16 11:12:50 UTC (rev 3033)
Changed blocks: 19, Lines Added: 34, Lines Deleted: 45; 9173 bytes
@@ -19,7 +19,7 @@
<indexterm>
<primary><literal>NDB</literal> storage engine</primary>
-<!-- <see>MySQL Cluster</see> -->
+<!-- <see>MySQL Cluster</see> -->
</indexterm>
<indexterm>
@@ -921,7 +921,7 @@
<para>
Although we refer to a Linux operating system in this How-To, the
instructions and procedures that we provide here should be easily
- adaptable to either Solaris or Mac OS X. We also assume that you
+ adaptable to other supported operating systems. We also assume that you
already know how to perform a minimal installation and
configuration of the operating system with networking capability,
or that you are able to obtain assistance in this elsewhere if
@@ -966,15 +966,14 @@
<para>
The software requirements for Cluster are also modest. Host
operating systems do not require any unusual modules, services,
- applications, or configuration to support MySQL Cluster. For Mac
- OS X or Solaris, the standard installation is sufficient. For
- Linux, a standard, <quote>out of the box</quote> installation
- should be all that is necessary. The MySQL software requirements
+ applications, or configuration to support MySQL Cluster. For
+ supported operating systems, a standard
+ installation should be sufficient. The MySQL software requirements
are simple: all that is needed is a production release of MySQL
¤t-series; to have Cluster support. It is not necessary to
compile MySQL yourself merely to be able to use Cluster. In this
How-To, we assume that you are using the server binary
- appropriate to your Linux, Solaris, or Mac OS X operating
+ appropriate to your operating
system, available via the MySQL software downloads page at
<ulink url="&base-url-downloads;"/>.
</para>
@@ -1626,10 +1625,11 @@
</programlisting>
<para>
- <emphasis role="bold">Note</emphasis>: If you are using an older
- version of MySQL, you may see the SQL node referenced as
- <literal>[mysqld(API)]</literal>. This reflects an older usage
- that is now deprecated.
+ <emphasis role="bold">Note</emphasis>: The SQL node is
+ referenced here as <literal>[mysqld(API)]</literal>. This is
+ perfectly normal, and reflects the fact that the
+ <command>mysqld</command> process is acting as a cluster API
+ node.
</para>
<para>
@@ -3874,10 +3874,6 @@
uniqueness constraints.
</para>
- <remark role="todo">
- [js] Still true in 5.0?
- </remark>
-
<para>
Currently, the only partitioning algorithm is hashing and
ordered indexes are local to each node. Thus, ordered indexes
@@ -4219,10 +4215,6 @@
<literal>TransactionBufferMemory</literal> is 1MB.
</para>
- <remark role="todo">
- Unchanged in 5.0? [js]
- </remark>
-
<para>
Normal read and write operations use a similar buffer,
whose usage is even more short-lived. The compile-time
@@ -6213,11 +6205,7 @@
<para>
MySQL Cluster attempts to use the shared memory transporter
- and configure it automatically where possible, chiefly where
- more than one node runs concurrently on the same cluster host.
- (In very early versions of MySQL Cluster, shared memory
- segments functioned only when the server binary was built
- using <option>--with-ndb-shm</option>.)
+ and configure it automatically where possible.
<literal>[SHM]</literal> sections in the
<filename>config.ini</filename> file explicitly define
shared-memory connections between nodes in the cluster. When
@@ -7412,7 +7400,7 @@
<section id="mysql-cluster-config-params-api">
- <title>SQL Node Configuration Parameters</title>
+ <title>SQL Node and API Node Configuration Parameters</title>
<indexterm>
<primary>MySQL Cluster</primary>
@@ -7420,14 +7408,18 @@
</indexterm>
<indexterm>
+ <primary><literal>[SQL]</literal> (MySQL Cluster)</primary>
+ </indexterm>
+
+ <indexterm>
<primary><literal>[API]</literal> (MySQL Cluster)</primary>
</indexterm>
<para>
The following table provides information about parameters used
- in the <literal>[API]</literal> sections of a
+ in the <literal>[SQL]</literal> and <literal>[API]</literal> sections of a
<filename>config.ini</filename> file for configuring MySQL
- Cluster SQL nodes. For detailed descriptions and other
+ Cluster SQL nodes and API nodes. For detailed descriptions and other
additional information about each of these parameters, see
<xref linkend="mysql-cluster-api-definition"/>.
</para>
@@ -8553,7 +8545,7 @@
<indexterm>
<primary>API nodes</primary>
-<!-- <see>SQL nodes</see> -->
+<!-- <see>SQL nodes</see> -->
</indexterm>
<para>
@@ -8737,7 +8729,7 @@
</indexterm>
<indexterm>
- <primary>storage nodes</primary>
+ <primary>storage nodes - see data nodes, <command>ndbd</command></primary>
<!-- <see>data nodes, <command>ndbd</command></see> -->
</indexterm>
@@ -8872,7 +8864,8 @@
<filename>ndb_<replaceable>node_id</replaceable>_out.log</filename>
is a file containing any data output by the
<command>ndbd</command> process. This file is created only
- if <command>ndbd</command> is started as a daemon.
+ if <command>ndbd</command> is started as a daemon, which is
+ the default behavior.
</para>
</listitem>
@@ -9417,8 +9410,8 @@
<para>
Instructs <command>ndbd</command> to execute as a daemon
process. This is the default behavior.
- <option>--nodaemon</option> can be used to not start the
- process as a daemon.
+ <option>--nodaemon</option> can be used to prevent
+ the process from running as a daemon.
</para>
</listitem>
@@ -9626,7 +9619,7 @@
<listitem>
<para>
<option>--config-file=<replaceable>filename</replaceable></option>,
- <option>-f <replaceable>filename</replaceable></option>,
+ <option>-f <replaceable>filename</replaceable></option>
</para>
<para>
@@ -15772,7 +15765,7 @@
<indexterm>
<primary>limitations of MySQL Cluster</primary>
-<!-- <see>MySQL Cluster limitations</see> -->
+<!-- <see>MySQL Cluster limitations</see> -->
</indexterm>
<para>
@@ -17028,7 +17021,7 @@
<listitem>
<indexterm>
<primary><literal>NDB</literal></primary>
-<!-- <seealso>MySQL Cluster</seealso> -->
+<!-- <seealso>MySQL Cluster</seealso> -->
</indexterm>
<para>
@@ -17642,8 +17635,7 @@
<para>
Cluster is supported in all server binaries in the
¤t-series; release series for operating systems on which
- MySQL Cluster is available (currently Linux, Mac OS X, and
- Solaris). See <xref linkend="mysqld"/>. You can determine
+ MySQL Cluster is available. See <xref linkend="mysqld"/>. You can determine
whether your server has NDB support using either the
<literal>SHOW VARIABLES LIKE 'have_%'</literal> or
<literal>SHOW ENGINES</literal> statement.
@@ -17778,17 +17770,12 @@
</para>
<para>
- <literal>NDB</literal> tables in MySQL are subject to the
+ <literal>NDB</literal> tables in MySQL ¤t-series; are subject to the
following limitations:
</para>
<itemizedlist>
- <remark role="todo">
- [js] Check this list against mysql-cluster-limitations once
- that section has been reviewed for 5.0.
- </remark>
-
<listitem>
<para>
Not all character sets and collations are supported.
@@ -18418,9 +18405,11 @@
were sometimes referred to as <quote>database nodes</quote>.
The term <quote>storage nodes</quote> has also been used. In
addition, SQL nodes were sometimes known as <quote>client
- nodes</quote>. They are also often referred to as <quote>API
- nodes</quote>. The older terminology has been deprecated to
+ nodes</quote>. This older terminology has been deprecated to
minimize confusion, and for this reason should be avoided.
+ They are also often referred to as <quote>API nodes</quote>
+ — an SQL node is actually an API node that provides an
+ SQL interface to the cluster.
</para>
</listitem>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r3033 - in trunk: refman-4.1 refman-5.0 refman-5.1 | jon | 16 Aug |