Author: jstephens
Date: 2007-09-23 23:28:20 +0200 (Sun, 23 Sep 2007)
New Revision: 7896
Log:
Documentation for CGE online DDL operations (ALTER ONLINE TABLE)
Updated CGE changelogs, version and feature listings
Modified:
trunk/refman-5.1/mysql-cluster.xml
trunk/refman-5.1/news-5.1.xml
trunk/refman-5.1/sql-syntax.xml
trunk/refman-5.2/sql-syntax.xml
Modified: trunk/refman-5.1/mysql-cluster.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster.xml 2007-09-22 14:21:51 UTC (rev 7895)
+++ trunk/refman-5.1/mysql-cluster.xml 2007-09-23 21:28:20 UTC (rev 7896)
Changed blocks: 5, Lines Added: 101, Lines Deleted: 3; 5401 bytes
@@ -1126,6 +1126,50 @@
</para>
</listitem>
+ <listitem>
+ <para>
+ Support for the online <literal>ALTER TABLE</literal>
+ operations <literal>ADD COLUMN</literal>, <literal>ADD
+ INDEX</literal>, and <literal>DROP INDEX</literal> is
+ available. When the <literal>ONLINE</literal> keyword is
+ used, the <literal>ALTER TABLE</literal> is non-copying,
+ which means that indexes do not have to be re-created,
+ which provides these benefits:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ Single user mode is no longer required for
+ <literal>ALTER TABLE</literal> operations that can
+ be performed online.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Transactions can continue during <literal>ALTER
+ TABLE</literal> operations that can be performed
+ online.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ (MySQL 5.1.22-ndb-6.2.5)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ More information has been added to the
+ <literal>mysql.ndb_binlog_index</literal> table so that
+ it is possible to determine which originating epochs
+ have been applied inside an epoch. This is useful in
+ 3-way replication. (MySQL 5.1.22-ndb-6.2.6)
+ </para>
+ </listitem>
+
</itemizedlist>
</para>
@@ -1150,6 +1194,16 @@
<listitem>
<para>
+ More information has been added to the
+ <literal>mysql.ndb_binlog_index</literal> table so that
+ it is possible to determine which originating epochs
+ have been applied inside an epoch. This is useful in
+ 3-way replication. (MySQL 5.1.22-ndb-6.3.2)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
The ability to control whether fixed-width or
variable-width storage is used for a given column of an
<literal>NDB</literal> table by means of the
@@ -1190,14 +1244,48 @@
</para>
</listitem>
+ <listitem>
+ <para>
+ Support for the online <literal>ALTER TABLE</literal>
+ operations <literal>ADD COLUMN</literal>, <literal>ADD
+ INDEX</literal>, and <literal>DROP INDEX</literal> is
+ available. When the <literal>ONLINE</literal> keyword is
+ used, the <literal>ALTER TABLE</literal> is non-copying,
+ which means that indexes do not have to be re-created,
+ which provides these benefits:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ Single user mode is no longer required for
+ <literal>ALTER TABLE</literal> operations that can
+ be performed online.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Transactions can continue during <literal>ALTER
+ TABLE</literal> operations that can be performed
+ online.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ (MySQL 5.1.22-ndb-6.3.2)
+ </para>
+ </listitem>
+
</itemizedlist>
</para>
</formalpara>
<para>
- More detailed information can be found in the changelogs for
- individual &mccge-series; releases; see
+ More detailed information about these features can be found in
+ the changelogs for the indicated &mccge-series; releases; see
<xref linkend="mysql-cluster-cge-releases"/>, for a current
changelog listing.
</para>
@@ -1492,6 +1580,12 @@
</para>
</listitem>
+ <listitem>
+ <para>
+ <xref linkend="news-5-1-22-ndb-6-3-3"/>
+ </para>
+ </listitem>
+
</itemizedlist>
</para>
@@ -1505,7 +1599,11 @@
5.1.19-ndb-6.2.3, and MySQL 5.1.19-ndb-6.2.4; MySQL
5.1.22-based ndb-6.3.<replaceable>x</replaceable> releases
include those enhancements made in MySQL 5.1.19-ndb-6.3.0
- and MySQL 5.1.19-ndb-6.3.1.
+ and MySQL 5.1.19-ndb-6.3.1;
+ ndb-6.3.<replaceable>x</replaceable> releases beginning
+ with MySQL 5.1.22-ndb-6.3.2 include those enhancements
+ made in the ndb-6.2.<replaceable>x</replaceable> series
+ through and MySQL 5.1.22-ndb-6.2.5.
</para>
</listitem>
Modified: trunk/refman-5.1/news-5.1.xml
===================================================================
--- trunk/refman-5.1/news-5.1.xml 2007-09-22 14:21:51 UTC (rev 7895)
+++ trunk/refman-5.1/news-5.1.xml 2007-09-23 21:28:20 UTC (rev 7896)
Changed blocks: 2, Lines Added: 24, Lines Deleted: 0; 1744 bytes
@@ -876,6 +876,18 @@
<listitem>
<para>
+ <literal>ADD COLUMN</literal>, <literal>ADD INDEX</literal>,
+ and <literal>DROP INDEX</literal> operations can now be
+ performed online for <literal>NDB</literal> and
+ <literal>MyISAM</literal> tables — that is, without
+ re-creation of indexes — using <literal>ALTER ONLINE
+ TABLE</literal>. See <xref linkend="alter-table"/>, for more
+ information.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
A new cluster management server startup option
<option>--bind-address</option> makes it possible to
restrict management client connections to
@@ -1243,6 +1255,18 @@
<listitem>
<para>
+ <literal>ADD COLUMN</literal>, <literal>ADD INDEX</literal>,
+ and <literal>DROP INDEX</literal> operations can now be
+ performed online for <literal>NDB</literal> and
+ <literal>MyISAM</literal> tables — that is, without
+ re-creation of indexes — using <literal>ALTER ONLINE
+ TABLE</literal>. See <xref linkend="alter-table"/>, for more
+ information.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
A new cluster management server startup option
<option>--bind-address</option> makes it possible to
restrict management client connections to
Modified: trunk/refman-5.1/sql-syntax.xml
===================================================================
--- trunk/refman-5.1/sql-syntax.xml 2007-09-22 14:21:51 UTC (rev 7895)
+++ trunk/refman-5.1/sql-syntax.xml 2007-09-23 21:28:20 UTC (rev 7896)
Changed blocks: 2, Lines Added: 76, Lines Deleted: 2; 3799 bytes
@@ -332,13 +332,14 @@
PRIMARY KEY KEYS UNIQUE FULLTEXT SPATIAL CONSTRAINT DROP DISABLE
ENABLE RENAME ORDER MODIFY CHANGE DEFAULT SET FOREIGN IGNORE
ENGINE TYPE WITH PARSER DISCARD IMPORT TABLESPACE PARTITION
- COALESCE REORGANIZE ANALYZE CHECK OPTIMIZE REBUILD REPAIR REMOVE
+ COALESCE REORGANIZE ANALYZE CHECK ONLINE OPTIMIZE REBUILD REPAIR
+ REMOVE
</remark>
<remark role="help-syntax"/>
<programlisting>
-ALTER [IGNORE] TABLE <replaceable>tbl_name</replaceable>
+ALTER [ONLINE] [IGNORE] TABLE <replaceable>tbl_name</replaceable>
<replaceable>alter_specification</replaceable> [, <replaceable>alter_specification</replaceable>] ...
<replaceable>alter_specification</replaceable>:
@@ -489,7 +490,80 @@
</listitem>
<listitem>
+
+ &mccge-warning-begin;
+
<para>
+ The <literal>ONLINE</literal> keyword can be used to perform
+ online <literal>ADD COLUMN</literal>, <literal>ADD
+ INDEX</literal>, and <literal>DROP INDEX</literal>
+ operations on <literal>NDB</literal> and
+ <literal>MyISAM</literal> tables. Online operations are
+ non-copying; that is, they do not require that indexes be
+ re-created. Such operations do not require single user mode
+ for <literal>NDB</literal> table alterations made in a
+ cluster with multiple API nodes; transactions can continue
+ uninterrupted during online DDL operations.
+ </para>
+
+ <formalpara>
+
+ <title>Limitations</title>
+
+ <para>
+ Online <literal>ALTER TABLE</literal> operations are
+ subject to the following limitations:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ The table to be altered must have an explicit
+ primary key; the hidden primary key created by the
+ <literal>NDB</literal> storage engine is not
+ sufficient for this purpose.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Online <literal>DROP COLUMN</literal> operations are
+ not supported.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ A given online <literal>ALTER TABLE</literal> can
+ use only one of <literal>ADD COLUMN</literal>,
+ <literal>ADD INDEX</literal>, or <literal>DROP
+ INDEX</literal>.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ </formalpara>
+
+ <para>
+ The <literal>KEY</literal>, <literal>CONSTRAINT</literal>,
+ and <literal>IGNORE</literal> keywords are supported in
+ <literal>ALTER TABLE</literal> statements using the
+ <literal>ONLINE</literal> keyword.
+ </para>
+
+ <para>
+ The <literal>ONLINE</literal> keyword was added in MySQL
+ 5.1.22-ndb-6.2.5 and MySQL 5.1.22-ndb-6.3.2.
+ </para>
+
+ &mccge-warning-end-all;
+
+ </listitem>
+
+ <listitem>
+ <para>
<literal>IGNORE</literal> is a MySQL extension to standard
SQL. It controls how <literal>ALTER TABLE</literal> works if
there are duplicates on unique keys in the new table or if
Modified: trunk/refman-5.2/sql-syntax.xml
===================================================================
--- trunk/refman-5.2/sql-syntax.xml 2007-09-22 14:21:51 UTC (rev 7895)
+++ trunk/refman-5.2/sql-syntax.xml 2007-09-23 21:28:20 UTC (rev 7896)
Changed blocks: 2, Lines Added: 70, Lines Deleted: 2; 3631 bytes
@@ -332,13 +332,14 @@
PRIMARY KEY KEYS UNIQUE FULLTEXT SPATIAL CONSTRAINT DROP DISABLE
ENABLE RENAME ORDER MODIFY CHANGE DEFAULT SET FOREIGN IGNORE
ENGINE TYPE WITH PARSER DISCARD IMPORT TABLESPACE PARTITION
- COALESCE REORGANIZE ANALYZE CHECK OPTIMIZE REBUILD REPAIR REMOVE
+ COALESCE REORGANIZE ANALYZE CHECK ONLINE OPTIMIZE REBUILD REPAIR
+ REMOVE
</remark>
<remark role="help-syntax"/>
<programlisting>
-ALTER [IGNORE] TABLE <replaceable>tbl_name</replaceable>
+ALTER [ONLINE] [IGNORE] TABLE <replaceable>tbl_name</replaceable>
<replaceable>alter_specification</replaceable> [, <replaceable>alter_specification</replaceable>] ...
<replaceable>alter_specification</replaceable>:
@@ -490,6 +491,73 @@
<listitem>
<para>
+ The <literal>ONLINE</literal> keyword can be used to perform
+ online <literal>ADD COLUMN</literal>, <literal>ADD
+ INDEX</literal>, and <literal>DROP INDEX</literal>
+ operations on <literal>NDB</literal> and
+ <literal>MyISAM</literal> tables. Online operations are
+ non-copying; that is, they do not require that indexes be
+ re-created. Such operations do not require single user mode
+ for <literal>NDB</literal> table alterations made in a
+ cluster with multiple API nodes; transactions can continue
+ uninterrupted during online DDL operations.
+ </para>
+
+ <formalpara>
+
+ <title>Limitations</title>
+
+ <para>
+ Online <literal>ALTER TABLE</literal> operations are
+ subject to the following limitations:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ The table to be altered must have an explicit
+ primary key; the hidden primary key created by the
+ <literal>NDB</literal> storage engine is not
+ sufficient for this purpose.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Online <literal>DROP COLUMN</literal> operations are
+ not supported.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ A given online <literal>ALTER TABLE</literal> can
+ use only one of <literal>ADD COLUMN</literal>,
+ <literal>ADD INDEX</literal>, or <literal>DROP
+ INDEX</literal>.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ </formalpara>
+
+ <para>
+ The <literal>KEY</literal>, <literal>CONSTRAINT</literal>,
+ and <literal>IGNORE</literal> keywords are supported in
+ <literal>ALTER TABLE</literal> statements using the
+ <literal>ONLINE</literal> keyword.
+ </para>
+
+ <para>
+ The <literal>ONLINE</literal> keyword was added in MySQL
+ 5.2.6.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
<literal>IGNORE</literal> is a MySQL extension to standard
SQL. It controls how <literal>ALTER TABLE</literal> works if
there are duplicates on unique keys in the new table or if
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r7896 - in trunk: refman-5.1 refman-5.2 | jon | 23 Sep |
