| List: | Commits | « Previous MessageNext Message » | |
| From: | paul | Date: | February 1 2006 5:47pm |
| Subject: | svn commit - mysqldoc@docsrva: r1168 - in trunk: . refman-4.1 refman-5.0 refman-5.1 | ||
| View as plain text | |||
Author: paul Date: 2006-02-01 17:47:00 +0100 (Wed, 01 Feb 2006) New Revision: 1168 Log: r7026@frost: paul | 2006-02-01 10:45:59 -0600 General revisions. Modified: trunk/ trunk/refman-4.1/database-administration.xml trunk/refman-4.1/ndbcluster.xml trunk/refman-5.0/database-administration.xml trunk/refman-5.0/ndbcluster.xml trunk/refman-5.1/database-administration.xml trunk/refman-5.1/ndbcluster.xml Property changes on: trunk ___________________________________________________________________ Name: svk:merge - b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:7023 bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:2749 + b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:7026 bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:2749 Modified: trunk/refman-4.1/database-administration.xml =================================================================== --- trunk/refman-4.1/database-administration.xml 2006-02-01 14:46:41 UTC (rev 1167) +++ trunk/refman-4.1/database-administration.xml 2006-02-01 16:47:00 UTC (rev 1168) @@ -425,8 +425,9 @@ <para> Options specific to particular storage engines: See <xref linkend="myisam-start"/>, - <xref linkend="bdb-start"/>, and - <xref linkend="innodb-parameters"/>. + <xref linkend="bdb-start"/>, + <xref linkend="innodb-parameters"/>, and + <xref linkend="new-mysqld-command-options"/>. </para> </listitem> Modified: trunk/refman-4.1/ndbcluster.xml =================================================================== --- trunk/refman-4.1/ndbcluster.xml 2006-02-01 14:46:41 UTC (rev 1167) +++ trunk/refman-4.1/ndbcluster.xml 2006-02-01 16:47:00 UTC (rev 1168) @@ -5773,8 +5773,8 @@ </para> <para> - When starting <command>ndbd</command> it may also be necessary - to specify the hostname of the management server and the port on + To start <command>ndbd</command>, it may also be necessary to + specify the hostname of the management server and the port on which it is listening. Optionally, one may also specify the node ID that the process is to use. </para> @@ -5786,6 +5786,8 @@ <para> See <xref linkend="mysql-cluster-connectstring"/>, for additional information about this issue. + <xref linkend="mysql-cluster-command-options"/>, describes other + options for <command>ndbd</command>. </para> <para> @@ -5841,6 +5843,13 @@ </para> <para> + See <xref linkend="mysql-cluster-connectstring"/>, for + information about using connectstrings. + <xref linkend="mysql-cluster-command-options"/>, describes other + options for <command>ndb_mgmd</command>. + </para> + + <para> The following files are created or used by <command>ndb_mgmd</command> in its starting directory. From MySQL 4.1.5, the log and PID files are placed in the @@ -5856,8 +5865,9 @@ <para> <filename>config.ini</filename> is the configuration file for the cluster as a whole. This file is created by the user - and read by the management server. Setting up this file is - discussed in <xref linkend="mysql-cluster-configuration"/>. + and read by the management server. + <xref linkend="mysql-cluster-configuration"/>, discusses how + to set up this file. </para> </listitem> @@ -5879,9 +5889,9 @@ (was <filename>cluster.log.<replaceable>seq_id</replaceable></filename> where <replaceable>seq_id</replaceable> is the sequence - number of the cluster log file. (For example: If 1, 2, and 3 - already exist, the next log file will be named using the - number <literal>4</literal>.) + number of the cluster log file. (For example: If files with + the sequence numbers 1, 2, and 3 already exist, the next log + file is named using the number <literal>4</literal>.) </para> </listitem> @@ -5900,8 +5910,8 @@ <filename>ndb_<replaceable>node_id</replaceable>.pid</filename> (was <filename>node<replaceable>node_id</replaceable>.pid</filename> - in version 4.1.3) is the PID file used when running the - management server as a daemon. + in version 4.1.3) is the process ID file used when running + the management server as a daemon. </para> </listitem> @@ -5917,26 +5927,37 @@ The management client process is actually not needed to run the cluster. Its value lies in providing a set of commands for checking the cluster's status, starting backups, and performing - other administrative functions. The management client access the - management server using a C API that advanced users can also - employ for programming dedicated management processes which can - perform tasks similar to those performed by + other administrative functions. The management client accesses + the management server using a C API. Advanced users can also + employ this API for programming dedicated management processes + to perform tasks similar to those performed by <command>ndb_mgm</command>. </para> <para> - When starting the management client, it is necessary to supply - the hostname and port of the management server as in the - following example The default values are - <literal>localhost</literal> and <literal>1186</literal> (prior - to MySQL 4.1.8, the default Cluster port was 2200). + To start the management client, it is necessary to supply the + hostname and port number of the management server: </para> <programlisting> -shell> <userinput>ndb_mgm localhost 1186</userinput> +shell> <userinput>ndb_mgm [<replaceable>host_name</replaceable> [<replaceable>port_num</replaceable>]]</userinput> </programlisting> <para> + For example: + </para> + +<programlisting> +shell> <userinput>ndb_mgm ndb_mgmd.mysql.com 1186</userinput> +</programlisting> + + <para> + The default hostname and port number are + <literal>localhost</literal> and 1186, respectively. (Prior to + MySQL 4.1.8, the default Cluster port was 2200.) + </para> + + <para> Additional information about using <command>ndb_mgm</command> can be found in <xref linkend="ndb-mgm-command-options"/>, and <xref linkend="mgm-client-commands"/>. @@ -5950,15 +5971,20 @@ <para> All MySQL Cluster executables (except for - <command>mysqld</command>) take the following options as of - 4.1.8. Users of earlier MySQL Cluster versions should note that - some of these options have been changed to make them consistent - with one another as well as with <command>mysqld</command>. (For - example, the <option>-V</option> switch was <option>-v</option> - in earlier versions.) You can use the <option>--help</option> - option to view a list of supported options. + <command>mysqld</command>) take the options described in this + section as of MySQL 4.1.8. Users of earlier MySQL Cluster + versions should note that some of these options have been + changed to make consistent with one another as well as with + <command>mysqld</command>. You can use the + <option>--help</option> option to view a list of supported + options. </para> + <para> + The following sections describe options specific to individual + NDB programs. + </para> + <itemizedlist> <listitem> @@ -5981,9 +6007,9 @@ </para> <para> - <replaceable>connect_string</replaceable> sets the connect - string to the management server as a command option. (For - reasons of backward compatability, + <replaceable>connect_string</replaceable> sets the + connectstring to the management server as a command option. + (For reasons of backward compatability, <command>ndb_mgmd</command> does not accept the -c option before MySQL 5.0, as this switch specifies the configuration file in previous versions). Available with @@ -6040,9 +6066,10 @@ </programlisting> <para> - This is analogous to how the <option>-e</option> option - works with the <command>mysql</command> command-line client. - See <xref linkend="command-line-options"/>. + This is analogous to how the <option>--execute</option> or + <option>-e</option> option works with the + <command>mysql</command> command-line client. See + <xref linkend="command-line-options"/>. </para> </listitem> @@ -6078,10 +6105,9 @@ </para> <para> - When using the <literal>NDB</literal> storage engine, it - is possible through setting this option to specify the - management server that distributes cluster configuration - data. + When using the <literal>NDB Cluster</literal> storage + engine, this option specifies the management server that + distributes cluster configuration data. </para> </listitem> @@ -6091,32 +6117,17 @@ </para> <para> - If the binary includes support for the <literal>NDB - Cluster</literal> storage engine, the default disabling of - the <literal>NDB Cluster</literal> storage engine (also - referred to more simply as the <literal>NDB</literal> - storage engine) can be overridden by using this option. The <literal>NDB Cluster</literal> storage engine is - necessary for using MySQL Cluster. + necessary for using MySQL Cluster. If a + <command>mysqld</command> binary includes support for the + <literal>NDB Cluster</literal> storage engine, the engine + is disabled by default. Use the + <option>--ndbcluster</option> option to enable it. Use + <option>--skip-ndbcluster</option> to explicitly disable + the engine. </para> </listitem> - <listitem> - <para> - <option>--skip-ndbcluster</option> - </para> - - <para> - Disables the <literal>NDB Cluster</literal> storage - engine. This option is activated by default for binaries - where it is included; in other words, the <literal>NDB - Cluster</literal> storage engine is disabled until - activated via <option>--ndbcluster</option>. This option - applies only if the server was compiled with support for - the <literal>NDB Cluster</literal> storage engine. - </para> - </listitem> - </itemizedlist> </section> @@ -6126,7 +6137,7 @@ <title>&title-ndbd-command-options;</title> <para> - For some common options see + For options common to NDB programs, see <xref linkend="mysql-cluster-command-options"/>. </para> @@ -6167,7 +6178,7 @@ <para> An <option>--initial</option> start is to be used only the very first time that the <command>ndbd</command> process - is started, as it removes all files from the Cluster + is started because it removes all files from the Cluster filesystem and re-creates all REDO log files. The exceptions to this rule are: </para> @@ -6192,7 +6203,7 @@ <para> As a measure of last resort when for some reason the node restart or system restart repeatedly fails. In - this case be aware that this node can no longer be + this case, be aware that this node can no longer be used to restore data due to the destruction of the datafiles. </para> @@ -6219,8 +6230,8 @@ <para> Instructs <command>ndbd</command> not to start as a daemon - process. Useful when <command>ndbd</command> is being - debugged and you want output to be redirected to the + process. This is useful when <command>ndbd</command> is + being debugged and you want output to be redirected to the screen. </para> </listitem> @@ -6235,7 +6246,7 @@ automatically. When this option is used, <command>ndbd</command> connects to the management server, obtains configuration data from it, and initializes - communication objects. However, it will not actually start + communication objects. However, it does not actually start the execution engine until specifically requested to do so by the management server. This can be accomplished by issuing the proper command to the management client. @@ -6251,7 +6262,7 @@ <title>&title-ndb-mgmd-command-options;</title> <para> - For some common options see + For options common to NDB programs, see <xref linkend="mysql-cluster-command-options"/>. </para> @@ -6279,8 +6290,8 @@ </para> <para> - Instructs <command>ndb_mgmd</command> to start as a - daemon. This is the default behavior. + Instructs <command>ndb_mgmd</command> to start as a daemon + process. This is the default behavior. </para> </listitem> @@ -6290,7 +6301,8 @@ </para> <para> - Instructs the management server not to start as a daemon. + Instructs <command>ndb_mgmd</command> not to start as a + daemon process. </para> </listitem> @@ -6303,7 +6315,7 @@ <title>&title-ndb-mgm-command-options;</title> <para> - For some common options see + For options common to NDB programs, see <xref linkend="mysql-cluster-command-options"/>. </para> @@ -6311,21 +6323,6 @@ <listitem> <para> - <option>[<replaceable>host_name</replaceable> - [<replaceable>port_num</replaceable>]]</option> - </para> - - <para> - To start the management client it is necessary to specify - where the management server resides, which means - specifying the hostname and the port. The default hostname - is <literal>localhost</literal> and the default port is - 1186 (this was port 2200 prior to version 4.1.8). - </para> - </listitem> - - <listitem> - <para> <option>--try-reconnect=<replaceable>number</replaceable></option> </para> @@ -6367,8 +6364,8 @@ There are essentially two methods of actively managing a running MySQL Cluster. The first of these is through the use of commands entered into the management client whereby cluster status can be - checked, log levels changed, backups started and stopped and nodes - stopped and started. The second method involves studying the + checked, log levels changed, backups started and stopped, and + nodes stopped and started. The second method involves studying the contents of the cluster log <filename>ndb_<replaceable>node_id</replaceable>_cluster.log</filename> in the management server's <literal>DataDir</literal> directory. @@ -6410,7 +6407,7 @@ <emphasis role="bold">System Restart</emphasis>: The cluster starts and reads data stored in the data nodes. This occurs when the cluster has been shut down after having been in - use, when it is desired for the cluster resume operations + use, when it is desired for the cluster to resume operations from the point where it left off. </para> </listitem> @@ -6435,7 +6432,8 @@ <para> Prior to startup, each data node (<literal>ndbd</literal> - process) must be initialized. This consists of the following: + process) must be initialized. Initialization consists of the + following steps: </para> <orderedlist> Modified: trunk/refman-5.0/database-administration.xml =================================================================== --- trunk/refman-5.0/database-administration.xml 2006-02-01 14:46:41 UTC (rev 1167) +++ trunk/refman-5.0/database-administration.xml 2006-02-01 16:47:00 UTC (rev 1168) @@ -444,8 +444,9 @@ <para> Options specific to particular storage engines: See <xref linkend="myisam-start"/>, - <xref linkend="bdb-start"/>, and - <xref linkend="innodb-parameters"/>. + <xref linkend="bdb-start"/>, + <xref linkend="innodb-parameters"/>, and + <xref linkend="new-mysqld-command-options"/>. </para> </listitem> Modified: trunk/refman-5.0/ndbcluster.xml =================================================================== --- trunk/refman-5.0/ndbcluster.xml 2006-02-01 14:46:41 UTC (rev 1167) +++ trunk/refman-5.0/ndbcluster.xml 2006-02-01 16:47:00 UTC (rev 1168) @@ -5761,8 +5761,8 @@ </para> <para> - When starting <command>ndbd</command> it may also be necessary - to specify the hostname of the management server and the port on + To start <command>ndbd</command>, it may also be necessary to + specify the hostname of the management server and the port on which it is listening. Optionally, one may also specify the node ID that the process is to use. </para> @@ -5774,6 +5774,8 @@ <para> See <xref linkend="mysql-cluster-connectstring"/>, for additional information about this issue. + <xref linkend="mysql-cluster-command-options"/>, describes other + options for <command>ndbd</command>. </para> <para> @@ -5829,6 +5831,13 @@ </para> <para> + See <xref linkend="mysql-cluster-connectstring"/>, for + information about using connectstrings. + <xref linkend="mysql-cluster-command-options"/>, describes other + options for <command>ndb_mgmd</command>. + </para> + + <para> The following files are created or used by <command>ndb_mgmd</command> in its starting directory, and are placed in the <literal>DataDir</literal> as specified in the @@ -5843,8 +5852,9 @@ <para> <filename>config.ini</filename> is the configuration file for the cluster as a whole. This file is created by the user - and read by the management server. Setting up this file is - discussed in <xref linkend="mysql-cluster-configuration"/>. + and read by the management server. + <xref linkend="mysql-cluster-configuration"/>, discusses how + to set up this file. </para> </listitem> @@ -5863,9 +5873,9 @@ the file is renamed to <filename>ndb_<replaceable>node_id</replaceable>_cluster.log.<replaceable>seq_id</replaceable></filename>, where <replaceable>seq_id</replaceable> is the sequence - number of the cluster log file. (For example: If 1, 2, and 3 - already exist, the next log file will be named using the - number <literal>4</literal>.) + number of the cluster log file. (For example: If files with + the sequence numbers 1, 2, and 3 already exist, the next log + file is named using the number <literal>4</literal>.) </para> </listitem> @@ -5881,8 +5891,8 @@ <listitem> <para> <filename>ndb_<replaceable>node_id</replaceable>.pid</filename> - is the PID file used when running the management server as a - daemon. + is the process ID file used when running the management + server as a daemon. </para> </listitem> @@ -5898,25 +5908,36 @@ The management client process is actually not needed to run the cluster. Its value lies in providing a set of commands for checking the cluster's status, starting backups, and performing - other administrative functions. The management client access the - management server using a C API that advanced users can also - employ for programming dedicated management processes which can - perform tasks similar to those performed by + other administrative functions. The management client accesses + the management server using a C API. Advanced users can also + employ this API for programming dedicated management processes + to perform tasks similar to those performed by <command>ndb_mgm</command>. </para> <para> - When starting the management client, it is necessary to supply - the hostname and port of the management server as in the - following example. The default values are - <literal>localhost</literal> and <literal>1186</literal>. + To start the management client, it is necessary to supply the + hostname and port number of the management server: </para> <programlisting> -shell> <userinput>ndb_mgm localhost 1186</userinput> +shell> <userinput>ndb_mgm [<replaceable>host_name</replaceable> [<replaceable>port_num</replaceable>]]</userinput> </programlisting> <para> + For example: + </para> + +<programlisting> +shell> <userinput>ndb_mgm ndb_mgmd.mysql.com 1186</userinput> +</programlisting> + + <para> + The default hostname and port number are + <literal>localhost</literal> and 1186, respectively. + </para> + + <para> Additional information about using <command>ndb_mgm</command> can be found in <xref linkend="ndb-mgm-command-options"/>, and <xref linkend="mgm-client-commands"/>. @@ -5930,15 +5951,20 @@ <para> All MySQL Cluster executables (except for - <command>mysqld</command>) take the following options. Users of - earlier MySQL Cluster versions should note that some of these - options have been changed from those in MySQL 4.1 Cluster in - order to make them consistent with one another as well as with - <command>mysqld</command>. You can use the + <command>mysqld</command>) take the options described in this + section. Users of earlier MySQL Cluster versions should note + that some of these options have been changed from those in MySQL + 4.1 Cluster to make them consistent with one another as well as + with <command>mysqld</command>. You can use the <option>--help</option> option to view a list of supported options. </para> + <para> + The following sections describe options specific to individual + NDB programs. + </para> + <itemizedlist> <listitem> @@ -5961,8 +5987,8 @@ </para> <para> - <replaceable>connect_string</replaceable> sets the connect - string to the management server as a command option. + <replaceable>connect_string</replaceable> sets the + connectstring to the management server as a command option. </para> <programlisting> @@ -6015,9 +6041,10 @@ </programlisting> <para> - This is analogous to how the <option>-e</option> option - works with the <command>mysql</command> command-line client. - See <xref linkend="command-line-options"/>. + This is analogous to how the <option>--execute</option> or + <option>-e</option> option works with the + <command>mysql</command> command-line client. See + <xref linkend="command-line-options"/>. </para> </listitem> @@ -6053,10 +6080,9 @@ </para> <para> - When using the <literal>NDB</literal> storage engine, it - is possible through setting this option to specify the - management server that distributes cluster configuration - data. + When using the <literal>NDB Cluster</literal> storage + engine, this option specifies the management server that + distributes cluster configuration data. </para> </listitem> @@ -6066,32 +6092,17 @@ </para> <para> - If the binary includes support for the <literal>NDB - Cluster</literal> storage engine, the default disabling of - the <literal>NDB Cluster</literal> storage engine (also - referred to more simply as the <literal>NDB</literal> - storage engine) can be overridden by using this option. The <literal>NDB Cluster</literal> storage engine is - necessary for using MySQL Cluster. + necessary for using MySQL Cluster. If a + <command>mysqld</command> binary includes support for the + <literal>NDB Cluster</literal> storage engine, the engine + is disabled by default. Use the + <option>--ndbcluster</option> option to enable it. Use + <option>--skip-ndbcluster</option> to explicitly disable + the engine. </para> </listitem> - <listitem> - <para> - <option>--skip-ndbcluster</option> - </para> - - <para> - Disables the <literal>NDB Cluster</literal> storage - engine. This option is activated by default for binaries - where it is included; in other words, the <literal>NDB - Cluster</literal> storage engine is disabled until - activated via <option>--ndbcluster</option>. This option - applies only if the server was compiled with support for - the <literal>NDB Cluster</literal> storage engine. - </para> - </listitem> - </itemizedlist> </section> @@ -6101,7 +6112,7 @@ <title>&title-ndbd-command-options;</title> <para> - For some common options see + For options common to NDB programs, see <xref linkend="mysql-cluster-command-options"/>. </para> @@ -6114,7 +6125,7 @@ <para> Instructs <command>ndbd</command> to execute as a daemon - process (the default behavior). + process. This is the default behavior. <option>--nodaemon</option> can be used to not start the process as a daemon. </para> @@ -6142,7 +6153,7 @@ <para> An <option>--initial</option> start is to be used only the very first time that the <command>ndbd</command> process - is started, as it removes all files from the Cluster + is started because it removes all files from the Cluster filesystem and re-creates all REDO log files. The exceptions to this rule are: </para> @@ -6167,7 +6178,7 @@ <para> As a measure of last resort when for some reason the node restart or system restart repeatedly fails. In - this case be aware that this node can no longer be + this case, be aware that this node can no longer be used to restore data due to the destruction of the datafiles. </para> @@ -6188,8 +6199,8 @@ <para> Instructs <command>ndbd</command> not to start as a daemon - process. Useful when <command>ndbd</command> is being - debugged and you want output to be redirected to the + process. This is useful when <command>ndbd</command> is + being debugged and you want output to be redirected to the screen. </para> </listitem> @@ -6204,7 +6215,7 @@ automatically. When this option is used, <command>ndbd</command> connects to the management server, obtains configuration data from it, and initializes - communication objects. However, it will not actually start + communication objects. However, it does not actually start the execution engine until specifically requested to do so by the management server. This can be accomplished by issuing the proper command to the management client. @@ -6220,7 +6231,7 @@ <title>&title-ndb-mgmd-command-options;</title> <para> - For some common options see + For options common to NDB programs, see <xref linkend="mysql-cluster-command-options"/>. </para> @@ -6254,8 +6265,8 @@ </para> <para> - Instructs <command>ndb_mgmd</command> to start as a - daemon. This is the default behavior. + Instructs <command>ndb_mgmd</command> to start as a daemon + process. This is the default behavior. </para> </listitem> @@ -6265,7 +6276,8 @@ </para> <para> - Instructs the management server not to start as a daemon. + Instructs <command>ndb_mgmd</command> not to start as a + daemon process. </para> </listitem> @@ -6278,7 +6290,7 @@ <title>&title-ndb-mgm-command-options;</title> <para> - For some common options see + For options common to NDB programs, see <xref linkend="mysql-cluster-command-options"/>. </para> @@ -6286,20 +6298,6 @@ <listitem> <para> - <option>[<replaceable>host_name</replaceable> - [<replaceable>port_num</replaceable>]]</option> - </para> - - <para> - To start the management client it is necessary to specify - where the management server resides, which means - specifying the hostname and the port. The default hostname - is <literal>localhost</literal>; the default port is 1186. - </para> - </listitem> - - <listitem> - <para> <option>--try-reconnect=<replaceable>number</replaceable></option> </para> @@ -6341,8 +6339,8 @@ There are essentially two methods of actively managing a running MySQL Cluster. The first of these is through the use of commands entered into the management client whereby cluster status can be - checked, log levels changed, backups started and stopped and nodes - stopped and started. The second method involves studying the + checked, log levels changed, backups started and stopped, and + nodes stopped and started. The second method involves studying the contents of the cluster log <filename>ndb_<replaceable>node_id</replaceable>_cluster.log</filename> in the management server's <literal>DataDir</literal> directory. @@ -6384,7 +6382,7 @@ <emphasis role="bold">System Restart</emphasis>: The cluster starts and reads data stored in the data nodes. This occurs when the cluster has been shut down after having been in - use, when it is desired for the cluster resume operations + use, when it is desired for the cluster to resume operations from the point where it left off. </para> </listitem> @@ -6409,7 +6407,8 @@ <para> Prior to startup, each data node (<literal>ndbd</literal> - process) must be initialized. This consists of the following: + process) must be initialized. Initialization consists of the + following steps: </para> <orderedlist> Modified: trunk/refman-5.1/database-administration.xml =================================================================== --- trunk/refman-5.1/database-administration.xml 2006-02-01 14:46:41 UTC (rev 1167) +++ trunk/refman-5.1/database-administration.xml 2006-02-01 16:47:00 UTC (rev 1168) @@ -443,8 +443,9 @@ <para> Options specific to particular storage engines: See <xref linkend="myisam-start"/>, - <xref linkend="bdb-start"/>, and - <xref linkend="innodb-parameters"/>. + <xref linkend="bdb-start"/>, + <xref linkend="innodb-parameters"/>, and + <xref linkend="new-mysqld-command-options"/>. </para> </listitem> Modified: trunk/refman-5.1/ndbcluster.xml =================================================================== --- trunk/refman-5.1/ndbcluster.xml 2006-02-01 14:46:41 UTC (rev 1167) +++ trunk/refman-5.1/ndbcluster.xml 2006-02-01 16:47:00 UTC (rev 1168) @@ -5759,8 +5759,8 @@ </para> <para> - When starting <command>ndbd</command> it may also be necessary - to specify the hostname of the management server and the port on + To start <command>ndbd</command>, it may also be necessary to + specify the hostname of the management server and the port on which it is listening. Optionally, one may also specify the node ID that the process is to use. </para> @@ -5772,6 +5772,8 @@ <para> See <xref linkend="mysql-cluster-connectstring"/>, for additional information about this issue. + <xref linkend="mysql-cluster-command-options"/>, describes other + options for <command>ndbd</command>. </para> <para> @@ -5827,6 +5829,13 @@ </para> <para> + See <xref linkend="mysql-cluster-connectstring"/>, for + information about using connectstrings. + <xref linkend="mysql-cluster-command-options"/>, describes other + options for <command>ndb_mgmd</command>. + </para> + + <para> The following files are created or used by <command>ndb_mgmd</command> in its starting directory, and are placed in the <literal>DataDir</literal> as specified in the @@ -5841,8 +5850,9 @@ <para> <filename>config.ini</filename> is the configuration file for the cluster as a whole. This file is created by the user - and read by the management server. Setting up this file is - discussed in <xref linkend="mysql-cluster-configuration"/>. + and read by the management server. + <xref linkend="mysql-cluster-configuration"/>, discusses how + to set up this file. </para> </listitem> @@ -5861,9 +5871,9 @@ the file is renamed to <filename>ndb_<replaceable>node_id</replaceable>_cluster.log.<replaceable>seq_id</replaceable></filename>, where <replaceable>seq_id</replaceable> is the sequence - number of the cluster log file. (For example: If 1, 2, and 3 - already exist, the next log file will be named using the - number <literal>4</literal>.) + number of the cluster log file. (For example: If files with + the sequence numbers 1, 2, and 3 already exist, the next log + file is named using the number <literal>4</literal>.) </para> </listitem> @@ -5879,8 +5889,8 @@ <listitem> <para> <filename>ndb_<replaceable>node_id</replaceable>.pid</filename> - is the PID file used when running the management server as a - daemon. + is the process ID file used when running the management + server as a daemon. </para> </listitem> @@ -5896,25 +5906,36 @@ The management client process is actually not needed to run the cluster. Its value lies in providing a set of commands for checking the cluster's status, starting backups, and performing - other administrative functions. The management client access the - management server using a C API that advanced users can also - employ for programming dedicated management processes which can - perform tasks similar to those performed by + other administrative functions. The management client accesses + the management server using a C API. Advanced users can also + employ this API for programming dedicated management processes + to perform tasks similar to those performed by <command>ndb_mgm</command>. </para> <para> - When starting the management client, it is necessary to supply - the hostname and port of the management server as in the - following example. The default values are - <literal>localhost</literal> and <literal>1186</literal>. + To start the management client, it is necessary to supply the + hostname and port number of the management server: </para> <programlisting> -shell> <userinput>ndb_mgm localhost 1186</userinput> +shell> <userinput>ndb_mgm [<replaceable>host_name</replaceable> [<replaceable>port_num</replaceable>]]</userinput> </programlisting> <para> + For example: + </para> + +<programlisting> +shell> <userinput>ndb_mgm ndb_mgmd.mysql.com 1186</userinput> +</programlisting> + + <para> + The default hostname and port number are + <literal>localhost</literal> and 1186, respectively. + </para> + + <para> Additional information about using <command>ndb_mgm</command> can be found in <xref linkend="ndb-mgm-command-options"/>, and <xref linkend="mgm-client-commands"/>. @@ -5928,15 +5949,20 @@ <para> All MySQL Cluster executables (except for - <command>mysqld</command>) take the following options. Users of - earlier MySQL Cluster versions should note that some of these - options have been changed from those in MySQL 4.1 Cluster in - order to make them consistent with one another as well as with - <command>mysqld</command>. You can use the + <command>mysqld</command>) take the options described in this + section. Users of earlier MySQL Cluster versions should note + that some of these options have been changed from those in MySQL + 4.1 Cluster to make them consistent with one another as well as + with <command>mysqld</command>. You can use the <option>--help</option> option to view a list of supported options. </para> + <para> + The following sections describe options specific to individual + NDB programs. + </para> + <itemizedlist> <listitem> @@ -5959,8 +5985,8 @@ </para> <para> - <replaceable>connect_string</replaceable> sets the connect - string to the management server as a command option. + <replaceable>connect_string</replaceable> sets the + connectstring to the management server as a command option. </para> <programlisting> @@ -6013,9 +6039,10 @@ </programlisting> <para> - This is analogous to how the <option>-e</option> option - works with the <command>mysql</command> command-line client. - See <xref linkend="command-line-options"/>. + This is analogous to how the <option>--execute</option> or + <option>-e</option> option works with the + <command>mysql</command> command-line client. See + <xref linkend="command-line-options"/>. </para> </listitem> @@ -6051,10 +6078,9 @@ </para> <para> - When using the <literal>NDB</literal> storage engine, it - is possible through setting this option to specify the - management server that distributes cluster configuration - data. + When using the <literal>NDB Cluster</literal> storage + engine, this option specifies the management server that + distributes cluster configuration data. </para> </listitem> @@ -6064,32 +6090,17 @@ </para> <para> - If the binary includes support for the <literal>NDB - Cluster</literal> storage engine, the default disabling of - the <literal>NDB Cluster</literal> storage engine (also - referred to more simply as the <literal>NDB</literal> - storage engine) can be overridden by using this option. The <literal>NDB Cluster</literal> storage engine is - necessary for using MySQL Cluster. + necessary for using MySQL Cluster. If a + <command>mysqld</command> binary includes support for the + <literal>NDB Cluster</literal> storage engine, the engine + is disabled by default. Use the + <option>--ndbcluster</option> option to enable it. Use + <option>--skip-ndbcluster</option> to explicitly disable + the engine. </para> </listitem> - <listitem> - <para> - <option>--skip-ndbcluster</option> - </para> - - <para> - Disables the <literal>NDB Cluster</literal> storage - engine. This option is activated by default for binaries - where it is included; in other words, the <literal>NDB - Cluster</literal> storage engine is disabled until - activated via <option>--ndbcluster</option>. This option - applies only if the server was compiled with support for - the <literal>NDB Cluster</literal> storage engine. - </para> - </listitem> - </itemizedlist> </section> @@ -6099,7 +6110,7 @@ <title>&title-ndbd-command-options;</title> <para> - For some common options see + For options common to NDB programs, see <xref linkend="mysql-cluster-command-options"/>. </para> @@ -6112,7 +6123,7 @@ <para> Instructs <command>ndbd</command> to execute as a daemon - process (the default behavior). + process. This is the default behavior. <option>--nodaemon</option> can be used to not start the process as a daemon. </para> @@ -6140,7 +6151,7 @@ <para> An <option>--initial</option> start is to be used only the very first time that the <command>ndbd</command> process - is started, as it removes all files from the Cluster + is started because it removes all files from the Cluster filesystem and re-creates all REDO log files. The exceptions to this rule are: </para> @@ -6165,7 +6176,7 @@ <para> As a measure of last resort when for some reason the node restart or system restart repeatedly fails. In - this case be aware that this node can no longer be + this case, be aware that this node can no longer be used to restore data due to the destruction of the datafiles. </para> @@ -6186,8 +6197,8 @@ <para> Instructs <command>ndbd</command> not to start as a daemon - process. Useful when <command>ndbd</command> is being - debugged and you want output to be redirected to the + process. This is useful when <command>ndbd</command> is + being debugged and you want output to be redirected to the screen. </para> </listitem> @@ -6202,7 +6213,7 @@ automatically. When this option is used, <command>ndbd</command> connects to the management server, obtains configuration data from it, and initializes - communication objects. However, it will not actually start + communication objects. However, it does not actually start the execution engine until specifically requested to do so by the management server. This can be accomplished by issuing the proper command to the management client. @@ -6218,7 +6229,7 @@ <title>&title-ndb-mgmd-command-options;</title> <para> - For some common options see + For options common to NDB programs, see <xref linkend="mysql-cluster-command-options"/>. </para> @@ -6252,8 +6263,8 @@ </para> <para> - Instructs <command>ndb_mgmd</command> to start as a - daemon. This is the default behavior. + Instructs <command>ndb_mgmd</command> to start as a daemon + process. This is the default behavior. </para> </listitem> @@ -6263,7 +6274,8 @@ </para> <para> - Instructs the management server not to start as a daemon. + Instructs <command>ndb_mgmd</command> not to start as a + daemon process. </para> </listitem> @@ -6276,7 +6288,7 @@ <title>&title-ndb-mgm-command-options;</title> <para> - For some common options see + For options common to NDB programs, see <xref linkend="mysql-cluster-command-options"/>. </para> @@ -6284,20 +6296,6 @@ <listitem> <para> - <option>[<replaceable>host_name</replaceable> - [<replaceable>port_num</replaceable>]]</option> - </para> - - <para> - To start the management client it is necessary to specify - where the management server resides, which means - specifying the hostname and the port. The default hostname - is <literal>localhost</literal>; the default port is 1186. - </para> - </listitem> - - <listitem> - <para> <option>--try-reconnect=<replaceable>number</replaceable></option> </para> @@ -6339,8 +6337,8 @@ There are essentially two methods of actively managing a running MySQL Cluster. The first of these is through the use of commands entered into the management client whereby cluster status can be - checked, log levels changed, backups started and stopped and nodes - stopped and started. The second method involves studying the + checked, log levels changed, backups started and stopped, and + nodes stopped and started. The second method involves studying the contents of the cluster log <filename>ndb_<replaceable>node_id</replaceable>_cluster.log</filename> in the management server's <literal>DataDir</literal> directory. @@ -6382,7 +6380,7 @@ <emphasis role="bold">System Restart</emphasis>: The cluster starts and reads data stored in the data nodes. This occurs when the cluster has been shut down after having been in - use, when it is desired for the cluster resume operations + use, when it is desired for the cluster to resume operations from the point where it left off. </para> </listitem> @@ -6407,7 +6405,8 @@ <para> Prior to startup, each data node (<literal>ndbd</literal> - process) must be initialized. This consists of the following: + process) must be initialized. Initialization consists of the + following steps: </para> <orderedlist>
| Thread | ||
|---|---|---|
| • svn commit - mysqldoc@docsrva: r1168 - in trunk: . refman-4.1 refman-5.0 refman-5.1 | paul | 1 Feb |
© 1995-2008 MySQL AB, 2008-2009 Sun Microsystems, Inc.
Page generated in 0.894 sec. using MySQL 5.1.14-beta-log