Author: jstephens
Date: 2007-01-25 14:13:13 +0100 (Thu, 25 Jan 2007)
New Revision: 4634
Log:
Reformat.
Modified:
branches/telcos/refman-5.1/mysql-cluster.xml
trunk/refman-4.1/mysql-cluster.xml
trunk/refman-5.0/mysql-cluster.xml
trunk/refman-5.1/mysql-cluster.xml
Modified: branches/telcos/refman-5.1/mysql-cluster.xml
===================================================================
--- branches/telcos/refman-5.1/mysql-cluster.xml 2007-01-25 13:07:27 UTC (rev 4633)
+++ branches/telcos/refman-5.1/mysql-cluster.xml 2007-01-25 13:13:13 UTC (rev 4634)
Changed blocks: 14, Lines Added: 124, Lines Deleted: 121; 16382 bytes
@@ -1182,8 +1182,8 @@
</para>
<para>
- On each of the machines designated to host data or SQL
- nodes, perform the following steps as the system
+ On each of the machines designated to host data or SQL nodes,
+ perform the following steps as the system
<literal>root</literal> user:
</para>
@@ -3203,7 +3203,7 @@
<primary>MySQL Cluster</primary>
<secondary>configuration</secondary>
</indexterm>
-
+
<para>
The <literal>[NDB_MGMD]</literal> section is used to configure
the behavior of the management server.
@@ -3299,7 +3299,7 @@
information. There are three options in this regard
— <literal>CONSOLE</literal>,
<literal>SYSLOG</literal>, and <literal>FILE</literal>
- — with <literal>FILE</literal> being the default:
+ — with <literal>FILE</literal> being the default:
</para>
<itemizedlist>
@@ -3394,7 +3394,7 @@
</listitem>
</itemizedlist>
-
+
<para>
It is possible to specify multiple log destinations
separated by semicolons as shown here:
@@ -3491,12 +3491,11 @@
parameter for <literal>LogDestination</literal> as
discussed previously in this section.)
</para>
-
+
<para>
The default value for this parameter is the directory in
which <command>ndb_mgmd</command> is located.
</para>
-
</listitem>
</itemizedlist>
@@ -4894,68 +4893,69 @@
<itemizedlist>
<listitem>
-
-
- <indexterm>
- <primary><literal>LockPagesInMainMemory</literal></primary>
- </indexterm>
-
- <para id="mysql-cluster-param-ndbd-definition-lockpagesinmainmemory">
- <literal>LockPagesInMainMemory</literal>
- </para>
-
-
- <para>
- For a number of operating systems, including Solaris and
- Linux, it is possible to lock a process into memory and so
- avoid any swapping to disk. This can be used to help
- guarantee the cluster's real-time characteristics.
- </para>
-
- <para>
- Beginning with MySQL 5.1.14/NDB-6.1.1, this parameter takes one of
- the integer values <literal>0</literal>,
- <literal>1</literal>, or <literal>2</literal>, which act
- as follows:
- </para>
-
- <itemizedlist>
- <listitem>
- <para>
- <literal>0</literal>: Disables locking. This is the
- default value.
- </para>
- </listitem>
- <listitem>
- <para>
- <literal>1</literal>: Performs the lock after
- allocating memory for the process.
- </para>
- </listitem>
- <listitem>
- <para>
- <literal>2</literal>: Performs the lock before
- memory for the process is allocated.
- </para>
- </listitem>
- </itemizedlist>
-
- <para>
- Previously, this parameter was a Boolean.
- <literal>0</literal> or <literal>false</literal> was the
- default setting, and disabled lcocking.
- <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.14/NDB-6.1.1, 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
- <literal>0</literal>, <literal>1</literal>, or
- <literal>2</literal>.
- </para>
- </listitem>
+ <indexterm>
+ <primary><literal>LockPagesInMainMemory</literal></primary>
+ </indexterm>
+ <para id="mysql-cluster-param-ndbd-definition-lockpagesinmainmemory">
+ <literal>LockPagesInMainMemory</literal>
+ </para>
+
+ <para>
+ For a number of operating systems, including Solaris and
+ Linux, it is possible to lock a process into memory and so
+ avoid any swapping to disk. This can be used to help
+ guarantee the cluster's real-time characteristics.
+ </para>
+
+ <para>
+ Beginning with MySQL 5.1.14/NDB-6.1.1, this parameter
+ takes one of the integer values <literal>0</literal>,
+ <literal>1</literal>, or <literal>2</literal>, which act
+ as follows:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>0</literal>: Disables locking. This is the
+ default value.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>1</literal>: Performs the lock after
+ allocating memory for the process.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>2</literal>: Performs the lock before memory
+ for the process is allocated.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ Previously, this parameter was a Boolean.
+ <literal>0</literal> or <literal>false</literal> was the
+ default setting, and disabled lcocking.
+ <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.14/NDB-6.1.1, 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
+ <literal>0</literal>, <literal>1</literal>, or
+ <literal>2</literal>.
+ </para>
+ </listitem>
+
<listitem>
<indexterm>
<primary><literal>StopOnError</literal></primary>
@@ -7347,7 +7347,9 @@
</row>
<row>
<entry><literal><link linkend="mysql-cluster-param-ndbd-definition-lockpagesinmainmemory">LockPagesInMainMemory</link></literal></entry>
- <entry><emphasis>As of MySQL 5.1.14/NDB-6.1.1</emphasis>: integer; <emphasis>previously</emphasis>: true|false (<literal>1</literal>|<literal>0</literal>)</entry>
+ <entry><emphasis>As of MySQL 5.1.14/NDB-6.1.1</emphasis>: integer;
+ <emphasis>previously</emphasis>: true|false
+ (<literal>1</literal>|<literal>0</literal>)</entry>
<entry>0</entry>
<entry>0</entry>
<entry>1</entry>
@@ -12324,63 +12326,63 @@
</section>
<section id="mysql-cluster-backup-using-management-client">
-
+
<title>Using The Management Client to Create a Backup</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
<xref linkend="mysql-cluster-backup-configuration"/>.)
</para>
-
+
<para>
Creating a backup using the management client involves the
following steps:
</para>
-
+
<orderedlist>
-
+
<listitem>
<para>
Start the management client (<command>ndb_mgm</command>).
</para>
</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>
</listitem>
-
+
<listitem>
<para>
The management client responds as shown here:
</para>
-
- <programlisting>
+
+<programlisting>
Waiting for completed, this may take several minutes
Node 1: Backup <replaceable>backup_id</replaceable> started from node <replaceable>management_node_id</replaceable>
</programlisting>
-
+
<para>
Here, <replaceable>backup_id</replaceable> is the unique
identifier for this particular backup. (This identifier will
@@ -12390,13 +12392,13 @@
of the management to which the management client is
connected.
</para>
-
+
<para>
This means that the cluster has received and processed the
backup request. It does <emphasis>not</emphasis> mean that
the backup has been completed.
</para>
-
+
<para>
<emphasis role="bold">Note</emphasis>: Backup messages were
not recorded in the cluster log in MySQL 5.1.12 or 5.1.13.
@@ -12404,20 +12406,20 @@
5.1.14 (see Bug #24544).
</para>
</listitem>
-
+
<listitem>
<para>
When the backup is completed, the management client will
indicate this as shown here:
</para>
-
- <programlisting>
+
+<programlisting>
Node 1: Backup <replaceable>backup_id</replaceable> started from node <replaceable>management_node_id</replaceable> completed
StartGCP: 417599 StopGCP: 417602
#Records: 105957 #LogRecords: 0
Data: 99719356 bytes Log: 0 bytes
</programlisting>
-
+
<para>
The values shown for <literal>StartGCP</literal>,
<literal>StopGCP</literal>, <literal>#Records</literal>,
@@ -12426,9 +12428,9 @@
of your cluster.
</para>
</listitem>
-
+
</orderedlist>
-
+
<para>
Cluster backups are created by default in the
<filename>BACKUP</filename> subdirectory of the
@@ -12438,69 +12440,70 @@
using the <literal>BackupDataDir</literal> configuration
parameter as discussed in
<link linkend="mysql-cluster-identifying-data-nodes">Identifying
- Data Nodes</link>. The backup files created for a backup with a
+ Data Nodes</link>. The backup files created for a backup with a
given <replaceable>backup_id</replaceable> are stored in a
subdirectory named
<filename>BACKUP-<replaceable>backup_id</replaceable></filename>
in the backup directory.
</para>
-
+
<para>
To abort a backup that is already in progress:
</para>
-
+
<orderedlist>
-
+
<listitem>
<para>
Start the management client.
</para>
</listitem>
-
+
<listitem>
<para>
Execute this command:
</para>
-
- <programlisting>
+
+<programlisting>
ndb_mgm> <userinput>ABORT BACKUP <replaceable>backup_id</replaceable></userinput>
</programlisting>
-
- <para>The number <replaceable>backup_id</replaceable> is the
+
+ <para>
+ The number <replaceable>backup_id</replaceable> is the
identifier of the backup that was included in the response
of the management client when the backup was started (in the
message <literal>Backup <replaceable>backup_id</replaceable>
- started from node
- <replaceable>management_node_id</replaceable></literal>).
+ started from node
+ <replaceable>management_node_id</replaceable></literal>).
</para>
</listitem>
-
+
<listitem>
<para>
The management client will acknowledge the abort request
with <literal>Abort of backup
- <replaceable>backup_id</replaceable> ordered</literal>.
+ <replaceable>backup_id</replaceable> ordered</literal>.
<emphasis role="bold">Note</emphasis>: At this point, the
management client has not yet received a response from the
cluster data nodes to this request, and the backup has not
yet actually been aborted.
</para>
</listitem>
-
+
<listitem>
<para>
After the backup has been aborted, the management client
will report this fact in a manner similar to what is shown
here:
</para>
-
- <programlisting>
+
+<programlisting>
Node 1: Backup 3 started from 5 has been aborted. Error: 1321 - Backup aborted by user request: Permanent error: User defined error
Node 3: Backup 3 started from 5 has been aborted. Error: 1323 - 1323: Permanent error: Internal error
Node 2: Backup 3 started from 5 has been aborted. Error: 1323 - 1323: Permanent error: Internal error
Node 4: Backup 3 started from 5 has been aborted. Error: 1323 - 1323: Permanent error: Internal error
</programlisting>
-
+
<para>
In this example, we have shown sample output for a cluster
with 4 data nodes, where the sequence number of the backup
@@ -12510,33 +12513,33 @@
its part in aborting the backup reports that the reason for
the abort was due to a request by the user. (The remaining
nodes report that the backup was aborted due to an
- unspecified internal error.)
+ unspecified internal error.)
<emphasis role="bold">Note</emphasis>: There is no guarantee
that the cluster nodes will respond to an <literal>ABORT
- BACKUP</literal> command in any particular order.
+ BACKUP</literal> command in any particular order.
</para>
-
- <para>
+
+ <para>
The <literal>Backup <replaceable>backup_id</replaceable>
- started from node
- <replaceable>management_node_id</replaceable> has been
- aborted</literal> messages mean that the backup has been
+ started from node
+ <replaceable>management_node_id</replaceable> has been
+ aborted</literal> messages mean that the backup has been
terminated and that all files relating to this backup have
been removed from the cluster filesystem.
</para>
</listitem>
-
+
</orderedlist>
-
+
<para>
It is also possible to abort a backup in progress from a system
shell using this command:
</para>
-
- <programlisting>
+
+<programlisting>
shell> <userinput>ndb_mgm -e "ABORT BACKUP <replaceable>backup_id</replaceable>"</userinput>
</programlisting>
-
+
<para>
<emphasis role="bold">Note</emphasis>: If there is no backup
with ID <replaceable>backup_id</replaceable> running when an
@@ -12544,7 +12547,7 @@
makes no response, nor is it indicated in the cluster log that
an invalid abort command was sent.
</para>
-
+
</section>
<section id="mysql-cluster-restore">
Modified: trunk/refman-4.1/mysql-cluster.xml
===================================================================
--- trunk/refman-4.1/mysql-cluster.xml 2007-01-25 13:07:27 UTC (rev 4633)
+++ trunk/refman-4.1/mysql-cluster.xml 2007-01-25 13:13:13 UTC (rev 4634)
Changed blocks: 12, Lines Added: 62, Lines Deleted: 62; 10900 bytes
@@ -1066,10 +1066,9 @@
have installed on it a MySQL-max binary. For management nodes,
it is not necessary to install the MySQL server binary, but you
do have to install the MGM server daemon and client binaries
- (<command>ndb_mgmd</command> and
- <command>ndb_mgm</command>, respectively). This section covers
- the steps necessary to install the correct binaries for each
- type of Cluster node.
+ (<command>ndb_mgmd</command> and <command>ndb_mgm</command>,
+ respectively). This section covers the steps necessary to
+ install the correct binaries for each type of Cluster node.
</para>
<para>
@@ -1185,8 +1184,8 @@
</para>
<para>
- On each of the machines designated to host data or SQL
- nodes, perform the following steps as the system
+ On each of the machines designated to host data or SQL nodes,
+ perform the following steps as the system
<literal>root</literal> user:
</para>
@@ -3317,7 +3316,7 @@
information. There are three options in this regard
— <literal>CONSOLE</literal>,
<literal>SYSLOG</literal>, and <literal>FILE</literal>
- — with <literal>FILE</literal> being the default:
+ — with <literal>FILE</literal> being the default:
</para>
<itemizedlist>
@@ -3412,10 +3411,10 @@
</listitem>
</itemizedlist>
-
+
<para>
It is possible to specify multiple log destinations
- separated by semicolons as shown here:
+ separated by semicolons as shown here:
</para>
<programlisting>
@@ -3509,7 +3508,7 @@
parameter for <literal>LogDestination</literal> as
discussed previously in this section.)
</para>
-
+
<para>
The default value for this parameter is the directory in
which <command>ndb_mgmd</command> is located.
@@ -12105,63 +12104,63 @@
</section>
<section id="mysql-cluster-backup-using-management-client">
-
+
<title>Using The Management Client to Create a Backup</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
<xref linkend="mysql-cluster-backup-configuration"/>.)
</para>
-
+
<para>
Creating a backup using the management client involves the
following steps:
</para>
-
+
<orderedlist>
-
+
<listitem>
<para>
Start the management client (<command>ndb_mgm</command>).
</para>
</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>
</listitem>
-
+
<listitem>
<para>
The management client responds as shown here:
</para>
-
- <programlisting>
+
+<programlisting>
Waiting for completed, this may take several minutes
Node 1: Backup <replaceable>backup_id</replaceable> started from node <replaceable>management_node_id</replaceable>
</programlisting>
-
+
<para>
Here, <replaceable>backup_id</replaceable> is the unique
identifier for this particular backup. (This identifier will
@@ -12171,13 +12170,13 @@
of the management to which the management client is
connected.
</para>
-
+
<para>
This means that the cluster has received and processed the
backup request. It does <emphasis>not</emphasis> mean that
the backup has been completed.
</para>
-
+
<para>
<emphasis role="bold">Note</emphasis>: Backup messages were
not recorded in the cluster log in MySQL 5.1.12 or 5.1.13.
@@ -12185,20 +12184,20 @@
5.1.14 (see Bug #24544).
</para>
</listitem>
-
+
<listitem>
<para>
When the backup is completed, the management client will
indicate this as shown here:
</para>
-
- <programlisting>
+
+<programlisting>
Node 1: Backup <replaceable>backup_id</replaceable> started from node <replaceable>management_node_id</replaceable> completed
StartGCP: 417599 StopGCP: 417602
#Records: 105957 #LogRecords: 0
Data: 99719356 bytes Log: 0 bytes
</programlisting>
-
+
<para>
The values shown for <literal>StartGCP</literal>,
<literal>StopGCP</literal>, <literal>#Records</literal>,
@@ -12207,9 +12206,9 @@
of your cluster.
</para>
</listitem>
-
+
</orderedlist>
-
+
<para>
Cluster backups are created by default in the
<filename>BACKUP</filename> subdirectory of the
@@ -12219,69 +12218,70 @@
using the <literal>BackupDataDir</literal> configuration
parameter as discussed in
<link linkend="mysql-cluster-identifying-data-nodes">Identifying
- Data Nodes</link>. The backup files created for a backup with a
+ Data Nodes</link>. The backup files created for a backup with a
given <replaceable>backup_id</replaceable> are stored in a
subdirectory named
<filename>BACKUP-<replaceable>backup_id</replaceable></filename>
in the backup directory.
</para>
-
+
<para>
To abort a backup that is already in progress:
</para>
-
+
<orderedlist>
-
+
<listitem>
<para>
Start the management client.
</para>
</listitem>
-
+
<listitem>
<para>
Execute this command:
</para>
-
- <programlisting>
+
+<programlisting>
ndb_mgm> <userinput>ABORT BACKUP <replaceable>backup_id</replaceable></userinput>
</programlisting>
-
- <para>The number <replaceable>backup_id</replaceable> is the
+
+ <para>
+ The number <replaceable>backup_id</replaceable> is the
identifier of the backup that was included in the response
of the management client when the backup was started (in the
message <literal>Backup <replaceable>backup_id</replaceable>
- started from node
- <replaceable>management_node_id</replaceable></literal>).
+ started from node
+ <replaceable>management_node_id</replaceable></literal>).
</para>
</listitem>
-
+
<listitem>
<para>
The management client will acknowledge the abort request
with <literal>Abort of backup
- <replaceable>backup_id</replaceable> ordered</literal>.
+ <replaceable>backup_id</replaceable> ordered</literal>.
<emphasis role="bold">Note</emphasis>: At this point, the
management client has not yet received a response from the
cluster data nodes to this request, and the backup has not
yet actually been aborted.
</para>
</listitem>
-
+
<listitem>
<para>
After the backup has been aborted, the management client
will report this fact in a manner similar to what is shown
here:
</para>
-
- <programlisting>
+
+<programlisting>
Node 1: Backup 3 started from 5 has been aborted. Error: 1321 - Backup aborted by user request: Permanent error: User defined error
Node 3: Backup 3 started from 5 has been aborted. Error: 1323 - 1323: Permanent error: Internal error
Node 2: Backup 3 started from 5 has been aborted. Error: 1323 - 1323: Permanent error: Internal error
Node 4: Backup 3 started from 5 has been aborted. Error: 1323 - 1323: Permanent error: Internal error
</programlisting>
-
+
<para>
In this example, we have shown sample output for a cluster
with 4 data nodes, where the sequence number of the backup
@@ -12291,33 +12291,33 @@
its part in aborting the backup reports that the reason for
the abort was due to a request by the user. (The remaining
nodes report that the backup was aborted due to an
- unspecified internal error.)
+ unspecified internal error.)
<emphasis role="bold">Note</emphasis>: There is no guarantee
that the cluster nodes will respond to an <literal>ABORT
- BACKUP</literal> command in any particular order.
+ BACKUP</literal> command in any particular order.
</para>
-
- <para>
+
+ <para>
The <literal>Backup <replaceable>backup_id</replaceable>
- started from node
- <replaceable>management_node_id</replaceable> has been
- aborted</literal> messages mean that the backup has been
+ started from node
+ <replaceable>management_node_id</replaceable> has been
+ aborted</literal> messages mean that the backup has been
terminated and that all files relating to this backup have
been removed from the cluster filesystem.
</para>
</listitem>
-
+
</orderedlist>
-
+
<para>
It is also possible to abort a backup in progress from a system
shell using this command:
</para>
-
- <programlisting>
+
+<programlisting>
shell> <userinput>ndb_mgm -e "ABORT BACKUP <replaceable>backup_id</replaceable>"</userinput>
</programlisting>
-
+
<para>
<emphasis role="bold">Note</emphasis>: If there is no backup
with ID <replaceable>backup_id</replaceable> running when an
@@ -12325,7 +12325,7 @@
makes no response, nor is it indicated in the cluster log that
an invalid abort command was sent.
</para>
-
+
</section>
<section id="mysql-cluster-restore">
Modified: trunk/refman-5.0/mysql-cluster.xml
===================================================================
--- trunk/refman-5.0/mysql-cluster.xml 2007-01-25 13:07:27 UTC (rev 4633)
+++ trunk/refman-5.0/mysql-cluster.xml 2007-01-25 13:13:13 UTC (rev 4634)
Changed blocks: 14, Lines Added: 74, Lines Deleted: 69; 13197 bytes
@@ -1066,10 +1066,9 @@
have installed on it a MySQL-max binary. For management nodes,
it is not necessary to install the MySQL server binary, but you
do have to install the MGM server daemon and client binaries
- (<command>ndb_mgmd</command> and
- <command>ndb_mgm</command>, respectively). This section covers
- the steps necessary to install the correct binaries for each
- type of Cluster node.
+ (<command>ndb_mgmd</command> and <command>ndb_mgm</command>,
+ respectively). This section covers the steps necessary to
+ install the correct binaries for each type of Cluster node.
</para>
<para>
@@ -1185,8 +1184,8 @@
</para>
<para>
- On each of the machines designated to host data or SQL
- nodes, perform the following steps as the system
+ On each of the machines designated to host data or SQL nodes,
+ perform the following steps as the system
<literal>root</literal> user:
</para>
@@ -3301,7 +3300,7 @@
information. There are three options in this regard
— <literal>CONSOLE</literal>,
<literal>SYSLOG</literal>, and <literal>FILE</literal>
- — with <literal>FILE</literal> being the default:
+ — with <literal>FILE</literal> being the default:
</para>
<itemizedlist>
@@ -3396,7 +3395,7 @@
</listitem>
</itemizedlist>
-
+
<para>
It is possible to specify multiple log destinations
separated by semicolons as shown here:
@@ -3493,7 +3492,7 @@
parameter for <literal>LogDestination</literal> as
discussed previously in this section.)
</para>
-
+
<para>
The default value for this parameter is the directory in
which <command>ndb_mgmd</command> is located.
@@ -4890,41 +4889,44 @@
<para id="mysql-cluster-param-ndbd-definition-lockpagesinmainmemory">
<literal>LockPagesInMainMemory</literal>
</para>
-
-
+
<para>
For a number of operating systems, including Solaris and
Linux, it is possible to lock a process into memory and so
avoid any swapping to disk. This can be used to help
guarantee the cluster's real-time characteristics.
</para>
-
+
<para>
Beginning with MySQL 5.0.36, this parameter takes one of
the integer values
<literal>0</literal>,<literal>1</literal>, or
- <literal>2</literal>, which act as follows:
+ <literal>2</literal>, which act as follows:
</para>
-
+
<itemizedlist>
+
<listitem>
<para>
<literal>0</literal>: Disables locking. This is the
default value.
</para>
</listitem>
+
<listitem>
<para>
<literal>1</literal>: Performs the lock after
allocating memory for the process.
</para>
</listitem>
+
<listitem>
<para>
- <literal>2</literal>: Performs the lock before
- memory for the process is allocated.
+ <literal>2</literal>: Performs the lock before memory
+ for the process is allocated.
</para>
</listitem>
+
</itemizedlist>
<para>
@@ -7290,7 +7292,9 @@
</row>
<row>
<entry><literal><link linkend="mysql-cluster-param-ndbd-definition-lockpagesinmainmemory">LockPagesInMainMemory</link></literal></entry>
- <entry><emphasis>As of MySQL 5.0.36</emphasis>: integer; <emphasis>previously</emphasis>: true|false (<literal>1</literal>|<literal>0</literal>)</entry>
+ <entry><emphasis>As of MySQL 5.0.36</emphasis>: integer;
+ <emphasis>previously</emphasis>: true|false
+ (<literal>1</literal>|<literal>0</literal>)</entry>
<entry>0</entry>
<entry>0</entry>
<entry>1</entry>
@@ -12213,63 +12217,63 @@
</section>
<section id="mysql-cluster-backup-using-management-client">
-
+
<title>Using The Management Client to Create a Backup</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
<xref linkend="mysql-cluster-backup-configuration"/>.)
</para>
-
+
<para>
Creating a backup using the management client involves the
following steps:
</para>
-
+
<orderedlist>
-
+
<listitem>
<para>
Start the management client (<command>ndb_mgm</command>).
</para>
</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>
</listitem>
-
+
<listitem>
<para>
The management client responds as shown here:
</para>
-
- <programlisting>
+
+<programlisting>
Waiting for completed, this may take several minutes
Node 1: Backup <replaceable>backup_id</replaceable> started from node <replaceable>management_node_id</replaceable>
</programlisting>
-
+
<para>
Here, <replaceable>backup_id</replaceable> is the unique
identifier for this particular backup. (This identifier will
@@ -12279,13 +12283,13 @@
of the management to which the management client is
connected.
</para>
-
+
<para>
This means that the cluster has received and processed the
backup request. It does <emphasis>not</emphasis> mean that
the backup has been completed.
</para>
-
+
<para>
<emphasis role="bold">Note</emphasis>: Backup messages were
not recorded in the cluster log in MySQL 5.1.12 or 5.1.13.
@@ -12293,20 +12297,20 @@
5.1.14 (see Bug #24544).
</para>
</listitem>
-
+
<listitem>
<para>
When the backup is completed, the management client will
indicate this as shown here:
</para>
-
- <programlisting>
+
+<programlisting>
Node 1: Backup <replaceable>backup_id</replaceable> started from node <replaceable>management_node_id</replaceable> completed
StartGCP: 417599 StopGCP: 417602
#Records: 105957 #LogRecords: 0
Data: 99719356 bytes Log: 0 bytes
</programlisting>
-
+
<para>
The values shown for <literal>StartGCP</literal>,
<literal>StopGCP</literal>, <literal>#Records</literal>,
@@ -12315,9 +12319,9 @@
of your cluster.
</para>
</listitem>
-
+
</orderedlist>
-
+
<para>
Cluster backups are created by default in the
<filename>BACKUP</filename> subdirectory of the
@@ -12327,69 +12331,70 @@
using the <literal>BackupDataDir</literal> configuration
parameter as discussed in
<link linkend="mysql-cluster-identifying-data-nodes">Identifying
- Data Nodes</link>. The backup files created for a backup with a
+ Data Nodes</link>. The backup files created for a backup with a
given <replaceable>backup_id</replaceable> are stored in a
subdirectory named
<filename>BACKUP-<replaceable>backup_id</replaceable></filename>
in the backup directory.
</para>
-
+
<para>
To abort a backup that is already in progress:
</para>
-
+
<orderedlist>
-
+
<listitem>
<para>
Start the management client.
</para>
</listitem>
-
+
<listitem>
<para>
Execute this command:
</para>
-
- <programlisting>
+
+<programlisting>
ndb_mgm> <userinput>ABORT BACKUP <replaceable>backup_id</replaceable></userinput>
</programlisting>
-
- <para>The number <replaceable>backup_id</replaceable> is the
+
+ <para>
+ The number <replaceable>backup_id</replaceable> is the
identifier of the backup that was included in the response
of the management client when the backup was started (in the
message <literal>Backup <replaceable>backup_id</replaceable>
- started from node
- <replaceable>management_node_id</replaceable></literal>).
+ started from node
+ <replaceable>management_node_id</replaceable></literal>).
</para>
</listitem>
-
+
<listitem>
<para>
The management client will acknowledge the abort request
with <literal>Abort of backup
- <replaceable>backup_id</replaceable> ordered</literal>.
+ <replaceable>backup_id</replaceable> ordered</literal>.
<emphasis role="bold">Note</emphasis>: At this point, the
management client has not yet received a response from the
cluster data nodes to this request, and the backup has not
yet actually been aborted.
</para>
</listitem>
-
+
<listitem>
<para>
After the backup has been aborted, the management client
will report this fact in a manner similar to what is shown
here:
</para>
-
- <programlisting>
+
+<programlisting>
Node 1: Backup 3 started from 5 has been aborted. Error: 1321 - Backup aborted by user request: Permanent error: User defined error
Node 3: Backup 3 started from 5 has been aborted. Error: 1323 - 1323: Permanent error: Internal error
Node 2: Backup 3 started from 5 has been aborted. Error: 1323 - 1323: Permanent error: Internal error
Node 4: Backup 3 started from 5 has been aborted. Error: 1323 - 1323: Permanent error: Internal error
</programlisting>
-
+
<para>
In this example, we have shown sample output for a cluster
with 4 data nodes, where the sequence number of the backup
@@ -12399,33 +12404,33 @@
its part in aborting the backup reports that the reason for
the abort was due to a request by the user. (The remaining
nodes report that the backup was aborted due to an
- unspecified internal error.)
+ unspecified internal error.)
<emphasis role="bold">Note</emphasis>: There is no guarantee
that the cluster nodes will respond to an <literal>ABORT
- BACKUP</literal> command in any particular order.
+ BACKUP</literal> command in any particular order.
</para>
-
- <para>
+
+ <para>
The <literal>Backup <replaceable>backup_id</replaceable>
- started from node
- <replaceable>management_node_id</replaceable> has been
- aborted</literal> messages mean that the backup has been
+ started from node
+ <replaceable>management_node_id</replaceable> has been
+ aborted</literal> messages mean that the backup has been
terminated and that all files relating to this backup have
been removed from the cluster filesystem.
</para>
</listitem>
-
+
</orderedlist>
-
+
<para>
It is also possible to abort a backup in progress from a system
shell using this command:
</para>
-
- <programlisting>
+
+<programlisting>
shell> <userinput>ndb_mgm -e "ABORT BACKUP <replaceable>backup_id</replaceable>"</userinput>
</programlisting>
-
+
<para>
<emphasis role="bold">Note</emphasis>: If there is no backup
with ID <replaceable>backup_id</replaceable> running when an
@@ -12433,7 +12438,7 @@
makes no response, nor is it indicated in the cluster log that
an invalid abort command was sent.
</para>
-
+
</section>
<section id="mysql-cluster-restore">
Modified: trunk/refman-5.1/mysql-cluster.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster.xml 2007-01-25 13:07:27 UTC (rev 4633)
+++ trunk/refman-5.1/mysql-cluster.xml 2007-01-25 13:13:13 UTC (rev 4634)
Changed blocks: 13, Lines Added: 42, Lines Deleted: 37; 8843 bytes
@@ -1186,8 +1186,8 @@
</para>
<para>
- On each of the machines designated to host data or SQL
- nodes, perform the following steps as the system
+ On each of the machines designated to host data or SQL nodes,
+ perform the following steps as the system
<literal>root</literal> user:
</para>
@@ -3207,7 +3207,7 @@
<primary>MySQL Cluster</primary>
<secondary>configuration</secondary>
</indexterm>
-
+
<para>
The <literal>[NDB_MGMD]</literal> section is used to configure
the behavior of the management server.
@@ -3303,7 +3303,7 @@
information. There are three options in this regard
— <literal>CONSOLE</literal>,
<literal>SYSLOG</literal>, and <literal>FILE</literal>
- — with <literal>FILE</literal> being the default:
+ — with <literal>FILE</literal> being the default:
</para>
<itemizedlist>
@@ -3398,7 +3398,7 @@
</listitem>
</itemizedlist>
-
+
<para>
It is possible to specify multiple log destinations
separated by semicolons as shown here:
@@ -3495,12 +3495,11 @@
parameter for <literal>LogDestination</literal> as
discussed previously in this section.)
</para>
-
+
<para>
The default value for this parameter is the directory in
which <command>ndb_mgmd</command> is located.
</para>
-
</listitem>
</itemizedlist>
@@ -4896,52 +4895,55 @@
</para>
<itemizedlist>
-
+
<listitem>
<indexterm>
<primary><literal>LockPagesInMainMemory</literal></primary>
</indexterm>
-
+
<para id="mysql-cluster-param-ndbd-definition-lockpagesinmainmemory">
<literal>LockPagesInMainMemory</literal>
</para>
-
-
+
<para>
For a number of operating systems, including Solaris and
Linux, it is possible to lock a process into memory and so
avoid any swapping to disk. This can be used to help
guarantee the cluster's real-time characteristics.
</para>
-
+
<para>
Beginning with MySQL 5.0.36, this parameter takes one of
the integer values <literal>0</literal>,
<literal>1</literal>, or <literal>2</literal>, which act
- as follows:
+ as follows:
</para>
-
+
<itemizedlist>
+
<listitem>
<para>
<literal>0</literal>: Disables locking. This is the
default value.
</para>
</listitem>
+
<listitem>
<para>
<literal>1</literal>: Performs the lock after
allocating memory for the process.
</para>
</listitem>
+
<listitem>
<para>
- <literal>2</literal>: Performs the lock before
- memory for the process is allocated.
+ <literal>2</literal>: Performs the lock before memory
+ for the process is allocated.
</para>
</listitem>
+
</itemizedlist>
-
+
<para>
Previously, this parameter was a Boolean.
<literal>0</literal> or <literal>false</literal> was the
@@ -7297,7 +7299,9 @@
</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; <emphasis>previously</emphasis>: true|false (<literal>1</literal>|<literal>0</literal>)</entry>
+ <entry><emphasis>As of MySQL 5.1.15</emphasis>: integer;
+ <emphasis>previously</emphasis>: true|false
+ (<literal>1</literal>|<literal>0</literal>)</entry>
<entry>0</entry>
<entry>0</entry>
<entry>1</entry>
@@ -12317,12 +12321,12 @@
<para>
The management client responds as shown here:
</para>
-
+
<programlisting>
Waiting for completed, this may take several minutes
Node 1: Backup <replaceable>backup_id</replaceable> started from node <replaceable>management_node_id</replaceable>
</programlisting>
-
+
<para>
Here, <replaceable>backup_id</replaceable> is the unique
identifier for this particular backup. (This identifier will
@@ -12332,7 +12336,7 @@
of the management to which the management client is
connected.
</para>
-
+
<para>
This means that the cluster has received and processed the
backup request. It does <emphasis>not</emphasis> mean that
@@ -12352,14 +12356,14 @@
When the backup is completed, the management client will
indicate this as shown here:
</para>
-
+
<programlisting>
Node 1: Backup <replaceable>backup_id</replaceable> started from node <replaceable>management_node_id</replaceable> completed
StartGCP: 417599 StopGCP: 417602
#Records: 105957 #LogRecords: 0
Data: 99719356 bytes Log: 0 bytes
</programlisting>
-
+
<para>
The values shown for <literal>StartGCP</literal>,
<literal>StopGCP</literal>, <literal>#Records</literal>,
@@ -12403,17 +12407,18 @@
<para>
Execute this command:
</para>
-
+
<programlisting>
ndb_mgm> <userinput>ABORT BACKUP <replaceable>backup_id</replaceable></userinput>
</programlisting>
-
- <para>The number <replaceable>backup_id</replaceable> is the
+
+ <para>
+ The number <replaceable>backup_id</replaceable> is the
identifier of the backup that was included in the response
of the management client when the backup was started (in the
message <literal>Backup <replaceable>backup_id</replaceable>
- started from node
- <replaceable>management_node_id</replaceable></literal>).
+ started from node
+ <replaceable>management_node_id</replaceable></literal>).
</para>
</listitem>
@@ -12435,14 +12440,14 @@
will report this fact in a manner similar to what is shown
here:
</para>
-
+
<programlisting>
Node 1: Backup 3 started from 5 has been aborted. Error: 1321 - Backup aborted by user request: Permanent error: User defined error
Node 3: Backup 3 started from 5 has been aborted. Error: 1323 - 1323: Permanent error: Internal error
Node 2: Backup 3 started from 5 has been aborted. Error: 1323 - 1323: Permanent error: Internal error
Node 4: Backup 3 started from 5 has been aborted. Error: 1323 - 1323: Permanent error: Internal error
</programlisting>
-
+
<para>
In this example, we have shown sample output for a cluster
with 4 data nodes, where the sequence number of the backup
@@ -12452,17 +12457,17 @@
its part in aborting the backup reports that the reason for
the abort was due to a request by the user. (The remaining
nodes report that the backup was aborted due to an
- unspecified internal error.)
+ unspecified internal error.)
<emphasis role="bold">Note</emphasis>: There is no guarantee
that the cluster nodes will respond to an <literal>ABORT
- BACKUP</literal> command in any particular order.
+ BACKUP</literal> command in any particular order.
</para>
-
- <para>
+
+ <para>
The <literal>Backup <replaceable>backup_id</replaceable>
- started from node
- <replaceable>management_node_id</replaceable> has been
- aborted</literal> messages mean that the backup has been
+ started from node
+ <replaceable>management_node_id</replaceable> has been
+ aborted</literal> messages mean that the backup has been
terminated and that all files relating to this backup have
been removed from the cluster filesystem.
</para>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r4634 - branches/telcos/refman-5.1 trunk/refman-4.1 trunk/refman-5.0 trunk/refman-5.1 | jon | 25 Jan |
