Author: jstephens
Date: 2006-05-24 16:46:48 +0200 (Wed, 24 May 2006)
New Revision: 2189
Log:
Reformat.
Modified:
trunk/ndbapi/ndb-classes.xml
trunk/refman-4.1/ndbcluster.xml
trunk/refman-5.0/ndbcluster.xml
trunk/refman-5.1/ndbcluster.xml
Modified: trunk/ndbapi/ndb-classes.xml
===================================================================
--- trunk/ndbapi/ndb-classes.xml 2006-05-24 14:44:04 UTC (rev 2188)
+++ trunk/ndbapi/ndb-classes.xml 2006-05-24 14:46:48 UTC (rev 2189)
@@ -175,21 +175,19 @@
</tbody>
</tgroup>
</informaltable>
-
+
<para>
This UML diagram provides the signatures of all the available
methods of the <literal>Ndb</literal> class:
</para>
-
+
<mediaobject>
<imageobject>
<imagedata fileref="images/Ndb-class.png" format="PNG"/>
</imageobject>
<textobject>
- <phrase lang="en">
- UML Diagram showing methods and signatures of the
- <literal>Ndb</literal> class.
- </phrase>
+ <phrase lang="en"> UML Diagram showing methods and signatures of
+ the <literal>Ndb</literal> class. </phrase>
</textobject>
</mediaobject>
@@ -236,22 +234,24 @@
</formalpara>
<formalpara>
+
<title>Parameters</title>
-
+
<para>
The <literal>Ndb</literal> class constructor can take up to 3
parameters, of which only the first is required:
-
+
<itemizedlist>
+
<listitem>
<para>
<replaceable>ndb_cluster_connection</replaceable> is an
instance of <literal>Ndb_cluster_connection</literal>,
- which represents a cluster connectstring. (See
+ which represents a cluster connectstring. (See
<xref linkend="class-ndb-cluster-connection"/>.)
</para>
</listitem>
-
+
<listitem>
<para>
<replaceable>catalogName</replaceable> is an optional
@@ -259,37 +259,40 @@
indexes created in any connection from the
<literal>Ndb</literal> object.
</para>
-
+
<para>
The default value for this parameter is an empty string.
</para>
</listitem>
-
+
<listitem>
<para>
The optional <replaceable>schemaName</replaceable>
provides an additional namespace for the tables and
- indexes created in a given catalog.
+ indexes created in a given catalog.
</para>
-
+
<para>
The default value for this parameter is the string
<quote>def</quote>.
</para>
</listitem>
+
</itemizedlist>
</para>
+
</formalpara>
-
+
<formalpara>
+
<title>Returns</title>
-
+
<para>
An <literal>Ndb</literal> object.
</para>
+
</formalpara>
-
-
+
<formalpara>
<title>Example</title>
@@ -330,11 +333,11 @@
<para>
This method is used to initialise an <literal>Ndb</literal>
- object.
+ object.
</para>
</formalpara>
-
+
<formalpara>
<title>Signature</title>
@@ -349,10 +352,11 @@
</para>
</formalpara>
-
+
<formalpara>
+
<title>Parameters</title>
-
+
<para>
The <literal>init()</literal> method takes a single parameter
<replaceable>maxNoOfTransactions</replaceable> of type
@@ -361,26 +365,29 @@
handled by this instance of <literal>Ndb</literal>. The
maximum permitted value for
<replaceable>maxNoOfTransactions</replaceable> is 1024; if not
- specified, it defaults to 4.
+ specified, it defaults to 4.
</para>
+
</formalpara>
-
+
<note>
<para>
Each scan or index operation uses an extra
- <literal>NdbTransaction</literal> object. See
+ <literal>NdbTransaction</literal> object. See
<xref linkend="class-ndbtransaction"/>.
</para>
</note>
-
+
<formalpara>
+
<title>Returns</title>
-
+
<para>
This method returns an <literal>int</literal>, which can be
either of two values:
-
+
<itemizedlist>
+
<listitem>
<para>
<emphasis role="bold">0</emphasis>: indicates that the
@@ -388,15 +395,16 @@
successfuly.
</para>
</listitem>
-
+
<listitem>
<para>
<emphasis role="bold">-1</emphasis>: indicates failure.
</para>
</listitem>
+
</itemizedlist>
-
</para>
+
</formalpara>
<formalpara>
@@ -445,21 +453,25 @@
</para>
</formalpara>
-
+
<formalpara>
+
<title>Parameters</title>
-
+
<para>
None.
</para>
+
</formalpara>
-
+
<formalpara>
+
<title>Returns</title>
-
+
<para>
The name of the current database.
</para>
+
</formalpara>
<formalpara>
@@ -508,23 +520,27 @@
</para>
</formalpara>
-
+
<formalpara>
+
<title>Parameters</title>
-
+
<para>
<literal>setDatabaseName()</literal> takes a single, required
parameter, the name of the new database to be set as the
current database.
</para>
+
</formalpara>
-
+
<formalpara>
+
<title>Returns</title>
-
+
<para>
N/A.
</para>
+
</formalpara>
<formalpara>
@@ -574,21 +590,25 @@
</para>
</formalpara>
-
+
<formalpara>
+
<title>Parameters</title>
-
+
<para>
None.
</para>
+
</formalpara>
-
+
<formalpara>
+
<title>Returns</title>
-
+
<para>
The name of the current database schema.
</para>
+
</formalpara>
<formalpara>
@@ -638,21 +658,25 @@
</para>
</formalpara>
-
+
<formalpara>
+
<title>Parameters</title>
-
+
<para>
The name of the database schema.
</para>
+
</formalpara>
-
+
<formalpara>
+
<title>Returns</title>
-
+
<para>
N/A.
</para>
+
</formalpara>
<formalpara>
@@ -686,7 +710,7 @@
</para>
</formalpara>
-
+
<important>
<para>
When the transaction is completed it must be closed using
@@ -695,13 +719,14 @@
regardless of the transaction's final outcome, even if fials
due to an an error.
</para>
-
+
<para>
- See <xref linkend="class-ndb-closetransaction"/>, and
+ See <xref linkend="class-ndb-closetransaction"/>, and
<xref linkend="class-ndbtransaction"/>.
+
<remark role="todo">
[js] Update the previous link to point directly to the
- method once the section for it has been created.
+ method once the section for it has been created.
</remark>
</para>
</important>
@@ -722,24 +747,26 @@
</para>
</formalpara>
-
+
<formalpara>
+
<title>Parameters</title>
-
+
<para>
This method takes three parameters, as follows:
-
+
<itemizedlist>
+
<listitem>
<para>
<replaceable>table</replaceable>: A pointer to a
- <literal>Table</literal> object. (See
+ <literal>Table</literal> object. (See
<xref linkend="class-table"/>.) This is used to
determine on which node the Transaction Co-Ordinator
should run.
</para>
</listitem>
-
+
<listitem>
<para>
<replaceable>keyData</replaceable>: A pointer to a
@@ -747,25 +774,28 @@
<replaceable>table</replaceable>.
</para>
</listitem>
-
+
<listitem>
<para>
<replaceable>keyLen</replaceable>: The length of the
partition key, expressed in bytes.
</para>
</listitem>
+
</itemizedlist>
-
</para>
+
</formalpara>
-
+
<formalpara>
+
<title>Returns</title>
-
+
<para>
- An <literal>NdbTransaction</literal> object. See
+ An <literal>NdbTransaction</literal> object. See
<xref linkend="class-ndbtransaction"/>.
</para>
+
</formalpara>
<formalpara>
@@ -797,13 +827,14 @@
<para>
This is one of two NDB API methods provided for closing a
transaction (the other being
- <literal>NdbTransaction::close()</literal> — see
+ <literal>NdbTransaction::close()</literal> — see
<xref linkend="class-ndbtransaction"/>). You must call one of
these two methods to close the transaction once it has been
- completed, whether or not the transaction succeeded.
+ completed, whether or not the transaction succeeded.
+
<remark role="todo">
[js] Update the previous link to point directly to the
- method once the section for it has been created.
+ method once the section for it has been created.
</remark>
</para>
@@ -823,22 +854,26 @@
</para>
</formalpara>
-
+
<formalpara>
+
<title>Parameters</title>
-
+
<para>
This method takes a single argument, a pointer to the
<literal>NdbTransaction</literal> to be closed.
</para>
+
</formalpara>
-
+
<formalpara>
+
<title>Returns</title>
-
+
<para>
N/A.
</para>
+
</formalpara>
<formalpara>
@@ -887,25 +922,29 @@
</para>
</formalpara>
-
+
<formalpara>
+
<title>Parameters</title>
-
+
<para>
This method takes a single argument, the unique
<replaceable>eventName</replaceable> identifying the event to
which you wish to subscribe.
</para>
+
</formalpara>
-
+
<formalpara>
+
<title>Returns</title>
-
+
<para>
A pointer to an <literal>NdbEventOperation</literal> object
(or <literal>NULL</literal>, in the event of failure). See
<xref linkend="class-ndbeventoperation"/>.
</para>
+
</formalpara>
<formalpara>
@@ -955,23 +994,27 @@
</para>
</formalpara>
-
+
<formalpara>
+
<title>Parameters</title>
-
+
<para>
This method requires a single input parameter, a pointer to an
instance of <literal>NdbEventOperation</literal>.
</para>
+
</formalpara>
-
+
<formalpara>
+
<title>Returns</title>
-
+
<para>
<emphasis role="bold">0</emphasis> on success; any other
result indicates failure.
</para>
+
</formalpara>
<formalpara>
@@ -1002,10 +1045,10 @@
<para>
This method waits for an event to occur, and returns as soon
- as an event is detected in any existing subscription
- belonging to the <literal>Ndb</literal> object for which the
- method is invoked. It is used to determine whether any events
- are available in the subscription queue.
+ as an event is detected in any existing subscription belonging
+ to the <literal>Ndb</literal> object for which the method is
+ invoked. It is used to determine whether any events are
+ available in the subscription queue.
</para>
</formalpara>
@@ -1025,68 +1068,74 @@
</para>
</formalpara>
-
+
<formalpara>
+
<title>Parameters</title>
-
+
<para>
This method takes two parameters, as shown here:
-
+
<itemizedlist>
+
<listitem>
<para>
The maxmimum time to wait, in milliseconds, before
<quote>giving up</quote> and reporting that no events
were available (that is, before the methyod
- automatically returns
+ automatically returns
<emphasis role="bold">0</emphasis>).
</para>
</listitem>
-
+
<listitem>
<para>
The index of the most recent global checkpoint.
Normally, this may safely be permitted to assume its
- default value, which is
+ default value, which is
<emphasis role="bold">0</emphasis>.
</para>
</listitem>
+
</itemizedlist>
-
</para>
+
</formalpara>
-
+
<formalpara>
+
<title>Returns</title>
-
+
<para>
<literal>pollEvents()</literal> returns a value of type
<literal>int</literal>, which may be interpreted as follows:
-
+
<itemizedlist>
+
<listitem>
<para>
<emphasis role="bold">> 0</emphasis>: There are
events avaialable in the queue.
</para>
</listitem>
-
+
<listitem>
<para>
<emphasis role="bold">0</emphasis>: There are no events
available.
</para>
</listitem>
-
+
<listitem>
<para>
<emphasis role="bold">< 0</emphasis>: Indicates
failure (possible error).
</para>
- </listitem>
+ </listitem>
+
</itemizedlist>
-
</para>
+
</formalpara>
<formalpara>
@@ -1136,25 +1185,29 @@
</para>
</formalpara>
-
+
<formalpara>
+
<title>Parameters</title>
-
+
<para>
None.
</para>
+
</formalpara>
-
+
<formalpara>
+
<title>Returns</title>
-
+
<para>
This method returns an <literal>NdbEventOperation</literal>
object representing the next event in a subscription queue, if
there is such an event. If there is no event in the queue, it
- returns <literal>NULL</literal> instead. (See
+ returns <literal>NULL</literal> instead. (See
<xref linkend="class-ndbeventoperation"/>.)
</para>
+
</formalpara>
<formalpara>
@@ -1199,30 +1252,35 @@
The <literal>getNdbError()</literal> method actually has two
variants. The first of these sinply gets the most recent error
to have occured:
+
<programlisting>
const NdbError &getNdbError
(
void
)
</programlisting>
+
The second variant returns the error corresponding to a given
error code:
+
<programlisting>
const NdbError &getNdbError
(
int <replaceable>errorCode</replaceable>
)
</programlisting>
+
Regardless of which version of the method is used, the
<literal>NdbError</literal> object returned persists until the
next NDB API method is invoked.
</para>
</formalpara>
-
+
<formalpara>
+
<title>Parameters</title>
-
+
<para>
To obtain the most recent error, simply call
<literal>getNdbError()</literal> without any parameters. To
@@ -1230,20 +1288,23 @@
<replaceable>errorCode</replaceable>, invoke the method
passing the code (an <literal>int</literal>) to it as a
parameter. For a listing of NDB API error codes and
- corresponding error messages, see
+ corresponding error messages, see
<xref linkend="ndb-error-messages"/>.
</para>
+
</formalpara>
-
+
<formalpara>
+
<title>Returns</title>
-
+
<para>
An <literal>NdbError</literal> object containing information
about the error, including its type and, where applicable,
- contextual information as to how the error arose. See
+ contextual information as to how the error arose. See
<xref linkend="struct-ndberror"/>, for details.
</para>
+
</formalpara>
<formalpara>
@@ -1257,9 +1318,11 @@
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
+
The next example shows how to retrieve an
<literal>NdbError</literal> object using
- <literal>getNdbError()</literal>, given a numeric error code:
+ <literal>getNdbError()</literal>, given a numeric error code:
+
<programlisting>
[<emphasis>To be written...</emphasis>]
</programlisting>
Modified: trunk/refman-4.1/ndbcluster.xml
===================================================================
--- trunk/refman-4.1/ndbcluster.xml 2006-05-24 14:44:04 UTC (rev 2188)
+++ trunk/refman-4.1/ndbcluster.xml 2006-05-24 14:46:48 UTC (rev 2189)
@@ -1009,14 +1009,13 @@
</indexterm>
<para>
- Each MySQL Cluster host computer running data or SQL nodes
- must have installed on it a MySQL-max binary. For management
- nodes, it is not necessary to install the MySQL server binary,
- but you do have to install the MGM server daemon and client
- binaries (<command>ndb_mgmd</command> and
- <command>ndb_mgm</command>, respectively). This section covers
- the steps necessary to install the correct binaries for each
- type of Cluster node.
+ Each MySQL Cluster host computer running data or SQL nodes must
+ have installed on it a MySQL-max binary. For management nodes,
+ it is not necessary to install the MySQL server binary, but you
+ do have to install the MGM server daemon and client binaries
+ (<command>ndb_mgmd</command> and <command>ndb_mgm</command>,
+ respectively). This section covers the steps necessary to
+ install the correct binaries for each type of Cluster node.
</para>
<para>
@@ -2858,7 +2857,8 @@
</listitem>
</orderedlist>
- <para>
+
+ <para>
However, these are now deprecated and should not be used
for new installations.
</para>
@@ -5991,13 +5991,13 @@
<primary>MySQL Cluster</primary>
<secondary>networking</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>transporters</secondary>
<tertiary>TCP/IP</tertiary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>direct connections between nodes</secondary>
@@ -6071,17 +6071,17 @@
<primary>MySQL Cluster</primary>
<secondary>networking</secondary>
</indexterm>
-
+
<indexterm>
<primary>shared memory transporter</primary>
<see>MySQL Cluster</see>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>shared memory transport</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>transporters</secondary>
@@ -6120,11 +6120,12 @@
<indexterm>
<primary>node identifiers (MySQL Cluster)</primary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>node identifiers</secondary>
</indexterm>
+
<para>
<literal>NodeId1</literal>, <literal>NodeId2</literal>
</para>
@@ -6140,6 +6141,7 @@
<indexterm>
<primary><literal>ShmKey</literal></primary>
</indexterm>
+
<para>
<literal>ShmKey</literal>
</para>
@@ -6156,6 +6158,7 @@
<indexterm>
<primary><literal>ShmSize</literal></primary>
</indexterm>
+
<para>
<literal>ShmSize</literal>
</para>
@@ -6172,6 +6175,7 @@
<indexterm>
<primary><literal>SendSignalId</literal></primary>
</indexterm>
+
<para>
<literal>SendSignalId</literal>
</para>
@@ -6189,6 +6193,7 @@
<indexterm>
<primary><literal>Checksum</literal> (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal>Checksum</literal>
</para>
@@ -6220,24 +6225,23 @@
<primary>MySQL Cluster</primary>
<secondary>networking</secondary>
</indexterm>
-
+
<indexterm>
<primary>SCI (Scalable Coherent Interface)</primary>
<see>MySQL Cluster</see>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>SCI (Scalable Coherent Interface)</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>transporters</secondary>
<tertiary>Scalable Coherent Interface (SCI)</tertiary>
</indexterm>
-
<para>
<literal>[SCI]</literal> sections in the
<filename>config.ini</filename> file explicitly define SCI
@@ -6275,11 +6279,12 @@
<indexterm>
<primary>node identifiers (MySQL Cluster)</primary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>node identifiers</secondary>
</indexterm>
+
<para>
<literal>NodeId1</literal>, <literal>NodeId2</literal>
</para>
@@ -6295,6 +6300,7 @@
<indexterm>
<primary><literal>Host*SciId*</literal> parameters</primary>
</indexterm>
+
<para>
<literal>Host1SciId0</literal>
</para>
@@ -6345,6 +6351,7 @@
<indexterm>
<primary><literal>SharedBufferSize</literal></primary>
</indexterm>
+
<para>
<literal>SharedBufferSize</literal>
</para>
@@ -6364,6 +6371,7 @@
<indexterm>
<primary><literal>SendLimit</literal></primary>
</indexterm>
+
<para>
<literal>SendLimit</literal>
</para>
@@ -6382,6 +6390,7 @@
<indexterm>
<primary><literal>SendSignalId</literal></primary>
</indexterm>
+
<para>
<literal>SendSignalId</literal>
</para>
@@ -6398,6 +6407,7 @@
<indexterm>
<primary><literal>Checksum</literal> (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal>Checksum</literal>
</para>
@@ -6437,12 +6447,12 @@
<primary>MySQL Cluster</primary>
<secondary>upgrades and downgrades</secondary>
</indexterm>
-
+
<indexterm>
<primary>upgrades</primary>
<secondary>MySQL Cluster</secondary>
</indexterm>
-
+
<indexterm>
<primary>downgrades</primary>
<secondary>MySQL Cluster</secondary>
@@ -6478,22 +6488,21 @@
<primary>MySQL Cluster</primary>
<secondary>upgrades and downgrades</secondary>
</indexterm>
-
+
<indexterm>
<primary>rolling upgrades and downgrades (MySQL Cluster)</primary>
</indexterm>
-
- <indexterm>
- <primary>upgrades</primary>
- <secondary>MySQL Cluster</secondary>
- </indexterm>
-
- <indexterm>
- <primary>downgrades</primary>
- <secondary>MySQL Cluster</secondary>
- </indexterm>
+ <indexterm>
+ <primary>upgrades</primary>
+ <secondary>MySQL Cluster</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>downgrades</primary>
+ <secondary>MySQL Cluster</secondary>
+ </indexterm>
+
<para>
This section discusses how to perform a <firstterm>rolling
upgrade</firstterm> of a MySQL Cluster installation, so called
@@ -6525,6 +6534,7 @@
<primary>MySQL Cluster</primary>
<secondary>configuration changes</secondary>
</indexterm>
+
<para>
<emphasis role="bold">Cluster Configuration
Change</emphasis>: To make a change in the cluster's
@@ -6555,6 +6565,7 @@
<primary>MySQL Cluster</primary>
<secondary>resetting</secondary>
</indexterm>
+
<para>
<emphasis role="bold">Cluster Reset</emphasis>: To reset the
cluster because it has reached an undesirable state
@@ -6810,22 +6821,22 @@
<primary>MySQL Cluster</primary>
<secondary>upgrades and downgrades</secondary>
</indexterm>
-
+
<indexterm>
<primary>upgrades and downgrades (MySQL Cluster)</primary>
<secondary>compatibility between versions</secondary>
</indexterm>
-
- <indexterm>
- <primary>upgrades</primary>
- <secondary>MySQL Cluster</secondary>
- </indexterm>
-
- <indexterm>
- <primary>downgrades</primary>
- <secondary>MySQL Cluster</secondary>
- </indexterm>
+ <indexterm>
+ <primary>upgrades</primary>
+ <secondary>MySQL Cluster</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>downgrades</primary>
+ <secondary>MySQL Cluster</secondary>
+ </indexterm>
+
<para>
This section provides information regarding Cluster software and
table file compatibility between differing versions of the MySQL
@@ -7173,15 +7184,15 @@
<primary>MySQL Cluster</primary>
<secondary>process management</secondary>
</indexterm>
-
+
<indexterm>
<primary>process management (MySQL Cluster)</primary>
</indexterm>
-
+
<indexterm>
<primary>managing MySQL Cluster processes</primary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster processes (types)</primary>
</indexterm>
@@ -7230,21 +7241,21 @@
<primary>MySQL Cluster</primary>
<secondary><command>mysqld</command> process</secondary>
</indexterm>
-
+
<indexterm>
<primary><command>mysqld</command></primary>
<secondary>as MySQL Cluster process</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>SQL nodes</secondary>
</indexterm>
-
+
<indexterm>
<primary>SQL nodes (MySQL Cluster)</primary>
</indexterm>
-
+
<indexterm>
<primary>API nodes</primary>
<see>SQL nodes</see>
@@ -7307,11 +7318,11 @@
<primary>MySQL Cluster</primary>
<secondary>configuration</secondary>
</indexterm>
-
+
<indexterm>
<primary>configuring MySQL Cluster</primary>
</indexterm>
-
+
<indexterm>
<primary><filename>my.cnf</filename></primary>
<secondary>in MySQL Cluster</secondary>
@@ -7397,23 +7408,25 @@
<primary>MySQL Cluster</primary>
<secondary><command>ndbd</command> process</secondary>
</indexterm>
-
+
<indexterm>
<primary><command>ndbd</command> (MySQL Cluster process)</primary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>data nodes</secondary>
</indexterm>
-
+
<indexterm>
<primary>data nodes (MySQL Cluster)</primary>
</indexterm>
-
+
<indexterm>
<primary>storage nodes</primary>
- <see>data nodes, <command>ndbd</command></see>
+ <see>data nodes, <command>ndbd</command>
+
+ </see>
</indexterm>
<para>
@@ -7440,7 +7453,7 @@
<primary>MySQL Cluster</primary>
<secondary>log files</secondary>
</indexterm>
-
+
<indexterm>
<primary>log files (MySQL Cluster)</primary>
</indexterm>
@@ -7469,13 +7482,14 @@
<listitem>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>error logs</secondary>
- </indexterm>
-
- <indexterm>
- <primary>error logs (MySQL Cluster)</primary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>error logs</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>error logs (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
<filename>ndb_<replaceable>node_id</replaceable>_error.log</filename>
(was <filename>error.log</filename> in version 4.1.3) is a
@@ -7515,13 +7529,14 @@
<listitem>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>trace files</secondary>
- </indexterm>
-
- <indexterm>
- <primary>trace files (MySQL Cluster)</primary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>trace files</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>trace files (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
<filename>ndb_<replaceable>node_id</replaceable>_trace.log.<replaceable>trace_id</replaceable></filename>
(was
@@ -7654,27 +7669,30 @@
<primary>MySQL Cluster</primary>
<secondary><command>mgmd</command> process</secondary>
</indexterm>
-
+
<indexterm>
<primary><command>mgmd</command> (MySQL Cluster process)</primary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>management nodes</secondary>
</indexterm>
-
+
<indexterm>
<primary>management nodes (MySQL Cluster)</primary>
- <seealso><command>mgmd</command></seealso>
+ <seealso><command>mgmd</command>
+
+ </seealso>
</indexterm>
-
+
<indexterm>
<primary><command>ndb_mgmd</command></primary>
- <see><command>mgmd</command></see>
+ <see><command>mgmd</command>
+
+ </see>
</indexterm>
-
<para>
The management server is the process that reads the cluster
configuration file and distributes this information to all nodes
@@ -7712,17 +7730,18 @@
<listitem>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>configuration</secondary>
- </indexterm>
-
- <indexterm>
- <primary>configuring MySQL Cluster</primary>
- </indexterm>
-
+ <primary>MySQL Cluster</primary>
+ <secondary>configuration</secondary>
+ </indexterm>
+
<indexterm>
+ <primary>configuring MySQL Cluster</primary>
+ </indexterm>
+
+ <indexterm>
<primary><filename>config.ini</filename> (MySQL Cluster)</primary>
</indexterm>
+
<para>
<filename>config.ini</filename> is the configuration file
for the cluster as a whole. This file is created by the user
@@ -7788,31 +7807,35 @@
<primary>MySQL Cluster</primary>
<secondary><command>mgm</command> process</secondary>
</indexterm>
-
+
<indexterm>
<primary><command>mgm</command> (MySQL Cluster process)</primary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>management client (<command>mgm</command>)</secondary>
</indexterm>
-
+
<indexterm>
<primary>management client (MySQL Cluster)</primary>
- <seealso><command>mgm</command></seealso>
+ <seealso><command>mgm</command>
+
+ </seealso>
</indexterm>
-
+
<indexterm>
<primary><command>ndb_mgm</command></primary>
- <see><command>mgm</command></see>
+ <see><command>mgm</command>
+
+ </see>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>administration</secondary>
</indexterm>
-
+
<indexterm>
<primary>administration of MySQL Cluster</primary>
</indexterm>
@@ -7867,27 +7890,27 @@
<primary>MySQL Cluster</primary>
<secondary>administration</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>commands</secondary>
</indexterm>
-
+
<indexterm>
<primary>command options</primary>
<secondary>MySQL Cluster</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary><command>ndbd</command></secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary><command>mgm</command></secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary><command>mgmd</command></secondary>
@@ -8010,7 +8033,7 @@
Cluster processes verifies that the versions of the binaries
being used can co-exist in the same cluster. This is also
important when performing an online (rolling) software
- upgrade of MySQL Cluster. (See
+ upgrade of MySQL Cluster. (See
<xref linkend="mysql-cluster-upgrade-downgrade-rolling"/>).
</para>
</listitem>
@@ -8022,26 +8045,26 @@
<title>&title-new-mysqld-command-options;</title>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>administration</secondary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>commands</secondary>
- </indexterm>
-
- <indexterm>
- <primary>command options</primary>
- <secondary>MySQL Cluster</secondary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><command>mysqld</command> process</secondary>
- </indexterm>
-
+ <primary>MySQL Cluster</primary>
+ <secondary>administration</secondary>
+ </indexterm>
+
<indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>commands</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>command options</primary>
+ <secondary>MySQL Cluster</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><command>mysqld</command> process</secondary>
+ </indexterm>
+
+ <indexterm>
<primary><command>mysqld</command></primary>
<secondary>as MySQL Cluster process</secondary>
</indexterm>
@@ -8086,25 +8109,25 @@
<title>&title-ndbd-command-options;</title>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>administration</secondary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>commands</secondary>
- </indexterm>
-
- <indexterm>
- <primary>command options</primary>
- <secondary>MySQL Cluster</secondary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><command>ndbd</command> process</secondary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>administration</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>commands</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>command options</primary>
+ <secondary>MySQL Cluster</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><command>ndbd</command> process</secondary>
+ </indexterm>
+
<para>
For options common to NDB programs, see
<xref linkend="mysql-cluster-command-options"/>.
@@ -8231,25 +8254,25 @@
<title>&title-ndb-mgmd-command-options;</title>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>administration</secondary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>commands</secondary>
- </indexterm>
-
- <indexterm>
- <primary>command options</primary>
- <secondary>MySQL Cluster</secondary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><command>mgmd</command> process</secondary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>administration</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>commands</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>command options</primary>
+ <secondary>MySQL Cluster</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><command>mgmd</command> process</secondary>
+ </indexterm>
+
<para>
For options common to NDB programs, see
<xref linkend="mysql-cluster-command-options"/>.
@@ -8304,25 +8327,25 @@
<title>&title-ndb-mgm-command-options;</title>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>administration</secondary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>commands</secondary>
- </indexterm>
-
- <indexterm>
- <primary>command options</primary>
- <secondary>MySQL Cluster</secondary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><command>mgm</command> process</secondary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>administration</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>commands</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>command options</primary>
+ <secondary>MySQL Cluster</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><command>mgm</command> process</secondary>
+ </indexterm>
+
<para>
For options common to NDB programs, see
<xref linkend="mysql-cluster-command-options"/>.
@@ -8358,10 +8381,10 @@
<title>&title-mysql-cluster-management;</title>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>managing</secondary>
- </indexterm>
-
+ <primary>MySQL Cluster</primary>
+ <secondary>managing</secondary>
+ </indexterm>
+
<indexterm>
<primary>managing MySQL Cluster</primary>
</indexterm>
@@ -8717,12 +8740,12 @@
<primary>MySQL Cluster</primary>
<secondary>administration</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>commands</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary><command>mgm</command> client</secondary>
@@ -8757,9 +8780,11 @@
<primary>MySQL Cluster</primary>
<secondary><literal>HELP</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>HELP</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal>HELP</literal>
</para>
@@ -8774,9 +8799,11 @@
<primary>MySQL Cluster</primary>
<secondary><literal>SHOW</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>SHOW</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal>SHOW</literal>
</para>
@@ -8798,9 +8825,11 @@
<primary>MySQL Cluster</primary>
<secondary><literal>START</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>START</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal><replaceable>node_id</replaceable> START</literal>
</para>
@@ -8816,9 +8845,11 @@
<primary>MySQL Cluster</primary>
<secondary><literal>STOP</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>STOP</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal><replaceable>node_id</replaceable> STOP</literal>
</para>
@@ -8834,9 +8865,11 @@
<primary>MySQL Cluster</primary>
<secondary><literal>RESTART</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>RESTART</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<remark role="todo">
[js] Need to explain -N and -I switches better.
</remark>
@@ -8857,9 +8890,11 @@
<primary>MySQL Cluster</primary>
<secondary><literal>STATUS</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>STATUS</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal><replaceable>node_id</replaceable> STATUS</literal>
</para>
@@ -8875,16 +8910,20 @@
<primary>MySQL Cluster</primary>
<secondary>single-user mode</secondary>
</indexterm>
+
<indexterm>
<primary>single-user mode (MySQL Cluster)</primary>
</indexterm>
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary><literal>ENTER SINGLE USER MODE</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>ENTER SINGLE USER MODE</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal>ENTER SINGLE USER MODE
<replaceable>node_id</replaceable></literal>
@@ -8902,9 +8941,11 @@
<primary>MySQL Cluster</primary>
<secondary><literal>EXIT SINGLE USER MODE</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>EXIT SINGLE USER MODE</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal>EXIT SINGLE USER MODE</literal>
</para>
@@ -8921,9 +8962,11 @@
<primary>MySQL Cluster</primary>
<secondary><literal>QUIT</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>QUIT</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal>QUIT</literal>
</para>
@@ -8938,9 +8981,11 @@
<primary>MySQL Cluster</primary>
<secondary><literal>SHUTDOWN</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>SHUTDOWN</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal>SHUTDOWN</literal>
</para>
@@ -8963,24 +9008,24 @@
<primary>MySQL Cluster</primary>
<secondary>event logs</secondary>
</indexterm>
-
+
<indexterm>
<primary>event logs (MySQL Cluster)</primary>
</indexterm>
-
+
<indexterm>
<primary>cluster logs</primary>
</indexterm>
-
+
<indexterm>
<primary>node logs (MySQL Cluster)</primary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>cluster logs</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>node logs</secondary>
@@ -8993,10 +9038,9 @@
<para>
MySQL Cluster provides two types of event log. These are the
- <firstterm>cluster log</firstterm>, which includes
- events generated by all cluster nodes, and the
- <firstterm>node logs</firstterm>, which are local to
- each data node.
+ <firstterm>cluster log</firstterm>, which includes events
+ generated by all cluster nodes, and the <firstterm>node
+ logs</firstterm>, which are local to each data node.
</para>
<para>
@@ -9028,7 +9072,7 @@
<primary>MySQL Cluster</primary>
<secondary>event types</secondary>
</indexterm>
-
+
<indexterm>
<primary>event types (MySQL Cluster)</primary>
</indexterm>
@@ -9078,32 +9122,32 @@
<title>&title-mysql-cluster-logging-management-commands;</title>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>event logs</secondary>
- </indexterm>
-
- <indexterm>
- <primary>event logs (MySQL Cluster)</primary>
- </indexterm>
-
- <indexterm>
- <primary>cluster logs</primary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>cluster logs</secondary>
- </indexterm>
-
- <indexterm>
- <primary>logging commands (MySQL Cluster)</primary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>logging commands</secondary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>event logs</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>event logs (MySQL Cluster)</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>cluster logs</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>cluster logs</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>logging commands (MySQL Cluster)</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>logging commands</secondary>
+ </indexterm>
+
<para>
The following management commands are related to the cluster
log:
@@ -9113,7 +9157,7 @@
<primary>MySQL Cluster</primary>
<secondary><literal>CLUSTERLOG</literal> commands</secondary>
</indexterm>
-
+
<indexterm>
<primary><literal>CLUSTERLOG</literal> commands (MySQL Cluster)</primary>
</indexterm>
@@ -9185,14 +9229,14 @@
</para>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>event logging thresholds</secondary>
- </indexterm>
-
- <indexterm>
- <primary>event logs (MySQL Cluster)</primary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>event logging thresholds</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>event logs (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
Note that events are reported per data node, and that the
threshold can be set to different values on different nodes.
@@ -9253,14 +9297,14 @@
</para>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>event severity levels</secondary>
- </indexterm>
-
- <indexterm>
- <primary>event severity levels (MySQL Cluster)</primary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>event severity levels</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>event severity levels (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
The following table shows the event severity levels.
(<emphasis role="bold">Note</emphasis>: These correspond to
@@ -9331,14 +9375,14 @@
<title>&title-mysql-cluster-log-events;</title>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>event log format</secondary>
- </indexterm>
-
- <indexterm>
- <primary>event log format (MySQL Cluster)</primary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>event log format</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>event log format (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
An event report reported in the event logs has the following
format:
@@ -9368,23 +9412,23 @@
</para>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>event types</secondary>
- </indexterm>
-
- <indexterm>
- <primary>event types (MySQL Cluster)</primary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><literal>CONNECTION</literal> Events</secondary>
- </indexterm>
-
- <indexterm>
- <primary><literal>CONNECTION</literal> Events (MySQL Cluster)</primary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>event types</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>event types (MySQL Cluster)</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><literal>CONNECTION</literal> Events</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary><literal>CONNECTION</literal> Events (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
<emphasis role="bold"><literal>CONNECTION</literal>
Events</emphasis>
@@ -9442,14 +9486,14 @@
</para>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><literal>CHECKPOINT</literal> Events</secondary>
- </indexterm>
-
- <indexterm>
- <primary><literal>CHECKPOINT</literal> Events (MySQL Cluster)</primary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><literal>CHECKPOINT</literal> Events</secondary>
+ </indexterm>
+ <indexterm>
+ <primary><literal>CHECKPOINT</literal> Events (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
The logging messages shown here are associated with
checkpoints.
@@ -9520,14 +9564,14 @@
</para>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><literal>STARTUP</literal> Events</secondary>
- </indexterm>
-
- <indexterm>
- <primary><literal>STARTUP</literal> Events (MySQL Cluster)</primary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><literal>STARTUP</literal> Events</secondary>
+ </indexterm>
+ <indexterm>
+ <primary><literal>STARTUP</literal> Events (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
The following events are generated in response to the startup
of a node or of the cluster and of its success or failure.
@@ -9635,14 +9679,14 @@
</para>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><literal>NODERESTART</literal> Events</secondary>
- </indexterm>
-
- <indexterm>
- <primary><literal>NODERESTART</literal> Events (MySQL Cluster)</primary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><literal>NODERESTART</literal> Events</secondary>
+ </indexterm>
+ <indexterm>
+ <primary><literal>NODERESTART</literal> Events (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
The following events are generated when restarting a node and
relate to the success or failure of the node restart process.
@@ -9866,14 +9910,14 @@
</para>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><literal>STATISTICS</literal> Events</secondary>
- </indexterm>
-
- <indexterm>
- <primary><literal>STATISTICS</literal> Events (MySQL Cluster)</primary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><literal>STATISTICS</literal> Events</secondary>
+ </indexterm>
+ <indexterm>
+ <primary><literal>STATISTICS</literal> Events (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
The following events are of a statistical nature. They provide
information such as numbers of transactions and other
@@ -9948,14 +9992,14 @@
</para>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><literal>ERROR</literal> Events</secondary>
- </indexterm>
-
- <indexterm>
- <primary><literal>ERROR</literal> Events (MySQL Cluster)</primary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><literal>ERROR</literal> Events</secondary>
+ </indexterm>
+ <indexterm>
+ <primary><literal>ERROR</literal> Events (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
These events relate to Cluster errors and warnings. The
presence of one or more of these generally indicates that a
@@ -10017,14 +10061,14 @@
</para>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><literal>INFO</literal> Events</secondary>
- </indexterm>
-
- <indexterm>
- <primary><literal>INFO</literal> Events (MySQL Cluster)</primary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><literal>INFO</literal> Events</secondary>
+ </indexterm>
+ <indexterm>
+ <primary><literal>INFO</literal> Events (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
These events provide general information about the state of
the cluster and activities associated with Cluster
@@ -10073,35 +10117,34 @@
<title>&title-mysql-cluster-log-statistics;</title>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><literal>CLUSTERLOG STATISTICS</literal> command</secondary>
- </indexterm>
-
- <indexterm>
- <primary><literal>CLUSTERLOG STATISTICS</literal> command (MySQL Cluster)</primary>
- </indexterm>
-
+ <primary>MySQL Cluster</primary>
+ <secondary><literal>CLUSTERLOG STATISTICS</literal> command</secondary>
+ </indexterm>
+
<indexterm>
+ <primary><literal>CLUSTERLOG STATISTICS</literal> command (MySQL Cluster)</primary>
+ </indexterm>
+
+ <indexterm>
<primary>MySQL Cluster</primary>
<secondary>administration</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>management commands</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary><command>mgm</command> management client</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>runtime statistics</secondary>
</indexterm>
-
<para>
The <literal>NDB</literal> management client's
<literal>CLUSTERLOG STATISTICS</literal> command can provide a
@@ -10250,7 +10293,7 @@
<primary>MySQL Cluster</primary>
<secondary>single-user mode</secondary>
</indexterm>
-
+
<indexterm>
<primary>single-user mode (MySQL Cluster)</primary>
</indexterm>
@@ -10390,7 +10433,7 @@
<primary>MySQL Cluster</primary>
<secondary>backups</secondary>
</indexterm>
-
+
<indexterm>
<primary>backups</primary>
<secondary>in MySQL Cluster</secondary>
@@ -10406,15 +10449,15 @@
<title>&title-mysql-cluster-backup-concepts;</title>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>backups</secondary>
- </indexterm>
-
- <indexterm>
- <primary>backups</primary>
- <secondary>in MySQL Cluster</secondary>
+ <primary>MySQL Cluster</primary>
+ <secondary>backups</secondary>
</indexterm>
+ <indexterm>
+ <primary>backups</primary>
+ <secondary>in MySQL Cluster</secondary>
+ </indexterm>
+
<para>
A backup is a snapshot of the database at a given time. The
backup consists of three main parts:
@@ -10513,15 +10556,15 @@
<title>&title-mysql-cluster-backup-using-management-server;</title>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>backups</secondary>
- </indexterm>
-
- <indexterm>
- <primary>backups</primary>
- <secondary>in MySQL Cluster</secondary>
+ <primary>MySQL Cluster</primary>
+ <secondary>backups</secondary>
</indexterm>
+ <indexterm>
+ <primary>backups</primary>
+ <secondary>in MySQL Cluster</secondary>
+ </indexterm>
+
<para>
Before starting a backup, make sure that the cluster is
properly configured for performing one. (See
@@ -10537,13 +10580,14 @@
<listitem>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><literal>START BACKUP</literal> command</secondary>
- </indexterm>
-
- <indexterm>
- <primary><literal>START BACKUP</literal> command (MySQL Cluster)</primary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><literal>START BACKUP</literal> command</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary><literal>START BACKUP</literal> command (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
Start the management server (<command>ndb_mgm</command>).
</para>
@@ -10660,25 +10704,25 @@
<title>&title-mysql-cluster-restore;</title>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>backups</secondary>
- </indexterm>
-
- <indexterm>
- <primary>backups</primary>
- <secondary>in MySQL Cluster</secondary>
+ <primary>MySQL Cluster</primary>
+ <secondary>backups</secondary>
</indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>restoring backups</secondary>
- </indexterm>
-
- <indexterm>
- <primary>restoring backups</primary>
- <secondary>in MySQL Cluster</secondary>
+
+ <indexterm>
+ <primary>backups</primary>
+ <secondary>in MySQL Cluster</secondary>
</indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>restoring backups</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>restoring backups</primary>
+ <secondary>in MySQL Cluster</secondary>
+ </indexterm>
+
<remark role="todo">
Need to provide an example of ndb_restore usage or pointer to
same. [js]
@@ -10742,25 +10786,25 @@
<title>&title-mysql-cluster-backup-configuration;</title>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>backups</secondary>
- </indexterm>
-
- <indexterm>
- <primary>backups</primary>
- <secondary>in MySQL Cluster</secondary>
+ <primary>MySQL Cluster</primary>
+ <secondary>backups</secondary>
</indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>configuring</secondary>
- </indexterm>
-
- <indexterm>
- <primary>configuring backups</primary>
- <secondary>in MySQL Cluster</secondary>
+
+ <indexterm>
+ <primary>backups</primary>
+ <secondary>in MySQL Cluster</secondary>
</indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>configuring</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>configuring backups</primary>
+ <secondary>in MySQL Cluster</secondary>
+ </indexterm>
+
<para>
Four configuration parameters are essential for backup:
</para>
@@ -10842,20 +10886,20 @@
<title>&title-mysql-cluster-backup-troubleshooting;</title>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>backups</secondary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>troubleshooting backups</secondary>
- </indexterm>
-
- <indexterm>
- <primary>backups, troubleshooting</primary>
- <secondary>in MySQL Cluster</secondary>
+ <primary>MySQL Cluster</primary>
+ <secondary>backups</secondary>
</indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>troubleshooting backups</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>backups, troubleshooting</primary>
+ <secondary>in MySQL Cluster</secondary>
+ </indexterm>
+
<para>
If an error code is returned when issuing a backup request,
the most likely cause is insufficient memory or insufficient
@@ -11954,9 +11998,9 @@
<para>
All Cluster table rows are of fixed length. This means
(for example) that if a table has one or more
- <literal>VARCHAR</literal> fields containing
- only relatively small values, more memory and disk space
- is required when using the <literal>NDB</literal> storage
+ <literal>VARCHAR</literal> fields containing only
+ relatively small values, more memory and disk space is
+ required when using the <literal>NDB</literal> storage
engine than would be the case for the same table and data
using the <literal>MyISAM</literal> engine. (In other
words, in the case of a <literal>VARCHAR</literal> column,
@@ -11982,8 +12026,8 @@
<listitem>
<para>
- The maximum permitted size of any one row is 8KB.
- Note that each <literal>BLOB</literal> or
+ The maximum permitted size of any one row is 8KB. Note
+ that each <literal>BLOB</literal> or
<literal>TEXT</literal> column contributes a maximum of
256 bytes towards this total.
</para>
@@ -12563,7 +12607,7 @@
Cluster on any but the three platforms mentioned here should
be considered alpha software (at best), cannot be guaranteed
reliable in a production setting, and <emphasis>is not
- supported by MySQL AB</emphasis>.
+ supported by MySQL AB</emphasis>.
</para>
</listitem>
@@ -12620,9 +12664,9 @@
</para>
<para>
- (We have implemented disk data storage for MySQL Cluster in MySQL
- 5.1, but we have no plans to add this capability in MySQL
- ¤t-series;.)
+ (We have implemented disk data storage for MySQL Cluster in
+ MySQL 5.1, but we have no plans to add this capability in
+ MySQL ¤t-series;.)
</para>
<para>
Modified: trunk/refman-5.0/ndbcluster.xml
===================================================================
--- trunk/refman-5.0/ndbcluster.xml 2006-05-24 14:44:04 UTC (rev 2188)
+++ trunk/refman-5.0/ndbcluster.xml 2006-05-24 14:46:48 UTC (rev 2189)
@@ -1009,14 +1009,13 @@
</indexterm>
<para>
- Each MySQL Cluster host computer running data or SQL nodes
- must have installed on it a MySQL-max binary. For management
- nodes, it is not necessary to install the MySQL server binary,
- but you do have to install the MGM server daemon and client
- binaries (<command>ndb_mgmd</command> and
- <command>ndb_mgm</command>, respectively). This section covers
- the steps necessary to install the correct binaries for each
- type of Cluster node.
+ Each MySQL Cluster host computer running data or SQL nodes must
+ have installed on it a MySQL-max binary. For management nodes,
+ it is not necessary to install the MySQL server binary, but you
+ do have to install the MGM server daemon and client binaries
+ (<command>ndb_mgmd</command> and <command>ndb_mgm</command>,
+ respectively). This section covers the steps necessary to
+ install the correct binaries for each type of Cluster node.
</para>
<para>
@@ -1779,9 +1778,9 @@
the <literal>CREATE SCHEMA world</literal> statement (beginning
with MySQL 5.0.2, you may use <literal>CREATE SCHEMA
world</literal> instead), followed by <literal>FLUSH
- TABLES</literal> on each SQL node in the
- cluster. This causes the node to recognize the database and read
- its table definitions.
+ TABLES</literal> on each SQL node in the cluster. This causes
+ the node to recognize the database and read its table
+ definitions.
</para>
<para>
@@ -5986,13 +5985,13 @@
<primary>MySQL Cluster</primary>
<secondary>networking</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>transporters</secondary>
<tertiary>TCP/IP</tertiary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>direct connections between nodes</secondary>
@@ -6066,17 +6065,17 @@
<primary>MySQL Cluster</primary>
<secondary>networking</secondary>
</indexterm>
-
+
<indexterm>
<primary>shared memory transporter</primary>
<see>MySQL Cluster</see>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>shared memory transport</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>transporters</secondary>
@@ -6116,11 +6115,12 @@
<indexterm>
<primary>node identifiers (MySQL Cluster)</primary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>node identifiers</secondary>
</indexterm>
+
<para>
<literal>NodeId1</literal>, <literal>NodeId2</literal>
</para>
@@ -6136,6 +6136,7 @@
<indexterm>
<primary><literal>ShmKey</literal></primary>
</indexterm>
+
<para>
<literal>ShmKey</literal>
</para>
@@ -6152,6 +6153,7 @@
<indexterm>
<primary><literal>ShmSize</literal></primary>
</indexterm>
+
<para>
<literal>ShmSize</literal>
</para>
@@ -6168,6 +6170,7 @@
<indexterm>
<primary><literal>SendSignalId</literal></primary>
</indexterm>
+
<para>
<literal>SendSignalId</literal>
</para>
@@ -6185,6 +6188,7 @@
<indexterm>
<primary><literal>Checksum</literal> (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal>Checksum</literal>
</para>
@@ -6216,24 +6220,23 @@
<primary>MySQL Cluster</primary>
<secondary>networking</secondary>
</indexterm>
-
+
<indexterm>
<primary>SCI (Scalable Coherent Interface)</primary>
<see>MySQL Cluster</see>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>SCI (Scalable Coherent Interface)</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>transporters</secondary>
<tertiary>Scalable Coherent Interface (SCI)</tertiary>
</indexterm>
-
<para>
<literal>[SCI]</literal> sections in the
<filename>config.ini</filename> file explicitly define SCI
@@ -6271,11 +6274,12 @@
<indexterm>
<primary>node identifiers (MySQL Cluster)</primary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>node identifiers</secondary>
</indexterm>
+
<para>
<literal>NodeId1</literal>, <literal>NodeId2</literal>
</para>
@@ -6291,6 +6295,7 @@
<indexterm>
<primary><literal>Host*SciId*</literal> parameters</primary>
</indexterm>
+
<para>
<literal>Host1SciId0</literal>
</para>
@@ -6341,6 +6346,7 @@
<indexterm>
<primary><literal>SharedBufferSize</literal></primary>
</indexterm>
+
<para>
<literal>SharedBufferSize</literal>
</para>
@@ -6360,6 +6366,7 @@
<indexterm>
<primary><literal>SendLimit</literal></primary>
</indexterm>
+
<para>
<literal>SendLimit</literal>
</para>
@@ -6378,6 +6385,7 @@
<indexterm>
<primary><literal>SendSignalId</literal></primary>
</indexterm>
+
<para>
<literal>SendSignalId</literal>
</para>
@@ -6394,6 +6402,7 @@
<indexterm>
<primary><literal>Checksum</literal> (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal>Checksum</literal>
</para>
@@ -6424,6 +6433,7 @@
</section>
</section>
+
<section id="mysql-cluster-upgrade-downgrade">
<title>&title-mysql-cluster-upgrade-downgrade;</title>
@@ -6432,12 +6442,12 @@
<primary>MySQL Cluster</primary>
<secondary>upgrades and downgrades</secondary>
</indexterm>
-
+
<indexterm>
<primary>upgrades</primary>
<secondary>MySQL Cluster</secondary>
</indexterm>
-
+
<indexterm>
<primary>downgrades</primary>
<secondary>MySQL Cluster</secondary>
@@ -6473,22 +6483,21 @@
<primary>MySQL Cluster</primary>
<secondary>upgrades and downgrades</secondary>
</indexterm>
-
+
<indexterm>
<primary>rolling upgrades and downgrades (MySQL Cluster)</primary>
</indexterm>
-
- <indexterm>
- <primary>upgrades</primary>
- <secondary>MySQL Cluster</secondary>
- </indexterm>
-
- <indexterm>
- <primary>downgrades</primary>
- <secondary>MySQL Cluster</secondary>
- </indexterm>
+ <indexterm>
+ <primary>upgrades</primary>
+ <secondary>MySQL Cluster</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>downgrades</primary>
+ <secondary>MySQL Cluster</secondary>
+ </indexterm>
+
<para>
This section discusses how to perform a <firstterm>rolling
upgrade</firstterm> of a MySQL Cluster installation, so called
@@ -6520,6 +6529,7 @@
<primary>MySQL Cluster</primary>
<secondary>configuration changes</secondary>
</indexterm>
+
<para>
<emphasis role="bold">Cluster Configuration
Change</emphasis>: To make a change in the cluster's
@@ -6550,6 +6560,7 @@
<primary>MySQL Cluster</primary>
<secondary>resetting</secondary>
</indexterm>
+
<para>
<emphasis role="bold">Cluster Reset</emphasis>: To reset the
cluster because it has reached an undesirable state
@@ -6805,22 +6816,22 @@
<primary>MySQL Cluster</primary>
<secondary>upgrades and downgrades</secondary>
</indexterm>
-
+
<indexterm>
<primary>upgrades and downgrades (MySQL Cluster)</primary>
<secondary>compatibility between versions</secondary>
</indexterm>
-
- <indexterm>
- <primary>upgrades</primary>
- <secondary>MySQL Cluster</secondary>
- </indexterm>
-
- <indexterm>
- <primary>downgrades</primary>
- <secondary>MySQL Cluster</secondary>
- </indexterm>
+ <indexterm>
+ <primary>upgrades</primary>
+ <secondary>MySQL Cluster</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>downgrades</primary>
+ <secondary>MySQL Cluster</secondary>
+ </indexterm>
+
<para>
This section provides information regarding Cluster software and
table file compatibility between differing versions of the MySQL
@@ -7168,15 +7179,15 @@
<primary>MySQL Cluster</primary>
<secondary>process management</secondary>
</indexterm>
-
+
<indexterm>
<primary>process management (MySQL Cluster)</primary>
</indexterm>
-
+
<indexterm>
<primary>managing MySQL Cluster processes</primary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster processes (types)</primary>
</indexterm>
@@ -7225,21 +7236,21 @@
<primary>MySQL Cluster</primary>
<secondary><command>mysqld</command> process</secondary>
</indexterm>
-
+
<indexterm>
<primary><command>mysqld</command></primary>
<secondary>as MySQL Cluster process</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>SQL nodes</secondary>
</indexterm>
-
+
<indexterm>
<primary>SQL nodes (MySQL Cluster)</primary>
</indexterm>
-
+
<indexterm>
<primary>API nodes</primary>
<see>SQL nodes</see>
@@ -7301,11 +7312,11 @@
<primary>MySQL Cluster</primary>
<secondary>configuration</secondary>
</indexterm>
-
+
<indexterm>
<primary>configuring MySQL Cluster</primary>
</indexterm>
-
+
<indexterm>
<primary><filename>my.cnf</filename></primary>
<secondary>in MySQL Cluster</secondary>
@@ -7390,23 +7401,25 @@
<primary>MySQL Cluster</primary>
<secondary><command>ndbd</command> process</secondary>
</indexterm>
-
+
<indexterm>
<primary><command>ndbd</command> (MySQL Cluster process)</primary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>data nodes</secondary>
</indexterm>
-
+
<indexterm>
<primary>data nodes (MySQL Cluster)</primary>
</indexterm>
-
+
<indexterm>
<primary>storage nodes</primary>
- <see>data nodes, <command>ndbd</command></see>
+ <see>data nodes, <command>ndbd</command>
+
+ </see>
</indexterm>
<para>
@@ -7433,7 +7446,7 @@
<primary>MySQL Cluster</primary>
<secondary>log files</secondary>
</indexterm>
-
+
<indexterm>
<primary>log files (MySQL Cluster)</primary>
</indexterm>
@@ -7453,13 +7466,14 @@
<listitem>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>error logs</secondary>
- </indexterm>
-
- <indexterm>
- <primary>error logs (MySQL Cluster)</primary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>error logs</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>error logs (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
<filename>ndb_<replaceable>node_id</replaceable>_error.log</filename>
is a file containing records of all crashes which the
@@ -7498,13 +7512,14 @@
<listitem>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>trace files</secondary>
- </indexterm>
-
- <indexterm>
- <primary>trace files (MySQL Cluster)</primary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>trace files</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>trace files (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
<filename>ndb_<replaceable>node_id</replaceable>_trace.log.<replaceable>trace_id</replaceable></filename>
is a trace file describing exactly what happened just before
@@ -7629,27 +7644,30 @@
<primary>MySQL Cluster</primary>
<secondary><command>mgmd</command> process</secondary>
</indexterm>
-
+
<indexterm>
<primary><command>mgmd</command> (MySQL Cluster process)</primary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>management nodes</secondary>
</indexterm>
-
+
<indexterm>
<primary>management nodes (MySQL Cluster)</primary>
- <seealso><command>mgmd</command></seealso>
+ <seealso><command>mgmd</command>
+
+ </seealso>
</indexterm>
-
+
<indexterm>
<primary><command>ndb_mgmd</command></primary>
- <see><command>mgmd</command></see>
+ <see><command>mgmd</command>
+
+ </see>
</indexterm>
-
<para>
The management server is the process that reads the cluster
configuration file and distributes this information to all nodes
@@ -7686,17 +7704,18 @@
<listitem>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>configuration</secondary>
- </indexterm>
-
- <indexterm>
- <primary>configuring MySQL Cluster</primary>
- </indexterm>
-
+ <primary>MySQL Cluster</primary>
+ <secondary>configuration</secondary>
+ </indexterm>
+
<indexterm>
+ <primary>configuring MySQL Cluster</primary>
+ </indexterm>
+
+ <indexterm>
<primary><filename>config.ini</filename> (MySQL Cluster)</primary>
</indexterm>
+
<para>
<filename>config.ini</filename> is the configuration file
for the cluster as a whole. This file is created by the user
@@ -7756,31 +7775,35 @@
<primary>MySQL Cluster</primary>
<secondary><command>mgm</command> process</secondary>
</indexterm>
-
+
<indexterm>
<primary><command>mgm</command> (MySQL Cluster process)</primary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>management client (<command>mgm</command>)</secondary>
</indexterm>
-
+
<indexterm>
<primary>management client (MySQL Cluster)</primary>
- <seealso><command>mgm</command></seealso>
+ <seealso><command>mgm</command>
+
+ </seealso>
</indexterm>
-
+
<indexterm>
<primary><command>ndb_mgm</command></primary>
- <see><command>mgm</command></see>
+ <see><command>mgm</command>
+
+ </see>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>administration</secondary>
</indexterm>
-
+
<indexterm>
<primary>administration of MySQL Cluster</primary>
</indexterm>
@@ -7834,27 +7857,27 @@
<primary>MySQL Cluster</primary>
<secondary>administration</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>commands</secondary>
</indexterm>
-
+
<indexterm>
<primary>command options</primary>
<secondary>MySQL Cluster</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary><command>ndbd</command></secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary><command>mgm</command></secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary><command>mgmd</command></secondary>
@@ -7972,7 +7995,7 @@
Cluster processes verifies that the versions of the binaries
being used can co-exist in the same cluster. This is also
important when performing an online (rolling) software
- upgrade of MySQL Cluster. (See
+ upgrade of MySQL Cluster. (See
<xref linkend="mysql-cluster-upgrade-downgrade-rolling"/>).
</para>
</listitem>
@@ -7984,26 +8007,26 @@
<title>&title-new-mysqld-command-options;</title>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>administration</secondary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>commands</secondary>
- </indexterm>
-
- <indexterm>
- <primary>command options</primary>
- <secondary>MySQL Cluster</secondary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><command>mysqld</command> process</secondary>
- </indexterm>
-
+ <primary>MySQL Cluster</primary>
+ <secondary>administration</secondary>
+ </indexterm>
+
<indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>commands</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>command options</primary>
+ <secondary>MySQL Cluster</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><command>mysqld</command> process</secondary>
+ </indexterm>
+
+ <indexterm>
<primary><command>mysqld</command></primary>
<secondary>as MySQL Cluster process</secondary>
</indexterm>
@@ -8048,25 +8071,25 @@
<title>&title-ndbd-command-options;</title>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>administration</secondary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>commands</secondary>
- </indexterm>
-
- <indexterm>
- <primary>command options</primary>
- <secondary>MySQL Cluster</secondary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><command>ndbd</command> process</secondary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>administration</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>commands</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>command options</primary>
+ <secondary>MySQL Cluster</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><command>ndbd</command> process</secondary>
+ </indexterm>
+
<para>
For options common to NDB programs, see
<xref linkend="mysql-cluster-command-options"/>.
@@ -8187,25 +8210,25 @@
<title>&title-ndb-mgmd-command-options;</title>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>administration</secondary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>commands</secondary>
- </indexterm>
-
- <indexterm>
- <primary>command options</primary>
- <secondary>MySQL Cluster</secondary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><command>mgmd</command> process</secondary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>administration</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>commands</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>command options</primary>
+ <secondary>MySQL Cluster</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><command>mgmd</command> process</secondary>
+ </indexterm>
+
<para>
For options common to NDB programs, see
<xref linkend="mysql-cluster-command-options"/>.
@@ -8266,25 +8289,25 @@
<title>&title-ndb-mgm-command-options;</title>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>administration</secondary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>commands</secondary>
- </indexterm>
-
- <indexterm>
- <primary>command options</primary>
- <secondary>MySQL Cluster</secondary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><command>mgm</command> process</secondary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>administration</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>commands</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>command options</primary>
+ <secondary>MySQL Cluster</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><command>mgm</command> process</secondary>
+ </indexterm>
+
<para>
For options common to NDB programs, see
<xref linkend="mysql-cluster-command-options"/>.
@@ -8312,19 +8335,18 @@
</section>
</section>
+
</section>
-
-
<section id="mysql-cluster-management">
<title>&title-mysql-cluster-management;</title>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>managing</secondary>
- </indexterm>
-
+ <primary>MySQL Cluster</primary>
+ <secondary>managing</secondary>
+ </indexterm>
+
<indexterm>
<primary>managing MySQL Cluster</primary>
</indexterm>
@@ -8680,12 +8702,12 @@
<primary>MySQL Cluster</primary>
<secondary>administration</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>commands</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary><command>mgm</command> client</secondary>
@@ -8720,9 +8742,11 @@
<primary>MySQL Cluster</primary>
<secondary><literal>HELP</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>HELP</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal>HELP</literal>
</para>
@@ -8737,9 +8761,11 @@
<primary>MySQL Cluster</primary>
<secondary><literal>SHOW</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>SHOW</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal>SHOW</literal>
</para>
@@ -8761,9 +8787,11 @@
<primary>MySQL Cluster</primary>
<secondary><literal>START</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>START</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal><replaceable>node_id</replaceable> START</literal>
</para>
@@ -8786,9 +8814,11 @@
<primary>MySQL Cluster</primary>
<secondary><literal>STOP</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>STOP</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal><replaceable>node_id</replaceable> STOP</literal>
</para>
@@ -8811,9 +8841,11 @@
<primary>MySQL Cluster</primary>
<secondary><literal>RESTART</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>RESTART</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<remark role="todo">
[js] Need to explain -N and -I switches better.
</remark>
@@ -8834,9 +8866,11 @@
<primary>MySQL Cluster</primary>
<secondary><literal>STATUS</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>STATUS</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal><replaceable>node_id</replaceable> STATUS</literal>
</para>
@@ -8852,16 +8886,20 @@
<primary>MySQL Cluster</primary>
<secondary>single-user mode</secondary>
</indexterm>
+
<indexterm>
<primary>single-user mode (MySQL Cluster)</primary>
</indexterm>
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary><literal>ENTER SINGLE USER MODE</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>ENTER SINGLE USER MODE</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal>ENTER SINGLE USER MODE
<replaceable>node_id</replaceable></literal>
@@ -8879,9 +8917,11 @@
<primary>MySQL Cluster</primary>
<secondary><literal>EXIT SINGLE USER MODE</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>EXIT SINGLE USER MODE</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal>EXIT SINGLE USER MODE</literal>
</para>
@@ -8898,9 +8938,11 @@
<primary>MySQL Cluster</primary>
<secondary><literal>QUIT</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>QUIT</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal>QUIT</literal>
</para>
@@ -8915,9 +8957,11 @@
<primary>MySQL Cluster</primary>
<secondary><literal>SHUTDOWN</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>SHUTDOWN</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal>SHUTDOWN</literal>
</para>
@@ -8940,24 +8984,24 @@
<primary>MySQL Cluster</primary>
<secondary>event logs</secondary>
</indexterm>
-
+
<indexterm>
<primary>event logs (MySQL Cluster)</primary>
</indexterm>
-
+
<indexterm>
<primary>cluster logs</primary>
</indexterm>
-
+
<indexterm>
<primary>node logs (MySQL Cluster)</primary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>cluster logs</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>node logs</secondary>
@@ -8970,10 +9014,9 @@
<para>
MySQL Cluster provides two types of event log. These are the
- <firstterm>cluster log</firstterm>, which includes
- events generated by all cluster nodes, and the
- <firstterm>node logs</firstterm>, which are local to
- each data node.
+ <firstterm>cluster log</firstterm>, which includes events
+ generated by all cluster nodes, and the <firstterm>node
+ logs</firstterm>, which are local to each data node.
</para>
<para>
@@ -9005,7 +9048,7 @@
<primary>MySQL Cluster</primary>
<secondary>event types</secondary>
</indexterm>
-
+
<indexterm>
<primary>event types (MySQL Cluster)</primary>
</indexterm>
@@ -9055,32 +9098,32 @@
<title>&title-mysql-cluster-logging-management-commands;</title>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>event logs</secondary>
- </indexterm>
-
- <indexterm>
- <primary>event logs (MySQL Cluster)</primary>
- </indexterm>
-
- <indexterm>
- <primary>cluster logs</primary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>cluster logs</secondary>
- </indexterm>
-
- <indexterm>
- <primary>logging commands (MySQL Cluster)</primary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>logging commands</secondary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>event logs</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>event logs (MySQL Cluster)</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>cluster logs</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>cluster logs</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>logging commands (MySQL Cluster)</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>logging commands</secondary>
+ </indexterm>
+
<para>
The following management commands are related to the cluster
log:
@@ -9090,7 +9133,7 @@
<primary>MySQL Cluster</primary>
<secondary><literal>CLUSTERLOG</literal> commands</secondary>
</indexterm>
-
+
<indexterm>
<primary><literal>CLUSTERLOG</literal> commands (MySQL Cluster)</primary>
</indexterm>
@@ -9162,14 +9205,14 @@
</para>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>event logging thresholds</secondary>
- </indexterm>
-
- <indexterm>
- <primary>event logs (MySQL Cluster)</primary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>event logging thresholds</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>event logs (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
Note that events are reported per data node, and that the
threshold can be set to different values on different nodes.
@@ -9230,14 +9273,14 @@
</para>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>event severity levels</secondary>
- </indexterm>
-
- <indexterm>
- <primary>event severity levels (MySQL Cluster)</primary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>event severity levels</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>event severity levels (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
The following table shows the event severity levels.
(<emphasis role="bold">Note</emphasis>: These correspond to
@@ -9308,14 +9351,14 @@
<title>&title-mysql-cluster-log-events;</title>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>event log format</secondary>
- </indexterm>
-
- <indexterm>
- <primary>event log format (MySQL Cluster)</primary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>event log format</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>event log format (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
An event report reported in the event logs has the following
format:
@@ -9345,23 +9388,23 @@
</para>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>event types</secondary>
- </indexterm>
-
- <indexterm>
- <primary>event types (MySQL Cluster)</primary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><literal>CONNECTION</literal> Events</secondary>
- </indexterm>
-
- <indexterm>
- <primary><literal>CONNECTION</literal> Events (MySQL Cluster)</primary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>event types</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>event types (MySQL Cluster)</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><literal>CONNECTION</literal> Events</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary><literal>CONNECTION</literal> Events (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
<emphasis role="bold"><literal>CONNECTION</literal>
Events</emphasis>
@@ -9419,14 +9462,14 @@
</para>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><literal>CHECKPOINT</literal> Events</secondary>
- </indexterm>
-
- <indexterm>
- <primary><literal>CHECKPOINT</literal> Events (MySQL Cluster)</primary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><literal>CHECKPOINT</literal> Events</secondary>
+ </indexterm>
+ <indexterm>
+ <primary><literal>CHECKPOINT</literal> Events (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
The logging messages shown here are associated with
checkpoints.
@@ -9497,14 +9540,14 @@
</para>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><literal>STARTUP</literal> Events</secondary>
- </indexterm>
-
- <indexterm>
- <primary><literal>STARTUP</literal> Events (MySQL Cluster)</primary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><literal>STARTUP</literal> Events</secondary>
+ </indexterm>
+ <indexterm>
+ <primary><literal>STARTUP</literal> Events (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
The following events are generated in response to the startup
of a node or of the cluster and of its success or failure.
@@ -9612,14 +9655,14 @@
</para>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><literal>NODERESTART</literal> Events</secondary>
- </indexterm>
-
- <indexterm>
- <primary><literal>NODERESTART</literal> Events (MySQL Cluster)</primary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><literal>NODERESTART</literal> Events</secondary>
+ </indexterm>
+ <indexterm>
+ <primary><literal>NODERESTART</literal> Events (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
The following events are generated when restarting a node and
relate to the success or failure of the node restart process.
@@ -9843,14 +9886,14 @@
</para>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><literal>STATISTICS</literal> Events</secondary>
- </indexterm>
-
- <indexterm>
- <primary><literal>STATISTICS</literal> Events (MySQL Cluster)</primary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><literal>STATISTICS</literal> Events</secondary>
+ </indexterm>
+ <indexterm>
+ <primary><literal>STATISTICS</literal> Events (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
The following events are of a statistical nature. They provide
information such as numbers of transactions and other
@@ -9925,14 +9968,14 @@
</para>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><literal>ERROR</literal> Events</secondary>
- </indexterm>
-
- <indexterm>
- <primary><literal>ERROR</literal> Events (MySQL Cluster)</primary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><literal>ERROR</literal> Events</secondary>
+ </indexterm>
+ <indexterm>
+ <primary><literal>ERROR</literal> Events (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
These events relate to Cluster errors and warnings. The
presence of one or more of these generally indicates that a
@@ -9994,14 +10037,14 @@
</para>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><literal>INFO</literal> Events</secondary>
- </indexterm>
-
- <indexterm>
- <primary><literal>INFO</literal> Events (MySQL Cluster)</primary>
- </indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><literal>INFO</literal> Events</secondary>
+ </indexterm>
+ <indexterm>
+ <primary><literal>INFO</literal> Events (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
These events provide general information about the state of
the cluster and activities associated with Cluster
@@ -10044,182 +10087,178 @@
</informaltable>
</section>
-
-
- <section id="mysql-cluster-log-statistics">
+ <section id="mysql-cluster-log-statistics">
- <title>&title-mysql-cluster-log-statistics;</title>
+ <title>&title-mysql-cluster-log-statistics;</title>
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><literal>CLUSTERLOG STATISTICS</literal> command</secondary>
- </indexterm>
-
- <indexterm>
- <primary><literal>CLUSTERLOG STATISTICS</literal> command (MySQL Cluster)</primary>
- </indexterm>
-
<indexterm>
<primary>MySQL Cluster</primary>
+ <secondary><literal>CLUSTERLOG STATISTICS</literal> command</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary><literal>CLUSTERLOG STATISTICS</literal> command (MySQL Cluster)</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
<secondary>administration</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>management commands</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary><command>mgm</command> management client</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>runtime statistics</secondary>
</indexterm>
-
<para>
- The <literal>NDB</literal> management client's
- <literal>CLUSTERLOG STATISTICS</literal> command can provide a
- number of useful statistics in its output. The following
- statistics are reported by the transaction coordinator:
- </para>
+ The <literal>NDB</literal> management client's
+ <literal>CLUSTERLOG STATISTICS</literal> command can provide a
+ number of useful statistics in its output. The following
+ statistics are reported by the transaction coordinator:
+ </para>
- <informaltable>
- <tgroup cols="2">
- <colspec colwidth="30*"/>
- <colspec colwidth="70*"/>
- <tbody>
- <row>
- <entry><emphasis role="bold">Statistic</emphasis></entry>
- <entry><emphasis role="bold">Description (<emphasis>Number
- of...</emphasis>)</emphasis></entry>
- </row>
- <row>
- <entry><literal>Trans. Count</literal></entry>
- <entry>Transactions attempted with this node as coordinator</entry>
- </row>
- <row>
- <entry><literal>Commit Count</literal></entry>
- <entry>Transactions committed with this node as coordinator</entry>
- </row>
- <row>
- <entry><literal>Read Count</literal></entry>
- <entry>Primary key reads (all)</entry>
- </row>
- <row>
- <entry><literal>Simple Read Count</literal></entry>
- <entry>Primary key reads reading the latest committed value</entry>
- </row>
- <row>
- <entry><literal>Write Count</literal></entry>
- <entry>Primary key writes (includes all <literal>INSERT</literal>,
- <literal>UPDATE</literal>, and <literal>DELETE</literal>
- operations)</entry>
- </row>
- <row>
- <entry><literal>AttrInfoCount</literal></entry>
- <entry>Data words used to describe all reads and writes received</entry>
- </row>
- <row>
- <entry><literal>Concurrent Operations</literal></entry>
- <entry>All concurrent operations ongoing at the moment the report is taken</entry>
- </row>
- <row>
- <entry><literal>Abort Count</literal></entry>
- <entry>Transactions with this node as coordinator that were aborted</entry>
- </row>
- <row>
- <entry><literal>Scans</literal></entry>
- <entry>Scans (all)</entry>
- </row>
- <row>
- <entry><literal>Range Scans</literal></entry>
- <entry>Index scans</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colwidth="30*"/>
+ <colspec colwidth="70*"/>
+ <tbody>
+ <row>
+ <entry><emphasis role="bold">Statistic</emphasis></entry>
+ <entry><emphasis role="bold">Description (<emphasis>Number
+ of...</emphasis>)</emphasis></entry>
+ </row>
+ <row>
+ <entry><literal>Trans. Count</literal></entry>
+ <entry>Transactions attempted with this node as coordinator</entry>
+ </row>
+ <row>
+ <entry><literal>Commit Count</literal></entry>
+ <entry>Transactions committed with this node as coordinator</entry>
+ </row>
+ <row>
+ <entry><literal>Read Count</literal></entry>
+ <entry>Primary key reads (all)</entry>
+ </row>
+ <row>
+ <entry><literal>Simple Read Count</literal></entry>
+ <entry>Primary key reads reading the latest committed value</entry>
+ </row>
+ <row>
+ <entry><literal>Write Count</literal></entry>
+ <entry>Primary key writes (includes all <literal>INSERT</literal>,
+ <literal>UPDATE</literal>, and
+ <literal>DELETE</literal> operations)</entry>
+ </row>
+ <row>
+ <entry><literal>AttrInfoCount</literal></entry>
+ <entry>Data words used to describe all reads and writes received</entry>
+ </row>
+ <row>
+ <entry><literal>Concurrent Operations</literal></entry>
+ <entry>All concurrent operations ongoing at the moment the report is taken</entry>
+ </row>
+ <row>
+ <entry><literal>Abort Count</literal></entry>
+ <entry>Transactions with this node as coordinator that were aborted</entry>
+ </row>
+ <row>
+ <entry><literal>Scans</literal></entry>
+ <entry>Scans (all)</entry>
+ </row>
+ <row>
+ <entry><literal>Range Scans</literal></entry>
+ <entry>Index scans</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
- <para>
- The <command>ndbd</command> process has a scheduler that runs in
- an infinite loop. During each loop scheduler performs the
- following tasks:
- </para>
+ <para>
+ The <command>ndbd</command> process has a scheduler that runs
+ in an infinite loop. During each loop scheduler performs the
+ following tasks:
+ </para>
- <indexterm>
+ <indexterm>
<primary>MySQL Cluster</primary>
<secondary><command>ndbd</command> process</secondary>
</indexterm>
<orderedlist>
- <listitem>
- <para>
- Read any incoming messages from sockets into a job buffer.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ Read any incoming messages from sockets into a job buffer.
+ </para>
+ </listitem>
- <listitem>
- <para>
- Check whether there are any timed messages to be executed;
- if so, put these into the job buffer as well.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ Check whether there are any timed messages to be executed;
+ if so, put these into the job buffer as well.
+ </para>
+ </listitem>
- <listitem>
- <para>
- Execute (in a loop) any messages in the job buffer.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ Execute (in a loop) any messages in the job buffer.
+ </para>
+ </listitem>
- <listitem>
- <para>
- Send any distributed messages that were generated by
- executing the messages in the job buffer.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ Send any distributed messages that were generated by
+ executing the messages in the job buffer.
+ </para>
+ </listitem>
- <listitem>
- <para>
- Wait for any new incoming messages.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ Wait for any new incoming messages.
+ </para>
+ </listitem>
- </orderedlist>
+ </orderedlist>
- <para>
- The number of loops executed in the third step is reported as
- the <literal>Mean Loop Counter</literal>. This statistic
- increases in size as the utilisation of the TCP/IP buffer
- improves. You can use this to monitor performance as you add new
- processes to the cluster.
- </para>
+ <para>
+ The number of loops executed in the third step is reported as
+ the <literal>Mean Loop Counter</literal>. This statistic
+ increases in size as the utilisation of the TCP/IP buffer
+ improves. You can use this to monitor performance as you add
+ new processes to the cluster.
+ </para>
- <para>
- The <literal>Mean send size</literal> and <literal>Mean receive
- size</literal> statistics allow you to gauge the efficiency of
- writes and reads (respectively) between nodes. These values are
- given in bytes. Higher values mean a lower cost per byte sent or
- received; the maximum is 64k.
- </para>
+ <para>
+ The <literal>Mean send size</literal> and <literal>Mean
+ receive size</literal> statistics allow you to gauge the
+ efficiency of writes and reads (respectively) between nodes.
+ These values are given in bytes. Higher values mean a lower
+ cost per byte sent or received; the maximum is 64k.
+ </para>
- <para>
- To generate a report of all cluster log statistics, you can use
- the following command in the <literal>NDB</literal> management
- client:
- </para>
+ <para>
+ To generate a report of all cluster log statistics, you can
+ use the following command in the <literal>NDB</literal>
+ management client:
+ </para>
<programlisting>
ndb_mgm> <userinput>ALL CLUSTERLOG STATISTICS=15</userinput>
</programlisting>
- </section>
+ </section>
-
</section>
<section id="mysql-cluster-single-user-mode">
@@ -10230,7 +10269,7 @@
<primary>MySQL Cluster</primary>
<secondary>single-user mode</secondary>
</indexterm>
-
+
<indexterm>
<primary>single-user mode (MySQL Cluster)</primary>
</indexterm>
@@ -10370,7 +10409,7 @@
<primary>MySQL Cluster</primary>
<secondary>backups</secondary>
</indexterm>
-
+
<indexterm>
<primary>backups</primary>
<secondary>in MySQL Cluster</secondary>
@@ -10386,15 +10425,15 @@
<title>&title-mysql-cluster-backup-concepts;</title>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>backups</secondary>
- </indexterm>
-
- <indexterm>
- <primary>backups</primary>
- <secondary>in MySQL Cluster</secondary>
+ <primary>MySQL Cluster</primary>
+ <secondary>backups</secondary>
</indexterm>
+ <indexterm>
+ <primary>backups</primary>
+ <secondary>in MySQL Cluster</secondary>
+ </indexterm>
+
<para>
A backup is a snapshot of the database at a given time. The
backup consists of three main parts:
@@ -10493,15 +10532,15 @@
<title>&title-mysql-cluster-backup-using-management-server;</title>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>backups</secondary>
- </indexterm>
-
- <indexterm>
- <primary>backups</primary>
- <secondary>in MySQL Cluster</secondary>
+ <primary>MySQL Cluster</primary>
+ <secondary>backups</secondary>
</indexterm>
+ <indexterm>
+ <primary>backups</primary>
+ <secondary>in MySQL Cluster</secondary>
+ </indexterm>
+
<para>
Before starting a backup, make sure that the cluster is
properly configured for performing one. (See
@@ -10516,23 +10555,21 @@
<orderedlist>
<listitem>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><literal>START BACKUP</literal> command</secondary>
- </indexterm>
-
- <indexterm>
- <primary><literal>START BACKUP</literal> command (MySQL Cluster)</primary>
- </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><literal>START BACKUP</literal> command</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary><literal>START BACKUP</literal> command (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
Start the management server (<command>ndb_mgm</command>).
</para>
</listitem>
<listitem>
-
-
<para>
Execute the command <literal>START BACKUP</literal>.
</para>
@@ -10643,25 +10680,25 @@
<title>&title-mysql-cluster-restore;</title>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>backups</secondary>
- </indexterm>
-
- <indexterm>
- <primary>backups</primary>
- <secondary>in MySQL Cluster</secondary>
+ <primary>MySQL Cluster</primary>
+ <secondary>backups</secondary>
</indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>restoring backups</secondary>
- </indexterm>
-
- <indexterm>
- <primary>restoring backups</primary>
- <secondary>in MySQL Cluster</secondary>
+
+ <indexterm>
+ <primary>backups</primary>
+ <secondary>in MySQL Cluster</secondary>
</indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>restoring backups</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>restoring backups</primary>
+ <secondary>in MySQL Cluster</secondary>
+ </indexterm>
+
<remark role="todo">
Need to provide an example of ndb_restore usage or pointer to
same. [js]
@@ -10725,25 +10762,25 @@
<title>&title-mysql-cluster-backup-configuration;</title>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>backups</secondary>
- </indexterm>
-
- <indexterm>
- <primary>backups</primary>
- <secondary>in MySQL Cluster</secondary>
+ <primary>MySQL Cluster</primary>
+ <secondary>backups</secondary>
</indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>configuring</secondary>
- </indexterm>
-
- <indexterm>
- <primary>configuring backups</primary>
- <secondary>in MySQL Cluster</secondary>
+
+ <indexterm>
+ <primary>backups</primary>
+ <secondary>in MySQL Cluster</secondary>
</indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>configuring</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>configuring backups</primary>
+ <secondary>in MySQL Cluster</secondary>
+ </indexterm>
+
<para>
Four configuration parameters are essential for backup:
</para>
@@ -10754,6 +10791,7 @@
<indexterm>
<primary><literal>BackupDataBufferSize</literal></primary>
</indexterm>
+
<para>
<literal>BackupDataBufferSize</literal>
</para>
@@ -10768,6 +10806,7 @@
<indexterm>
<primary><literal>BackupLogBufferSize</literal></primary>
</indexterm>
+
<para>
<literal>BackupLogBufferSize</literal>
</para>
@@ -10782,6 +10821,7 @@
<indexterm>
<primary><literal>BackupMemory</literal></primary>
</indexterm>
+
<para>
<literal>BackupMemory</literal>
</para>
@@ -10797,6 +10837,7 @@
<indexterm>
<primary><literal>BackupWriteSize</literal></primary>
</indexterm>
+
<para>
<literal>BackupWriteSize</literal>
</para>
@@ -10821,20 +10862,20 @@
<title>&title-mysql-cluster-backup-troubleshooting;</title>
<indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>backups</secondary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>troubleshooting backups</secondary>
- </indexterm>
-
- <indexterm>
- <primary>backups, troubleshooting</primary>
- <secondary>in MySQL Cluster</secondary>
+ <primary>MySQL Cluster</primary>
+ <secondary>backups</secondary>
</indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>troubleshooting backups</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>backups, troubleshooting</primary>
+ <secondary>in MySQL Cluster</secondary>
+ </indexterm>
+
<para>
If an error code is returned when issuing a backup request,
the most likely cause is insufficient memory or insufficient
@@ -11964,8 +12005,8 @@
<listitem>
<para>
- The maximum permitted size of any one row is 8KB.
- Note that each <literal>BLOB</literal> or
+ The maximum permitted size of any one row is 8KB. Note
+ that each <literal>BLOB</literal> or
<literal>TEXT</literal> column contributes a maximum of
256 bytes towards this total.
</para>
@@ -12841,7 +12882,7 @@
Cluster on any but the three platforms mentioned here should
be considered alpha software (at best), cannot be guaranteed
reliable in a production setting, and <emphasis>is not
- supported by MySQL AB</emphasis>.
+ supported by MySQL AB</emphasis>.
</para>
</listitem>
@@ -12898,9 +12939,9 @@
</para>
<para>
- (We have implemented disk data storage for MySQL Cluster in MySQL
- 5.1, but we have no plans to add this capability in MySQL
- ¤t-series;.)
+ (We have implemented disk data storage for MySQL Cluster in
+ MySQL 5.1, but we have no plans to add this capability in
+ MySQL ¤t-series;.)
</para>
<para>
Modified: trunk/refman-5.1/ndbcluster.xml
===================================================================
--- trunk/refman-5.1/ndbcluster.xml 2006-05-24 14:44:04 UTC (rev 2188)
+++ trunk/refman-5.1/ndbcluster.xml 2006-05-24 14:46:48 UTC (rev 2189)
@@ -1004,8 +1004,8 @@
</indexterm>
<para>
- Each MySQL Cluster host computer running data or SQL nodes
- must have installed on it a MySQL server binary. For management
+ Each MySQL Cluster host computer running data or SQL nodes must
+ have installed on it a MySQL server binary. For management
nodes, it is not necessary to install the MySQL server binary,
but you do have to install the MGM server daemon and client
binaries (<command>ndb_mgmd</command> and
@@ -1504,7 +1504,7 @@
instances that are needed for recovery, including the
recovery log files.
</para>
-
+
<para>
An exception to this is that <option>--initial</option> does
not delete Disk Data files. If you do need to perform an
@@ -4492,9 +4492,8 @@
</para>
<para>
- Replication
- between clusters also makes use of
- internal triggers.
+ Replication between clusters also makes use of internal
+ triggers.
</para>
<para>
@@ -5986,18 +5985,18 @@
<section id="mysql-cluster-direct-tcp-definition">
<title>&title-mysql-cluster-direct-tcp-definition;</title>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>networking</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>transporters</secondary>
<tertiary>TCP/IP</tertiary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>direct connections between nodes</secondary>
@@ -6066,22 +6065,22 @@
<section id="mysql-cluster-shm-definition">
<title>&title-mysql-cluster-shm-definition;</title>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>networking</secondary>
</indexterm>
-
+
<indexterm>
<primary>shared memory transporter</primary>
<see>MySQL Cluster</see>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>shared memory transport</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>transporters</secondary>
@@ -6121,11 +6120,12 @@
<indexterm>
<primary>node identifiers (MySQL Cluster)</primary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>node identifiers</secondary>
</indexterm>
+
<para>
<literal>NodeId1</literal>, <literal>NodeId2</literal>
</para>
@@ -6141,6 +6141,7 @@
<indexterm>
<primary><literal>ShmKey</literal></primary>
</indexterm>
+
<para>
<literal>ShmKey</literal>
</para>
@@ -6157,6 +6158,7 @@
<indexterm>
<primary><literal>ShmSize</literal></primary>
</indexterm>
+
<para>
<literal>ShmSize</literal>
</para>
@@ -6173,6 +6175,7 @@
<indexterm>
<primary><literal>SendSignalId</literal></primary>
</indexterm>
+
<para>
<literal>SendSignalId</literal>
</para>
@@ -6190,6 +6193,7 @@
<indexterm>
<primary><literal>Checksum</literal> (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal>Checksum</literal>
</para>
@@ -6216,29 +6220,28 @@
<section id="mysql-cluster-sci-definition">
<title>&title-mysql-cluster-sci-definition;</title>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>networking</secondary>
</indexterm>
-
+
<indexterm>
<primary>SCI (Scalable Coherent Interface)</primary>
<see>MySQL Cluster</see>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>SCI (Scalable Coherent Interface)</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>transporters</secondary>
<tertiary>Scalable Coherent Interface (SCI)</tertiary>
</indexterm>
-
<para>
<literal>[SCI]</literal> sections in the
<filename>config.ini</filename> file explicitly define SCI
@@ -6276,11 +6279,12 @@
<indexterm>
<primary>node identifiers (MySQL Cluster)</primary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>node identifiers</secondary>
</indexterm>
+
<para>
<literal>NodeId1</literal>, <literal>NodeId2</literal>
</para>
@@ -6296,6 +6300,7 @@
<indexterm>
<primary><literal>Host*SciId*</literal> parameters</primary>
</indexterm>
+
<para>
<literal>Host1SciId0</literal>
</para>
@@ -6346,6 +6351,7 @@
<indexterm>
<primary><literal>SharedBufferSize</literal></primary>
</indexterm>
+
<para>
<literal>SharedBufferSize</literal>
</para>
@@ -6365,6 +6371,7 @@
<indexterm>
<primary><literal>SendLimit</literal></primary>
</indexterm>
+
<para>
<literal>SendLimit</literal>
</para>
@@ -6383,6 +6390,7 @@
<indexterm>
<primary><literal>SendSignalId</literal></primary>
</indexterm>
+
<para>
<literal>SendSignalId</literal>
</para>
@@ -6399,6 +6407,7 @@
<indexterm>
<primary><literal>Checksum</literal> (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal>Checksum</literal>
</para>
@@ -6433,17 +6442,17 @@
<section id="mysql-cluster-upgrade-downgrade">
<title>&title-mysql-cluster-upgrade-downgrade;</title>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>upgrades and downgrades</secondary>
</indexterm>
-
+
<indexterm>
<primary>upgrades</primary>
<secondary>MySQL Cluster</secondary>
</indexterm>
-
+
<indexterm>
<primary>downgrades</primary>
<secondary>MySQL Cluster</secondary>
@@ -6474,27 +6483,26 @@
<section id="mysql-cluster-upgrade-downgrade-rolling">
<title>&title-mysql-cluster-upgrade-downgrade-rolling;</title>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>upgrades and downgrades</secondary>
</indexterm>
-
+
<indexterm>
<primary>rolling upgrades and downgrades (MySQL Cluster)</primary>
</indexterm>
-
- <indexterm>
- <primary>upgrades</primary>
- <secondary>MySQL Cluster</secondary>
- </indexterm>
-
- <indexterm>
- <primary>downgrades</primary>
- <secondary>MySQL Cluster</secondary>
- </indexterm>
+ <indexterm>
+ <primary>upgrades</primary>
+ <secondary>MySQL Cluster</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>downgrades</primary>
+ <secondary>MySQL Cluster</secondary>
+ </indexterm>
+
<para>
This section discusses how to perform a <firstterm>rolling
upgrade</firstterm> of a MySQL Cluster installation, so called
@@ -6526,6 +6534,7 @@
<primary>MySQL Cluster</primary>
<secondary>configuration changes</secondary>
</indexterm>
+
<para>
<emphasis role="bold">Cluster Configuration
Change</emphasis>: To make a change in the cluster's
@@ -6556,6 +6565,7 @@
<primary>MySQL Cluster</primary>
<secondary>resetting</secondary>
</indexterm>
+
<para>
<emphasis role="bold">Cluster Reset</emphasis>: To reset the
cluster because it has reached an undesirable state
@@ -6806,27 +6816,27 @@
<section id="mysql-cluster-upgrade-downgrade-compatibility">
<title>&title-mysql-cluster-upgrade-downgrade-compatibility;</title>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>upgrades and downgrades</secondary>
</indexterm>
-
+
<indexterm>
<primary>upgrades and downgrades (MySQL Cluster)</primary>
<secondary>compatibility between versions</secondary>
</indexterm>
-
- <indexterm>
- <primary>upgrades</primary>
- <secondary>MySQL Cluster</secondary>
- </indexterm>
-
- <indexterm>
- <primary>downgrades</primary>
- <secondary>MySQL Cluster</secondary>
- </indexterm>
+ <indexterm>
+ <primary>upgrades</primary>
+ <secondary>MySQL Cluster</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>downgrades</primary>
+ <secondary>MySQL Cluster</secondary>
+ </indexterm>
+
<para>
This section provides information regarding Cluster software and
table file compatibility between differing versions of the MySQL
@@ -7169,20 +7179,20 @@
<section id="mysql-cluster-process-management">
<title>&title-mysql-cluster-process-management;</title>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>process management</secondary>
</indexterm>
-
+
<indexterm>
<primary>process management (MySQL Cluster)</primary>
</indexterm>
-
+
<indexterm>
<primary>managing MySQL Cluster processes</primary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster processes (types)</primary>
</indexterm>
@@ -7226,26 +7236,26 @@
<section id="mysqld-process">
<title>&title-mysqld-process;</title>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary><command>mysqld</command> process</secondary>
</indexterm>
-
+
<indexterm>
<primary><command>mysqld</command></primary>
<secondary>as MySQL Cluster process</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>SQL nodes</secondary>
</indexterm>
-
+
<indexterm>
<primary>SQL nodes (MySQL Cluster)</primary>
</indexterm>
-
+
<indexterm>
<primary>API nodes</primary>
<see>SQL nodes</see>
@@ -7302,16 +7312,16 @@
<literal>DISABLED</literal> in this row, you need to enable it
in either one of the two ways just described.
</para>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>configuration</secondary>
</indexterm>
-
+
<indexterm>
<primary>configuring MySQL Cluster</primary>
</indexterm>
-
+
<indexterm>
<primary><filename>my.cnf</filename></primary>
<secondary>in MySQL Cluster</secondary>
@@ -7391,28 +7401,30 @@
<section id="ndbd-process">
<title>&title-ndbd-process;</title>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary><command>ndbd</command> process</secondary>
</indexterm>
-
+
<indexterm>
<primary><command>ndbd</command> (MySQL Cluster process)</primary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>data nodes</secondary>
</indexterm>
-
+
<indexterm>
<primary>data nodes (MySQL Cluster)</primary>
</indexterm>
-
+
<indexterm>
<primary>storage nodes</primary>
- <see>data nodes, <command>ndbd</command></see>
+ <see>data nodes, <command>ndbd</command>
+
+ </see>
</indexterm>
<para>
@@ -7434,12 +7446,12 @@
<remark role="todo">
[js] Insert figure here?
</remark>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>log files</secondary>
</indexterm>
-
+
<indexterm>
<primary>log files (MySQL Cluster)</primary>
</indexterm>
@@ -7458,15 +7470,15 @@
<itemizedlist>
<listitem>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>error logs</secondary>
- </indexterm>
-
- <indexterm>
- <primary>error logs (MySQL Cluster)</primary>
- </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>error logs</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>error logs (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
<filename>ndb_<replaceable>node_id</replaceable>_error.log</filename>
is a file containing records of all crashes which the
@@ -7504,15 +7516,15 @@
</listitem>
<listitem>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>trace files</secondary>
- </indexterm>
-
- <indexterm>
- <primary>trace files (MySQL Cluster)</primary>
- </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>trace files</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>trace files (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
<filename>ndb_<replaceable>node_id</replaceable>_trace.log.<replaceable>trace_id</replaceable></filename>
is a trace file describing exactly what happened just before
@@ -7632,32 +7644,35 @@
<section id="ndb-mgmd-process">
<title>&title-ndb-mgmd-process;</title>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary><command>mgmd</command> process</secondary>
</indexterm>
-
+
<indexterm>
<primary><command>mgmd</command> (MySQL Cluster process)</primary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>management nodes</secondary>
</indexterm>
-
+
<indexterm>
<primary>management nodes (MySQL Cluster)</primary>
- <seealso><command>mgmd</command></seealso>
+ <seealso><command>mgmd</command>
+
+ </seealso>
</indexterm>
-
+
<indexterm>
<primary><command>ndb_mgmd</command></primary>
- <see><command>mgmd</command></see>
+ <see><command>mgmd</command>
+
+ </see>
</indexterm>
-
<para>
The management server is the process that reads the cluster
configuration file and distributes this information to all nodes
@@ -7693,19 +7708,19 @@
<itemizedlist>
<listitem>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>configuration</secondary>
- </indexterm>
-
- <indexterm>
- <primary>configuring MySQL Cluster</primary>
- </indexterm>
-
<indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>configuration</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>configuring MySQL Cluster</primary>
+ </indexterm>
+
+ <indexterm>
<primary><filename>config.ini</filename> (MySQL Cluster)</primary>
</indexterm>
+
<para>
<filename>config.ini</filename> is the configuration file
for the cluster as a whole. This file is created by the user
@@ -7760,36 +7775,40 @@
<section id="ndb-mgm-process">
<title>&title-ndb-mgm-process;</title>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary><command>mgm</command> process</secondary>
</indexterm>
-
+
<indexterm>
<primary><command>mgm</command> (MySQL Cluster process)</primary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>management client (<command>mgm</command>)</secondary>
</indexterm>
-
+
<indexterm>
<primary>management client (MySQL Cluster)</primary>
- <seealso><command>mgm</command></seealso>
+ <seealso><command>mgm</command>
+
+ </seealso>
</indexterm>
-
+
<indexterm>
<primary><command>ndb_mgm</command></primary>
- <see><command>mgm</command></see>
+ <see><command>mgm</command>
+
+ </see>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>administration</secondary>
</indexterm>
-
+
<indexterm>
<primary>administration of MySQL Cluster</primary>
</indexterm>
@@ -7838,32 +7857,32 @@
<section id="mysql-cluster-command-options">
<title>&title-mysql-cluster-command-options;</title>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>administration</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>commands</secondary>
</indexterm>
-
+
<indexterm>
<primary>command options</primary>
<secondary>MySQL Cluster</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary><command>ndbd</command></secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary><command>mgm</command></secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary><command>mgmd</command></secondary>
@@ -7981,7 +8000,7 @@
Cluster processes verifies that the versions of the binaries
being used can co-exist in the same cluster. This is also
important when performing an online (rolling) software
- upgrade of MySQL Cluster. (See
+ upgrade of MySQL Cluster. (See
<xref linkend="mysql-cluster-upgrade-downgrade-rolling"/>).
</para>
</listitem>
@@ -7991,28 +8010,28 @@
<section id="new-mysqld-command-options">
<title>&title-new-mysqld-command-options;</title>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>administration</secondary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>commands</secondary>
- </indexterm>
-
- <indexterm>
- <primary>command options</primary>
- <secondary>MySQL Cluster</secondary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><command>mysqld</command> process</secondary>
- </indexterm>
-
+
<indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>administration</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>commands</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>command options</primary>
+ <secondary>MySQL Cluster</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><command>mysqld</command> process</secondary>
+ </indexterm>
+
+ <indexterm>
<primary><command>mysqld</command></primary>
<secondary>as MySQL Cluster process</secondary>
</indexterm>
@@ -8055,27 +8074,27 @@
<section id="ndbd-command-options">
<title>&title-ndbd-command-options;</title>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>administration</secondary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>commands</secondary>
- </indexterm>
-
- <indexterm>
- <primary>command options</primary>
- <secondary>MySQL Cluster</secondary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><command>ndbd</command> process</secondary>
- </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>administration</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>commands</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>command options</primary>
+ <secondary>MySQL Cluster</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><command>ndbd</command> process</secondary>
+ </indexterm>
+
<para>
For options common to NDB programs, see
<xref linkend="mysql-cluster-command-options"/>.
@@ -8194,27 +8213,27 @@
<section id="ndb-mgmd-command-options">
<title>&title-ndb-mgmd-command-options;</title>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>administration</secondary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>commands</secondary>
- </indexterm>
-
- <indexterm>
- <primary>command options</primary>
- <secondary>MySQL Cluster</secondary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><command>mgmd</command> process</secondary>
- </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>administration</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>commands</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>command options</primary>
+ <secondary>MySQL Cluster</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><command>mgmd</command> process</secondary>
+ </indexterm>
+
<para>
For options common to NDB programs, see
<xref linkend="mysql-cluster-command-options"/>.
@@ -8273,27 +8292,27 @@
<section id="ndb-mgm-command-options">
<title>&title-ndb-mgm-command-options;</title>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>administration</secondary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>commands</secondary>
- </indexterm>
-
- <indexterm>
- <primary>command options</primary>
- <secondary>MySQL Cluster</secondary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><command>mgm</command> process</secondary>
- </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>administration</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>commands</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>command options</primary>
+ <secondary>MySQL Cluster</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><command>mgm</command> process</secondary>
+ </indexterm>
+
<para>
For options common to NDB programs, see
<xref linkend="mysql-cluster-command-options"/>.
@@ -8327,13 +8346,13 @@
<section id="mysql-cluster-management">
<title>&title-mysql-cluster-management;</title>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>managing</secondary>
- </indexterm>
-
+
<indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>managing</secondary>
+ </indexterm>
+
+ <indexterm>
<primary>managing MySQL Cluster</primary>
</indexterm>
@@ -8368,7 +8387,7 @@
<section id="mysql-cluster-startup-phases">
<title>&title-mysql-cluster-startup-phases;</title>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>starting or restarting</secondary>
@@ -8683,17 +8702,17 @@
<section id="mgm-client-commands">
<title>&title-mgm-client-commands;</title>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>administration</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>commands</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary><command>mgm</command> client</secondary>
@@ -8728,9 +8747,11 @@
<primary>MySQL Cluster</primary>
<secondary><literal>HELP</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>HELP</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal>HELP</literal>
</para>
@@ -8745,9 +8766,11 @@
<primary>MySQL Cluster</primary>
<secondary><literal>SHOW</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>SHOW</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal>SHOW</literal>
</para>
@@ -8769,9 +8792,11 @@
<primary>MySQL Cluster</primary>
<secondary><literal>START</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>START</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal><replaceable>node_id</replaceable> START</literal>
</para>
@@ -8789,9 +8814,11 @@
<primary>MySQL Cluster</primary>
<secondary><literal>STOP</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>STOP</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal><replaceable>node_id</replaceable> STOP</literal>
</para>
@@ -8809,9 +8836,11 @@
<primary>MySQL Cluster</primary>
<secondary><literal>RESTART</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>RESTART</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<remark role="todo">
[js] Need to explain -N and -I switches better.
</remark>
@@ -8832,9 +8861,11 @@
<primary>MySQL Cluster</primary>
<secondary><literal>STATUS</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>STATUS</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal><replaceable>node_id</replaceable> STATUS</literal>
</para>
@@ -8850,16 +8881,20 @@
<primary>MySQL Cluster</primary>
<secondary>single-user mode</secondary>
</indexterm>
+
<indexterm>
<primary>single-user mode (MySQL Cluster)</primary>
</indexterm>
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary><literal>ENTER SINGLE USER MODE</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>ENTER SINGLE USER MODE</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal>ENTER SINGLE USER MODE
<replaceable>node_id</replaceable></literal>
@@ -8877,9 +8912,11 @@
<primary>MySQL Cluster</primary>
<secondary><literal>EXIT SINGLE USER MODE</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>EXIT SINGLE USER MODE</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal>EXIT SINGLE USER MODE</literal>
</para>
@@ -8896,9 +8933,11 @@
<primary>MySQL Cluster</primary>
<secondary><literal>QUIT</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>QUIT</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal>QUIT</literal>
</para>
@@ -8913,9 +8952,11 @@
<primary>MySQL Cluster</primary>
<secondary><literal>SHUTDOWN</literal> command</secondary>
</indexterm>
+
<indexterm>
<primary><literal>SHUTDOWN</literal> command (MySQL Cluster)</primary>
</indexterm>
+
<para>
<literal>SHUTDOWN</literal>
</para>
@@ -8933,29 +8974,29 @@
<section id="mysql-cluster-event-reports">
<title>&title-mysql-cluster-event-reports;</title>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>event logs</secondary>
</indexterm>
-
+
<indexterm>
<primary>event logs (MySQL Cluster)</primary>
</indexterm>
-
+
<indexterm>
<primary>cluster logs</primary>
</indexterm>
-
+
<indexterm>
<primary>node logs (MySQL Cluster)</primary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>cluster logs</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>node logs</secondary>
@@ -8968,10 +9009,9 @@
<para>
MySQL Cluster provides two types of event log. These are the
- <firstterm>cluster log</firstterm>, which includes
- events generated by all cluster nodes, and the
- <firstterm>node logs</firstterm>, which are local to
- each data node.
+ <firstterm>cluster log</firstterm>, which includes events
+ generated by all cluster nodes, and the <firstterm>node
+ logs</firstterm>, which are local to each data node.
</para>
<para>
@@ -8998,12 +9038,12 @@
Each reportable event can be distinguished according to three
different criteria:
</para>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>event types</secondary>
</indexterm>
-
+
<indexterm>
<primary>event types (MySQL Cluster)</primary>
</indexterm>
@@ -9051,44 +9091,44 @@
<section id="mysql-cluster-logging-management-commands">
<title>&title-mysql-cluster-logging-management-commands;</title>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>event logs</secondary>
- </indexterm>
-
- <indexterm>
- <primary>event logs (MySQL Cluster)</primary>
- </indexterm>
-
- <indexterm>
- <primary>cluster logs</primary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>cluster logs</secondary>
- </indexterm>
-
- <indexterm>
- <primary>logging commands (MySQL Cluster)</primary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>logging commands</secondary>
- </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>event logs</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>event logs (MySQL Cluster)</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>cluster logs</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>cluster logs</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>logging commands (MySQL Cluster)</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>logging commands</secondary>
+ </indexterm>
+
<para>
The following management commands are related to the cluster
log:
</para>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary><literal>CLUSTERLOG</literal> commands</secondary>
</indexterm>
-
+
<indexterm>
<primary><literal>CLUSTERLOG</literal> commands (MySQL Cluster)</primary>
</indexterm>
@@ -9158,16 +9198,16 @@
has a priority with a value lower than or equal to the
priority threshold, it is reported in the cluster log.
</para>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>event logging thresholds</secondary>
- </indexterm>
-
- <indexterm>
- <primary>event logs (MySQL Cluster)</primary>
- </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>event logging thresholds</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>event logs (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
Note that events are reported per data node, and that the
threshold can be set to different values on different nodes.
@@ -9226,16 +9266,16 @@
events with priority 3 or lower are sent if the threshold is
3.
</para>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>event severity levels</secondary>
- </indexterm>
-
- <indexterm>
- <primary>event severity levels (MySQL Cluster)</primary>
- </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>event severity levels</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>event severity levels (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
The following table shows the event severity levels.
(<emphasis role="bold">Note</emphasis>: These correspond to
@@ -9304,16 +9344,16 @@
<section id="mysql-cluster-log-events">
<title>&title-mysql-cluster-log-events;</title>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>event log format</secondary>
- </indexterm>
-
- <indexterm>
- <primary>event log format (MySQL Cluster)</primary>
- </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>event log format</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>event log format (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
An event report reported in the event logs has the following
format:
@@ -9341,25 +9381,25 @@
Checkpoint</quote> and <quote>Local Checkpoint,</quote>
respectively.
</para>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>event types</secondary>
- </indexterm>
-
- <indexterm>
- <primary>event types (MySQL Cluster)</primary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><literal>CONNECTION</literal> Events</secondary>
- </indexterm>
-
- <indexterm>
- <primary><literal>CONNECTION</literal> Events (MySQL Cluster)</primary>
- </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>event types</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>event types (MySQL Cluster)</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><literal>CONNECTION</literal> Events</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary><literal>CONNECTION</literal> Events (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
<emphasis role="bold"><literal>CONNECTION</literal>
Events</emphasis>
@@ -9415,16 +9455,16 @@
<emphasis role="bold"><literal>CHECKPOINT</literal>
Events</emphasis>
</para>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><literal>CHECKPOINT</literal> Events</secondary>
- </indexterm>
-
- <indexterm>
- <primary><literal>CHECKPOINT</literal> Events (MySQL Cluster)</primary>
- </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><literal>CHECKPOINT</literal> Events</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary><literal>CHECKPOINT</literal> Events (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
The logging messages shown here are associated with
checkpoints.
@@ -9493,16 +9533,16 @@
<emphasis role="bold"><literal>STARTUP</literal>
Events</emphasis>
</para>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><literal>STARTUP</literal> Events</secondary>
- </indexterm>
-
- <indexterm>
- <primary><literal>STARTUP</literal> Events (MySQL Cluster)</primary>
- </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><literal>STARTUP</literal> Events</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary><literal>STARTUP</literal> Events (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
The following events are generated in response to the startup
of a node or of the cluster and of its success or failure.
@@ -9608,16 +9648,16 @@
<emphasis role="bold"><literal>NODERESTART</literal>
Events</emphasis>
</para>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><literal>NODERESTART</literal> Events</secondary>
- </indexterm>
-
- <indexterm>
- <primary><literal>NODERESTART</literal> Events (MySQL Cluster)</primary>
- </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><literal>NODERESTART</literal> Events</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary><literal>NODERESTART</literal> Events (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
The following events are generated when restarting a node and
relate to the success or failure of the node restart process.
@@ -9839,16 +9879,16 @@
<emphasis role="bold"><literal>STATISTICS</literal>
Events</emphasis>
</para>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><literal>STATISTICS</literal> Events</secondary>
- </indexterm>
-
- <indexterm>
- <primary><literal>STATISTICS</literal> Events (MySQL Cluster)</primary>
- </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><literal>STATISTICS</literal> Events</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary><literal>STATISTICS</literal> Events (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
The following events are of a statistical nature. They provide
information such as numbers of transactions and other
@@ -9921,16 +9961,16 @@
<emphasis role="bold"><literal>ERROR</literal>
Events</emphasis>
</para>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><literal>ERROR</literal> Events</secondary>
- </indexterm>
-
- <indexterm>
- <primary><literal>ERROR</literal> Events (MySQL Cluster)</primary>
- </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><literal>ERROR</literal> Events</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary><literal>ERROR</literal> Events (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
These events relate to Cluster errors and warnings. The
presence of one or more of these generally indicates that a
@@ -9990,16 +10030,16 @@
<emphasis role="bold"><literal>INFO</literal>
Events</emphasis>
</para>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><literal>INFO</literal> Events</secondary>
- </indexterm>
-
- <indexterm>
- <primary><literal>INFO</literal> Events (MySQL Cluster)</primary>
- </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><literal>INFO</literal> Events</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary><literal>INFO</literal> Events (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
These events provide general information about the state of
the cluster and activities associated with Cluster
@@ -10046,37 +10086,36 @@
<section id="mysql-cluster-log-statistics">
<title>&title-mysql-cluster-log-statistics;</title>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><literal>CLUSTERLOG STATISTICS</literal> command</secondary>
- </indexterm>
-
- <indexterm>
- <primary><literal>CLUSTERLOG STATISTICS</literal> command (MySQL Cluster)</primary>
- </indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
+ <secondary><literal>CLUSTERLOG STATISTICS</literal> command</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary><literal>CLUSTERLOG STATISTICS</literal> command (MySQL Cluster)</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
<secondary>administration</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>management commands</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary><command>mgm</command> management client</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>runtime statistics</secondary>
</indexterm>
-
<para>
The <literal>NDB</literal> management client's
<literal>CLUSTERLOG STATISTICS</literal> command can provide a
@@ -10145,7 +10184,7 @@
in an infinite loop. During each loop scheduler performs the
following tasks:
</para>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary><command>ndbd</command> process</secondary>
@@ -10220,12 +10259,12 @@
<section id="mysql-cluster-single-user-mode">
<title>&title-mysql-cluster-single-user-mode;</title>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>single-user mode</secondary>
</indexterm>
-
+
<indexterm>
<primary>single-user mode (MySQL Cluster)</primary>
</indexterm>
@@ -10301,7 +10340,7 @@
<programlisting>
NDB> <userinput>EXIT SINGLE USER MODE</userinput>
</programlisting>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>node failure (single-user mode)</secondary>
@@ -10360,12 +10399,12 @@
<section id="mysql-cluster-backup">
<title>&title-mysql-cluster-backup;</title>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>backups</secondary>
</indexterm>
-
+
<indexterm>
<primary>backups</primary>
<secondary>in MySQL Cluster</secondary>
@@ -10379,17 +10418,17 @@
<section id="mysql-cluster-backup-concepts">
<title>&title-mysql-cluster-backup-concepts;</title>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>backups</secondary>
- </indexterm>
-
- <indexterm>
- <primary>backups</primary>
- <secondary>in MySQL Cluster</secondary>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>backups</secondary>
</indexterm>
+ <indexterm>
+ <primary>backups</primary>
+ <secondary>in MySQL Cluster</secondary>
+ </indexterm>
+
<para>
A backup is a snapshot of the database at a given time. The
backup consists of three main parts:
@@ -10486,17 +10525,17 @@
<section id="mysql-cluster-backup-using-management-server">
<title>&title-mysql-cluster-backup-using-management-server;</title>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>backups</secondary>
- </indexterm>
-
- <indexterm>
- <primary>backups</primary>
- <secondary>in MySQL Cluster</secondary>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>backups</secondary>
</indexterm>
+ <indexterm>
+ <primary>backups</primary>
+ <secondary>in MySQL Cluster</secondary>
+ </indexterm>
+
<para>
Before starting a backup, make sure that the cluster is
properly configured for performing one. (See
@@ -10517,16 +10556,15 @@
</listitem>
<listitem>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary><literal>START BACKUP</literal> command</secondary>
- </indexterm>
-
- <indexterm>
- <primary><literal>START BACKUP</literal> command (MySQL Cluster)</primary>
- </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary><literal>START BACKUP</literal> command</secondary>
+ </indexterm>
+ <indexterm>
+ <primary><literal>START BACKUP</literal> command (MySQL Cluster)</primary>
+ </indexterm>
+
<para>
Execute the command <literal>START BACKUP</literal>.
</para>
@@ -10635,27 +10673,27 @@
<section id="mysql-cluster-restore">
<title>&title-mysql-cluster-restore;</title>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>backups</secondary>
- </indexterm>
-
- <indexterm>
- <primary>backups</primary>
- <secondary>in MySQL Cluster</secondary>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>backups</secondary>
</indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>restoring backups</secondary>
- </indexterm>
-
- <indexterm>
- <primary>restoring backups</primary>
- <secondary>in MySQL Cluster</secondary>
+
+ <indexterm>
+ <primary>backups</primary>
+ <secondary>in MySQL Cluster</secondary>
</indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>restoring backups</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>restoring backups</primary>
+ <secondary>in MySQL Cluster</secondary>
+ </indexterm>
+
<remark role="todo">
Need to provide an example of ndb_restore usage or pointer to
same. [js]
@@ -10717,27 +10755,27 @@
<section id="mysql-cluster-backup-configuration">
<title>&title-mysql-cluster-backup-configuration;</title>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>backups</secondary>
- </indexterm>
-
- <indexterm>
- <primary>backups</primary>
- <secondary>in MySQL Cluster</secondary>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>backups</secondary>
</indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>configuring</secondary>
- </indexterm>
-
- <indexterm>
- <primary>configuring backups</primary>
- <secondary>in MySQL Cluster</secondary>
+
+ <indexterm>
+ <primary>backups</primary>
+ <secondary>in MySQL Cluster</secondary>
</indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>configuring</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>configuring backups</primary>
+ <secondary>in MySQL Cluster</secondary>
+ </indexterm>
+
<para>
Four configuration parameters are essential for backup:
</para>
@@ -10748,6 +10786,7 @@
<indexterm>
<primary><literal>BackupDataBufferSize</literal></primary>
</indexterm>
+
<para>
<literal>BackupDataBufferSize</literal>
</para>
@@ -10762,6 +10801,7 @@
<indexterm>
<primary><literal>BackupLogBufferSize</literal></primary>
</indexterm>
+
<para>
<literal>BackupLogBufferSize</literal>
</para>
@@ -10776,6 +10816,7 @@
<indexterm>
<primary><literal>BackupMemory</literal></primary>
</indexterm>
+
<para>
<literal>BackupMemory</literal>
</para>
@@ -10791,6 +10832,7 @@
<indexterm>
<primary><literal>BackupWriteSize</literal></primary>
</indexterm>
+
<para>
<literal>BackupWriteSize</literal>
</para>
@@ -10813,22 +10855,22 @@
<section id="mysql-cluster-backup-troubleshooting">
<title>&title-mysql-cluster-backup-troubleshooting;</title>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>backups</secondary>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>troubleshooting backups</secondary>
- </indexterm>
-
- <indexterm>
- <primary>backups, troubleshooting</primary>
- <secondary>in MySQL Cluster</secondary>
+
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>backups</secondary>
</indexterm>
+ <indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>troubleshooting backups</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>backups, troubleshooting</primary>
+ <secondary>in MySQL Cluster</secondary>
+ </indexterm>
+
<para>
If an error code is returned when issuing a backup request,
the most likely cause is insufficient memory or insufficient
@@ -10862,28 +10904,28 @@
<section id="mysql-cluster-replication">
<title>&title-mysql-cluster-replication;</title>
-
- <indexterm>
- <primary>MySQL Cluster</primary>
- <secondary>replication</secondary>
- <seealso>MySQL Cluster replication</seealso>
- </indexterm>
-
- <indexterm>
- <primary>replication</primary>
- <secondary>in MySQL Cluster</secondary>
- <seealso>MySQL Cluster replication</seealso>
- </indexterm>
-
- <indexterm>
- <primary>MySQL Cluster replication</primary>
- </indexterm>
-
+
<indexterm>
+ <primary>MySQL Cluster</primary>
+ <secondary>replication</secondary>
+ <seealso>MySQL Cluster replication</seealso>
+ </indexterm>
+
+ <indexterm>
+ <primary>replication</primary>
+ <secondary>in MySQL Cluster</secondary>
+ <seealso>MySQL Cluster replication</seealso>
+ </indexterm>
+
+ <indexterm>
+ <primary>MySQL Cluster replication</primary>
+ </indexterm>
+
+ <indexterm>
<primary>asynchronous replication</primary>
<see>MySQL Cluster replication</see>
</indexterm>
-
+
<indexterm>
<primary>replication, asynchronous</primary>
<see>MySQL Cluster replication</see>
@@ -10947,7 +10989,7 @@
<section id="mysql-cluster-replication-abbreviations">
<title>&title-mysql-cluster-replication-abbreviations;</title>
-
+
<indexterm>
<primary>MySQL Cluster replication</primary>
<secondary>concepts</secondary>
@@ -11029,7 +11071,7 @@
<section id="mysql-cluster-replication-general">
<title>&title-mysql-cluster-replication-general;</title>
-
+
<indexterm>
<primary>MySQL Cluster replication</primary>
<secondary>concepts</secondary>
@@ -11100,7 +11142,7 @@
<section id="mysql-cluster-replication-issues">
<title>&title-mysql-cluster-replication-issues;</title>
-
+
<indexterm>
<primary>MySQL Cluster replication</primary>
<secondary>known issues</secondary>
@@ -11205,28 +11247,28 @@
<section id="mysql-cluster-replication-schema">
<title>&title-mysql-cluster-replication-schema;</title>
-
+
<indexterm>
<primary>MySQL Cluster replication</primary>
<secondary><literal>cluster</literal> database</secondary>
</indexterm>
-
+
<indexterm>
<primary><literal>cluster</literal> database</primary>
<seealso>MySQL Cluster replication</seealso>
</indexterm>
-
+
<indexterm>
- <primary><literal>cluster_replication</literal> database
- (deprecated)</primary>
+ <primary><literal>cluster_replication</literal> database (deprecated)</primary>
<see>MySQL Cluster replication</see>
</indexterm>
-
+
<indexterm>
- <primary><literal>binlog_index</literal> table (<literal>cluster</literal> database)</primary>
+ <primary><literal>binlog_index</literal> table (<literal>cluster</literal>
+ database)</primary>
<seealso>MySQL Cluster replication</seealso>
</indexterm>
-
+
<indexterm>
<primary><literal>cluster.binlog_index</literal> table</primary>
<see>MySQL Cluster replication</see>
@@ -11285,12 +11327,13 @@
<literal>binlog_index</literal> table</phrase>
</textobject>
</mediaobject>
-
+
<indexterm>
- <primary><literal>apply_status</literal> table (<literal>cluster</literal> database)</primary>
+ <primary><literal>apply_status</literal> table (<literal>cluster</literal>
+ database)</primary>
<seealso>MySQL Cluster replication</seealso>
</indexterm>
-
+
<indexterm>
<primary><literal>cluster.apply_status</literal> table</primary>
<see>MySQL Cluster replication</see>
@@ -11349,14 +11392,12 @@
<section id="mysql-cluster-replication-preparation">
<title>&title-mysql-cluster-replication-preparation;</title>
-
-
-
+
<indexterm>
<primary>MySQL Cluster replication</primary>
<secondary>preparing</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>preparing for replication</secondary>
@@ -11424,7 +11465,7 @@
Monitor, this can be accomplished with the <literal>CHANGE
MASTER TO</literal> statement:
</para>
-
+
<indexterm>
<primary><literal>CHANGE MASTER TO</literal> statement</primary>
<secondary>in MySQL Cluster</secondary>
@@ -11587,7 +11628,7 @@
<section id="mysql-cluster-replication-starting">
<title>&title-mysql-cluster-replication-starting;</title>
-
+
<indexterm>
<primary>MySQL Cluster replication</primary>
<secondary>starting</secondary>
@@ -11706,7 +11747,7 @@
<section id="mysql-cluster-replication-two-channels">
<title>&title-mysql-cluster-replication-two-channels;</title>
-
+
<indexterm>
<primary>MySQL Cluster replication</primary>
</indexterm>
@@ -11831,12 +11872,12 @@
<section id="mysql-cluster-replication-failover">
<title>&title-mysql-cluster-replication-failover;</title>
-
+
<indexterm>
<primary>MySQL Cluster replication</primary>
<secondary>failover</secondary>
</indexterm>
-
+
<indexterm>
<primary>failover</primary>
<secondary>in MySQL Cluster replication</secondary>
@@ -11867,10 +11908,10 @@
<listitem>
<indexterm>
- <primary><literal>binlog_index</literal> table
- (<literal>cluster</literal> database)</primary>
+ <primary><literal>binlog_index</literal> table (<literal>cluster</literal>
+ database)</primary>
</indexterm>
-
+
<para>
Using the information obtained from the query shown in Step
1, obtain the corresponding records from the
@@ -11966,22 +12007,22 @@
<section id="mysql-cluster-replication-backups">
<title>&title-mysql-cluster-replication-backups;</title>
-
+
<indexterm>
<primary>MySQL Cluster replication</primary>
<secondary>backups</secondary>
</indexterm>
-
+
<indexterm>
<primary>backups</primary>
<secondary>in MySQL Cluster replication</secondary>
</indexterm>
-
+
<indexterm>
<primary>MySQL Cluster replication</primary>
<secondary>restoring from backups</secondary>
</indexterm>
-
+
<indexterm>
<primary>restoring from backups</primary>
<secondary>in MySQL Cluster replication</secondary>
@@ -12040,7 +12081,7 @@
In this case, the backup can be started by executing
this statement on the replication master:
</para>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary><literal>START BACKUP</literal> command</secondary>
@@ -12308,12 +12349,12 @@
<section id="mysql-cluster-replication-auto-sync">
<title>&title-mysql-cluster-replication-auto-sync;</title>
-
- <indexterm>
- <primary>MySQL Cluster replication</primary>
- <secondary>backups</secondary>
- </indexterm>
+ <indexterm>
+ <primary>MySQL Cluster replication</primary>
+ <secondary>backups</secondary>
+ </indexterm>
+
<para>
It is possible to automate much of the process described in
the previous section (see
@@ -12321,13 +12362,12 @@
following Perl script <filename>reset-slave.pl</filename>
serves as an example of how you can do this.
</para>
-
+
<indexterm>
<primary>MySQL Cluster replication</primary>
- <secondary><filename>reset-slave.pl</filename> backup automation
- script</secondary>
+ <secondary><filename>reset-slave.pl</filename> backup automation script</secondary>
</indexterm>
-
+
<indexterm>
<primary><filename>reset-slave.pl</filename></primary>
<see>MySQL Cluster replication</see>
@@ -12520,7 +12560,7 @@
<section id="mysql-cluster-replication-schema-discovery">
<title>&title-mysql-cluster-replication-schema-discovery;</title>
-
+
<indexterm>
<primary>MySQL Cluster replication</primary>
<secondary>and schema changes</secondary>
@@ -13024,7 +13064,7 @@
(For help in calculating these values, see
<xref linkend="storage-requirements"/>.)
</para>
-
+
<para>
<emphasis role="bold">Note</emphasis>: Starting the cluster
with the <option>--initial</option> option does not remove
@@ -14289,8 +14329,8 @@
<listitem>
<para>
- The maximum permitted size of any one row is 8KB.
- Note that each <literal>BLOB</literal> or
+ The maximum permitted size of any one row is 8KB. Note
+ that each <literal>BLOB</literal> or
<literal>TEXT</literal> column contributes a maximum of
256 bytes towards this total.
</para>
@@ -14805,14 +14845,16 @@
</remark>
<remark role="todo">
- [pd] I see nothing for next-series.
- [js] Commented out reference for now.
+ [pd] I see nothing for next-series. [js] Commented out reference
+ for now.
</remark>
<para>
In this section, we discuss changes in the implementation of MySQL
Cluster in MySQL ¤t-series; as compared to MySQL
- &previous-series;. <!-- We will also discuss our roadmap for further
+ &previous-series;.
+
+<!-- We will also discuss our roadmap for further
improvements to MySQL Cluster as currently planned for MySQL
&next-series;. -->
</para>
@@ -15119,7 +15161,7 @@
Cluster on any but the three platforms mentioned here should
be considered alpha software (at best), cannot be guaranteed
reliable in a production setting, and <emphasis>is not
- supported by MySQL AB</emphasis>.
+ supported by MySQL AB</emphasis>.
</para>
</listitem>
@@ -15158,13 +15200,13 @@
</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
+ Previous to MySQL 5.1, Cluster was in-memory only. This meant
+ that all table data (including indexes) was stored in RAM. If
your data took up 1GB of space and you wanted to replicate it
- once in the cluster, you needed 2GB of memory to do so. This was in
- addition to the memory required by the operating system and
- any applications running on the cluster computers. This is still true
- of in-memory tables.
+ once in the cluster, you needed 2GB of memory to do so. This
+ was in addition to the memory required by the operating system
+ and any applications running on the cluster computers. This is
+ still true of in-memory tables.
</para>
<para>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r2189 - in trunk: ndbapi refman-4.1 refman-5.0 refman-5.1 | jon | 24 May |
