Author: jstephens
Date: 2007-04-27 11:59:52 +0200 (Fri, 27 Apr 2007)
New Revision: 6244
Log:
Starting merge of MCCGE material into mainline 5.1 Cluster chapter.
Modified:
trunk/refman-5.1/mysql-cluster-mccge.xml
trunk/refman-5.1/mysql-cluster-merged.xml
Modified: trunk/refman-5.1/mysql-cluster-mccge.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster-mccge.xml 2007-04-27 09:49:19 UTC (rev 6243)
+++ trunk/refman-5.1/mysql-cluster-mccge.xml 2007-04-27 09:59:52 UTC (rev 6244)
Changed blocks: 42, Lines Added: 389, Lines Deleted: 83; 33325 bytes
@@ -2,14 +2,8 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
- <!ENTITY % fixedchars.entities SYSTEM "../common/fixedchars.ent">
- %fixedchars.entities;
- <!ENTITY % urls.entities SYSTEM "../refman-common/urls.ent">
- %urls.entities;
- <!ENTITY % versions.entities SYSTEM "versions.ent">
- %versions.entities;
- <!ENTITY % phrases.entities SYSTEM "../common/phrases.ent">
- %phrases.entities;
+ <!ENTITY % all.entities SYSTEM "all-entities.ent">
+ %all.entities;
]>
<chapter id="mysql-cluster">
@@ -44,9 +38,9 @@
MySQL Cluster is a high-availability, high-redundancy version of
MySQL adapted for the distributed computing environment. It uses the
<literal>NDB Cluster</literal> storage engine to enable running
- several MySQL servers in a cluster. This storage engine is
- compatible with most Unix-style operating systems, including all
- modern Linux distributions.
+ several MySQL servers in a cluster. This storage engine is available
+ in MySQL ¤t-series; binary releases and in RPMs compatible
+ with most modern Linux distributions.
</para>
<indexterm>
@@ -55,9 +49,9 @@
</indexterm>
<para>
- MySQL ¤t-series-mccge; is currently available and supported on
- a number of platforms, including Linux, Solaris, Mac OS X, BSD,
- HP-UX, and many other Unix-style operating systems on a variety of
+ MySQL ¤t-series; is currently available and supported on a
+ number of platforms, including Linux, Solaris, Mac OS X, BSD, HP-UX,
+ and many other Unix-style operating systems on a variety of
hardware. For exact levels of support available for on specific
combinations of operating system versions, operating system
distributions, and hardware platforms, please refer to the
@@ -67,11 +61,10 @@
</para>
<para>
- Like the standard version of MySQL Cluster, MySQL
- ¤t-series-mccge; is <emphasis>not</emphasis> currently
- supported on Microsoft Windows. We are working to make MySQL Cluster
- available on all operating systems supported by MySQL, including
- Windows.
+ MySQL Cluster is <emphasis>not</emphasis> currently supported on
+ Microsoft Windows. We are working to make Cluster available on all
+ operating systems supported by MySQL, including Windows, and will
+ update the information provided here as this work continues.
</para>
<para>
@@ -1140,6 +1133,19 @@
<listitem>
<para>
+ Change location to the <filename>mysql</filename> directory
+ and run the supplied script for creating the system
+ databases:
+ </para>
+
+<programlisting>
+shell> <userinput>cd mysql</userinput>
+shell> <userinput>scripts/mysql_install_db --user=mysql</userinput>
+</programlisting>
+ </listitem>
+
+ <listitem>
+ <para>
Set the necessary permissions for the MySQL server and data
directories:
</para>
@@ -1501,7 +1507,7 @@
Starting the cluster is not very difficult after it has been
configured. Each cluster node process must be started
separately, and on the host where it resides. The management
- node ahould be started first, followed by the data nodes, and
+ node should be started first, followed by the data nodes, and
then finally by any SQL nodes:
</para>
@@ -2832,7 +2838,7 @@
<section id="mysql-cluster-connectstring">
- <title>The Cluster <literal>connectstring</literal></title>
+ <title>The Cluster Connectstring</title>
<indexterm>
<primary>MySQL Cluster</primary>
@@ -3587,9 +3593,9 @@
<para>
This parameter specifies the directory where all files
- created for metadata, REDO logs, UNDO logs and data files
- are placed. The default is the directory specified by
- <literal>DataDir</literal>.
+ created for metadata, REDO logs, UNDO logs (for Disk Data
+ tables) and data files are placed. The default is the
+ directory specified by <literal>DataDir</literal>.
<emphasis role="bold">Note</emphasis>: This directory must
exist before the <command>ndbd</command> process is
initiated.
@@ -6293,12 +6299,24 @@
</para>
<para>
- It is only necessary to define a connection to override the
+ It is necessary to define a connection only to override the
default connection parameters. In that case, it is necessary
to define at least <literal>NodeId1</literal>,
<literal>NodeId2</literal>, and the parameters to change.
</para>
+ <important>
+ <para>
+ Any <literal>[TCP]</literal> sections in the
+ <filename>config.ini</filename> file should be listed last,
+ following any other sections in the file. This is not
+ required for a <literal>[TCP DEFAULT]</literal> section.
+ This is a known issue with the way in which the
+ <filename>config.ini</filename> file is read by the cluster
+ management server.
+ </para>
+ </important>
+
<para>
It is also possible to change the default values for these
parameters by setting them in the <literal>[TCP
@@ -8318,19 +8336,13 @@
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"/>).
+ <xref linkend="mysql-cluster-upgrade-downgrade-compatibility"/>).
+ 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>
- <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 continues to be updated
and expanded.
</para>
@@ -8513,6 +8525,16 @@
client <literal>RESTART</literal> command.
</para>
+ <important>
+ <para>
+ When performing an upgrade or downgrade of the cluster
+ software, you <emphasis>must</emphasis> upgrade or downgrade
+ the management nodes <emphasis>first</emphasis>, then the data
+ nodes, and finally the SQL nodes. Doing so in any other order
+ may leave the cluster in an unusable state.
+ </para>
+ </important>
+
</section>
<section id="mysql-cluster-upgrade-downgrade-compatibility">
@@ -8668,7 +8690,8 @@
</para>
<para>
- MySQL 5.1.8 and MySQL 5.1.10 were not released.
+ MySQL 5.1.8, MySQL 5.1.10, and MySQL 5.1.13 were not
+ released.
</para>
<para>
@@ -8683,6 +8706,70 @@
</para>
</listitem>
+ <listitem>
+ <para>
+ Online downgrades from MySQL 5.1.14 or later to versions
+ previous to 5.1.14 are not supported due to incompatible
+ changes in the cluster system tables.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Online upgrades from MySQL 5.1.17 and earlier to 5.1.18 and
+ later are not supported for clusters using replication due
+ to incompatible changes in the
+ <literal>mysql.ndb_apply_status</literal> table. However, it
+ should not be necessary to shut down the cluster entirely,
+ if you follow this modified rolling restart procedure:
+
+ <orderedlist>
+
+ <listitem>
+ <para>
+ Stop the management server, update the
+ <literal>ndb_mgmd</literal> binary, then start it
+ again. For multiple management servers, repeat this
+ step for each management server in turn.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ For each data node in turn: Stop the data node,
+ replace the <literal>ndbd</literal> binary with the
+ new version, then restart the data node. It is not
+ necessary to use <literal>--initial</literal> when
+ restarting any of the data nodes.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Stop <emphasis>all</emphasis> SQL nodes. Replace the
+ <command>mysqld</command> binary with the new version
+ for all SQL nodes, then restart them. It is not
+ necessary to start them one at a time, but they must
+ all be shut down at the same time before starting any
+ of them again using the 5.1.18 (or later)
+ <command>mysqld</command>. Otherwise — due to
+ the fact that
+ <literal>mysql.ndb_apply_status</literal> uses the
+ <literal>NDB</literal> storage engine and is thus
+ shared between all SQL nodes — there may be
+ conflicts between MySQL servers using the old and new
+ versions of the table.
+ </para>
+ </listitem>
+
+ </orderedlist>
+
+ You can find more information about the changes to
+ <literal>ndb_apply_status</literal> in
+ <xref linkend="mysql-cluster-replication-schema"/>.
+ </para>
+ </listitem>
+
</itemizedlist>
</section>
@@ -8778,10 +8865,12 @@
<command>mysqld</command> is the traditional MySQL server
process. To be used with MySQL Cluster,
<command>mysqld</command> needs to be built with support for the
- <literal>NDB Cluster</literal> storage engine. When building
- MySQL from source, you must invoke <command>configure</command>
- with the <option>--with-ndbcluster</option> option to enable
- <literal>NDB Cluster</literal> storage engine support.
+ <literal>NDB Cluster</literal> storage engine, as it is in the
+ precompiled binaries available from
+ <ulink url="&base-url-downloads;"/>. If you build MySQL from
+ source, you must invoke <command>configure</command> with the
+ <option>--with-ndbcluster</option> option to enable <literal>NDB
+ Cluster</literal> storage engine support.
</para>
<para>
@@ -8889,7 +8978,7 @@
</para>
<programlisting>
-shell> <userinput>mysqld --ndb-connectstring=ndb_mgmd.mysql.com:1186</userinput>
+shell> <userinput>mysqld --ndbcluster --ndb-connectstring=ndb_mgmd.mysql.com:1186</userinput>
</programlisting>
<para>
@@ -8899,7 +8988,7 @@
<para>
Given this information, the MySQL server will be a full
- participant in the cluster. (We sometimes refer to a
+ participant in the cluster. (We often refer to a
<command>mysqld</command> process running in this manner as an
SQL node.) It will be fully aware of all cluster data nodes as
well as their status, and will establish connections to all data
@@ -8928,6 +9017,30 @@
Info: NULL
</programlisting>
+ <important>
+ <para>
+ To participate in a MySQL Cluster, the
+ <command>mysqld</command> process must be started with
+ <emphasis>both</emphasis> the options
+ <option>--ndbcluster</option> and
+ <option>--ndb-connectstring</option> (or their equivalents in
+ <filename>my.cnf</filename>). If <command>mysqld</command> is
+ started with only the <option>--ndbcluster</option> option, or
+ if it is unable to contact the cluster, it is not possible to
+ work with <literal>NDB</literal> tables, <emphasis>nor is it
+ possible to create any new tables regardless of storage
+ engine</emphasis>. The latter restriction is a safety measure
+ intended to prevent the creation of tables having the same
+ names as <literal>NDB</literal> tables while the SQL node is
+ not connected to the cluster. If you wish to create tables
+ using a different storage engine while the
+ <command>mysqld</command> process is not participating in a
+ MySQL Cluster, you must restart the server
+ <emphasis>without</emphasis> the <option>--ndbcluster</option>
+ option.
+ </para>
+ </important>
+
</section>
<section id="fake-id-for-ndbd-manpage-section-wrapper">
@@ -8965,7 +9078,7 @@
<manvolnum>1</manvolnum>
<refmiscinfo class="manual">MySQL Database System</refmiscinfo>
<refmiscinfo class="source">MySQL</refmiscinfo>
- <refmiscinfo class="version">¤t-series-mccge;</refmiscinfo>
+ <refmiscinfo class="version">¤t-series;</refmiscinfo>
<refmiscinfo class="refman">The Storage Engine Node Process</refmiscinfo>
</refmeta>
@@ -9207,7 +9320,7 @@
<command>ndbd</command> processes which belong to different
node groups; however, such a configuration is still
considered experimental and is not supported for MySQL
- ¤t-series-mccge; in a production setting. See
+ ¤t-series; in a production setting. See
<xref linkend="mysql-cluster-limitations"/>.
</para>
@@ -9253,7 +9366,7 @@
<manvolnum>1</manvolnum>
<refmiscinfo class="manual">MySQL Database System</refmiscinfo>
<refmiscinfo class="source">MySQL</refmiscinfo>
- <refmiscinfo class="version">¤t-series-mccge;</refmiscinfo>
+ <refmiscinfo class="version">¤t-series;</refmiscinfo>
<refmiscinfo class="refman">The Management Server Process</refmiscinfo>
</refmeta>
@@ -9422,7 +9535,7 @@
<manvolnum>1</manvolnum>
<refmiscinfo class="manual">MySQL Database System</refmiscinfo>
<refmiscinfo class="source">MySQL</refmiscinfo>
- <refmiscinfo class="version">¤t-series-mccge;</refmiscinfo>
+ <refmiscinfo class="version">¤t-series;</refmiscinfo>
<refmiscinfo class="refman">The Management Client Process</refmiscinfo>
</refmeta>
@@ -10367,7 +10480,7 @@
<listitem>
<para>
- Read data from the local checkpoint and undo logs.
+ Read data from the local checkpoint.
</para>
</listitem>
@@ -10475,7 +10588,7 @@
<listitem>
<para>
- <emphasis role="bold">Stage 10</emphasis>
+ <emphasis role="bold">Stage 100</emphasis>
</para>
<para>
@@ -10486,7 +10599,7 @@
<listitem>
<para>
- <emphasis role="bold">Stage 11</emphasis>
+ <emphasis role="bold">Stage 101</emphasis>
</para>
<para>
@@ -10510,7 +10623,7 @@
<section id="mysql-cluster-mgm-client-commands">
- <title>Commands in the Management Client</title>
+ <title>Commands in the MySQL Cluster Management Client</title>
<indexterm>
<primary>MySQL Cluster</primary>
@@ -10643,9 +10756,9 @@
</para>
<para>
- Starts the data or management node identified by
+ Stops the data or management node identified by
<replaceable>node_id</replaceable>. Note that <literal>ALL
- STOP</literal> works to start all data nodes only, and does
+ STOP</literal> works to stop all data nodes only, and does
not affect management nodes.
</para>
@@ -10750,9 +10863,9 @@
</para>
<para>
- It is not possible in MySQL ¤t-series-mccge; for data
- nodes to join the cluster while it is running in single user
- mode. (See Bug #20395 for more information.)
+ It is not possible in MySQL ¤t-series; for data nodes
+ to join the cluster while it is running in single user mode.
+ (See Bug #20395 for more information.)
</para>
</listitem>
@@ -11505,12 +11618,18 @@
<entry><literal>INFO</literal></entry>
<entry>Start of LCP: data written to disk</entry>
</row>
+<!--
<row>
+ <remark role="note">
+ [js] No longer applies since there are no more undo
+ logs in 5.1, right?
+ </remark>
<entry>Report undo log blocked</entry>
<entry>7</entry>
<entry><literal>INFO</literal></entry>
<entry>UNDO logging blocked; buffer near overflow</entry>
</row>
+-->
</tbody>
</tgroup>
</informaltable>
@@ -11556,12 +11675,18 @@
<entry><literal>INFO</literal></entry>
<entry>Blocks received after completion of restart</entry>
</row>
+<!--
+ <remark role="note">
+ [js] No longer applies since 5.1 doesn't have undo logs,
+ right?
+ </remark>
<row>
<entry>Undo records executed</entry>
<entry>15</entry>
<entry><literal>INFO</literal></entry>
<entry/>
</row>
+-->
<row>
<entry>New REDO log started</entry>
<entry>10</entry>
@@ -11582,7 +11707,7 @@
<entry>8</entry>
<entry><literal>INFO</literal></entry>
<entry>Node cannot be included in cluster due to misconfiguration, inability to
- establish communication, or other problem</entry>
+ establish communication, or some other problem</entry>
</row>
<row>
<entry>data node neighbors</entry>
@@ -13078,7 +13203,7 @@
<manvolnum>1</manvolnum>
<refmiscinfo class="manual">MySQL Database System</refmiscinfo>
<refmiscinfo class="source">MySQL</refmiscinfo>
- <refmiscinfo class="version">¤t-series-mccge;</refmiscinfo>
+ <refmiscinfo class="version">¤t-series;</refmiscinfo>
<refmiscinfo class="refman">Restore a Cluster Backup</refmiscinfo>
</refmeta>
@@ -13136,7 +13261,7 @@
</para>
<programlisting>
-ndb_restore [-c <replaceable>connectstring</replaceable>] -n <replaceable>node_id</replaceable> [-m] -b <replaceable>backup_id</replaceable> -r <replaceable>/path/to/backup/files</replaceable>
+ndb_restore [-c <replaceable>connectstring</replaceable>] -n <replaceable>node_id</replaceable> [-s] [-m] -b <replaceable>backup_id</replaceable> -r [backup_path=]<replaceable>/path/to/backup/files</replaceable> [-e]
</programlisting>
<para>
@@ -13191,6 +13316,29 @@
</para>
<para>
+ It is possible to restore data without restoring table
+ metadata. Prior to MySQL 5.1.17,
+ <command>ndb_restore</command> did not perform any checks of
+ table schemas; if a table was altered between the time the
+ backup was taken and when <command>ndb_restore</command> was
+ run, <command>ndb_restore</command> would still attempt to
+ restore the data to the altered table.
+ </para>
+
+ <para>
+ Beginning with MySQL 5.1.17, the default behavior is for
+ <command>ndb_restore</command> is to fail with an error if
+ table data do not match the table schema; this can be
+ overridden using the <option>--skip-table-check</option> or
+ <option>-s</option> option. If this option is used, then
+ <command>ndb_restore</command> attempts to fit data into the
+ existing table schema. <emphasis>The result of restoring a
+ backup to a table schema that does not match the original is
+ unspecified and is subject to change without
+ notice</emphasis>. (Bug #24363)
+ </para>
+
+ <para>
The <option>-b</option> option is used to specify the ID or
sequence number of the backup, and is the same number shown
by the management client in the <literal>Backup
@@ -13200,15 +13348,44 @@
</para>
<para>
- The <option>-r</option> option is required, and is used to
- tell <literal>ndb_restore</literal> the directory where it
- can find the backup files.
- <emphasis role="bold">Important</emphasis>: When restoring
- cluster backups, you must be sure to restore all data nodes
- from backups having the same backup ID.
+ <option>-e</option> adds (or restores) epoch information to
+ the cluster replication status table. This is useful for
+ starting replication on a MySQL Cluster replication slave.
+ When this option is used, the row in the
+ <literal>mysql.ndb_apply_status</literal> having
+ <literal>0</literal> in the <literal>id</literal> column is
+ updated if it already exists; such a row is inserted if it
+ does not already exist. (See
+ <xref linkend="mysql-cluster-replication-backups"/>.)
</para>
<para>
+ The path to the backup directory is required, and must
+ include the subdirectory corresponding to the ID backup of
+ the backup to be restored. For example, if the data node's
+ <literal>DataDir</literal> is
+ <filename>/var/lib/mysql-cluster</filename>, then the backup
+ directory is
+ <filename>/var/lib/mysql-cluster/BACKUP</filename>, and the
+ backup files for the backup with the ID 3 can be found in
+ <filename>/var/lib/mysql-cluster/BACKUP/BACKUP-3</filename>.
+ The path may be absolute or relative to the directory in
+ which the <command>ndb_restore</command> executable is
+ located, and may be optionally prefixed with
+ <option>backup_path=</option>.
+ </para>
+
+ <important>
+ <para>
+ When restoring cluster backups, you must be sure to
+ restore all data nodes from backups having the same backup
+ ID. Using files from different backups will at best result
+ in restoring the cluster to an inconsistent state, and may
+ fail altogether.
+ </para>
+ </important>
+
+ <para>
It is possible to restore a backup to a database with a
different configuration than it was created from. For
example, suppose that a backup with backup ID
@@ -13225,21 +13402,23 @@
for more information.
</para>
- <para>
- <emphasis role="bold">Note</emphasis>: For more rapid
- restoration, the data may be restored in parallel, provided
- that there is a sufficient number of cluster connections
- available. That is, when restoring to multiple nodes in
- parallel, you must have an <literal>[API]</literal> or
- <literal>[MYSQLD]</literal> section in the cluster
- <filename>config.ini</filename> file available for each
- concurrent <command>ndb_restore</command> process. However,
- the data files must always be applied before the logs.
- </para>
+ <note>
+ <para>
+ For more rapid restoration, the data may be restored in
+ parallel, provided that there is a sufficient number of
+ cluster connections available. That is, when restoring to
+ multiple nodes in parallel, you must have an
+ <literal>[API]</literal> or <literal>[MYSQLD]</literal>
+ section in the cluster <filename>config.ini</filename>
+ file available for each concurrent
+ <command>ndb_restore</command> process. However, the data
+ files must always be applied before the logs.
+ </para>
+ </note>
<para>
- A complete listing of options available for this program is
- shown in the following table:
+ Most of the options available for this program are shown in
+ the following table:
</para>
<informaltable>
@@ -13280,7 +13459,7 @@
<entry>Set the connectstring in
<literal>[nodeid=<replaceable>node_id;][host=]</replaceable><replaceable>host</replaceable>[:<replaceable>port</replaceable>]</literal>
format</entry>
- <entry><emphasis>None</emphasis></entry>
+ <entry><literal>localhost:1186</literal></entry>
</row>
<row>
<entry><option>--core-file</option></entry>
@@ -13370,7 +13549,7 @@
<row>
<entry><option>--print</option></entry>
<entry><emphasis>None</emphasis></entry>
- <entry>Print data and log to <literal>stdout</literal></entry>
+ <entry>Print metadata and log to <literal>stdout</literal></entry>
<entry><literal>FALSE</literal></entry>
</row>
<row>
@@ -13414,6 +13593,13 @@
<entry><literal>FALSE</literal></entry>
</row>
<row>
+ <entry><option>--skip-table-check</option></entry>
+ <entry><option>-s</option></entry>
+ <entry>Do not check table schemas (Added in MySQL 5.1.17;
+ <em>not supported in &mccge-series;</em>)</entry>
+ <entry><literal>FALSE</literal></entry>
+ </row>
+ <row>
<entry><option>--version</option></entry>
<entry><option>-V</option></entry>
<entry>Output version information and exit</entry>
@@ -13423,6 +13609,124 @@
</tgroup>
</informaltable>
+ <para>
+ Beginning with MySQL 5.1.18, several additional options are
+ available for use with the <option>--print_data</option>
+ option in generating data dumps, either to
+ <literal>stdout</literal>, or to a file. These are similar
+ to some of the options used with
+ <command>mysqldump</command>, and are shown in the following
+ table:
+
+ <informaltable>
+ <tgroup cols="4">
+ <colspec colwidth="25*"/>
+ <colspec colwidth="15*"/>
+ <colspec colwidth="40*"/>
+ <colspec colwidth="20*"/>
+ <tbody>
+ <row>
+ <entry><emphasis role="bold">Long Form</emphasis></entry>
+ <entry><emphasis role="bold">Short Form</emphasis></entry>
+ <entry><emphasis role="bold">Description</emphasis></entry>
+ <entry><emphasis role="bold">Default Value</emphasis></entry>
+ </row>
+ <row>
+ <entry><option>--tab</option></entry>
+ <entry><option>-T</option></entry>
+ <entry>Creates dumpfiles, one per table, each named
+ <filename><replaceable>tbl_name</replaceable>.txt</filename>.
+ Takes as its argument the path to the directory
+ where the files should be saved (required; use
+ <literal>.</literal> for the current directory).</entry>
+ <entry><emphasis>None</emphasis></entry>
+ </row>
+ <row>
+ <entry><option>--fields-enclosed-by</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>String used to enclose all column values</entry>
+ <entry><emphasis>None</emphasis></entry>
+ </row>
+ <row>
+ <entry><option>--fields-optionally-enclosed-by</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>String used to enclose column values containing character data (such as
+ <literal>CHAR</literal>,
+ <literal>VARCHAR</literal>,
+ <literal>BINARY</literal>,
+ <literal>TEXT</literal>, or
+ <literal>ENUM</literal>)</entry>
+ <entry><emphasis>None</emphasis></entry>
+ </row>
+ <row>
+ <entry><option>--fields-terminated-by</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>String used to separate column values</entry>
+ <entry><literal>\t</literal> (tab character)</entry>
+ </row>
+ <row>
+ <entry><option>--hex</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>Use hex format for binary values</entry>
+ <entry>[N/A]</entry>
+ </row>
+ <row>
+ <entry><option>--lines-terminated-by</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>String used to terminate each line</entry>
+ <entry><literal>\n</literal> (linefeed character)</entry>
+ </row>
+ <row>
+ <entry><option>--appends</option></entry>
+ <entry><emphasis>None</emphasis></entry>
+ <entry>When used with <option>--tab</option>, causes the data to be appended to
+ existing files of the same name</entry>
+ <entry>[N/A]</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+
+ <note>
+ <para>
+ If a table has no explicit primary key, then the output
+ generated when using the <option>--print</option> includes
+ the table's hidden primary key.
+ </para>
+ </note>
+
+ <para>
+ Beginning with MySQL 5.1.18, it is possible to restore
+ selected databases, or to restore selected tables from a
+ given database using the syntax shown here:
+
+<programlisting>
+ndb_restore <replaceable>other_options</replaceable> <replaceable>db_name_1</replaceable> [<replaceable>db_name_2</replaceable>[, <replaceable>db_name_3</replaceable>][, ...] | <replaceable>tbl_name_1</replaceable>[, <replaceable>tbl_name_2</replaceable>][, ...]]
+</programlisting>
+
+ In other words, you can specify either of the following to
+ be restored:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ All tables from one or more databases
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ One or more tables from a single database
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ &mccge-warning-end-cluster;
+
<indexterm>
<primary><command>ndb_restore</command></primary>
<secondary>errors</secondary>
@@ -13469,7 +13773,7 @@
</indexterm>
<para>
- Four configuration parameters are essential for backup:
+ Five configuration parameters are essential for backup:
</para>
<itemizedlist>
@@ -13703,9 +14007,9 @@
applications using the <literal>NDB</literal> API. The source code
for most of these programs may be found in the
<filename>storage/ndb/tools</filename> directory of the MySQL
- ¤t-series-mccge; tree (see
- <xref linkend="installing-source"/>). The <literal>NDB</literal>
- API is not covered in this manual; please refer to the
+ ¤t-series; tree (see <xref linkend="installing-source"/>).
+ The <literal>NDB</literal> API is not covered in this manual;
+ please refer to the
<ulink url="&base-url-docs;/ndbapi/en/"><literal>NDB</literal> API
Guide</ulink> for information about this API.
</para>
@@ -13867,6 +14171,8 @@
</itemizedlist>
+ <!-- MERGED THROUGH HERE -->
+
<para>
Most of these utilities need to connect to a Cluster management
server in order to function. The exceptions are
Modified: trunk/refman-5.1/mysql-cluster-merged.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster-merged.xml 2007-04-27 09:49:19 UTC (rev 6243)
+++ trunk/refman-5.1/mysql-cluster-merged.xml 2007-04-27 09:59:52 UTC (rev 6244)
Changed blocks: 19, Lines Added: 131, Lines Deleted: 10; 10888 bytes
@@ -74,6 +74,11 @@
site at <ulink url="http://www.mysql.com/products/cluster/"/>.
</para>
+ <para>
+ Information about MySQL ¤t-series-mccge; can be found at
+ <ulink url="http://www.mysql.com/products/database/clustercge/"/>.
+ </para>
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>information sources</secondary>
@@ -2342,7 +2347,38 @@
<xref linkend="installing-source-tree"/>.
</para>
+ <warning>
+ <para>
+ <command>BUILD/compile-pentium-max</command> by default builds
+ the MySQL Server with support for the
+ <literal>InnoDB</literal> storage engine. <emphasis>You must
+ not deploy or make use of MySQL ¤t-series-mccge;
+ employing the <literal>InnoDB</literal> storage engine without
+ prior written permission to do so from MySQL AB</emphasis>.
+ </para>
+
+ <para>
+ If you wish to use <literal>InnoDB</literal> technology in
+ conjunction with your use of MySQL ¤t-series-mccge; and
+ do not already have authorization to do so as part of your
+ MySQL Server license, contact your MySQL AB salesperson or
+ other authorized MySQL AB representative for assistance in
+ upgrading your MySQL Server license.
+ </para>
+ </warning>
+
<para>
+ <command>BUILD/compile-pentium-max</command> also includes
+ OpenSSL, so you must either have or obtain OpenSSL to build
+ successfully, or else modify
+ <command>compile-pentium-max</command> to exclude this
+ requirement. Of course, you can also just follow the standard
+ instructions for compiling your own binaries, and then perform
+ the usual tests and installation procedure. See
+ <xref linkend="installing-source-tree"/>.
+ </para>
+
+ <para>
You should also note that <command>compile-pentium-max</command>
installs MySQL to the directory
<filename>/usr/local/mysql</filename>, placing all MySQL Cluster
@@ -3450,6 +3486,18 @@
<literal>ArbitrationRank</literal> to 1 (the default
value) and that of all SQL nodes to 0.
</para>
+
+ &mccge-warning-begin;
+
+ <para>
+ Beginning with MySQL 5.1.15-ndb-6.1.3, it is possible to
+ disable arbitration by setting
+ <literal>ArbitrationRank</literal> to 0 on all management
+ and SQL nodes.
+ </para>
+
+ &mccge-warning-end-cluster;
+
</listitem>
<listitem>
@@ -3648,6 +3696,30 @@
</listitem>
<listitem>
+
+ &mccge-warning-begin;
+
+ <para id="mysql-cluster-param-ndbd-definition-tcpbind-inaddr-any">
+ <literal>TcpBind_INADDR_ANY</literal>
+ </para>
+
+ <para>
+ Setting this parameter to <literal>TRUE</literal> or
+ <literal>1</literal> binds <literal>IP_ADDR_ANY</literal>
+ so that connections can be made from anywhere (for
+ autogenerated connections). The default is
+ <literal>FALSE</literal> (<literal>0</literal>).
+ </para>
+
+ <para>
+ This parameter was added in MySQL 5.1.16-ndb-6.2.0.
+ </para>
+
+ &mccge-warning-end-cluster;
+
+ </listitem>
+
+ <listitem>
<indexterm>
<primary><literal>NoOfReplicas</literal></primary>
</indexterm>
@@ -4920,7 +4992,7 @@
</para>
<para>
- Beginning with MySQL 5.1.15, this parameter takes one of
+ Beginning with MySQL 5.1.15 (MySQL 5.1.15-ndb-6.1.1 in &mccge-series;), this parameter takes one of
the integer values <literal>0</literal>,
<literal>1</literal>, or <literal>2</literal>, which act
as follows:
@@ -4958,7 +5030,7 @@
<literal>1</literal> or <literal>true</literal> enabled
locking of the process after its memory was allocated.
<emphasis role="bold">Important</emphasis>: Beginning with
- MySQL 5.1.15, it is no longer possible to use
+ MySQL 5.1.15 (MySQL 5.1.15-ndb-6.1.1 in &mccge-series;), it is no longer possible to use
<literal>true</literal> or <literal>false</literal> for
the value of this parameter; when upgrading from a
previous version, you must change the value to
@@ -5504,7 +5576,8 @@
<literal>NoOfDiskPagesToDiskAfterRestartTUP</literal> to a
value of <literal>20</literal> entails writing 1.6MB in
data pages to disk each second during a local checkpoint.
- That is, this parameter handles the limitation of writes
+ This value includes the writing of UNDO log records for
+ data pages. That is, this parameter handles the limitation of writes
from data memory. (See the entry for
<literal>IndexMemory</literal> for information about index
pages.)
@@ -5687,9 +5760,9 @@
All update activities need to be logged. The REDO log makes it
possible to replay these updates whenever the system is
restarted. The NDB recovery algorithm uses a
- <quote>fuzzy</quote> checkpoint of the data, and then applies
- the REDO log to play back all changes up to the restoration
- point.
+ <quote>fuzzy</quote> checkpoint of the data together with the
+ UNDO log, and then applies the REDO log to play back all
+ changes up to the restoration point.
</para>
<para>
@@ -5990,7 +6063,8 @@
</para>
<para>
- This parameter was added in MySQL Cluster 5.1.16.
+ This parameter was added in MySQL Cluster 5.1.16. In &mccge-series;,
+ this parameter was added in MySQL Cluster 5.1.14-ndb-6.1.0.
</para>
</listitem>
@@ -7430,7 +7504,7 @@
</row>
<row>
<entry><literal><link linkend="mysql-cluster-param-ndbd-definition-lockpagesinmainmemory">LockPagesInMainMemory</link></literal></entry>
- <entry><emphasis>As of MySQL 5.1.15</emphasis>: integer;
+ <entry><emphasis>As of MySQL 5.1.15 (&mccge-series;: MySQL 5.1.15-ndb-6.1.1)</emphasis>: integer;
<emphasis>previously</emphasis>: true|false
(<literal>1</literal>|<literal>0</literal>)</entry>
<entry>0</entry>
@@ -7644,7 +7718,7 @@
</row>
<row>
<entry><literal><link linkend="mysql-cluster-param-ndbd-definition-memreportfrequency">MemReportFrequency</link></literal>
- (added in MySQL 5.1.16)</entry>
+ (added in MySQL 5.1.16; &mccge-series;: added in MySQL 5.1.14-ndb-6.1.0)</entry>
<entry>integer</entry>
<entry>0</entry>
<entry>0</entry>
@@ -7780,6 +7854,15 @@
<entry>S</entry>
</row>
<row>
+ <entry><literal><link linkend="mysql-cluster-param-ndbd-definition-tcpbind-inaddr-any">TcpBind_INADDR_ANY</link></literal>
+ (<em>&mccge-series; only</em>: added in MySQL 5.1.16-ndb-6.2.0)</entry>
+ <entry>true|false (<literal>1</literal>|<literal>0</literal>)</entry>
+ <entry>1</entry>
+ <entry>0</entry>
+ <entry>0</entry>
+ <entry>N</entry>
+ </row>
+ <row>
<entry><literal><link linkend="mysql-cluster-param-ndbd-definition-timebetweenglobalcheckpoints">TimeBetweenGlobalCheckpoints</link></literal></entry>
<entry>milliseconds</entry>
<entry>2000</entry>
@@ -8461,6 +8544,12 @@
</para>
<para>
+ For information about upgrading or downgrading between &mccge-series; releases,
+ or between &mccge-series; releases and mainline MySQL releases, see the changelogs
+ relating to &mccge-series;.
+ </para>
+
+ <para>
This section remains in development, and continues to be updated
and expanded.
</para>
@@ -13433,6 +13522,8 @@
present in the data node's <literal>DataDir</literal>.)
</para>
+ &mccge-warning-unsupported-begin;
+
<para>
It is possible to restore data without restoring table
metadata. Prior to MySQL 5.1.17,
@@ -13456,6 +13547,8 @@
notice</emphasis>. (Bug #24363)
</para>
+ &mccge-warning-end-cluster;
+
<para>
The <option>-b</option> option is used to specify the ID or
sequence number of the backup, and is the same number shown
@@ -13713,7 +13806,8 @@
<row>
<entry><option>--skip-table-check</option></entry>
<entry><option>-s</option></entry>
- <entry>Do not check table schemas (Added in MySQL 5.1.17)</entry>
+ <entry>Do not check table schemas (Added in MySQL 5.1.17;
+ <em>not supported in &mccge-series;</em>)</entry>
<entry><literal>FALSE</literal></entry>
</row>
<row>
@@ -13726,6 +13820,8 @@
</tgroup>
</informaltable>
+ &mccge-warning-unsupported-begin;
+
<para>
Beginning with MySQL 5.1.18, several additional options are
available for use with the <option>--print_data</option>
@@ -13842,6 +13938,8 @@
</itemizedlist>
</para>
+ &mccge-warning-end-cluster;
+
<indexterm>
<primary><command>ndb_restore</command></primary>
<secondary>errors</secondary>
@@ -14268,8 +14366,31 @@
</para>
</listitem>
+ <listitem>
+ &mccge-warning-being;
+
+ <para>
+ <command>ndbd_redo_log_reader</command>: Reads a redo log
+ file, checking it for errors, printing it in a human-readable
+ format, or both.
+ </para>
+
+ <note>
+ <para>
+ An alpha version of this utility was made available in MySQL
+ 5.1.15-ndb-6.1.3. Currently, it should be considered
+ experimental.
+ </para>
+ </note>
+
+ &mccge-warning-end;
+
+ </listitem>
+
</itemizedlist>
+ <!-- MERGED THROUGH HERE -->
+
<para>
Most of these utilities need to connect to a Cluster management
server in order to function. The exceptions are
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r6244 - trunk/refman-5.1 | jon | 27 Apr |
