| List: | Commits | « Previous MessageNext Message » | |
| From: | jon | Date: | May 24 2006 4:44pm |
| Subject: | svn commit - mysqldoc@docsrva: r2188 - in trunk: ndbapi ndbapi/images refman-4.1 refman-5.0 refman-5.1 | ||
| View as plain text | |||
Author: jstephens Date: 2006-05-24 16:44:04 +0200 (Wed, 24 May 2006) New Revision: 2188 Log: Cluster chapter: - More indexterms (heaps more) - Reordered a couple of sections that had wandered out of order - Merged some unneeded diffs - Fixed a few misc. typos/wording issues NDBAPI: - Fixed bad path for image - Reduced class diagram size - Make depend Modified: trunk/ndbapi/Makefile trunk/ndbapi/images/Ndb-class.png 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/Makefile =================================================================== --- trunk/ndbapi/Makefile 2006-05-24 13:43:56 UTC (rev 2187) +++ trunk/ndbapi/Makefile 2006-05-24 14:44:04 UTC (rev 2188) @@ -39,7 +39,7 @@ # Dependency list for NDB API document # This variable is updated by "make depend" -NDBAPI_SRCS = $(NDBAPI_SRCS_EXTRA) ndbapi.xml overview.xml tips-tricks-problems.xml mgm-api.xml ndb-classes.xml errors.xml examples.xml +NDBAPI_SRCS = $(NDBAPI_SRCS_EXTRA) ndbapi.xml overview.xml tips-tricks-problems.xml mgm-api.xml ndb-classes.xml images/Ndb-class.png errors.xml examples.xml ndbapi-prepped.xml: $(NDBAPI_SRCS) Modified: trunk/ndbapi/images/Ndb-class.png =================================================================== (Binary files differ) Modified: trunk/ndbapi/ndb-classes.xml =================================================================== --- trunk/ndbapi/ndb-classes.xml 2006-05-24 13:43:56 UTC (rev 2187) +++ trunk/ndbapi/ndb-classes.xml 2006-05-24 14:44:04 UTC (rev 2188) @@ -183,7 +183,7 @@ <mediaobject> <imageobject> - <imagedata fileref="images/ndb-class.png" format="PNG"/> + <imagedata fileref="images/Ndb-class.png" format="PNG"/> </imageobject> <textobject> <phrase lang="en"> Modified: trunk/refman-4.1/ndbcluster.xml =================================================================== --- trunk/refman-4.1/ndbcluster.xml 2006-05-24 13:43:56 UTC (rev 2187) +++ trunk/refman-4.1/ndbcluster.xml 2006-05-24 14:44:04 UTC (rev 2188) @@ -1009,7 +1009,7 @@ </indexterm> <para> - Each MySQL Cluster host computer running storage or SQL nodes + 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 @@ -2858,6 +2858,10 @@ </listitem> </orderedlist> + <para> + However, these are now deprecated and should not be used + for new installations. + </para> </listitem> </itemizedlist> @@ -5960,8 +5964,7 @@ <listitem> <indexterm> - <primary><literal>ReceiveBufferMemory</literal> (MySQL Cluster configuration - parameter)</primary> + <primary><literal>ReceiveBufferMemory</literal></primary> </indexterm> <para> @@ -5984,6 +5987,22 @@ <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> + </indexterm> + <para> Setting up a cluster using direct connections between data nodes requires specifying explicitly the crossover IP @@ -6048,6 +6067,27 @@ <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> + <tertiary>shared memory (SHM)</tertiary> + </indexterm> + <para> Beginning with MySQL 4.1.9-max, MySQL Cluster will attempt to use the shared memory transporter and configure it @@ -6077,6 +6117,14 @@ <itemizedlist> <listitem> + <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> @@ -6089,6 +6137,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ShmKey</literal></primary> + </indexterm> <para> <literal>ShmKey</literal> </para> @@ -6102,6 +6153,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ShmSize</literal></primary> + </indexterm> <para> <literal>ShmSize</literal> </para> @@ -6115,6 +6169,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>SendSignalId</literal></primary> + </indexterm> <para> <literal>SendSignalId</literal> </para> @@ -6129,6 +6186,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>Checksum</literal> (MySQL Cluster)</primary> + </indexterm> <para> <literal>Checksum</literal> </para> @@ -6156,6 +6216,28 @@ <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 @@ -6190,6 +6272,14 @@ <itemizedlist> <listitem> + <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> @@ -6202,6 +6292,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>Host*SciId*</literal> parameters</primary> + </indexterm> <para> <literal>Host1SciId0</literal> </para> @@ -6249,6 +6342,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>SharedBufferSize</literal></primary> + </indexterm> <para> <literal>SharedBufferSize</literal> </para> @@ -6265,6 +6361,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>SendLimit</literal></primary> + </indexterm> <para> <literal>SendLimit</literal> </para> @@ -6280,6 +6379,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>SendSignalId</literal></primary> + </indexterm> <para> <literal>SendSignalId</literal> </para> @@ -6293,6 +6395,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>Checksum</literal> (MySQL Cluster)</primary> + </indexterm> <para> <literal>Checksum</literal> </para> @@ -6310,11 +6415,6 @@ </itemizedlist> - <remark> - @node MySQL Cluster Complex Configuration, , MySQL Cluster SHM - Definition, MySQL Cluster Config File - </remark> - <remark role="todo"> [js] What is meant by "parts" here?? </remark> @@ -6329,10 +6429,763 @@ </section> + <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> + </indexterm> + + <para> + This portion of the MySQL Cluster chapter covers upgrading and + downgrading a MySQL Cluster from one MySQL release to another. It + discusses different types of Cluster upgrades and downgrades, and + provides a Cluster upgrade/downgrade compatibility matrix (see + <xref + linkend="mysql-cluster-upgrade-downgrade-compatibility"/>). + </para> + + <para> + <emphasis role="bold">Important</emphasis>: You are expected + already to be familiar with installing and configuring a MySQL + Cluster prior to attempting an upgrade or downgrade. See + <xref + linkend="mysql-cluster-configuration"/>. + </para> + + <para> + This section remains in development, and will be updated and + expanded considerably during the second quarter of 2006. + </para> + + <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> + + + <para> + This section discusses how to perform a <firstterm>rolling + upgrade</firstterm> of a MySQL Cluster installation, so called + because it involves stopping and starting (or restarting) each + node in turn, so that the cluster itself remains operational. + This type of upgrade is done where high availability of the + cluster is mandatory and no downtime of the cluster as a whole + is permissible. The information provided here also applies to + downgrades as well. + </para> + + <remark role="todo"> + [js] Possibly move this reference - and the matrix to which it + refers - to a separate Compatibility Matrix subsection of the + Cluster Upgrades section if/when it is created. For now, I'll + leave info covering all MySQL versions that support Cluster in + this matrix; eventually, we may wish to split it up. + </remark> + + <para> + There are a number of reasons why a rolling upgrade (or + downgrade) might be desired: + </para> + + <itemizedlist> + + <listitem> + <indexterm> + <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 + configuration, such as adding an SQL node or setting a + configuration parameter to a new value + </para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">Cluster Software + Upgrade/Downgrade</emphasis>: To upgrade the cluster to a + newer version of the MySQL Cluster software (or to downgrade + it to an older version) + </para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">Change on Node Host</emphasis>: To + make changes in the hardware or operating system on which + one or more cluster nodes are running + </para> + </listitem> + + <listitem> + <indexterm> + <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 + </para> + </listitem> + + </itemizedlist> + + <para> + The process for performing a rolling upgrade may be generalised + as follows: + </para> + + <orderedlist> + + <listitem> + <para> + Stop, reconfigure, then restart each cluster management node + (<command>ndb_mgmd</command> process) in turn + </para> + </listitem> + + <listitem> + <para> + Stop, reconfigure, then restart each cluster data node + (<command>ndbd</command> process) in turn + </para> + </listitem> + + </orderedlist> + + <para> + The specifics for implementing a particular rolling upgrade + depend upon the actual changes being made. A more detailed view + of the process is presented in the table shown here: + </para> + + <table> + <caption> Steps for Cluster rolling upgrades — by + upgrade type </caption> + <tbody> + <tr> + <th colspan="8">UPGRADE TYPE:</th> + </tr> + <tr> + <th colspan="2">Cluster Configuration Change</th> + <th colspan="2">Cluster Software Upgrade/Downgrade</th> + <th colspan="2">Change on Node Host</th> + <th colspan="2">Cluster Reset</th> + </tr> + <tr> + <th colspan="8">A. For each <command>ndb_mgmd</command> + process...</th> + </tr> + <tr> + <td colspan="2" rowspan="2"> + <orderedlist> + + <listitem> + <para> + Stop <command>ndb_mgmd</command> + </para> + </listitem> + + <listitem> + <para> + Make change in configuration file + </para> + </listitem> + + <listitem> + <para> + Start <command>ndb_mgmd</command> + </para> + </listitem> + + </orderedlist> + </td> + <td colspan="2" rowspan="2"> + <orderedlist> + + <listitem> + <para> + Stop <command>ndb_mgmd</command> + </para> + </listitem> + + <listitem> + <para> + Replace <command>ndb_mgmd</command> binary with new + version + </para> + </listitem> + + <listitem> + <para> + Start <command>ndb_mgmd</command> + </para> + </listitem> + + </orderedlist> + </td> + <td colspan="2" rowspan="2"> + <orderedlist> + + <listitem> + <para> + Stop <command>ndb_mgmd</command> + </para> + </listitem> + + <listitem> + <para> + Make desired changes in hardware/operating system + </para> + </listitem> + + <listitem> + <para> + Start <command>ndb_mgmd</command> + </para> + </listitem> + + </orderedlist> + </td> + <th colspan="2">( OR )</th> + </tr> + <tr> + <td> + <orderedlist> + + <listitem> + <para> + Stop <command>ndb_mgmd</command> + </para> + </listitem> + + <listitem> + <para> + Start <command>ndb_mgmd</command> + </para> + </listitem> + + </orderedlist> + </td> + <td> Restart <command>ndb_mgmd</command> (optional) </td> + </tr> + <tr> + <th colspan="8">B. For each <command>ndbd</command> + process...</th> + </tr> + <tr> + <th colspan="2">( OR )</th> + <td colspan="2" rowspan="2"> + <orderedlist> + + <listitem> + <para> + Stop <command>ndbd</command> + </para> + </listitem> + + <listitem> + <para> + Replace <command>ndbd</command> binary with new + version + </para> + </listitem> + + <listitem> + <para> + Start <command>ndbd</command> + </para> + </listitem> + + </orderedlist> + </td> + <td colspan="2" rowspan="2"> + <orderedlist> + + <listitem> + <para> + Stop <command>ndbd</command> + </para> + </listitem> + + <listitem> + <para> + Make desired changes in hardware/operating system + </para> + </listitem> + + <listitem> + <para> + Start <command>ndbd</command> + </para> + </listitem> + + </orderedlist> + </td> + <th colspan="2">( OR )</th> + </tr> + <tr> + <td> + <orderedlist> + + <listitem> + <para> + Stop <command>ndbd</command> + </para> + </listitem> + + <listitem> + <para> + Start <command>ndbd</command> + </para> + </listitem> + + </orderedlist> + </td> + <td> Restart <command>ndbd</command> + </td> + <td> + <orderedlist> + + <listitem> + <para> + Stop <command>ndbd</command> + </para> + </listitem> + + <listitem> + <para> + Start <command>ndbd</command> + </para> + </listitem> + + </orderedlist> + </td> + <td> Restart <command>ndbd</command> + </td> + </tr> + </tbody> + </table> + + </section> + + <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> + + <para> + This section provides information regarding Cluster software and + table file compatibility between differing versions of the MySQL + Server for purposes of performing upgrades and downgrades. + </para> + + <para> + <emphasis role="bold">Important</emphasis>: Only compatibility + between MySQL versions with regard to <literal>NDB + Cluster</literal> is taken into account in this section, and + there are likely other issues to be considered. <emphasis>As + with any other MySQL software upgrade or downgrade, you are + strongly encouraged to review the relevant portions of the MySQL + Manual for the MySQL versions from which and to which you intend + to migrate, before attempting an upgrade or downgrade of the + MySQL Cluster software</emphasis>. See + <xref linkend="upgrade"/>. + </para> + + <remark role="note"> + [js] Table info extracted from the file + mysql-5.2/storage/ndb/src/common/util/version.c + </remark> + + <remark role="todo"> + [js] Update as new server versions are released + </remark> + + <para> + The following table shows Cluster upgrade and downgrade + compatibility between different versions of the MySQL Server. + </para> + + <table> + <caption> Cluster Upgrade/Downgrade Compatibility — by + MySQL Server version </caption> + <tbody> + <tr> + <td colspan="2"> + <para> + <emphasis role="bold">MySQL 4.1</emphasis> + </para> + </td> + <td> </td> + <td colspan="2"> + <para> + <emphasis role="bold">MySQL 5.0</emphasis> + </para> + </td> + <td> </td> + <td colspan="2"> + <para> + <emphasis role="bold">MySQL 5.1</emphasis> + </para> + </td> + </tr> + <tr> + <td colspan="3"> </td> + <td>5.0.21</td> + <td>⇕</td> + <td colspan="3"> </td> + </tr> + <tr> + <td colspan="3"> </td> + <td>5.0.20</td> + <td>⇕</td> + <td colspan="3"> </td> + </tr> + <tr> + <td colspan="3"> </td> + <td>5.0.19</td> + <td>⇕</td> + <td colspan="3"> </td> + </tr> + <tr> + <td colspan="3"> </td> + <td>5.0.18</td> + <td>⇕</td> + <td colspan="3"> </td> + </tr> + <tr> + <td colspan="3"> </td> + <td>5.0.17</td> + <td>⇕</td> + <td colspan="3"> </td> + </tr> + <tr> + <td colspan="3"> </td> + <td>5.0.16</td> + <td>⇕</td> + <td colspan="3"> </td> + </tr> + <tr> + <td colspan="3"> </td> + <td>5.0.15</td> + <td>⇕</td> + <td colspan="3"> </td> + </tr> + <tr> + <td colspan="3"> </td> + <td>5.0.14</td> + <td>⇕</td> + <td colspan="3"> </td> + </tr> + <tr> + <td>4.1.19</td> + <td>⇕</td> + <td> </td> + <td>5.0.13</td> + <td>⇕</td> + <td colspan="3"> </td> + </tr> + <tr> + <td>4.1.18</td> + <td>⇕</td> + <td> </td> + <td>5.0.12</td> + <td>⇕</td> + <td colspan="3"> </td> + </tr> + <tr> + <td>4.1.17</td> + <td>⇕</td> + <td> </td> + <td>5.0.11</td> + <td>⇑ (see Notes)</td> + <td colspan="3"> </td> + </tr> + <tr> + <td>4.1.16</td> + <td>⇕</td> + <td> </td> + <td>5.0.10</td> + <td>⇕</td> + <td colspan="3"> </td> + </tr> + <tr> + <td>4.1.15</td> + <td>⇑ (see Notes)</td> + <td> </td> + <td>5.0.9</td> + <td>⇕</td> + <td colspan="3"> </td> + </tr> + <tr> + <td>4.1.14</td> + <td>⇕</td> + <td> </td> + <td>5.0.8</td> + <td>⇕</td> + <td> </td> + <td>5.1.10</td> + <td>⇕</td> + </tr> + <tr> + <td>4.1.13</td> + <td>⇕</td> + <td> </td> + <td>5.0.7</td> + <td>⇕</td> + <td> </td> + <td>5.1.9</td> + <td>⇕</td> + </tr> + <tr> + <td>4.1.12</td> + <td>⇕</td> + <td> </td> + <td>5.0.6</td> + <td>⇕</td> + <td> </td> + <td>5.1.7</td> + <td>⇕</td> + </tr> + <tr> + <td>4.1.11</td> + <td>⇕</td> + <td> </td> + <td>5.0.5</td> + <td>⇕</td> + <td> </td> + <td>5.1.6</td> + <td>⇕</td> + </tr> + <tr> + <td>4.1.10</td> + <td>⇕</td> + <td> </td> + <td>5.0.4</td> + <td>⇕</td> + <td> </td> + <td>5.1.5</td> + <td>⇕</td> + </tr> + <tr> + <td>4.1.9</td> + <td>⇑ / ⇓ (see Notes)</td> + <td> </td> + <td>5.0.3</td> + <td>⇕</td> + <td> </td> + <td>5.1.4</td> + <td>⇕</td> + </tr> + <tr> + <td>4.1.8</td> + <td>⇑</td> + <td> </td> + <td>5.0.2</td> + <td>⇑</td> + <td> </td> + <td>5.1.3</td> + <td>⇕</td> + </tr> + <tr> + <td colspan="1"> + <para> + <emphasis>KEY</emphasis>: + </para> + </td> + <td colspan="7"> + <itemizedlist> + + <listitem> + <para> + ⇕: Upwardly and downwardly compatible + </para> + </listitem> + + <listitem> + <para> + ⇑: Upwardly compatible only + </para> + </listitem> + + <listitem> + <para> + ⇓: Downwardly compatible only + </para> + </listitem> + + </itemizedlist> + </td> + </tr> + </tbody> + </table> + + <para> + <emphasis role="bold">Notes</emphasis>: + </para> + + <itemizedlist> + + <listitem> + <para> + <emphasis role="bold">4.1 Series</emphasis>: + </para> + + <para> + You cannot upgrade directly from 4.1.8 to 4.1.10 (or newer); + you must first upgrade from 4.1.8 to 4.1.9, then upgrade to + 4.1.10. Similarly, you cannot downgrade directly from 4.1.10 + (or newer) to 4.1.8; you must first downgrade from 4.1.10 to + 4.1.9, then downgrade from 4.1.9 to 4.1.8. + </para> + + <para> + If you wish to upgrade a MySQL Cluster to 4.1.15, you must + upgrade to 4.1.14 first, and you must upgrade to 4.1.15 + before upgrading to 4.1.16 or newer. + </para> + + <para> + Cluster downgrades from 4.1.15 to 4.1.14 (or earlier + versions) are not supported. + </para> + + <para> + Cluster upgrades from MySQL Server versions previous to + 4.1.8 are not supported; when upgrading from these, you must + dump all <literal>NDB</literal> tables, install the new + version of the software, and then reload the tables from the + dump. + </para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">5.0 Series</emphasis>: + </para> + + <para> + MySQL 5.0.2 was the first public release in this series. + </para> + + <para> + Cluster downgrades from MySQL 5.0 to MySQL 4.1 are not + supported. + </para> + + <para> + Cluster downgrades from 5.0.12 to 5.0.11 (or earlier) are + not supported. + </para> + + <para> + You cannot restore with <command>ndb_restore</command> to a + MySQL 5.0 Cluster using a backup made from a Cluster running + MySQL 5.1. You must use <command>mysqldump</command> in such + cases. + </para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">5.1 Series</emphasis>: + </para> + + <para> + MySQL 5.1.3 was the first public release in this series. + </para> + + <para> + You cannot downgrade a MySQL 5.1.6 or later Cluster using + Disk Data tables to MySQL 5.1.5 or earlier unless you + convert all such tables to in-memory Cluster tables first. + </para> + + <para> + There was no public release for MySQL 5.1.8. + </para> + </listitem> + + </itemizedlist> + + </section> + + </section> + <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> + <para> Understanding how to manage MySQL Cluster requires a knowledge of four essential processes. In the next few sections of this @@ -6373,6 +7226,30 @@ <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> + </indexterm> + <para> <command>mysqld</command> is the traditional MySQL server process. To be used with MySQL Cluster, @@ -6426,6 +7303,20 @@ 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> + </indexterm> + <para> To read cluster configuration data, the MySQL server requires at a minimum three pieces of information: @@ -6502,6 +7393,29 @@ <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> + </indexterm> + <para> <command>ndbd</command> is the process that is used to handle all the data in tables using the NDB Cluster storage engine. @@ -6522,6 +7436,15 @@ [js] Insert figure here? </remark> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>log files</secondary> + </indexterm> + + <indexterm> + <primary>log files (MySQL Cluster)</primary> + </indexterm> + <para> In MySQL versions prior to 4.1.5, each <command>ndbd</command> process should be started in a separate directory, the reason @@ -6545,6 +7468,14 @@ <itemizedlist> <listitem> + <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 @@ -6583,6 +7514,14 @@ </listitem> <listitem> + <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 @@ -6711,6 +7650,31 @@ <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> + </indexterm> + + <indexterm> + <primary><command>ndb_mgmd</command></primary> + <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 @@ -6747,6 +7711,18 @@ <itemizedlist> <listitem> + <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 @@ -6808,6 +7784,39 @@ <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> + </indexterm> + + <indexterm> + <primary><command>ndb_mgm</command></primary> + <see><command>mgm</command></see> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>administration</secondary> + </indexterm> + + <indexterm> + <primary>administration of MySQL Cluster</primary> + </indexterm> + <para> The management client process is actually not needed to run the cluster. Its value lies in providing a set of commands for @@ -6854,6 +7863,36 @@ <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> + </indexterm> + <para> All MySQL Cluster executables (except for <command>mysqld</command>) take the options described in this @@ -6970,11 +8009,9 @@ versions can be used together, and at startup the MySQL 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 software upgrade of - MySQL Cluster. - -<!-- (See <literal>Software Upgrade of MySQL - Cluster</literal>). --> + important when performing an online (rolling) software + upgrade of MySQL Cluster. (See + <xref linkend="mysql-cluster-upgrade-downgrade-rolling"/>). </para> </listitem> @@ -6984,6 +8021,31 @@ <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><command>mysqld</command></primary> + <secondary>as MySQL Cluster process</secondary> + </indexterm> + <itemizedlist> <listitem> @@ -7023,6 +8085,26 @@ <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> + <para> For options common to NDB programs, see <xref linkend="mysql-cluster-command-options"/>. @@ -7148,6 +8230,26 @@ <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> + <para> For options common to NDB programs, see <xref linkend="mysql-cluster-command-options"/>. @@ -7201,6 +8303,26 @@ <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> + <para> For options common to NDB programs, see <xref linkend="mysql-cluster-command-options"/>. @@ -7235,6 +8357,15 @@ <title>&title-mysql-cluster-management;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>managing</secondary> + </indexterm> + + <indexterm> + <primary>managing MySQL Cluster</primary> + </indexterm> + <para> Managing a MySQL Cluster involves a number of tasks, the first of which is to configure and start MySQL Cluster. This is covered in @@ -7267,6 +8398,11 @@ <title>&title-mysql-cluster-startup-phases;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>starting or restarting</secondary> + </indexterm> + <para> This section describes the steps involved when the cluster is started. @@ -7577,6 +8713,21 @@ <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> + </indexterm> + <para> In addition to the central configuration file, a cluster may also be controlled through a command-line interface available @@ -7602,6 +8753,13 @@ <itemizedlist> <listitem> + <indexterm> + <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> @@ -7612,6 +8770,13 @@ </listitem> <listitem> + <indexterm> + <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> @@ -7629,6 +8794,13 @@ </listitem> <listitem> + <indexterm> + <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> @@ -7640,6 +8812,13 @@ </listitem> <listitem> + <indexterm> + <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> @@ -7651,6 +8830,13 @@ </listitem> <listitem> + <indexterm> + <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> @@ -7667,6 +8853,13 @@ </listitem> <listitem> + <indexterm> + <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> @@ -7678,6 +8871,20 @@ </listitem> <listitem> + <indexterm> + <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> @@ -7691,6 +8898,13 @@ </listitem> <listitem> + <indexterm> + <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> @@ -7703,6 +8917,13 @@ </listitem> <listitem> + <indexterm> + <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> @@ -7713,6 +8934,13 @@ </listitem> <listitem> + <indexterm> + <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> @@ -7731,6 +8959,33 @@ <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> + </indexterm> + <para> In this section, we discuss the types of event logs provided by MySQL Cluster, and the types of events that are logged. @@ -7738,9 +8993,9 @@ <para> MySQL Cluster provides two types of event log. These are the - <emphasis role="bold">cluster log</emphasis>, which includes - events generated by all cluster nodes, and - <emphasis role="bold">node logs</emphasis>, which are local to + <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> @@ -7769,6 +9024,15 @@ different criteria: </para> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>event types</secondary> + </indexterm> + + <indexterm> + <primary>event types (MySQL Cluster)</primary> + </indexterm> + <itemizedlist> <listitem> @@ -7813,11 +9077,47 @@ <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> + <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> + <itemizedlist> <listitem> @@ -7884,6 +9184,15 @@ 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> + <para> Note that events are reported per data node, and that the threshold can be set to different values on different nodes. @@ -7943,6 +9252,15 @@ 3. </para> + <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 @@ -8012,6 +9330,15 @@ <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> + <para> An event report reported in the event logs has the following format: @@ -8040,6 +9367,24 @@ 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> + <para> <emphasis role="bold"><literal>CONNECTION</literal> Events</emphasis> @@ -8096,6 +9441,15 @@ 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> + <para> The logging messages shown here are associated with checkpoints. @@ -8165,6 +9519,15 @@ 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> + <para> The following events are generated in response to the startup of a node or of the cluster and of its success or failure. @@ -8271,6 +9634,15 @@ 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> + <para> The following events are generated when restarting a node and relate to the success or failure of the node restart process. @@ -8493,6 +9865,15 @@ 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> + <para> The following events are of a statistical nature. They provide information such as numbers of transactions and other @@ -8566,6 +9947,15 @@ 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> + <para> These events relate to Cluster errors and warnings. The presence of one or more of these generally indicates that a @@ -8626,6 +10016,15 @@ 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> + <para> These events provide general information about the state of the cluster and activities associated with Cluster @@ -8673,6 +10072,36 @@ <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>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 @@ -8742,6 +10171,11 @@ following tasks: </para> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary><command>ndbd</command> process</secondary> + </indexterm> + <orderedlist> <listitem> @@ -8812,6 +10246,15 @@ <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> + <para> Single-user mode allows the database administrator to restrict access to the database system to a single MySQL server (SQL @@ -8884,6 +10327,11 @@ NDB> <userinput>EXIT SINGLE USER MODE</userinput> </programlisting> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>node failure (single-user mode)</secondary> + </indexterm> + <para> There are two recommended ways to handle a node failure when running in single-user mode: @@ -8938,6 +10386,16 @@ <title>&title-mysql-cluster-backup;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>backups</secondary> + </indexterm> + + <indexterm> + <primary>backups</primary> + <secondary>in MySQL Cluster</secondary> + </indexterm> + <para> This section describes how to create a backup and how to restore the database from a backup at a later time. @@ -8947,6 +10405,16 @@ <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> + <para> A backup is a snapshot of the database at a given time. The backup consists of three main parts: @@ -9044,6 +10512,16 @@ <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> + <para> Before starting a backup, make sure that the cluster is properly configured for performing one. (See @@ -9058,6 +10536,14 @@ <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> <para> Start the management server (<command>ndb_mgm</command>). </para> @@ -9173,6 +10659,26 @@ <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> + + <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] @@ -9235,6 +10741,26 @@ <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> + + <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> @@ -9242,6 +10768,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>BackupDataBufferSize</literal></primary> + </indexterm> + <para> <literal>BackupDataBufferSize</literal> </para> @@ -9253,6 +10783,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>BackupLogBufferSize</literal></primary> + </indexterm> + <para> <literal>BackupLogBufferSize</literal> </para> @@ -9264,6 +10798,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>BackupMemory</literal></primary> + </indexterm> + <para> <literal>BackupMemory</literal> </para> @@ -9276,6 +10814,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>BackupWriteSize</literal></primary> + </indexterm> + <para> <literal>BackupWriteSize</literal> </para> @@ -9299,6 +10841,21 @@ <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> + <para> If an error code is returned when issuing a backup request, the most likely cause is insufficient memory or insufficient @@ -9329,672 +10886,6 @@ </section> - <section id="mysql-cluster-upgrade-downgrade"> - - <title>&title-mysql-cluster-upgrade-downgrade;</title> - - <para> - This portion of the MySQL Cluster chapter covers upgrading and - downgrading a MySQL Cluster from one MySQL release to another. It - discusses different types of Cluster upgrades and downgrades, and - provides a Cluster upgrade/downgrade compatibility matrix (see - <xref - linkend="mysql-cluster-upgrade-downgrade-compatibility"/>). - </para> - - <para> - <emphasis role="bold">Important</emphasis>: You are expected - already to be familiar with installing and configuring a MySQL - Cluster prior to attempting an upgrade or downgrade. See - <xref - linkend="mysql-cluster-configuration"/>. - </para> - - <para> - This section remains in development, and will be updated and - expanded considerably during the second quarter of 2006. - </para> - - <section id="mysql-cluster-upgrade-downgrade-rolling"> - - <title>&title-mysql-cluster-upgrade-downgrade-rolling;</title> - - <para> - This section discusses how to perform a <firstterm>rolling - upgrade</firstterm> of a MySQL Cluster installation, so called - because it involves stopping and starting (or restarting) each - node in turn, so that the cluster itself remains operational. - This type of upgrade is done where high availability of the - cluster is mandatory and no downtime of the cluster as a whole - is permissible. The information provided here also applies to - downgrades as well. - </para> - - <remark role="todo"> - [js] Possibly move this reference - and the matrix to which it - refers - to a separate Compatibility Matrix subsection of the - Cluster Upgrades section if/when it is created. For now, I'll - leave info covering all MySQL versions that support Cluster in - this matrix; eventually, we may wish to split it up. - </remark> - - <para> - There are a number of reasons why a rolling upgrade (or - downgrade) might be desired: - </para> - - <itemizedlist> - - <listitem> - <para> - <emphasis role="bold">Cluster Configuration - Change</emphasis>: To make a change in the cluster's - configuration, such as adding an SQL node or setting a - configuration parameter to a new value - </para> - </listitem> - - <listitem> - <para> - <emphasis role="bold">Cluster Software - Upgrade/Downgrade</emphasis>: To upgrade the cluster to a - newer version of the MySQL Cluster software (or to downgrade - it to an older version) - </para> - </listitem> - - <listitem> - <para> - <emphasis role="bold">Change on Node Host</emphasis>: To - make changes in the hardware or operating system on which - one or more cluster nodes are running - </para> - </listitem> - - <listitem> - <para> - <emphasis role="bold">Cluster Reset</emphasis>: To reset the - cluster because it has reached an undesirable state - </para> - </listitem> - - </itemizedlist> - - <para> - The process for performing a rolling upgrade may be generalised - as follows: - </para> - - <orderedlist> - - <listitem> - <para> - Stop, reconfigure, then restart each cluster management node - (<command>ndb_mgmd</command> process) in turn - </para> - </listitem> - - <listitem> - <para> - Stop, reconfigure, then restart each cluster data node - (<command>ndbd</command> process) in turn - </para> - </listitem> - - </orderedlist> - - <para> - The specifics for implementing a particular rolling upgrade - depend upon the actual changes being made. A more detailed view - of the process is presented in the table shown here: - </para> - - <table> - <caption> Steps for Cluster rolling upgrades — by - upgrade type </caption> - <tbody> - <tr> - <th colspan="8">UPGRADE TYPE:</th> - </tr> - <tr> - <th colspan="2">Cluster Configuration Change</th> - <th colspan="2">Cluster Software Upgrade/Downgrade</th> - <th colspan="2">Change on Node Host</th> - <th colspan="2">Cluster Reset</th> - </tr> - <tr> - <th colspan="8">A. For each <command>ndb_mgmd</command> - process...</th> - </tr> - <tr> - <td colspan="2" rowspan="2"> - <orderedlist> - - <listitem> - <para> - Stop <command>ndb_mgmd</command> - </para> - </listitem> - - <listitem> - <para> - Make change in configuration file - </para> - </listitem> - - <listitem> - <para> - Start <command>ndb_mgmd</command> - </para> - </listitem> - - </orderedlist> - </td> - <td colspan="2" rowspan="2"> - <orderedlist> - - <listitem> - <para> - Stop <command>ndb_mgmd</command> - </para> - </listitem> - - <listitem> - <para> - Replace <command>ndb_mgmd</command> binary with new - version - </para> - </listitem> - - <listitem> - <para> - Start <command>ndb_mgmd</command> - </para> - </listitem> - - </orderedlist> - </td> - <td colspan="2" rowspan="2"> - <orderedlist> - - <listitem> - <para> - Stop <command>ndb_mgmd</command> - </para> - </listitem> - - <listitem> - <para> - Make desired changes in hardware/operating system - </para> - </listitem> - - <listitem> - <para> - Start <command>ndb_mgmd</command> - </para> - </listitem> - - </orderedlist> - </td> - <th colspan="2">( OR )</th> - </tr> - <tr> - <td> - <orderedlist> - - <listitem> - <para> - Stop <command>ndb_mgmd</command> - </para> - </listitem> - - <listitem> - <para> - Start <command>ndb_mgmd</command> - </para> - </listitem> - - </orderedlist> - </td> - <td> Restart <command>ndb_mgmd</command> (optional) </td> - </tr> - <tr> - <th colspan="8">B. For each <command>ndbd</command> - process...</th> - </tr> - <tr> - <th colspan="2">( OR )</th> - <td colspan="2" rowspan="2"> - <orderedlist> - - <listitem> - <para> - Stop <command>ndbd</command> - </para> - </listitem> - - <listitem> - <para> - Replace <command>ndbd</command> binary with new - version - </para> - </listitem> - - <listitem> - <para> - Start <command>ndbd</command> - </para> - </listitem> - - </orderedlist> - </td> - <td colspan="2" rowspan="2"> - <orderedlist> - - <listitem> - <para> - Stop <command>ndbd</command> - </para> - </listitem> - - <listitem> - <para> - Make desired changes in hardware/operating system - </para> - </listitem> - - <listitem> - <para> - Start <command>ndbd</command> - </para> - </listitem> - - </orderedlist> - </td> - <th colspan="2">( OR )</th> - </tr> - <tr> - <td> - <orderedlist> - - <listitem> - <para> - Stop <command>ndbd</command> - </para> - </listitem> - - <listitem> - <para> - Start <command>ndbd</command> - </para> - </listitem> - - </orderedlist> - </td> - <td> Restart <command>ndbd</command> - </td> - <td> - <orderedlist> - - <listitem> - <para> - Stop <command>ndbd</command> - </para> - </listitem> - - <listitem> - <para> - Start <command>ndbd</command> - </para> - </listitem> - - </orderedlist> - </td> - <td> Restart <command>ndbd</command> - </td> - </tr> - </tbody> - </table> - - </section> - - <section id="mysql-cluster-upgrade-downgrade-compatibility"> - - <title>&title-mysql-cluster-upgrade-downgrade-compatibility;</title> - - <para> - This section provides information regarding Cluster software and - table file compatibility between differing versions of the MySQL - Server for purposes of performing upgrades and downgrades. - </para> - - <para> - <emphasis role="bold">Important</emphasis>: Only compatibility - between MySQL versions with regard to <literal>NDB - Cluster</literal> is taken into account in this section, and - there are likely other issues to be considered. <emphasis>As - with any other MySQL software upgrade or downgrade, you are - strongly encouraged to review the relevant portions of the MySQL - Manual for the MySQL versions from which and to which you intend - to migrate, before attempting an upgrade or downgrade of the - MySQL Cluster software</emphasis>. See - <xref linkend="upgrade"/>. - </para> - - <remark role="note"> - [js] Table info extracted from the file - mysql-5.2/storage/ndb/src/common/util/version.c - </remark> - - <remark role="todo"> - [js] Update as new server versions are released - </remark> - - <para> - The following table shows Cluster upgrade and downgrade - compatibility between different versions of the MySQL Server. - </para> - - <table> - <caption> Cluster Upgrade/Downgrade Compatibility — by - MySQL Server version </caption> - <tbody> - <tr> - <td colspan="2"> - <para> - <emphasis role="bold">MySQL 4.1</emphasis> - </para> - </td> - <td> </td> - <td colspan="2"> - <para> - <emphasis role="bold">MySQL 5.0</emphasis> - </para> - </td> - <td> </td> - <td colspan="2"> - <para> - <emphasis role="bold">MySQL 5.1</emphasis> - </para> - </td> - </tr> - <tr> - <td colspan="3"> </td> - <td>5.0.21</td> - <td>⇕</td> - <td colspan="3"> </td> - </tr> - <tr> - <td colspan="3"> </td> - <td>5.0.20</td> - <td>⇕</td> - <td colspan="3"> </td> - </tr> - <tr> - <td colspan="3"> </td> - <td>5.0.19</td> - <td>⇕</td> - <td colspan="3"> </td> - </tr> - <tr> - <td colspan="3"> </td> - <td>5.0.18</td> - <td>⇕</td> - <td colspan="3"> </td> - </tr> - <tr> - <td colspan="3"> </td> - <td>5.0.17</td> - <td>⇕</td> - <td colspan="3"> </td> - </tr> - <tr> - <td colspan="3"> </td> - <td>5.0.16</td> - <td>⇕</td> - <td colspan="3"> </td> - </tr> - <tr> - <td colspan="3"> </td> - <td>5.0.15</td> - <td>⇕</td> - <td colspan="3"> </td> - </tr> - <tr> - <td colspan="3"> </td> - <td>5.0.14</td> - <td>⇕</td> - <td colspan="3"> </td> - </tr> - <tr> - <td>4.1.19</td> - <td>⇕</td> - <td> </td> - <td>5.0.13</td> - <td>⇕</td> - <td colspan="3"> </td> - </tr> - <tr> - <td>4.1.18</td> - <td>⇕</td> - <td> </td> - <td>5.0.12</td> - <td>⇕</td> - <td colspan="3"> </td> - </tr> - <tr> - <td>4.1.17</td> - <td>⇕</td> - <td> </td> - <td>5.0.11</td> - <td>⇑ (see Notes)</td> - <td colspan="3"> </td> - </tr> - <tr> - <td>4.1.16</td> - <td>⇕</td> - <td> </td> - <td>5.0.10</td> - <td>⇕</td> - <td colspan="3"> </td> - </tr> - <tr> - <td>4.1.15</td> - <td>⇑ (see Notes)</td> - <td> </td> - <td>5.0.9</td> - <td>⇕</td> - <td colspan="3"> </td> - </tr> - <tr> - <td>4.1.14</td> - <td>⇕</td> - <td> </td> - <td>5.0.8</td> - <td>⇕</td> - <td> </td> - <td>5.1.10</td> - <td>⇕</td> - </tr> - <tr> - <td>4.1.13</td> - <td>⇕</td> - <td> </td> - <td>5.0.7</td> - <td>⇕</td> - <td> </td> - <td>5.1.9</td> - <td>⇕</td> - </tr> - <tr> - <td>4.1.12</td> - <td>⇕</td> - <td> </td> - <td>5.0.6</td> - <td>⇕</td> - <td> </td> - <td>5.1.7</td> - <td>⇕</td> - </tr> - <tr> - <td>4.1.11</td> - <td>⇕</td> - <td> </td> - <td>5.0.5</td> - <td>⇕</td> - <td> </td> - <td>5.1.6</td> - <td>⇕</td> - </tr> - <tr> - <td>4.1.10</td> - <td>⇕</td> - <td> </td> - <td>5.0.4</td> - <td>⇕</td> - <td> </td> - <td>5.1.5</td> - <td>⇕</td> - </tr> - <tr> - <td>4.1.9</td> - <td>⇑ / ⇓ (see Notes)</td> - <td> </td> - <td>5.0.3</td> - <td>⇕</td> - <td> </td> - <td>5.1.4</td> - <td>⇕</td> - </tr> - <tr> - <td>4.1.8</td> - <td>⇑</td> - <td> </td> - <td>5.0.2</td> - <td>⇑</td> - <td> </td> - <td>5.1.3</td> - <td>⇕</td> - </tr> - <tr> - <td colspan="1"> - <para> - <emphasis>KEY</emphasis>: - </para> - </td> - <td colspan="7"> - <itemizedlist> - - <listitem> - <para> - ⇕: Upwardly and downwardly compatible - </para> - </listitem> - - <listitem> - <para> - ⇑: Upwardly compatible only - </para> - </listitem> - - <listitem> - <para> - ⇓: Downwardly compatible only - </para> - </listitem> - - </itemizedlist> - </td> - </tr> - </tbody> - </table> - - <para> - <emphasis role="bold">Notes</emphasis>: - </para> - - <itemizedlist> - - <listitem> - <para> - <emphasis role="bold">4.1 Series</emphasis>: - </para> - - <para> - You cannot upgrade directly from 4.1.8 to 4.1.10 (or newer); - you must first upgrade from 4.1.8 to 4.1.9, then upgrade to - 4.1.10. Similarly, you cannot downgrade directly from 4.1.10 - (or newer) to 4.1.8; you must first downgrade from 4.1.10 to - 4.1.9, then downgrade from 4.1.9 to 4.1.8. - </para> - - <para> - If you wish to upgrade a MySQL Cluster to 4.1.15, you must - upgrade to 4.1.14 first, and you must upgrade to 4.1.15 - before upgrading to 4.1.16 or newer. - </para> - - <para> - Cluster downgrades from 4.1.15 to 4.1.14 (or earlier - versions) are not supported. - </para> - - <para> - Cluster upgrades from MySQL Server versions previous to - 4.1.8 are not supported; when upgrading from these, you must - dump all <literal>NDB</literal> tables, install the new - version of the software, and then reload the tables from the - dump. - </para> - </listitem> - - <listitem> - <para> - <emphasis role="bold">5.0 Series</emphasis>: - </para> - - <para> - MySQL 5.0.2 was the first public release in this series. - </para> - - <para> - Cluster downgrades from MySQL 5.0 to MySQL 4.1 are not - supported. - </para> - - <para> - Cluster downgrades from 5.0.12 to 5.0.11 (or earlier) are - not supported. - </para> - </listitem> - - <listitem> - <para> - <emphasis role="bold">5.1 Series</emphasis>: - </para> - - <para> - MySQL 5.1.3 was the first public release in this series. - </para> - - <para> - You cannot downgrade a MySQL 5.1.6 or later Cluster using - Disk Data tables to MySQL 5.1.5 or earlier unless you - convert all such tables to in-memory Cluster tables first. - </para> - - <para> - There was no public release for MySQL 5.1.8. - </para> - </listitem> - - </itemizedlist> - - </section> - - </section> - <section id="mysql-cluster-interconnects"> <title>&title-mysql-cluster-interconnects;</title> @@ -10720,8 +11611,8 @@ these issues in subsequent release series. If you check the <quote>Cluster</quote> category in the MySQL bugs database at <ulink url="http://bugs.mysql.com"/>, you can find known bugs - which (if marked 4.1) we intend to correct in upcoming releases of - MySQL 4.1. + which (if marked <quote>¤t-series;</quote>) we intend to + correct in upcoming releases of MySQL ¤t-series;. </para> <para> @@ -10729,7 +11620,7 @@ conditions just set forth. You can report any discrepancies that you encounter to the MySQL bugs database using the instructions given in <xref linkend="bug-reports"/>. If we do not plan to fix - the problem in MySQL 4.1 we will add it to the list. + the problem in MySQL ¤t-series;, we will add it to the list. </para> <itemizedlist> @@ -11061,13 +11952,16 @@ <listitem> <para> - In MySQL ¤t-series;, 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 + 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 engine than would be the case for the same table and data - using the <literal>MyISAM</literal> engine. + using the <literal>MyISAM</literal> engine. (In other + words, in the case of a <literal>VARCHAR</literal> column, + the column requires the same amount of storage as a + <literal>CHAR</literal> column of the same size.) </para> </listitem> @@ -11186,6 +12080,14 @@ <listitem> <para> + MySQL Cluster does not support durable commits on disk. + Commits are replicated, but there is no guarantee that + logs are flushed to disk on commit. + </para> + </listitem> + + <listitem> + <para> <literal>SQL_LOG_BIN</literal> has no effect on data operations; however, it is supported for schema operations. @@ -11718,7 +12620,7 @@ </para> <para> - ( We implemented disk data storage for MySQL Cluster in MySQL + (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> Modified: trunk/refman-5.0/ndbcluster.xml =================================================================== --- trunk/refman-5.0/ndbcluster.xml 2006-05-24 13:43:56 UTC (rev 2187) +++ trunk/refman-5.0/ndbcluster.xml 2006-05-24 14:44:04 UTC (rev 2188) @@ -1009,7 +1009,7 @@ </indexterm> <para> - Each MySQL Cluster host computer running storage or SQL nodes + 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 @@ -1779,9 +1779,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 will - cause 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> @@ -5959,8 +5959,7 @@ <listitem> <indexterm> - <primary><literal>ReceiveBufferMemory</literal> (MySQL Cluster configuration - parameter)</primary> + <primary><literal>ReceiveBufferMemory</literal></primary> </indexterm> <para> @@ -5983,6 +5982,22 @@ <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> + </indexterm> + <para> Setting up a cluster using direct connections between data nodes requires specifying explicitly the crossover IP @@ -6047,13 +6062,34 @@ <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> + <tertiary>shared memory (SHM)</tertiary> + </indexterm> + <para> MySQL Cluster attempts to use the shared memory transporter and configure it automatically where possible, chiefly where more than one node runs concurrently on the same cluster host. (In very early versions of MySQL Cluster, shared memory - segments functioned only when the <literal>-max</literal> - binary was built using <option>--with-ndb-shm</option>.) + segments functioned only when the server binary was built + using <option>--with-ndb-shm</option>.) <literal>[SHM]</literal> sections in the <filename>config.ini</filename> file explicitly define shared-memory connections between nodes in the cluster. When @@ -6077,6 +6113,14 @@ <itemizedlist> <listitem> + <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> @@ -6089,6 +6133,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ShmKey</literal></primary> + </indexterm> <para> <literal>ShmKey</literal> </para> @@ -6102,6 +6149,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ShmSize</literal></primary> + </indexterm> <para> <literal>ShmSize</literal> </para> @@ -6115,6 +6165,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>SendSignalId</literal></primary> + </indexterm> <para> <literal>SendSignalId</literal> </para> @@ -6129,6 +6182,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>Checksum</literal> (MySQL Cluster)</primary> + </indexterm> <para> <literal>Checksum</literal> </para> @@ -6156,6 +6212,28 @@ <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 @@ -6190,6 +6268,14 @@ <itemizedlist> <listitem> + <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> @@ -6202,6 +6288,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>Host*SciId*</literal> parameters</primary> + </indexterm> <para> <literal>Host1SciId0</literal> </para> @@ -6249,6 +6338,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>SharedBufferSize</literal></primary> + </indexterm> <para> <literal>SharedBufferSize</literal> </para> @@ -6265,6 +6357,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>SendLimit</literal></primary> + </indexterm> <para> <literal>SendLimit</literal> </para> @@ -6280,6 +6375,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>SendSignalId</literal></primary> + </indexterm> <para> <literal>SendSignalId</literal> </para> @@ -6293,6 +6391,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>Checksum</literal> (MySQL Cluster)</primary> + </indexterm> <para> <literal>Checksum</literal> </para> @@ -6310,11 +6411,6 @@ </itemizedlist> - <remark> - @node MySQL Cluster Complex Configuration, , MySQL Cluster SHM - Definition, MySQL Cluster Config File - </remark> - <remark role="todo"> [js] What is meant by "parts" here?? </remark> @@ -6328,11 +6424,763 @@ </section> </section> + <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> + </indexterm> + + <para> + This portion of the MySQL Cluster chapter covers upgrading and + downgrading a MySQL Cluster from one MySQL release to another. It + discusses different types of Cluster upgrades and downgrades, and + provides a Cluster upgrade/downgrade compatibility matrix (see + <xref + linkend="mysql-cluster-upgrade-downgrade-compatibility"/>). + </para> + + <para> + <emphasis role="bold">Important</emphasis>: You are expected + already to be familiar with installing and configuring a MySQL + Cluster prior to attempting an upgrade or downgrade. See + <xref + linkend="mysql-cluster-configuration"/>. + </para> + + <para> + This section remains in development, and will be updated and + expanded considerably during the second quarter of 2006. + </para> + + <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> + + + <para> + This section discusses how to perform a <firstterm>rolling + upgrade</firstterm> of a MySQL Cluster installation, so called + because it involves stopping and starting (or restarting) each + node in turn, so that the cluster itself remains operational. + This type of upgrade is done where high availability of the + cluster is mandatory and no downtime of the cluster as a whole + is permissible. The information provided here also applies to + downgrades as well. + </para> + + <remark role="todo"> + [js] Possibly move this reference - and the matrix to which it + refers - to a separate Compatibility Matrix subsection of the + Cluster Upgrades section if/when it is created. For now, I'll + leave info covering all MySQL versions that support Cluster in + this matrix; eventually, we may wish to split it up. + </remark> + + <para> + There are a number of reasons why a rolling upgrade (or + downgrade) might be desired: + </para> + + <itemizedlist> + + <listitem> + <indexterm> + <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 + configuration, such as adding an SQL node or setting a + configuration parameter to a new value + </para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">Cluster Software + Upgrade/Downgrade</emphasis>: To upgrade the cluster to a + newer version of the MySQL Cluster software (or to downgrade + it to an older version) + </para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">Change on Node Host</emphasis>: To + make changes in the hardware or operating system on which + one or more cluster nodes are running + </para> + </listitem> + + <listitem> + <indexterm> + <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 + </para> + </listitem> + + </itemizedlist> + + <para> + The process for performing a rolling upgrade may be generalised + as follows: + </para> + + <orderedlist> + + <listitem> + <para> + Stop, reconfigure, then restart each cluster management node + (<command>ndb_mgmd</command> process) in turn + </para> + </listitem> + + <listitem> + <para> + Stop, reconfigure, then restart each cluster data node + (<command>ndbd</command> process) in turn + </para> + </listitem> + + </orderedlist> + + <para> + The specifics for implementing a particular rolling upgrade + depend upon the actual changes being made. A more detailed view + of the process is presented in the table shown here: + </para> + + <table> + <caption> Steps for Cluster rolling upgrades — by + upgrade type </caption> + <tbody> + <tr> + <th colspan="8">UPGRADE TYPE:</th> + </tr> + <tr> + <th colspan="2">Cluster Configuration Change</th> + <th colspan="2">Cluster Software Upgrade/Downgrade</th> + <th colspan="2">Change on Node Host</th> + <th colspan="2">Cluster Reset</th> + </tr> + <tr> + <th colspan="8">A. For each <command>ndb_mgmd</command> + process...</th> + </tr> + <tr> + <td colspan="2" rowspan="2"> + <orderedlist> + + <listitem> + <para> + Stop <command>ndb_mgmd</command> + </para> + </listitem> + + <listitem> + <para> + Make change in configuration file + </para> + </listitem> + + <listitem> + <para> + Start <command>ndb_mgmd</command> + </para> + </listitem> + + </orderedlist> + </td> + <td colspan="2" rowspan="2"> + <orderedlist> + + <listitem> + <para> + Stop <command>ndb_mgmd</command> + </para> + </listitem> + + <listitem> + <para> + Replace <command>ndb_mgmd</command> binary with new + version + </para> + </listitem> + + <listitem> + <para> + Start <command>ndb_mgmd</command> + </para> + </listitem> + + </orderedlist> + </td> + <td colspan="2" rowspan="2"> + <orderedlist> + + <listitem> + <para> + Stop <command>ndb_mgmd</command> + </para> + </listitem> + + <listitem> + <para> + Make desired changes in hardware/operating system + </para> + </listitem> + + <listitem> + <para> + Start <command>ndb_mgmd</command> + </para> + </listitem> + + </orderedlist> + </td> + <th colspan="2">( OR )</th> + </tr> + <tr> + <td> + <orderedlist> + + <listitem> + <para> + Stop <command>ndb_mgmd</command> + </para> + </listitem> + + <listitem> + <para> + Start <command>ndb_mgmd</command> + </para> + </listitem> + + </orderedlist> + </td> + <td> Restart <command>ndb_mgmd</command> (optional) </td> + </tr> + <tr> + <th colspan="8">B. For each <command>ndbd</command> + process...</th> + </tr> + <tr> + <th colspan="2">( OR )</th> + <td colspan="2" rowspan="2"> + <orderedlist> + + <listitem> + <para> + Stop <command>ndbd</command> + </para> + </listitem> + + <listitem> + <para> + Replace <command>ndbd</command> binary with new + version + </para> + </listitem> + + <listitem> + <para> + Start <command>ndbd</command> + </para> + </listitem> + + </orderedlist> + </td> + <td colspan="2" rowspan="2"> + <orderedlist> + + <listitem> + <para> + Stop <command>ndbd</command> + </para> + </listitem> + + <listitem> + <para> + Make desired changes in hardware/operating system + </para> + </listitem> + + <listitem> + <para> + Start <command>ndbd</command> + </para> + </listitem> + + </orderedlist> + </td> + <th colspan="2">( OR )</th> + </tr> + <tr> + <td> + <orderedlist> + + <listitem> + <para> + Stop <command>ndbd</command> + </para> + </listitem> + + <listitem> + <para> + Start <command>ndbd</command> + </para> + </listitem> + + </orderedlist> + </td> + <td> Restart <command>ndbd</command> + </td> + <td> + <orderedlist> + + <listitem> + <para> + Stop <command>ndbd</command> + </para> + </listitem> + + <listitem> + <para> + Start <command>ndbd</command> + </para> + </listitem> + + </orderedlist> + </td> + <td> Restart <command>ndbd</command> + </td> + </tr> + </tbody> + </table> + + </section> + + <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> + + <para> + This section provides information regarding Cluster software and + table file compatibility between differing versions of the MySQL + Server for purposes of performing upgrades and downgrades. + </para> + + <para> + <emphasis role="bold">Important</emphasis>: Only compatibility + between MySQL versions with regard to <literal>NDB + Cluster</literal> is taken into account in this section, and + there are likely other issues to be considered. <emphasis>As + with any other MySQL software upgrade or downgrade, you are + strongly encouraged to review the relevant portions of the MySQL + Manual for the MySQL versions from which and to which you intend + to migrate, before attempting an upgrade or downgrade of the + MySQL Cluster software</emphasis>. See + <xref linkend="upgrade"/>. + </para> + + <remark role="note"> + [js] Table info extracted from the file + mysql-5.2/storage/ndb/src/common/util/version.c + </remark> + + <remark role="todo"> + [js] Update as new server versions are released + </remark> + + <para> + The following table shows Cluster upgrade and downgrade + compatibility between different versions of the MySQL Server. + </para> + + <table> + <caption> Cluster Upgrade/Downgrade Compatibility — by + MySQL Server version </caption> + <tbody> + <tr> + <td colspan="2"> + <para> + <emphasis role="bold">MySQL 4.1</emphasis> + </para> + </td> + <td> </td> + <td colspan="2"> + <para> + <emphasis role="bold">MySQL 5.0</emphasis> + </para> + </td> + <td> </td> + <td colspan="2"> + <para> + <emphasis role="bold">MySQL 5.1</emphasis> + </para> + </td> + </tr> + <tr> + <td colspan="3"> </td> + <td>5.0.21</td> + <td>⇕</td> + <td colspan="3"> </td> + </tr> + <tr> + <td colspan="3"> </td> + <td>5.0.20</td> + <td>⇕</td> + <td colspan="3"> </td> + </tr> + <tr> + <td colspan="3"> </td> + <td>5.0.19</td> + <td>⇕</td> + <td colspan="3"> </td> + </tr> + <tr> + <td colspan="3"> </td> + <td>5.0.18</td> + <td>⇕</td> + <td colspan="3"> </td> + </tr> + <tr> + <td colspan="3"> </td> + <td>5.0.17</td> + <td>⇕</td> + <td colspan="3"> </td> + </tr> + <tr> + <td colspan="3"> </td> + <td>5.0.16</td> + <td>⇕</td> + <td colspan="3"> </td> + </tr> + <tr> + <td colspan="3"> </td> + <td>5.0.15</td> + <td>⇕</td> + <td colspan="3"> </td> + </tr> + <tr> + <td colspan="3"> </td> + <td>5.0.14</td> + <td>⇕</td> + <td colspan="3"> </td> + </tr> + <tr> + <td>4.1.19</td> + <td>⇕</td> + <td> </td> + <td>5.0.13</td> + <td>⇕</td> + <td colspan="3"> </td> + </tr> + <tr> + <td>4.1.18</td> + <td>⇕</td> + <td> </td> + <td>5.0.12</td> + <td>⇕</td> + <td colspan="3"> </td> + </tr> + <tr> + <td>4.1.17</td> + <td>⇕</td> + <td> </td> + <td>5.0.11</td> + <td>⇑ (see Notes)</td> + <td colspan="3"> </td> + </tr> + <tr> + <td>4.1.16</td> + <td>⇕</td> + <td> </td> + <td>5.0.10</td> + <td>⇕</td> + <td colspan="3"> </td> + </tr> + <tr> + <td>4.1.15</td> + <td>⇑ (see Notes)</td> + <td> </td> + <td>5.0.9</td> + <td>⇕</td> + <td colspan="3"> </td> + </tr> + <tr> + <td>4.1.14</td> + <td>⇕</td> + <td> </td> + <td>5.0.8</td> + <td>⇕</td> + <td> </td> + <td>5.1.10</td> + <td>⇕</td> + </tr> + <tr> + <td>4.1.13</td> + <td>⇕</td> + <td> </td> + <td>5.0.7</td> + <td>⇕</td> + <td> </td> + <td>5.1.9</td> + <td>⇕</td> + </tr> + <tr> + <td>4.1.12</td> + <td>⇕</td> + <td> </td> + <td>5.0.6</td> + <td>⇕</td> + <td> </td> + <td>5.1.7</td> + <td>⇕</td> + </tr> + <tr> + <td>4.1.11</td> + <td>⇕</td> + <td> </td> + <td>5.0.5</td> + <td>⇕</td> + <td> </td> + <td>5.1.6</td> + <td>⇕</td> + </tr> + <tr> + <td>4.1.10</td> + <td>⇕</td> + <td> </td> + <td>5.0.4</td> + <td>⇕</td> + <td> </td> + <td>5.1.5</td> + <td>⇕</td> + </tr> + <tr> + <td>4.1.9</td> + <td>⇑ / ⇓ (see Notes)</td> + <td> </td> + <td>5.0.3</td> + <td>⇕</td> + <td> </td> + <td>5.1.4</td> + <td>⇕</td> + </tr> + <tr> + <td>4.1.8</td> + <td>⇑</td> + <td> </td> + <td>5.0.2</td> + <td>⇑</td> + <td> </td> + <td>5.1.3</td> + <td>⇕</td> + </tr> + <tr> + <td colspan="1"> + <para> + <emphasis>KEY</emphasis>: + </para> + </td> + <td colspan="7"> + <itemizedlist> + + <listitem> + <para> + ⇕: Upwardly and downwardly compatible + </para> + </listitem> + + <listitem> + <para> + ⇑: Upwardly compatible only + </para> + </listitem> + + <listitem> + <para> + ⇓: Downwardly compatible only + </para> + </listitem> + + </itemizedlist> + </td> + </tr> + </tbody> + </table> + + <para> + <emphasis role="bold">Notes</emphasis>: + </para> + + <itemizedlist> + + <listitem> + <para> + <emphasis role="bold">4.1 Series</emphasis>: + </para> + + <para> + You cannot upgrade directly from 4.1.8 to 4.1.10 (or newer); + you must first upgrade from 4.1.8 to 4.1.9, then upgrade to + 4.1.10. Similarly, you cannot downgrade directly from 4.1.10 + (or newer) to 4.1.8; you must first downgrade from 4.1.10 to + 4.1.9, then downgrade from 4.1.9 to 4.1.8. + </para> + + <para> + If you wish to upgrade a MySQL Cluster to 4.1.15, you must + upgrade to 4.1.14 first, and you must upgrade to 4.1.15 + before upgrading to 4.1.16 or newer. + </para> + + <para> + Cluster downgrades from 4.1.15 to 4.1.14 (or earlier + versions) are not supported. + </para> + + <para> + Cluster upgrades from MySQL Server versions previous to + 4.1.8 are not supported; when upgrading from these, you must + dump all <literal>NDB</literal> tables, install the new + version of the software, and then reload the tables from the + dump. + </para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">5.0 Series</emphasis>: + </para> + + <para> + MySQL 5.0.2 was the first public release in this series. + </para> + + <para> + Cluster downgrades from MySQL 5.0 to MySQL 4.1 are not + supported. + </para> + + <para> + Cluster downgrades from 5.0.12 to 5.0.11 (or earlier) are + not supported. + </para> + + <para> + You cannot restore with <command>ndb_restore</command> to a + MySQL 5.0 Cluster using a backup made from a Cluster running + MySQL 5.1. You must use <command>mysqldump</command> in such + cases. + </para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">5.1 Series</emphasis>: + </para> + + <para> + MySQL 5.1.3 was the first public release in this series. + </para> + + <para> + You cannot downgrade a MySQL 5.1.6 or later Cluster using + Disk Data tables to MySQL 5.1.5 or earlier unless you + convert all such tables to in-memory Cluster tables first. + </para> + + <para> + There was no public release for MySQL 5.1.8. + </para> + </listitem> + + </itemizedlist> + + </section> + + </section> + <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> + <para> Understanding how to manage MySQL Cluster requires a knowledge of four essential processes. In the next few sections of this @@ -6373,6 +7221,30 @@ <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> + </indexterm> + <para> <command>mysqld</command> is the traditional MySQL server process. To be used with MySQL Cluster, @@ -6425,6 +7297,20 @@ 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> + </indexterm> + <para> To read cluster configuration data, the MySQL server requires at a minimum three pieces of information: @@ -6500,6 +7386,29 @@ <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> + </indexterm> + <para> <command>ndbd</command> is the process that is used to handle all the data in tables using the NDB Cluster storage engine. @@ -6520,6 +7429,15 @@ [js] Insert figure here? </remark> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>log files</secondary> + </indexterm> + + <indexterm> + <primary>log files (MySQL Cluster)</primary> + </indexterm> + <para> <command>ndbd</command> generates a set of log files which are placed in the directory specified by <literal>DataDir</literal> @@ -6534,6 +7452,14 @@ <itemizedlist> <listitem> + <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 @@ -6571,6 +7497,14 @@ </listitem> <listitem> + <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 @@ -6691,6 +7625,31 @@ <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> + </indexterm> + + <indexterm> + <primary><command>ndb_mgmd</command></primary> + <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 @@ -6726,6 +7685,18 @@ <itemizedlist> <listitem> + <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 @@ -6781,6 +7752,39 @@ <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> + </indexterm> + + <indexterm> + <primary><command>ndb_mgm</command></primary> + <see><command>mgm</command></see> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>administration</secondary> + </indexterm> + + <indexterm> + <primary>administration of MySQL Cluster</primary> + </indexterm> + <para> The management client process is actually not needed to run the cluster. Its value lies in providing a set of commands for @@ -6826,6 +7830,36 @@ <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> + </indexterm> + <para> All MySQL Cluster executables (except for <command>mysqld</command>) take the options described in this @@ -6937,11 +7971,9 @@ versions can be used together, and at startup the MySQL 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 software upgrade of - MySQL Cluster. - -<!-- (See <literal>Software Upgrade of MySQL - Cluster</literal>). --> + important when performing an online (rolling) software + upgrade of MySQL Cluster. (See + <xref linkend="mysql-cluster-upgrade-downgrade-rolling"/>). </para> </listitem> @@ -6951,6 +7983,31 @@ <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><command>mysqld</command></primary> + <secondary>as MySQL Cluster process</secondary> + </indexterm> + <itemizedlist> <listitem> @@ -6990,6 +8047,26 @@ <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> + <para> For options common to NDB programs, see <xref linkend="mysql-cluster-command-options"/>. @@ -7109,6 +8186,26 @@ <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> + <para> For options common to NDB programs, see <xref linkend="mysql-cluster-command-options"/>. @@ -7168,6 +8265,26 @@ <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> + <para> For options common to NDB programs, see <xref linkend="mysql-cluster-command-options"/>. @@ -7195,823 +8312,23 @@ </section> </section> - - <section id="mysql-cluster-log-statistics"> - - <title>&title-mysql-cluster-log-statistics;</title> - - <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> - - <para> - The <command>ndbd</command> process has a scheduler that runs in - an infinite loop. During each loop scheduler performs the - following tasks: - </para> - - <orderedlist> - - <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> - 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> - Wait for any new incoming messages. - </para> - </listitem> - - </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 <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> - -<programlisting> -ndb_mgm> <userinput>ALL CLUSTERLOG STATISTICS=15</userinput> -</programlisting> - - </section> - </section> - <section id="mysql-cluster-upgrade-downgrade"> + - <title>&title-mysql-cluster-upgrade-downgrade;</title> - - <para> - This portion of the MySQL Cluster chapter covers upgrading and - downgrading a MySQL Cluster from one MySQL release to another. It - discusses different types of Cluster upgrades and downgrades, and - provides a Cluster upgrade/downgrade compatibility matrix (see - <xref - linkend="mysql-cluster-upgrade-downgrade-compatibility"/>). - </para> - - <para> - <emphasis role="bold">Important</emphasis>: You are expected - already to be familiar with installing and configuring a MySQL - Cluster prior to attempting an upgrade or downgrade. See - <xref - linkend="mysql-cluster-configuration"/>. - </para> - - <para> - This section remains in development, and will be updated and - expanded considerably during the second quarter of 2006. - </para> - - <section id="mysql-cluster-upgrade-downgrade-rolling"> - - <title>&title-mysql-cluster-upgrade-downgrade-rolling;</title> - - <para> - This section discusses how to perform a <firstterm>rolling - upgrade</firstterm> of a MySQL Cluster installation, so called - because it involves stopping and starting (or restarting) each - node in turn, so that the cluster itself remains operational. - This type of upgrade is done where high availability of the - cluster is mandatory and no downtime of the cluster as a whole - is permissible. The information provided here also applies to - downgrades as well. - </para> - - <remark role="todo"> - [js] Possibly move this reference - and the matrix to which it - refers - to a separate Compatibility Matrix subsection of the - Cluster Upgrades section if/when it is created. For now, I'll - leave info covering all MySQL versions that support Cluster in - this matrix; eventually, we may wish to split it up. - </remark> - - <para> - There are a number of reasons why a rolling upgrade (or - downgrade) might be desired: - </para> - - <itemizedlist> - - <listitem> - <para> - <emphasis role="bold">Cluster Configuration - Change</emphasis>: To make a change in the cluster's - configuration, such as adding an SQL node or setting a - configuration parameter to a new value - </para> - </listitem> - - <listitem> - <para> - <emphasis role="bold">Cluster Software - Upgrade/Downgrade</emphasis>: To upgrade the cluster to a - newer version of the MySQL Cluster software (or to downgrade - it to an older version) - </para> - </listitem> - - <listitem> - <para> - <emphasis role="bold">Change on Node Host</emphasis>: To - make changes in the hardware or operating system on which - one or more cluster nodes are running - </para> - </listitem> - - <listitem> - <para> - <emphasis role="bold">Cluster Reset</emphasis>: To reset the - cluster because it has reached an undesirable state - </para> - </listitem> - - </itemizedlist> - - <para> - The process for performing a rolling upgrade may be generalised - as follows: - </para> - - <orderedlist> - - <listitem> - <para> - Stop, reconfigure, then restart each cluster management node - (<command>ndb_mgmd</command> process) in turn - </para> - </listitem> - - <listitem> - <para> - Stop, reconfigure, then restart each cluster data node - (<command>ndbd</command> process) in turn - </para> - </listitem> - - </orderedlist> - - <para> - The specifics for implementing a particular rolling upgrade - depend upon the actual changes being made. A more detailed view - of the process is presented in the table shown here: - </para> - - <table> - <caption> Steps for Cluster rolling upgrades — by - upgrade type </caption> - <tbody> - <tr> - <th colspan="8">UPGRADE TYPE:</th> - </tr> - <tr> - <th colspan="2">Cluster Configuration Change</th> - <th colspan="2">Cluster Software Upgrade/Downgrade</th> - <th colspan="2">Change on Node Host</th> - <th colspan="2">Cluster Reset</th> - </tr> - <tr> - <th colspan="8">A. For each <command>ndb_mgmd</command> - process...</th> - </tr> - <tr> - <td colspan="2" rowspan="2"> - <orderedlist> - - <listitem> - <para> - Stop <command>ndb_mgmd</command> - </para> - </listitem> - - <listitem> - <para> - Make change in configuration file - </para> - </listitem> - - <listitem> - <para> - Start <command>ndb_mgmd</command> - </para> - </listitem> - - </orderedlist> - </td> - <td colspan="2" rowspan="2"> - <orderedlist> - - <listitem> - <para> - Stop <command>ndb_mgmd</command> - </para> - </listitem> - - <listitem> - <para> - Replace <command>ndb_mgmd</command> binary with new - version - </para> - </listitem> - - <listitem> - <para> - Start <command>ndb_mgmd</command> - </para> - </listitem> - - </orderedlist> - </td> - <td colspan="2" rowspan="2"> - <orderedlist> - - <listitem> - <para> - Stop <command>ndb_mgmd</command> - </para> - </listitem> - - <listitem> - <para> - Make desired changes in hardware/operating system - </para> - </listitem> - - <listitem> - <para> - Start <command>ndb_mgmd</command> - </para> - </listitem> - - </orderedlist> - </td> - <th colspan="2">( OR )</th> - </tr> - <tr> - <td> - <orderedlist> - - <listitem> - <para> - Stop <command>ndb_mgmd</command> - </para> - </listitem> - - <listitem> - <para> - Start <command>ndb_mgmd</command> - </para> - </listitem> - - </orderedlist> - </td> - <td> Restart <command>ndb_mgmd</command> (optional) </td> - </tr> - <tr> - <th colspan="8">B. For each <command>ndbd</command> - process...</th> - </tr> - <tr> - <th colspan="2">( OR )</th> - <td colspan="2" rowspan="2"> - <orderedlist> - - <listitem> - <para> - Stop <command>ndbd</command> - </para> - </listitem> - - <listitem> - <para> - Replace <command>ndbd</command> binary with new - version - </para> - </listitem> - - <listitem> - <para> - Start <command>ndbd</command> - </para> - </listitem> - - </orderedlist> - </td> - <td colspan="2" rowspan="2"> - <orderedlist> - - <listitem> - <para> - Stop <command>ndbd</command> - </para> - </listitem> - - <listitem> - <para> - Make desired changes in hardware/operating system - </para> - </listitem> - - <listitem> - <para> - Start <command>ndbd</command> - </para> - </listitem> - - </orderedlist> - </td> - <th colspan="2">( OR )</th> - </tr> - <tr> - <td> - <orderedlist> - - <listitem> - <para> - Stop <command>ndbd</command> - </para> - </listitem> - - <listitem> - <para> - Start <command>ndbd</command> - </para> - </listitem> - - </orderedlist> - </td> - <td> Restart <command>ndbd</command> - </td> - <td> - <orderedlist> - - <listitem> - <para> - Stop <command>ndbd</command> - </para> - </listitem> - - <listitem> - <para> - Start <command>ndbd</command> - </para> - </listitem> - - </orderedlist> - </td> - <td> Restart <command>ndbd</command> - </td> - </tr> - </tbody> - </table> - - </section> - - <section id="mysql-cluster-upgrade-downgrade-compatibility"> - - <title>&title-mysql-cluster-upgrade-downgrade-compatibility;</title> - - <para> - This section provides information regarding Cluster software and - table file compatibility between differing versions of the MySQL - Server for purposes of performing upgrades and downgrades. - </para> - - <para> - <emphasis role="bold">Important</emphasis>: Only compatibility - between MySQL versions with regard to <literal>NDB - Cluster</literal> is taken into account in this section, and - there are likely other issues to be considered. <emphasis>As - with any other MySQL software upgrade or downgrade, you are - strongly encouraged to review the relevant portions of the MySQL - Manual for the MySQL versions from which and to which you intend - to migrate, before attempting an upgrade or downgrade of the - MySQL Cluster software</emphasis>. See - <xref linkend="upgrade"/>. - </para> - - <remark role="note"> - [js] Table info extracted from the file - mysql-5.2/storage/ndb/src/common/util/version.c - </remark> - - <remark role="todo"> - [js] Update as new server versions are released - </remark> - - <para> - The following table shows Cluster upgrade and downgrade - compatibility between different versions of the MySQL Server. - </para> - - <table> - <caption> Cluster Upgrade/Downgrade Compatibility — by - MySQL Server version </caption> - <tbody> - <tr> - <td colspan="2"> - <para> - <emphasis role="bold">MySQL 4.1</emphasis> - </para> - </td> - <td> </td> - <td colspan="2"> - <para> - <emphasis role="bold">MySQL 5.0</emphasis> - </para> - </td> - <td> </td> - <td colspan="2"> - <para> - <emphasis role="bold">MySQL 5.1</emphasis> - </para> - </td> - </tr> - <tr> - <td colspan="3"> </td> - <td>5.0.21</td> - <td>⇕</td> - <td colspan="3"> </td> - </tr> - <tr> - <td colspan="3"> </td> - <td>5.0.20</td> - <td>⇕</td> - <td colspan="3"> </td> - </tr> - <tr> - <td colspan="3"> </td> - <td>5.0.19</td> - <td>⇕</td> - <td colspan="3"> </td> - </tr> - <tr> - <td colspan="3"> </td> - <td>5.0.18</td> - <td>⇕</td> - <td colspan="3"> </td> - </tr> - <tr> - <td colspan="3"> </td> - <td>5.0.17</td> - <td>⇕</td> - <td colspan="3"> </td> - </tr> - <tr> - <td colspan="3"> </td> - <td>5.0.16</td> - <td>⇕</td> - <td colspan="3"> </td> - </tr> - <tr> - <td colspan="3"> </td> - <td>5.0.15</td> - <td>⇕</td> - <td colspan="3"> </td> - </tr> - <tr> - <td colspan="3"> </td> - <td>5.0.14</td> - <td>⇕</td> - <td colspan="3"> </td> - </tr> - <tr> - <td>4.1.19</td> - <td>⇕</td> - <td> </td> - <td>5.0.13</td> - <td>⇕</td> - <td colspan="3"> </td> - </tr> - <tr> - <td>4.1.18</td> - <td>⇕</td> - <td> </td> - <td>5.0.12</td> - <td>⇕</td> - <td colspan="3"> </td> - </tr> - <tr> - <td>4.1.17</td> - <td>⇕</td> - <td> </td> - <td>5.0.11</td> - <td>⇑ (see Notes)</td> - <td colspan="3"> </td> - </tr> - <tr> - <td>4.1.16</td> - <td>⇕</td> - <td> </td> - <td>5.0.10</td> - <td>⇕</td> - <td colspan="3"> </td> - </tr> - <tr> - <td>4.1.15</td> - <td>⇑ (see Notes)</td> - <td> </td> - <td>5.0.9</td> - <td>⇕</td> - <td colspan="3"> </td> - </tr> - <tr> - <td>4.1.14</td> - <td>⇕</td> - <td> </td> - <td>5.0.8</td> - <td>⇕</td> - <td> </td> - <td>5.1.10</td> - <td>⇕</td> - </tr> - <tr> - <td>4.1.13</td> - <td>⇕</td> - <td> </td> - <td>5.0.7</td> - <td>⇕</td> - <td> </td> - <td>5.1.9</td> - <td>⇕</td> - </tr> - <tr> - <td>4.1.12</td> - <td>⇕</td> - <td> </td> - <td>5.0.6</td> - <td>⇕</td> - <td> </td> - <td>5.1.7</td> - <td>⇕</td> - </tr> - <tr> - <td>4.1.11</td> - <td>⇕</td> - <td> </td> - <td>5.0.5</td> - <td>⇕</td> - <td> </td> - <td>5.1.6</td> - <td>⇕</td> - </tr> - <tr> - <td>4.1.10</td> - <td>⇕</td> - <td> </td> - <td>5.0.4</td> - <td>⇕</td> - <td> </td> - <td>5.1.5</td> - <td>⇕</td> - </tr> - <tr> - <td>4.1.9</td> - <td>⇑ / ⇓ (see Notes)</td> - <td> </td> - <td>5.0.3</td> - <td>⇕</td> - <td> </td> - <td>5.1.4</td> - <td>⇕</td> - </tr> - <tr> - <td>4.1.8</td> - <td>⇑</td> - <td> </td> - <td>5.0.2</td> - <td>⇑</td> - <td> </td> - <td>5.1.3</td> - <td>⇕</td> - </tr> - <tr> - <td colspan="1"> - <para> - <emphasis>KEY</emphasis>: - </para> - </td> - <td colspan="7"> - <itemizedlist> - - <listitem> - <para> - ⇕: Upwardly and downwardly compatible - </para> - </listitem> - - <listitem> - <para> - ⇑: Upwardly compatible only - </para> - </listitem> - - <listitem> - <para> - ⇓: Downwardly compatible only - </para> - </listitem> - - </itemizedlist> - </td> - </tr> - </tbody> - </table> - - <para> - <emphasis role="bold">Notes</emphasis>: - </para> - - <itemizedlist> - - <listitem> - <para> - <emphasis role="bold">4.1 Series</emphasis>: - </para> - - <para> - You cannot upgrade directly from 4.1.8 to 4.1.10 (or newer); - you must first upgrade from 4.1.8 to 4.1.9, then upgrade to - 4.1.10. Similarly, you cannot downgrade directly from 4.1.10 - (or newer) to 4.1.8; you must first downgrade from 4.1.10 to - 4.1.9, then downgrade from 4.1.9 to 4.1.8. - </para> - - <para> - If you wish to upgrade a MySQL Cluster to 4.1.15, you must - upgrade to 4.1.14 first, and you must upgrade to 4.1.15 - before upgrading to 4.1.16 or newer. - </para> - - <para> - Cluster downgrades from 4.1.15 to 4.1.14 (or earlier - versions) are not supported. - </para> - - <para> - Cluster upgrades from MySQL Server versions previous to - 4.1.8 are not supported; when upgrading from these, you must - dump all <literal>NDB</literal> tables, install the new - version of the software, and then reload the tables from the - dump. - </para> - </listitem> - - <listitem> - <para> - <emphasis role="bold">5.0 Series</emphasis>: - </para> - - <para> - MySQL 5.0.2 was the first public release in this series. - </para> - - <para> - Cluster downgrades from MySQL 5.0 to MySQL 4.1 are not - supported. - </para> - - <para> - Cluster downgrades from 5.0.12 to 5.0.11 (or earlier) are - not supported. - </para> - - <para> - You cannot restore with <command>ndb_restore</command> to a - MySQL 5.0 Cluster using a backup made from a Cluster running - MySQL 5.1. You must use <command>mysqldump</command> in such - cases. - </para> - </listitem> - - <listitem> - <para> - <emphasis role="bold">5.1 Series</emphasis>: - </para> - - <para> - MySQL 5.1.3 was the first public release in this series. - </para> - - <para> - You cannot downgrade a MySQL 5.1.6 or later Cluster using - Disk Data tables to MySQL 5.1.5 or earlier unless you - convert all such tables to in-memory Cluster tables first. - </para> - - <para> - There was no public release for MySQL 5.1.8. - </para> - </listitem> - - </itemizedlist> - - </section> - - </section> - <section id="mysql-cluster-management"> <title>&title-mysql-cluster-management;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>managing</secondary> + </indexterm> + + <indexterm> + <primary>managing MySQL Cluster</primary> + </indexterm> + <para> Managing a MySQL Cluster involves a number of tasks, the first of which is to configure and start MySQL Cluster. This is covered in @@ -8044,6 +8361,11 @@ <title>&title-mysql-cluster-startup-phases;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>starting or restarting</secondary> + </indexterm> + <para> This section describes the steps involved when the cluster is started. @@ -8354,6 +8676,21 @@ <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> + </indexterm> + <para> In addition to the central configuration file, a cluster may also be controlled through a command-line interface available @@ -8363,7 +8700,7 @@ <para> Commands for the event logs are given in - <xref linkend="mysql-cluster-event-reports"/>. commands for + <xref linkend="mysql-cluster-event-reports"/>; commands for creating backups and restoring from backup are provided in <xref linkend="mysql-cluster-backup"/>. </para> @@ -8379,6 +8716,13 @@ <itemizedlist> <listitem> + <indexterm> + <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> @@ -8389,6 +8733,13 @@ </listitem> <listitem> + <indexterm> + <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> @@ -8406,6 +8757,13 @@ </listitem> <listitem> + <indexterm> + <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> @@ -8424,6 +8782,13 @@ </listitem> <listitem> + <indexterm> + <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> @@ -8442,6 +8807,13 @@ </listitem> <listitem> + <indexterm> + <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> @@ -8458,6 +8830,13 @@ </listitem> <listitem> + <indexterm> + <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> @@ -8469,6 +8848,20 @@ </listitem> <listitem> + <indexterm> + <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> @@ -8482,6 +8875,13 @@ </listitem> <listitem> + <indexterm> + <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> @@ -8494,6 +8894,13 @@ </listitem> <listitem> + <indexterm> + <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> @@ -8504,6 +8911,13 @@ </listitem> <listitem> + <indexterm> + <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> @@ -8522,6 +8936,33 @@ <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> + </indexterm> + <para> In this section, we discuss the types of event logs provided by MySQL Cluster, and the types of events that are logged. @@ -8529,9 +8970,9 @@ <para> MySQL Cluster provides two types of event log. These are the - <emphasis role="bold">cluster log</emphasis>, which includes - events generated by all cluster nodes, and - <emphasis role="bold">node logs</emphasis>, which are local to + <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> @@ -8560,6 +9001,15 @@ different criteria: </para> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>event types</secondary> + </indexterm> + + <indexterm> + <primary>event types (MySQL Cluster)</primary> + </indexterm> + <itemizedlist> <listitem> @@ -8604,11 +9054,47 @@ <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> + <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> + <itemizedlist> <listitem> @@ -8675,6 +9161,15 @@ 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> + <para> Note that events are reported per data node, and that the threshold can be set to different values on different nodes. @@ -8734,6 +9229,15 @@ 3. </para> + <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 @@ -8803,6 +9307,15 @@ <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> + <para> An event report reported in the event logs has the following format: @@ -8831,6 +9344,24 @@ 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> + <para> <emphasis role="bold"><literal>CONNECTION</literal> Events</emphasis> @@ -8887,6 +9418,15 @@ 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> + <para> The logging messages shown here are associated with checkpoints. @@ -8956,6 +9496,15 @@ 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> + <para> The following events are generated in response to the startup of a node or of the cluster and of its success or failure. @@ -9062,6 +9611,15 @@ 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> + <para> The following events are generated when restarting a node and relate to the success or failure of the node restart process. @@ -9284,6 +9842,15 @@ 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> + <para> The following events are of a statistical nature. They provide information such as numbers of transactions and other @@ -9357,6 +9924,15 @@ 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> + <para> These events relate to Cluster errors and warnings. The presence of one or more of these generally indicates that a @@ -9417,6 +9993,15 @@ 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> + <para> These events provide general information about the state of the cluster and activities associated with Cluster @@ -9459,13 +10044,197 @@ </informaltable> </section> + + + <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>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> + + <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> + + <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> + 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> + 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> + + </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 <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> + +<programlisting> +ndb_mgm> <userinput>ALL CLUSTERLOG STATISTICS=15</userinput> +</programlisting> + </section> + + </section> + <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> + <para> Single-user mode allows the database administrator to restrict access to the database system to a single MySQL server (SQL @@ -9538,6 +10307,11 @@ NDB> <userinput>EXIT SINGLE USER MODE</userinput> </programlisting> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>node failure (single-user mode)</secondary> + </indexterm> + <para> There are two recommended ways to handle a node failure when running in single-user mode: @@ -9592,6 +10366,16 @@ <title>&title-mysql-cluster-backup;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>backups</secondary> + </indexterm> + + <indexterm> + <primary>backups</primary> + <secondary>in MySQL Cluster</secondary> + </indexterm> + <para> This section describes how to create a backup and how to restore the database from a backup at a later time. @@ -9601,6 +10385,16 @@ <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> + <para> A backup is a snapshot of the database at a given time. The backup consists of three main parts: @@ -9698,6 +10492,16 @@ <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> + <para> Before starting a backup, make sure that the cluster is properly configured for performing one. (See @@ -9712,12 +10516,23 @@ <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> <para> Start the management server (<command>ndb_mgm</command>). </para> </listitem> <listitem> + + <para> Execute the command <literal>START BACKUP</literal>. </para> @@ -9827,6 +10642,26 @@ <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> + + <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] @@ -9889,6 +10724,26 @@ <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> + + <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> @@ -9896,6 +10751,9 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>BackupDataBufferSize</literal></primary> + </indexterm> <para> <literal>BackupDataBufferSize</literal> </para> @@ -9907,6 +10765,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>BackupLogBufferSize</literal></primary> + </indexterm> <para> <literal>BackupLogBufferSize</literal> </para> @@ -9918,6 +10779,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>BackupMemory</literal></primary> + </indexterm> <para> <literal>BackupMemory</literal> </para> @@ -9930,6 +10794,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>BackupWriteSize</literal></primary> + </indexterm> <para> <literal>BackupWriteSize</literal> </para> @@ -9953,6 +10820,21 @@ <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> + <para> If an error code is returned when issuing a backup request, the most likely cause is insufficient memory or insufficient @@ -11248,7 +12130,7 @@ <para> The only supported isolation level is <literal>READ COMMITTED</literal>. (InnoDB supports <literal>READ - COMMITTED</literal>, <literal>READ COMMITTED</literal>, + COMMITTED</literal>, <literal>READ UNCOMMITTED</literal>, <literal>REPEATABLE READ</literal>, and <literal>SERIALIZABLE</literal>.) See <xref linkend="mysql-cluster-backup-troubleshooting"/>, @@ -11997,7 +12879,7 @@ means that all table data (including indexes) is stored in RAM. Therefore, if your data takes up 1GB of space and you want to replicate it once in the cluster, you need 2GB of - memory to do so. This in addition to the memory required by + memory to do so. This is in addition to the memory required by the operating system and any applications running on the cluster computers. </para> @@ -12016,7 +12898,7 @@ </para> <para> - ( We implemented disk data storage for MySQL Cluster in MySQL + (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> Modified: trunk/refman-5.1/ndbcluster.xml =================================================================== --- trunk/refman-5.1/ndbcluster.xml 2006-05-24 13:43:56 UTC (rev 2187) +++ trunk/refman-5.1/ndbcluster.xml 2006-05-24 14:44:04 UTC (rev 2188) @@ -1004,7 +1004,7 @@ </indexterm> <para> - Each MySQL Cluster host computer running storage or SQL nodes + 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 @@ -4492,8 +4492,8 @@ </para> <para> - <emphasis role="bold">Note</emphasis>: When replication - between clusters is supported, this will also make use of + Replication + between clusters also makes use of internal triggers. </para> @@ -5964,8 +5964,7 @@ <listitem> <indexterm> - <primary><literal>ReceiveBufferMemory</literal> (MySQL Cluster configuration - parameter)</primary> + <primary><literal>ReceiveBufferMemory</literal></primary> </indexterm> <para> @@ -5987,6 +5986,22 @@ <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> + </indexterm> <para> Setting up a cluster using direct connections between data @@ -6051,6 +6066,27 @@ <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> + <tertiary>shared memory (SHM)</tertiary> + </indexterm> <para> MySQL Cluster attempts to use the shared memory transporter @@ -6082,6 +6118,14 @@ <itemizedlist> <listitem> + <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> @@ -6094,6 +6138,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ShmKey</literal></primary> + </indexterm> <para> <literal>ShmKey</literal> </para> @@ -6107,6 +6154,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ShmSize</literal></primary> + </indexterm> <para> <literal>ShmSize</literal> </para> @@ -6120,6 +6170,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>SendSignalId</literal></primary> + </indexterm> <para> <literal>SendSignalId</literal> </para> @@ -6134,6 +6187,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>Checksum</literal> (MySQL Cluster)</primary> + </indexterm> <para> <literal>Checksum</literal> </para> @@ -6160,7 +6216,29 @@ <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 @@ -6195,6 +6273,14 @@ <itemizedlist> <listitem> + <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> @@ -6207,6 +6293,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>Host*SciId*</literal> parameters</primary> + </indexterm> <para> <literal>Host1SciId0</literal> </para> @@ -6254,6 +6343,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>SharedBufferSize</literal></primary> + </indexterm> <para> <literal>SharedBufferSize</literal> </para> @@ -6270,6 +6362,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>SendLimit</literal></primary> + </indexterm> <para> <literal>SendLimit</literal> </para> @@ -6285,6 +6380,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>SendSignalId</literal></primary> + </indexterm> <para> <literal>SendSignalId</literal> </para> @@ -6298,6 +6396,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>Checksum</literal> (MySQL Cluster)</primary> + </indexterm> <para> <literal>Checksum</literal> </para> @@ -6315,11 +6416,6 @@ </itemizedlist> - <remark> - @node MySQL Cluster Complex Configuration, , MySQL Cluster SHM - Definition, MySQL Cluster Config File - </remark> - <remark role="todo"> [js] What is meant by "parts" here?? </remark> @@ -6337,6 +6433,21 @@ <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> + </indexterm> <para> This portion of the MySQL Cluster chapter covers upgrading and @@ -6363,7 +6474,27 @@ <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> + <para> This section discusses how to perform a <firstterm>rolling upgrade</firstterm> of a MySQL Cluster installation, so called @@ -6391,6 +6522,10 @@ <itemizedlist> <listitem> + <indexterm> + <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 @@ -6417,6 +6552,10 @@ </listitem> <listitem> + <indexterm> + <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 @@ -6667,6 +6806,26 @@ <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> <para> This section provides information regarding Cluster software and @@ -7010,6 +7169,23 @@ <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> <para> Understanding how to manage MySQL Cluster requires a knowledge of @@ -7050,6 +7226,30 @@ <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> + </indexterm> <para> <command>mysqld</command> is the traditional MySQL server @@ -7102,6 +7302,20 @@ <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> + </indexterm> <para> To read cluster configuration data, the MySQL server requires at @@ -7177,6 +7391,29 @@ <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> + </indexterm> <para> <command>ndbd</command> is the process that is used to handle @@ -7197,6 +7434,15 @@ <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> <para> <command>ndbd</command> generates a set of log files which are @@ -7212,6 +7458,15 @@ <itemizedlist> <listitem> + + <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 @@ -7249,6 +7504,15 @@ </listitem> <listitem> + + <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 @@ -7368,7 +7632,32 @@ <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> + </indexterm> + + <indexterm> + <primary><command>ndb_mgmd</command></primary> + <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 @@ -7404,6 +7693,19 @@ <itemizedlist> <listitem> + + <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 @@ -7458,6 +7760,39 @@ <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> + </indexterm> + + <indexterm> + <primary><command>ndb_mgm</command></primary> + <see><command>mgm</command></see> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>administration</secondary> + </indexterm> + + <indexterm> + <primary>administration of MySQL Cluster</primary> + </indexterm> <para> The management client process is actually not needed to run the @@ -7503,6 +7838,36 @@ <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> + </indexterm> <para> All MySQL Cluster executables (except for @@ -7615,11 +7980,9 @@ versions can be used together, and at startup the MySQL 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 software upgrade of - MySQL Cluster. - -<!-- (See <literal>Software Upgrade of MySQL - Cluster</literal>). --> + important when performing an online (rolling) software + upgrade of MySQL Cluster. (See + <xref linkend="mysql-cluster-upgrade-downgrade-rolling"/>). </para> </listitem> @@ -7628,6 +7991,31 @@ <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><command>mysqld</command></primary> + <secondary>as MySQL Cluster process</secondary> + </indexterm> <itemizedlist> @@ -7667,6 +8055,26 @@ <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> <para> For options common to NDB programs, see @@ -7786,6 +8194,26 @@ <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> <para> For options common to NDB programs, see @@ -7845,6 +8273,26 @@ <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> <para> For options common to NDB programs, see @@ -7879,6 +8327,15 @@ <section id="mysql-cluster-management"> <title>&title-mysql-cluster-management;</title> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>managing</secondary> + </indexterm> + + <indexterm> + <primary>managing MySQL Cluster</primary> + </indexterm> <para> Managing a MySQL Cluster involves a number of tasks, the first of @@ -7911,6 +8368,11 @@ <section id="mysql-cluster-startup-phases"> <title>&title-mysql-cluster-startup-phases;</title> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>starting or restarting</secondary> + </indexterm> <para> This section describes the steps involved when the cluster is @@ -8221,6 +8683,21 @@ <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> + </indexterm> <para> In addition to the central configuration file, a cluster may @@ -8231,7 +8708,7 @@ <para> Commands for the event logs are given in - <xref linkend="mysql-cluster-event-reports"/>. commands for + <xref linkend="mysql-cluster-event-reports"/>; commands for creating backups and restoring from backup are provided in <xref linkend="mysql-cluster-backup"/>. </para> @@ -8247,6 +8724,13 @@ <itemizedlist> <listitem> + <indexterm> + <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> @@ -8257,6 +8741,13 @@ </listitem> <listitem> + <indexterm> + <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> @@ -8274,6 +8765,13 @@ </listitem> <listitem> + <indexterm> + <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> @@ -8287,6 +8785,13 @@ </listitem> <listitem> + <indexterm> + <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> @@ -8300,6 +8805,13 @@ </listitem> <listitem> + <indexterm> + <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> @@ -8316,6 +8828,13 @@ </listitem> <listitem> + <indexterm> + <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> @@ -8327,6 +8846,20 @@ </listitem> <listitem> + <indexterm> + <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> @@ -8340,6 +8873,13 @@ </listitem> <listitem> + <indexterm> + <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> @@ -8352,6 +8892,13 @@ </listitem> <listitem> + <indexterm> + <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> @@ -8362,6 +8909,13 @@ </listitem> <listitem> + <indexterm> + <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> @@ -8379,6 +8933,33 @@ <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> + </indexterm> <para> In this section, we discuss the types of event logs provided by @@ -8387,9 +8968,9 @@ <para> MySQL Cluster provides two types of event log. These are the - <emphasis role="bold">cluster log</emphasis>, which includes - events generated by all cluster nodes, and - <emphasis role="bold">node logs</emphasis>, which are local to + <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> @@ -8417,6 +8998,15 @@ 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> <itemizedlist> @@ -8461,11 +9051,47 @@ <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> <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> <itemizedlist> @@ -8532,6 +9158,15 @@ 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> <para> Note that events are reported per data node, and that the @@ -8591,6 +9226,15 @@ 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> <para> The following table shows the event severity levels. @@ -8660,6 +9304,15 @@ <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> <para> An event report reported in the event logs has the following @@ -8688,6 +9341,24 @@ 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> <para> <emphasis role="bold"><literal>CONNECTION</literal> @@ -8744,6 +9415,15 @@ <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> <para> The logging messages shown here are associated with @@ -8813,6 +9493,15 @@ <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> <para> The following events are generated in response to the startup @@ -8919,6 +9608,15 @@ <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> <para> The following events are generated when restarting a node and @@ -9141,6 +9839,15 @@ <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> <para> The following events are of a statistical nature. They provide @@ -9214,6 +9921,15 @@ <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> <para> These events relate to Cluster errors and warnings. The @@ -9274,6 +9990,15 @@ <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> <para> These events provide general information about the state of @@ -9321,7 +10046,37 @@ <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>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 @@ -9390,6 +10145,11 @@ in an infinite loop. During each loop scheduler performs the following tasks: </para> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary><command>ndbd</command> process</secondary> + </indexterm> <orderedlist> @@ -9460,6 +10220,15 @@ <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> <para> Single-user mode allows the database administrator to restrict @@ -9532,6 +10301,11 @@ <programlisting> NDB> <userinput>EXIT SINGLE USER MODE</userinput> </programlisting> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>node failure (single-user mode)</secondary> + </indexterm> <para> There are two recommended ways to handle a node failure when @@ -9586,6 +10360,16 @@ <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> + </indexterm> <para> This section describes how to create a backup and how to restore @@ -9595,6 +10379,16 @@ <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> <para> A backup is a snapshot of the database at a given time. The @@ -9692,6 +10486,16 @@ <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> <para> Before starting a backup, make sure that the cluster is @@ -9713,6 +10517,16 @@ </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> + <para> Execute the command <literal>START BACKUP</literal>. </para> @@ -9821,6 +10635,26 @@ <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> + + <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 @@ -9883,6 +10717,26 @@ <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> + + <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: @@ -9891,6 +10745,9 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>BackupDataBufferSize</literal></primary> + </indexterm> <para> <literal>BackupDataBufferSize</literal> </para> @@ -9902,6 +10759,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>BackupLogBufferSize</literal></primary> + </indexterm> <para> <literal>BackupLogBufferSize</literal> </para> @@ -9913,6 +10773,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>BackupMemory</literal></primary> + </indexterm> <para> <literal>BackupMemory</literal> </para> @@ -9925,6 +10788,9 @@ </listitem> <listitem> + <indexterm> + <primary><literal>BackupWriteSize</literal></primary> + </indexterm> <para> <literal>BackupWriteSize</literal> </para> @@ -9947,6 +10813,21 @@ <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> <para> If an error code is returned when issuing a backup request, @@ -9981,6 +10862,32 @@ <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>asynchronous replication</primary> + <see>MySQL Cluster replication</see> + </indexterm> + + <indexterm> + <primary>replication, asynchronous</primary> + <see>MySQL Cluster replication</see> + </indexterm> <para> Previous to MySQL 5.1.6, <firstterm>asynchronous @@ -10040,6 +10947,11 @@ <section id="mysql-cluster-replication-abbreviations"> <title>&title-mysql-cluster-replication-abbreviations;</title> + + <indexterm> + <primary>MySQL Cluster replication</primary> + <secondary>concepts</secondary> + </indexterm> <para> Throughout this section, we use the following abbreviations or @@ -10117,6 +11029,11 @@ <section id="mysql-cluster-replication-general"> <title>&title-mysql-cluster-replication-general;</title> + + <indexterm> + <primary>MySQL Cluster replication</primary> + <secondary>concepts</secondary> + </indexterm> <para> A replication channel requires two MySQL servers acting as @@ -10183,6 +11100,11 @@ <section id="mysql-cluster-replication-issues"> <title>&title-mysql-cluster-replication-issues;</title> + + <indexterm> + <primary>MySQL Cluster replication</primary> + <secondary>known issues</secondary> + </indexterm> <para> The following are known problems or issues when using @@ -10283,6 +11205,32 @@ <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> + <see>MySQL Cluster replication</see> + </indexterm> + + <indexterm> + <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> + </indexterm> <para> Replication in MySQL Cluster makes use of a number of dedicated @@ -10337,6 +11285,16 @@ <literal>binlog_index</literal> table</phrase> </textobject> </mediaobject> + + <indexterm> + <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> + </indexterm> <para> An additional table, named <literal>apply_status</literal>, is @@ -10391,6 +11349,18 @@ <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> + </indexterm> <para> Preparing the MySQL Cluster for replication consists of the @@ -10454,6 +11424,11 @@ 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> + </indexterm> <programlisting> mysql<replaceable>S</replaceable>> <userinput>CHANGE MASTER TO</userinput> @@ -10612,6 +11587,11 @@ <section id="mysql-cluster-replication-starting"> <title>&title-mysql-cluster-replication-starting;</title> + + <indexterm> + <primary>MySQL Cluster replication</primary> + <secondary>starting</secondary> + </indexterm> <para> This section outlines the procedure for starting MySQL CLuster @@ -10726,6 +11706,10 @@ <section id="mysql-cluster-replication-two-channels"> <title>&title-mysql-cluster-replication-two-channels;</title> + + <indexterm> + <primary>MySQL Cluster replication</primary> + </indexterm> <para> In a more complete example scenario, we envision two replication @@ -10847,6 +11831,16 @@ <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> + </indexterm> <para> In the event that the primary Cluster replication process fails, @@ -10872,6 +11866,11 @@ </listitem> <listitem> + <indexterm> + <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 @@ -10967,6 +11966,26 @@ <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> + </indexterm> <para> This section discusses making backups and restoring from them @@ -11021,6 +12040,11 @@ 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> + </indexterm> <programlisting> shell<replaceable>M</replaceable>> <userinput>ndb_mgm -e "START BACKUP"</userinput> @@ -11284,6 +12308,11 @@ <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> <para> It is possible to automate much of the process described in @@ -11292,6 +12321,17 @@ 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> + </indexterm> + + <indexterm> + <primary><filename>reset-slave.pl</filename></primary> + <see>MySQL Cluster replication</see> + </indexterm> <programlisting> #!/user/bin/perl -w @@ -11480,6 +12520,11 @@ <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> + </indexterm> <para> The NDB Cluster storage engine does not at present @@ -13761,14 +14806,15 @@ <remark role="todo"> [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;. + &next-series;. --> </para> <para> @@ -14112,12 +15158,13 @@ </remark> <para> - Currently, Cluster is in-memory only. This means that all - table data (including indexes) is stored in RAM. Therefore, if - your data takes up 1GB of space and you want to replicate it - once in the cluster, you need 2GB of memory to do so. This in + 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. + any applications running on the cluster computers. This is still true + of in-memory tables. </para> <para>
| Thread | ||
|---|---|---|
| • svn commit - mysqldoc@docsrva: r2188 - in trunk: ndbapi ndbapi/images refman-4.1 refman-5.0 refman-5.1 | jon | 24 May |
© 1995-2008 MySQL AB, 2008-2009 Sun Microsystems, Inc.
Page generated in 2.356 sec. using MySQL 5.1.14-beta-log