Author: jstephens
Date: 2006-05-25 15:14:23 +0200 (Thu, 25 May 2006)
New Revision: 2199
Log:
Cluster chapter indexterms.
Some indexes related to Cluster elsewhere (5.1 Manual only).
Various misc. fixes in Cluster Glossary, Cluster FAQ.
Modified:
trunk/refman-4.1/ndbcluster.xml
trunk/refman-5.0/ndbcluster.xml
trunk/refman-5.1/information-schema.xml
trunk/refman-5.1/ndbcluster.xml
trunk/refman-5.1/sql-syntax.xml
Modified: trunk/refman-4.1/ndbcluster.xml
===================================================================
--- trunk/refman-4.1/ndbcluster.xml 2006-05-25 10:01:12 UTC (rev 2198)
+++ trunk/refman-4.1/ndbcluster.xml 2006-05-25 13:14:23 UTC (rev 2199)
@@ -10579,6 +10579,12 @@
<orderedlist>
<listitem>
+ <para>
+ Start the management server (<command>ndb_mgm</command>).
+ </para>
+ </listitem>
+
+ <listitem>
<indexterm>
<primary>MySQL Cluster</primary>
<secondary><literal>START BACKUP</literal> command</secondary>
@@ -10589,12 +10595,6 @@
</indexterm>
<para>
- Start the management server (<command>ndb_mgm</command>).
- </para>
- </listitem>
-
- <listitem>
- <para>
Execute the command <literal>START BACKUP</literal>.
</para>
</listitem>
@@ -10934,6 +10934,16 @@
<title>&title-mysql-cluster-interconnects;</title>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>network transporters</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>interconnects</secondary>
+ </indexterm>
+
<para>
Even before design of <literal>NDB Cluster</literal> began in
1996, it was evident that one of the major problems to be
@@ -10974,6 +10984,21 @@
<title>&title-sci-sockets;</title>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>network transporters</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>SCI (Scalable Coherent Interface)</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>SCI (Scalable Coherent Interface)</primary>
+ <see>MySQL Cluster</see>
+ </indexterm>
+
<para>
In this section, we show how to adapt a cluster configured for
normal TCP/IP communication to use SCI Sockets instead. This
@@ -11000,6 +11025,11 @@
verified these only with Linux 2.4 to date.
</para>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>SCI software requirements</secondary>
+ </indexterm>
+
<para>
There are essentially four requirements for SCI Sockets:
</para>
@@ -11076,6 +11106,11 @@
<emphasis role="bold">Package Installation</emphasis>
</para>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>SCI software installation</secondary>
+ </indexterm>
+
<para>
Once you have obtained the library packages, the next step is to
unpack them into appropriate directories, with the SCI Sockets
@@ -11127,6 +11162,16 @@
<emphasis role="bold">Network Configuration</emphasis>
</para>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>network configuration (SCI)</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>SCI network configuration</secondary>
+ </indexterm>
+
<para>
Now that all the libraries and binaries are in their proper
place, we need to ensure that the SCI cards have proper node IDs
@@ -11292,6 +11337,11 @@
<emphasis role="bold">Driver Installation</emphasis>
</para>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>SCI drivers</secondary>
+ </indexterm>
+
<para>
With the configuration files in place, the drivers can be
installed.
@@ -11419,6 +11469,16 @@
<title>&title-performance-figures;</title>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>performance</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>benchmarks</secondary>
+ </indexterm>
+
<para>
The <command>ndbd</command> process has a number of simple
constructs which are used to access the data in a MySQL Cluster.
@@ -11579,12 +11639,18 @@
</tgroup>
</informaltable>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>SCI, performance <foreignphrase>vs</foreignphrase> TCP/IP</secondary>
+ </indexterm>
+
<para>
We also performed another set of tests to check the performance
- of SCI Sockets vis-à-vis that of the SCI transporter, and both
- of these as compared with the TCP/IP transporter. All these
- tests used primary key accesses either serially and
- multi-threaded, or multi-threaded and batched.
+ of SCI Sockets <foreignphrase>vis-à-vis</foreignphrase> that of
+ the SCI transporter, and both of these as compared with the
+ TCP/IP transporter. All these tests used primary key accesses
+ either serially and multi-threaded, or multi-threaded and
+ batched.
</para>
<para>
@@ -11645,6 +11711,15 @@
<title>&title-mysql-cluster-limitations;</title>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>limitations of MySQL Cluster</primary>
+ <see>MySQL Cluster limitations</see>
+ </indexterm>
+
<para>
In this section, we provide a list of known limitations in MySQL
Cluster releases in the ¤t-series;.x series compared to
@@ -11670,6 +11745,10 @@
<itemizedlist>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>syntax</secondary>
+ </indexterm>
<para>
<emphasis role="bold">Noncompliance in syntax</emphasis>
(resulting in errors when running existing applications):
@@ -11733,6 +11812,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>causing errors</secondary>
+ </indexterm>
<para>
<emphasis role="bold">Non-compliance in limits or
behavior</emphasis> (may result in errors when running
@@ -11786,6 +11869,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>transactions</secondary>
+ </indexterm>
<para>
<emphasis role="bold">Transaction Handling</emphasis>:
</para>
@@ -11935,6 +12022,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>imposed by configuration</secondary>
+ </indexterm>
<para>
A number of hard limits exist which are configurable, but
available main memory in the cluster sets limits. See the
@@ -11981,6 +12072,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>database objects</secondary>
+ </indexterm>
<para>
Database names, table names and attribute names cannot be
as long in <literal>NDB</literal> tables as with other
@@ -12043,6 +12138,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>unsupported features</secondary>
+ </indexterm>
<para>
<emphasis role="bold">Unsupported features</emphasis> (do not
cause errors, but are not supported or enforced):
@@ -12081,6 +12180,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>performance</secondary>
+ </indexterm>
<para>
<emphasis role="bold">Performance and limitation-related
issues</emphasis>:
@@ -12201,6 +12304,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>unsupported features</secondary>
+ </indexterm>
<para>
<emphasis role="bold">Missing features</emphasis>:
</para>
@@ -12232,6 +12339,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>multiple MySQL servers</secondary>
+ </indexterm>
<para>
<emphasis role="bold">Problems relating to multiple MySQL
servers</emphasis> (not relating to <literal>MyISAM</literal>
@@ -12289,6 +12400,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>implementation</secondary>
+ </indexterm>
<para>
<emphasis role="bold">Issues exclusive to MySQL
Cluster</emphasis> (not related to <literal>MyISAM</literal>
@@ -12345,6 +12460,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>multiple management servers</secondary>
+ </indexterm>
<para>
When using multiple management servers:
</para>
@@ -12416,6 +12535,15 @@
<title>&title-mysql-cluster-faq;</title>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>FAQ</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>frequently-asked questions about MySQL Cluster</primary>
+ </indexterm>
+
<remark>
Cluster FAQ, version 1.0 (2005-01-29) Author: Jon Stephens, with
the assistance of Tomas Ulin, Mikael Ronström, Harrison Fisk,
@@ -12434,6 +12562,10 @@
<itemizedlist>
<listitem>
+ <indexterm>
+ <primary><literal>NDB</literal></primary>
+ <seealso>MySQL Cluster</seealso>
+ </indexterm>
<para>
<emphasis>What does <quote>NDB</quote> mean?</emphasis>
</para>
@@ -12446,9 +12578,15 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><foreignphrase>vs</foreignphrase> replication</secondary>
+ </indexterm>
+
<para>
- <emphasis>What's the difference in using Cluster vs. using
- replication?</emphasis>
+ <emphasis>What's the difference in using Cluster
+ <foreignphrase>vs</foreignphrase> using
+ replication?</emphasis>
</para>
<para>
@@ -12473,14 +12611,19 @@
</para>
<para>
- We are planning to implement (asynchronous) replication for
- Cluster in MySQL 5.1. This will include the capability to
- replicate both between two clusters and between a MySQL
- cluster and a non-Cluster MySQL server.
+ 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 this functionality to MySQL 4.1.
</para>
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>networking requirements</secondary>
+ </indexterm>
<para>
<emphasis>Do I need to do any special networking to run
Cluster? (How do computers in a cluster
@@ -12506,6 +12649,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>number of computers required</secondary>
+ </indexterm>
<para>
<emphasis>How many computers do I need to run a cluster, and
why?</emphasis>
@@ -12525,6 +12672,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>roles of computers</secondary>
+ </indexterm>
<para>
<emphasis>What do the different computers do in a
cluster?</emphasis>
@@ -12543,6 +12694,11 @@
are:
</para>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>node types</secondary>
+ </indexterm>
+
<itemizedlist>
<listitem>
@@ -12582,6 +12738,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>platforms supported</secondary>
+ </indexterm>
<remark role="todo">
Reference NDB client apps - ndb_mgmd, ndb_mgm, ndbd, mysqld
</remark>
@@ -12612,6 +12772,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>hardware requirements</secondary>
+ </indexterm>
<para>
<emphasis>What are the hardware requirements for running MySQL
Cluster?</emphasis>
@@ -12635,6 +12799,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>memory requirements</secondary>
+ </indexterm>
<para>
<emphasis>How much RAM do I need? Is it possible to use disk
memory at all?</emphasis>
@@ -12645,7 +12813,7 @@
means that all table data (including indexes) is stored in
RAM. Therefore, if your data takes up 1GB of space and you
want to replicate it once in the cluster, you need 2GB of
- memory to do so. This in addition to the memory required by
+ memory to do so. This is in addition to the memory required by
the operating system and any applications running on the
cluster computers.
</para>
@@ -12739,8 +12907,8 @@
</para>
<para>
- As of MySQL 4.1.11 there is no easy way determine exactly how
- much memory is being used for storage of Cluster indexes;
+ There is no easy way to determine exactly how much memory is
+ being used for storage of Cluster indexes at any given time;
however, warnings are written to the Cluster log when 80% of
available <literal>DataMemory</literal> or
<literal>IndexMemory</literal> is in use, and again when use
@@ -12779,6 +12947,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>networking requirements</secondary>
+ </indexterm>
<para>
<emphasis>Because MySQL Cluster uses TCP/IP, does that mean I
can run it over the Internet, with one or more nodes in a
@@ -12808,6 +12980,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>SQL statements</secondary>
+ </indexterm>
<para>
<emphasis>Do I have to learn a new programming or query
language to use Cluster?</emphasis>
@@ -12854,6 +13030,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>error messages</secondary>
+ </indexterm>
<para>
<emphasis>How do I find out what an error or warning message
means when using Cluster?</emphasis>
@@ -12886,6 +13066,14 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>transactions</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>transaction isolation levels supported</secondary>
+ </indexterm>
<para>
<emphasis>Is MySQL Cluster transaction-safe? What isolation
levels are supported?</emphasis>
@@ -12943,6 +13131,10 @@
-->
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>how to obtain</secondary>
+ </indexterm>
<para>
<emphasis>Which versions of the MySQL software support
Cluster? Do I have to compile from source?</emphasis>
@@ -13163,6 +13355,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>importing existing tables</secondary>
+ </indexterm>
<para>
<emphasis>How do I import an existing MySQL database into a
cluster?</emphasis>
@@ -13205,6 +13401,16 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>arbitrator</secondary>
+ </indexterm>
+
+
+ <indexterm>
+ <primary>arbitrator</primary>
+ <see>MySQL Cluster</see>
+ </indexterm>
<para>
<emphasis>What is an <quote>arbitrator</quote>?</emphasis>
</para>
@@ -13260,6 +13466,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>data types supported</secondary>
+ </indexterm>
<para>
<emphasis>What data types are supported by MySQL
Cluster?</emphasis>
@@ -13289,6 +13499,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>starting and stopping</secondary>
+ </indexterm>
<para>
<emphasis>How do I start and stop MySQL Cluster?</emphasis>
</para>
@@ -13457,6 +13671,14 @@
<title>&title-mysql-cluster-glossary;</title>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>terminology</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster Glossary</primary>
+ </indexterm>
+
<remark>
Author: Jon Stephens.
</remark>
@@ -13684,12 +13906,11 @@
<para>
<emphasis role="bold">Note Regarding Terms</emphasis>: In
older versions of the MySQL Cluster documentation, data nodes
- were sometimes referred to as <quote>database nodes</quote> or
- <quote>data nodes</quote>. The term <quote>storage
+ 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> or <quote>API
- nodes</quote>. This older terminology has been deprecated to
- minimize confusion, and for these reasons should be avoided.
+ 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 minimize confusion, and for this reason should be avoided.
</para>
</listitem>
@@ -13704,6 +13925,10 @@
should reside on different hosts. It is possible to control
which nodes belong to which node groups.
</para>
+ <para>
+ For more information, see
+ <xref linkend="mysql-cluster-nodes-groups"/>.
+ </para>
</listitem>
<listitem>
Modified: trunk/refman-5.0/ndbcluster.xml
===================================================================
--- trunk/refman-5.0/ndbcluster.xml 2006-05-25 10:01:12 UTC (rev 2198)
+++ trunk/refman-5.0/ndbcluster.xml 2006-05-25 13:14:23 UTC (rev 2199)
@@ -10555,6 +10555,12 @@
<orderedlist>
<listitem>
+ <para>
+ Start the management server (<command>ndb_mgm</command>).
+ </para>
+ </listitem>
+
+ <listitem>
<indexterm>
<primary>MySQL Cluster</primary>
<secondary><literal>START BACKUP</literal> command</secondary>
@@ -10565,12 +10571,6 @@
</indexterm>
<para>
- Start the management server (<command>ndb_mgm</command>).
- </para>
- </listitem>
-
- <listitem>
- <para>
Execute the command <literal>START BACKUP</literal>.
</para>
</listitem>
@@ -10910,6 +10910,16 @@
<title>&title-mysql-cluster-interconnects;</title>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>network transporters</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>interconnects</secondary>
+ </indexterm>
+
<para>
Even before design of <literal>NDB Cluster</literal> began in
1996, it was evident that one of the major problems to be
@@ -10950,6 +10960,21 @@
<title>&title-sci-sockets;</title>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>network transporters</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>SCI (Scalable Coherent Interface)</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>SCI (Scalable Coherent Interface)</primary>
+ <see>MySQL Cluster</see>
+ </indexterm>
+
<para>
In this section, we show how to adapt a cluster configured for
normal TCP/IP communication to use SCI Sockets instead. This
@@ -10976,6 +11001,11 @@
verified these only with Linux 2.4 to date.
</para>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>SCI software requirements</secondary>
+ </indexterm>
+
<para>
There are essentially four requirements for SCI Sockets:
</para>
@@ -11052,6 +11082,11 @@
<emphasis role="bold">Package Installation</emphasis>
</para>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>SCI software installation</secondary>
+ </indexterm>
+
<para>
Once you have obtained the library packages, the next step is to
unpack them into appropriate directories, with the SCI Sockets
@@ -11103,6 +11138,16 @@
<emphasis role="bold">Network Configuration</emphasis>
</para>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>network configuration (SCI)</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>SCI network configuration</secondary>
+ </indexterm>
+
<para>
Now that all the libraries and binaries are in their proper
place, we need to ensure that the SCI cards have proper node IDs
@@ -11268,6 +11313,11 @@
<emphasis role="bold">Driver Installation</emphasis>
</para>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>SCI drivers</secondary>
+ </indexterm>
+
<para>
With the configuration files in place, the drivers can be
installed.
@@ -11395,6 +11445,16 @@
<title>&title-performance-figures;</title>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>performance</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>benchmarks</secondary>
+ </indexterm>
+
<para>
The <command>ndbd</command> process has a number of simple
constructs which are used to access the data in a MySQL Cluster.
@@ -11555,12 +11615,18 @@
</tgroup>
</informaltable>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>SCI, performance <foreignphrase>vs</foreignphrase> TCP/IP</secondary>
+ </indexterm>
+
<para>
We also performed another set of tests to check the performance
- of SCI Sockets vis-à-vis that of the SCI transporter, and both
- of these as compared with the TCP/IP transporter. All these
- tests used primary key accesses either serially and
- multi-threaded, or multi-threaded and batched.
+ of SCI Sockets <foreignphrase>vis-à-vis</foreignphrase> that of
+ the SCI transporter, and both of these as compared with the
+ TCP/IP transporter. All these tests used primary key accesses
+ either serially and multi-threaded, or multi-threaded and
+ batched.
</para>
<para>
@@ -11621,9 +11687,14 @@
<title>&title-mysql-cluster-limitations;</title>
- <remark role="note">
- Changed section title to remove version-specificity. [js]
- </remark>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>limitations of MySQL Cluster</primary>
+ <see>MySQL Cluster limitations</see>
+ </indexterm>
<para>
In this section, we provide a list of known limitations in MySQL
@@ -11656,6 +11727,10 @@
<itemizedlist>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>syntax</secondary>
+ </indexterm>
<para>
<emphasis role="bold">Noncompliance in syntax</emphasis>
(resulting in errors when running existing applications):
@@ -11713,6 +11788,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>causing errors</secondary>
+ </indexterm>
<para>
<emphasis role="bold">Non-compliance in limits or
behavior</emphasis> (may result in errors when running
@@ -11766,6 +11845,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>transactions</secondary>
+ </indexterm>
<para>
<emphasis role="bold">Transaction Handling</emphasis>:
</para>
@@ -11915,6 +11998,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>imposed by configuration</secondary>
+ </indexterm>
<para>
A number of hard limits exist which are configurable, but
available main memory in the cluster sets limits. See the
@@ -11961,6 +12048,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>database objects</secondary>
+ </indexterm>
<para>
Database names, table names and attribute names cannot be
as long in <literal>NDB</literal> tables as with other
@@ -12022,6 +12113,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>unsupported features</secondary>
+ </indexterm>
<para>
<emphasis role="bold">Unsupported features</emphasis> (do not
cause errors, but are not supported or enforced):
@@ -12060,6 +12155,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>performance</secondary>
+ </indexterm>
<para>
<emphasis role="bold">Performance and limitation-related
issues</emphasis>:
@@ -12161,6 +12260,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>unsupported features</secondary>
+ </indexterm>
<para>
<emphasis role="bold">Missing features</emphasis>:
</para>
@@ -12192,6 +12295,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>multiple MySQL servers</secondary>
+ </indexterm>
<para>
<emphasis role="bold">Problems relating to multiple MySQL
servers</emphasis> (not relating to <literal>MyISAM</literal>
@@ -12251,6 +12358,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>implementation</secondary>
+ </indexterm>
<para>
<emphasis role="bold">Issues exclusive to MySQL
Cluster</emphasis> (not related to <literal>MyISAM</literal>
@@ -12307,6 +12418,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>multiple management servers</secondary>
+ </indexterm>
<para>
When using multiple management servers:
</para>
@@ -12380,6 +12495,10 @@
<itemizedlist>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>resolved in current version from previous versions</secondary>
+ </indexterm>
<para>
The <literal>NDB Cluster</literal> storage engine supports all
character sets and collations available in MySQL
@@ -12691,6 +12810,15 @@
<section id="mysql-cluster-faq">
<title>&title-mysql-cluster-faq;</title>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>FAQ</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>frequently-asked questions about MySQL Cluster</primary>
+ </indexterm>
<remark>
Cluster FAQ, version 1.0 (2005-01-29) Author: Jon Stephens, with
@@ -12710,6 +12838,10 @@
<itemizedlist>
<listitem>
+ <indexterm>
+ <primary><literal>NDB</literal></primary>
+ <seealso>MySQL Cluster</seealso>
+ </indexterm>
<para>
<emphasis>What does <quote>NDB</quote> mean?</emphasis>
</para>
@@ -12722,9 +12854,15 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><foreignphrase>vs</foreignphrase> replication</secondary>
+ </indexterm>
+
<para>
- <emphasis>What's the difference in using Cluster vs. using
- replication?</emphasis>
+ <emphasis>What's the difference in using Cluster
+ <foreignphrase>vs</foreignphrase> using
+ replication?</emphasis>
</para>
<para>
@@ -12749,14 +12887,19 @@
</para>
<para>
- We are planning to implement (asynchronous) replication for
- Cluster in MySQL 5.1. This will include the capability to
- replicate both between two clusters and between a MySQL
- cluster and a non-Cluster MySQL server.
+ 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 this functionality to MySQL 5.0.
</para>
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>networking requirements</secondary>
+ </indexterm>
<para>
<emphasis>Do I need to do any special networking to run
Cluster? (How do computers in a cluster
@@ -12782,6 +12925,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>number of computers required</secondary>
+ </indexterm>
<para>
<emphasis>How many computers do I need to run a cluster, and
why?</emphasis>
@@ -12801,6 +12948,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>roles of computers</secondary>
+ </indexterm>
<para>
<emphasis>What do the different computers do in a
cluster?</emphasis>
@@ -12819,6 +12970,11 @@
are:
</para>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>node types</secondary>
+ </indexterm>
+
<itemizedlist>
<listitem>
@@ -12858,6 +13014,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>platforms supported</secondary>
+ </indexterm>
<remark role="todo">
Reference NDB client apps - ndb_mgmd, ndb_mgm, ndbd, mysqld
</remark>
@@ -12887,6 +13047,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>hardware requirements</secondary>
+ </indexterm>
<para>
<emphasis>What are the hardware requirements for running MySQL
Cluster?</emphasis>
@@ -12910,6 +13074,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>memory requirements</secondary>
+ </indexterm>
<para>
<emphasis>How much RAM do I need? Is it possible to use disk
memory at all?</emphasis>
@@ -13054,6 +13222,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>networking requirements</secondary>
+ </indexterm>
<para>
<emphasis>Because MySQL Cluster uses TCP/IP, does that mean I
can run it over the Internet, with one or more nodes in a
@@ -13083,6 +13255,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>SQL statements</secondary>
+ </indexterm>
<para>
<emphasis>Do I have to learn a new programming or query
language to use Cluster?</emphasis>
@@ -13129,6 +13305,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>error messages</secondary>
+ </indexterm>
<para>
<emphasis>How do I find out what an error or warning message
means when using Cluster?</emphasis>
@@ -13161,6 +13341,14 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>transactions</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>transaction isolation levels supported</secondary>
+ </indexterm>
<para>
<emphasis>Is MySQL Cluster transaction-safe? What isolation
levels are supported?</emphasis>
@@ -13218,6 +13406,10 @@
-->
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>how to obtain</secondary>
+ </indexterm>
<para>
<emphasis>Which versions of the MySQL software support
Cluster? Do I have to compile from source?</emphasis>
@@ -13447,6 +13639,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>importing existing tables</secondary>
+ </indexterm>
<para>
<emphasis>How do I import an existing MySQL database into a
cluster?</emphasis>
@@ -13489,6 +13685,16 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>arbitrator</secondary>
+ </indexterm>
+
+
+ <indexterm>
+ <primary>arbitrator</primary>
+ <see>MySQL Cluster</see>
+ </indexterm>
<para>
<emphasis>What is an <quote>arbitrator</quote>?</emphasis>
</para>
@@ -13544,6 +13750,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>data types supported</secondary>
+ </indexterm>
<para>
<emphasis>What data types are supported by MySQL
Cluster?</emphasis>
@@ -13573,6 +13783,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>starting and stopping</secondary>
+ </indexterm>
<para>
<emphasis>How do I start and stop MySQL Cluster?</emphasis>
</para>
@@ -13741,6 +13955,14 @@
<title>&title-mysql-cluster-glossary;</title>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>terminology</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster Glossary</primary>
+ </indexterm>
+
<remark>
Author: Jon Stephens.
</remark>
@@ -13968,12 +14190,11 @@
<para>
<emphasis role="bold">Note Regarding Terms</emphasis>: In
older versions of the MySQL Cluster documentation, data nodes
- were sometimes referred to as <quote>database nodes</quote> or
- <quote>data nodes</quote>. The term <quote>storage
+ 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> or <quote>API
- nodes</quote>. This older terminology has been deprecated to
- minimize confusion, and for these reasons should be avoided.
+ 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 minimize confusion, and for this reason should be avoided.
</para>
</listitem>
@@ -13988,6 +14209,10 @@
should reside on different hosts. It is possible to control
which nodes belong to which node groups.
</para>
+ <para>
+ For more information, see
+ <xref linkend="mysql-cluster-nodes-groups"/>.
+ </para>
</listitem>
<listitem>
Modified: trunk/refman-5.1/information-schema.xml
===================================================================
--- trunk/refman-5.1/information-schema.xml 2006-05-25 10:01:12 UTC (rev 2198)
+++ trunk/refman-5.1/information-schema.xml 2006-05-25 13:14:23 UTC (rev 2199)
@@ -4067,6 +4067,7 @@
<indexterm type="function">
<primary>FILES</primary>
<secondary>INFORMATION_SCHEMA table</secondary>
+ <seealso>MySQL Cluster Disk Data</seealso>
</indexterm>
<para>
Modified: trunk/refman-5.1/ndbcluster.xml
===================================================================
--- trunk/refman-5.1/ndbcluster.xml 2006-05-25 10:01:12 UTC (rev 2198)
+++ trunk/refman-5.1/ndbcluster.xml 2006-05-25 13:14:23 UTC (rev 2199)
@@ -12766,6 +12766,21 @@
<section id="mysql-cluster-disk-data">
<title>&title-mysql-cluster-disk-data;</title>
+
+ <indexterm>
+ <primary>MySQL Cluster Disk Data</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>Disk Data tables</secondary>
+ <see>MySQL Cluster Disk Data</see>
+ </indexterm>
+
+ <indexterm>
+ <primary>Disk Data tables</primary>
+ <see>MySQL Cluster Disk Data</see>
+ </indexterm>
<remark role="note">
Author: Jon Stephens, based on information supplied by Mikael
@@ -12797,6 +12812,11 @@
newer, the basic steps for creating a Cluster table on disk are as
follows:
</para>
+
+ <indexterm>
+ <primary>MySQL Cluster Disk Data</primary>
+ <secondary>creating tables</secondary>
+ </indexterm>
<orderedlist>
@@ -12831,6 +12851,10 @@
<orderedlist>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster Disk Data</primary>
+ <secondary>creating logfile groups</secondary>
+ </indexterm>
<para>
We create a logfile group named <literal>lg_1</literal> using
<literal>CREATE LOGFILE GROUP</literal>. This logfile group is
@@ -12929,6 +12953,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster Disk Data</primary>
+ <secondary>creating tablespaces</secondary>
+ </indexterm>
<para>
Now we can create a tablespace. A tablespace contains files to
be used by MySQL Cluster Disk Data tables for storing their
@@ -13010,6 +13038,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster Disk Data</primary>
+ <secondary>creating tables</secondary>
+ </indexterm>
<para>
Now it is possible to create a table whose non-indexed columns
are stored on disk in the tablespace <literal>ts_1</literal>:
@@ -13055,6 +13087,11 @@
is something you must keep in mind as you design Disk Data
tables.
</para>
+
+ <indexterm>
+ <primary>MySQL Cluster Disk Data</primary>
+ <secondary>storage requirements</secondary>
+ </indexterm>
<para>
<emphasis role="bold">Important</emphasis>: For Disk Data
@@ -13080,6 +13117,11 @@
these must be created in a particular order. The same is true for
dropping any of these objects:
</para>
+
+ <indexterm>
+ <primary>MySQL Cluster Disk Data</primary>
+ <secondary>dropping Disk Data objects</secondary>
+ </indexterm>
<itemizedlist>
@@ -13151,6 +13193,9 @@
<itemizedlist>
<listitem>
+ <indexterm>
+ <primary><literal>DiskPageBufferMemory</literal></primary>
+ </indexterm>
<para>
<literal>DiskPageBufferMemory</literal>
</para>
@@ -13168,6 +13213,9 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary><literal>SharedGlobalMemory</literal></primary>
+ </indexterm>
<para>
<literal>SharedGlobalMemory</literal>
</para>
@@ -13191,6 +13239,16 @@
<section id="mysql-cluster-interconnects">
<title>&title-mysql-cluster-interconnects;</title>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>network transporters</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>interconnects</secondary>
+ </indexterm>
<para>
Even before design of <literal>NDB Cluster</literal> began in
@@ -13231,6 +13289,21 @@
<section id="sci-sockets">
<title>&title-sci-sockets;</title>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>network transporters</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>SCI (Scalable Coherent Interface)</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>SCI (Scalable Coherent Interface)</primary>
+ <see>MySQL Cluster</see>
+ </indexterm>
<para>
In this section, we show how to adapt a cluster configured for
@@ -13257,6 +13330,11 @@
successfully on additional operating systems although we have
verified these only with Linux 2.4 to date.
</para>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>SCI software requirements</secondary>
+ </indexterm>
<para>
There are essentially four requirements for SCI Sockets:
@@ -13333,6 +13411,11 @@
<para>
<emphasis role="bold">Package Installation</emphasis>
</para>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>SCI software installation</secondary>
+ </indexterm>
<para>
Once you have obtained the library packages, the next step is to
@@ -13384,6 +13467,16 @@
<para>
<emphasis role="bold">Network Configuration</emphasis>
</para>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>network configuration (SCI)</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>SCI network configuration</secondary>
+ </indexterm>
<para>
Now that all the libraries and binaries are in their proper
@@ -13549,6 +13642,11 @@
<para>
<emphasis role="bold">Driver Installation</emphasis>
</para>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>SCI drivers</secondary>
+ </indexterm>
<para>
With the configuration files in place, the drivers can be
@@ -13676,6 +13774,16 @@
<section id="performance-figures">
<title>&title-performance-figures;</title>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>performance</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>benchmarks</secondary>
+ </indexterm>
<para>
The <command>ndbd</command> process has a number of simple
@@ -13836,13 +13944,19 @@
</tbody>
</tgroup>
</informaltable>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>SCI, performance <foreignphrase>vs</foreignphrase> TCP/IP</secondary>
+ </indexterm>
<para>
We also performed another set of tests to check the performance
- of SCI Sockets vis-à-vis that of the SCI transporter, and both
- of these as compared with the TCP/IP transporter. All these
- tests used primary key accesses either serially and
- multi-threaded, or multi-threaded and batched.
+ of SCI Sockets <foreignphrase>vis-à-vis</foreignphrase> that of
+ the SCI transporter, and both of these as compared with the
+ TCP/IP transporter. All these tests used primary key accesses
+ either serially and multi-threaded, or multi-threaded and
+ batched.
</para>
<para>
@@ -13902,6 +14016,15 @@
<section id="mysql-cluster-limitations">
<title>&title-mysql-cluster-limitations;</title>
+
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>limitations of MySQL Cluster</primary>
+ <see>MySQL Cluster limitations</see>
+ </indexterm>
<remark role="note">
Changed section title to remove version-specificity. [js]
@@ -13944,6 +14067,10 @@
<itemizedlist>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>syntax</secondary>
+ </indexterm>
<para>
<emphasis role="bold">Noncompliance in syntax</emphasis>
(resulting in errors when running existing applications):
@@ -14052,6 +14179,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>causing errors</secondary>
+ </indexterm>
<para>
<emphasis role="bold">Non-compliance in limits or
behavior</emphasis> (may result in errors when running
@@ -14105,6 +14236,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>transactions</secondary>
+ </indexterm>
<para>
<emphasis role="bold">Transaction Handling</emphasis>:
</para>
@@ -14254,6 +14389,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>imposed by configuration</secondary>
+ </indexterm>
<para>
A number of hard limits exist which are configurable, but
available main memory in the cluster sets limits. See the
@@ -14300,6 +14439,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>database objects</secondary>
+ </indexterm>
<para>
Database names, table names and attribute names cannot be
as long in <literal>NDB</literal> tables as with other
@@ -14346,6 +14489,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>unsupported features</secondary>
+ </indexterm>
<para>
<emphasis role="bold">Unsupported features</emphasis> (do not
cause errors, but are not supported or enforced):
@@ -14384,6 +14531,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>performance</secondary>
+ </indexterm>
<para>
<emphasis role="bold">Performance and limitation-related
issues</emphasis>:
@@ -14521,6 +14672,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>unsupported features</secondary>
+ </indexterm>
<para>
<emphasis role="bold">Missing features</emphasis>:
</para>
@@ -14531,7 +14686,7 @@
<para>
The only supported isolation level is <literal>READ
COMMITTED</literal>. (InnoDB supports <literal>READ
- COMMITTED</literal>, <literal>READ COMMITTED</literal>,
+ COMMITTED</literal>, <literal>READ UNCOMMITTED</literal>,
<literal>REPEATABLE READ</literal>, and
<literal>SERIALIZABLE</literal>.) See
<xref linkend="mysql-cluster-backup-troubleshooting"/>,
@@ -14552,6 +14707,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>multiple MySQL servers</secondary>
+ </indexterm>
<para>
<emphasis role="bold">Problems relating to multiple MySQL
servers</emphasis> (not relating to <literal>MyISAM</literal>
@@ -14583,6 +14742,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>implementation</secondary>
+ </indexterm>
<para>
<emphasis role="bold">Issues exclusive to MySQL
Cluster</emphasis> (not related to <literal>MyISAM</literal>
@@ -14629,6 +14792,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>multiple management servers</secondary>
+ </indexterm>
<para>
When using multiple management servers:
</para>
@@ -14700,6 +14867,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>resolved in current version from previous versions</secondary>
+ </indexterm>
<para>
<emphasis role="bold">MySQL Cluster issues from previous
versions that have been resolved in MySQL 5.1</emphasis>:
@@ -14743,6 +14914,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>replication</secondary>
+ </indexterm>
<para>
It is now possible to use MySQL replication with Cluster
databases. For details, see
@@ -14757,6 +14932,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster limitations</primary>
+ <secondary>autodiscovery</secondary>
+ </indexterm>
<para>
Autodiscovery of databases is now supported for multiple
MySQL servers accessing the same MySQL Cluster, provided
@@ -14765,6 +14944,11 @@
database is created on a different
<command>mysqld</command>.
</para>
+
+ <remark role="todo">
+ [js] Update references to autodiscovery to reflect this
+ change!
+ </remark>
<para>
What this means is that if a <command>mysqld</command>
@@ -14860,7 +15044,7 @@
</para>
<para>
- There are a number of significant changes in the implementaiton of
+ There are a number of significant changes in the implementation of
the <literal>NDB Cluster</literal> storage engine in MySQL 5.1 as
compared to that in MySQL 5.0. For an overview of these changes,
see <xref linkend="mysql-5-1-cluster-changes"/>
@@ -14869,6 +15053,11 @@
<section id="mysql-5-1-cluster-changes">
<title>&title-mysql-5-1-cluster-changes;</title>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>features new in MySQL 5.1</secondary>
+ </indexterm>
<para>
Four major new features for MySQL Cluster have been developed
@@ -14970,6 +15159,15 @@
<section id="mysql-cluster-faq">
<title>&title-mysql-cluster-faq;</title>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>FAQ</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>frequently-asked questions about MySQL Cluster</primary>
+ </indexterm>
<remark>
Cluster FAQ, version 1.0 (2005-01-29) Author: Jon Stephens, with
@@ -14989,6 +15187,10 @@
<itemizedlist>
<listitem>
+ <indexterm>
+ <primary><literal>NDB</literal></primary>
+ <seealso>MySQL Cluster</seealso>
+ </indexterm>
<para>
<emphasis>What does <quote>NDB</quote> mean?</emphasis>
</para>
@@ -15001,9 +15203,14 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><foreignphrase>vs</foreignphrase> replication</secondary>
+ </indexterm>
<para>
- <emphasis>What's the difference in using Cluster vs. using
- replication?</emphasis>
+ <emphasis>What's the difference in using Cluster
+ <foreignphrase>vs</foreignphrase> using
+ replication?</emphasis>
</para>
<para>
@@ -15028,14 +15235,22 @@
</para>
<para>
- We are planning to implement (asynchronous) replication for
- Cluster in MySQL 5.1. This will include the capability to
- replicate both between two clusters and between a MySQL
- cluster and a non-Cluster MySQL server.
+ 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.
</para>
+
+ <para>
+ See <xref linkend="mysql-cluster-replication"/>.
+ </para>
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>networking requirements</secondary>
+ </indexterm>
<para>
<emphasis>Do I need to do any special networking to run
Cluster? (How do computers in a cluster
@@ -15061,6 +15276,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>number of computers required</secondary>
+ </indexterm>
<para>
<emphasis>How many computers do I need to run a cluster, and
why?</emphasis>
@@ -15080,6 +15299,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>roles of computers</secondary>
+ </indexterm>
<para>
<emphasis>What do the different computers do in a
cluster?</emphasis>
@@ -15097,6 +15320,10 @@
corresponding to a specific role within the cluster. These
are:
</para>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>node types</secondary>
+ </indexterm>
<itemizedlist>
@@ -15137,6 +15364,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>platforms supported</secondary>
+ </indexterm>
<remark role="todo">
Reference NDB client apps - ndb_mgmd, ndb_mgm, ndbd, mysqld
</remark>
@@ -15166,6 +15397,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>hardware requirements</secondary>
+ </indexterm>
<para>
<emphasis>What are the hardware requirements for running MySQL
Cluster?</emphasis>
@@ -15189,16 +15424,15 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>memory requirements</secondary>
+ </indexterm>
<para>
<emphasis>How much RAM do I need? Is it possible to use disk
memory at all?</emphasis>
</para>
- <remark role="todo">
- [js] Reword the following para when the Disk Data section is
- ready.
- </remark>
-
<para>
Previous to MySQL 5.1, Cluster was in-memory only. This meant
that all table data (including indexes) was stored in RAM. If
@@ -15339,6 +15573,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>networking requirements</secondary>
+ </indexterm>
<para>
<emphasis>Because MySQL Cluster uses TCP/IP, does that mean I
can run it over the Internet, with one or more nodes in a
@@ -15368,6 +15606,11 @@
</listitem>
<listitem>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>SQL statements</secondary>
+ </indexterm>
<para>
<emphasis>Do I have to learn a new programming or query
language to use Cluster?</emphasis>
@@ -15387,7 +15630,8 @@
<listitem>
<para>
- Creating, altering, and dropping tables
+ Creating, altering, and dropping tables (including Disk
+ Data tables and related objects)
</para>
</listitem>
@@ -15414,6 +15658,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>error messages</secondary>
+ </indexterm>
<para>
<emphasis>How do I find out what an error or warning message
means when using Cluster?</emphasis>
@@ -15446,6 +15694,14 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>transactions</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>transaction isolation levels supported</secondary>
+ </indexterm>
<para>
<emphasis>Is MySQL Cluster transaction-safe? What isolation
levels are supported?</emphasis>
@@ -15503,6 +15759,10 @@
-->
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>how to obtain</secondary>
+ </indexterm>
<para>
<emphasis>Which versions of the MySQL software support
Cluster? Do I have to compile from source?</emphasis>
@@ -15722,6 +15982,11 @@
</listitem>
<listitem>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>importing existing tables</secondary>
+ </indexterm>
<para>
<emphasis>How do I import an existing MySQL database into a
cluster?</emphasis>
@@ -15764,6 +16029,16 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>arbitrator</secondary>
+ </indexterm>
+
+
+ <indexterm>
+ <primary>arbitrator</primary>
+ <see>MySQL Cluster</see>
+ </indexterm>
<para>
<emphasis>What is an <quote>arbitrator</quote>?</emphasis>
</para>
@@ -15819,6 +16094,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>data types supported</secondary>
+ </indexterm>
<para>
<emphasis>What data types are supported by MySQL
Cluster?</emphasis>
@@ -15847,6 +16126,10 @@
</listitem>
<listitem>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>starting and stopping</secondary>
+ </indexterm>
<para>
<emphasis>How do I start and stop MySQL Cluster?</emphasis>
</para>
@@ -16014,6 +16297,13 @@
<section id="mysql-cluster-glossary">
<title>&title-mysql-cluster-glossary;</title>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>terminology</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster Glossary</primary>
+ </indexterm>
<remark>
Author: Jon Stephens.
@@ -16242,12 +16532,12 @@
<para>
<emphasis role="bold">Note Regarding Terms</emphasis>: In
older versions of the MySQL Cluster documentation, data nodes
- were sometimes referred to as <quote>database nodes</quote> or
- <quote>data nodes</quote>. The term <quote>storage
- nodes</quote> has also been used. In addition, SQL nodes were
- sometimes known as <quote>client nodes</quote> or <quote>API
- nodes</quote>. This older terminology has been deprecated to
- minimize confusion, and for these reasons should be avoided.
+ 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 minimize confusion, and for this reason should be avoided.
</para>
</listitem>
@@ -16262,6 +16552,11 @@
should reside on different hosts. It is possible to control
which nodes belong to which node groups.
</para>
+
+ <para>
+ For more information, see
+ <xref linkend="mysql-cluster-nodes-groups"/>.
+ </para>
</listitem>
<listitem>
Modified: trunk/refman-5.1/sql-syntax.xml
===================================================================
--- trunk/refman-5.1/sql-syntax.xml 2006-05-25 10:01:12 UTC (rev 2198)
+++ trunk/refman-5.1/sql-syntax.xml 2006-05-25 13:14:23 UTC (rev 2199)
@@ -1239,6 +1239,11 @@
<section id="alter-logfile-group">
<title>&title-alter-logfile-group;</title>
+
+ <indexterm>
+ <primary><literal>ALTER LOGFILE GROUP</literal> statement</primary>
+ <seealso>MySQL Cluster Disk Data</seealso>
+ </indexterm>
<programlisting>
ALTER LOGFILE GROUP <replaceable>logfile_group</replaceable>
@@ -1328,6 +1333,11 @@
<section id="alter-tablespace">
<title>&title-alter-tablespace;</title>
+
+ <indexterm>
+ <primary><literal>ALTER TABLESPACE</literal> statement</primary>
+ <seealso>MySQL Cluster Disk Data</seealso>
+ </indexterm>
<programlisting>
ALTER TABLESPACE <replaceable>tablespace</replaceable>
@@ -3808,6 +3818,11 @@
<section id="create-logfile-group">
<title>&title-create-logfile-group;</title>
+
+ <indexterm>
+ <primary><literal>CREATE LOGFILE GROUP</literal> statement</primary>
+ <seealso>MySQL Cluster Disk Data</seealso>
+ </indexterm>
<programlisting>
CREATE LOGFILE GROUP <replaceable>logfile_group</replaceable>
@@ -3895,6 +3910,11 @@
<section id="create-tablespace">
<title>&title-create-tablespace;</title>
+
+ <indexterm>
+ <primary><literal>CREATE TABLESPACE</literal> statement</primary>
+ <seealso>MySQL Cluster Disk Data</seealso>
+ </indexterm>
<programlisting>
CREATE TABLESPACE <replaceable>tablespace</replaceable>
@@ -4301,6 +4321,11 @@
<section id="drop-logfile-group">
<title>&title-drop-logfile-group;</title>
+
+ <indexterm>
+ <primary><literal>DROP LOGFILE GROUP</literal> statement</primary>
+ <seealso>MySQL Cluster Disk Data</seealso>
+ </indexterm>
<programlisting>
DROP LOGFILE GROUP <replaceable>logfile_group</replaceable>
@@ -4340,6 +4365,11 @@
<section id="drop-tablespace">
<title>&title-drop-tablespace;</title>
+
+ <indexterm>
+ <primary><literal>DROP TABLESPACE</literal> statement</primary>
+ <seealso>MySQL Cluster Disk Data</seealso>
+ </indexterm>
<programlisting>
DROP TABLESPACE <replaceable>tablespace</replaceable>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r2199 - in trunk: refman-4.1 refman-5.0 refman-5.1 | jon | 25 May |