From: jon Date: December 6 2008 3:08pm Subject: svn commit - mysqldoc@docsrva: r12820 - in trunk: refman-4.1 refman-5.0 refman-5.1 List-Archive: http://lists.mysql.com/commits/60808 Message-Id: <200812061508.mB6F83uj028678@docsrva.mysql.com> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Author: jstephens Date: 2008-12-06 16:08:02 +0100 (Sat, 06 Dec 2008) New Revision: 12820 Log: Some wording fixes; define 'global configuration file' Modified: trunk/refman-4.1/mysql-cluster-configuration.xml trunk/refman-5.0/mysql-cluster-configuration.xml trunk/refman-5.1/mysql-cluster-configuration.xml Modified: trunk/refman-4.1/mysql-cluster-configuration.xml =================================================================== --- trunk/refman-4.1/mysql-cluster-configuration.xml 2008-12-06 14:38:37 UTC (rev 12819) +++ trunk/refman-4.1/mysql-cluster-configuration.xml 2008-12-06 15:08:02 UTC (rev 12820) Changed blocks: 4, Lines Added: 54, Lines Deleted: 46; 7612 bytes @@ -403,12 +403,13 @@ - config.ini: This file is read only by the - MySQL Cluster management server, which then distributes the - information contained therein to all processes participating - in the cluster. config.ini contains a - description of each node involved in the cluster. This - includes configuration parameters for data nodes and + config.ini: This file, sometimes known as + the global configuration file, is read + only by the MySQL Cluster management server, which then + distributes the information contained therein to all processes + participating in the cluster. config.ini + contains a description of each node involved in the cluster. + This includes configuration parameters for data nodes and configuration parameters for connections between all nodes in the cluster. For a quick reference to the sections that can appear in this file, and what sorts of configuration @@ -452,22 +453,25 @@ To support MySQL Cluster, you will need to update my.cnf as shown in the following example. - Note that the options shown here should not be confused with - those that are used in config.ini files. You may also specify these parameters on the command line when invoking the executables. - From version 4.1.8 some simplifications in - my.cnf were made, including new sections - for ndbcluster executables. However, these - should not be confused with those occurring in - config.ini files. As always, you may - specify these parameters when invoking those executables from - the command line. + In MySQL 4.1.8, some simplifications in + my.cnf were introduced, including new + sections for ndbcluster executables. + + + The options shown here should not be confused with those that + are used in config.ini global + configuration files. Global configuration options are + discussed later in this section. + + + # my.cnf # example additions to my.cnf for MySQL Cluster @@ -545,10 +549,10 @@ - The configuration file is named config.ini - by default. It is read by ndb_mgmd at startup - and can be placed anywhere. Its location and name are specified - by using + The MySQL Cluster global configuration file is named + config.ini by default. It is read by + ndb_mgmd at startup and can be placed + anywhere. Its location and name are specified by using on the ndb_mgmd command line. If the configuration file is not specified, ndb_mgmd @@ -558,40 +562,44 @@ - Currently, the configuration file is in INI format, which - consists of sections preceded by section headings (surrounded by - square brackets), followed by the appropriate parameter names - and values. One deviation from the standard INI format is that - the parameter name and value can be separated by a colon - (:) as well as the equals sign - (=); however, the equals sign - is preferred. Another deviation is that sections are not - uniquely identified by section name. Instead, unique sections - (such as two different nodes of the same type) are identified by - a unique ID specified as a parameter within the section. + The global configuration file for MySQL Cluster uses INI format, + which consists of sections preceded by section headings + (surrounded by square brackets), followed by the appropriate + parameter names and values. One deviation from the standard INI + format is that the parameter name and value can be separated by + a colon (:) as well as the + equals sign (=); however, the + equals sign is preferred. Another deviation is that sections are + not uniquely identified by section name. Instead, unique + sections (such as two different nodes of the same type) are + identified by a unique ID specified as a parameter within the + section. Default values are defined for most parameters, and can also be - specified in config.ini. To create a - default value section, simply add the word - default to the section name. For example, an - [ndbd] section contains parameters that apply - to a particular data node, whereas an [ndbd - default] section contains parameters that apply to all - data nodes. Suppose that all data nodes should use the same data - memory size. To configure them all, create an [ndbd - default] section that contains a - DataMemory line to specify the data memory - size. + specified in config.ini. + (Exception: The + NoOfReplicas configuration parameter has no + default value, and must always be specified explicitly in the + [ndbd default] section.) To create a default + value section, simply add the word default to + the section name. For example, an [ndbd] + section contains parameters that apply to a particular data + node, whereas an [ndbd default] section + contains parameters that apply to all data nodes. Suppose that + all data nodes should use the same data memory size. To + configure them all, create an [ndbd default] + section that contains a DataMemory line to + specify the data memory size. - At a minimum, the configuration file must define the computers - and nodes involved in the cluster and on which computers these - nodes are located. An example of a simple configuration file for - a cluster consisting of one management server, two data nodes - and two MySQL servers is shown here: + The global configuration file must define the computers and + nodes involved in the cluster and on which computers these nodes + are located. An example of a simple configuration file for a + cluster consisting of one management server, two data nodes and + two MySQL servers is shown here: Modified: trunk/refman-5.0/mysql-cluster-configuration.xml =================================================================== --- trunk/refman-5.0/mysql-cluster-configuration.xml 2008-12-06 14:38:37 UTC (rev 12819) +++ trunk/refman-5.0/mysql-cluster-configuration.xml 2008-12-06 15:08:02 UTC (rev 12820) Changed blocks: 4, Lines Added: 51, Lines Deleted: 39; 6997 bytes @@ -402,12 +402,13 @@ - config.ini: This file is read only by the - MySQL Cluster management server, which then distributes the - information contained therein to all processes participating - in the cluster. config.ini contains a - description of each node involved in the cluster. This - includes configuration parameters for data nodes and + config.ini: This file, sometimes known as + the global configuration file, is read + only by the MySQL Cluster management server, which then + distributes the information contained therein to all processes + participating in the cluster. config.ini + contains a description of each node involved in the cluster. + This includes configuration parameters for data nodes and configuration parameters for connections between all nodes in the cluster. For a quick reference to the sections that can appear in this file, and what sorts of configuration @@ -451,12 +452,19 @@ To support MySQL Cluster, you will need to update my.cnf as shown in the following example. - Note that the options shown here should not be confused with - those that are used in config.ini files. You may also specify these parameters on the command line when invoking the executables. + + + The options shown here should not be confused with those that + are used in config.ini global + configuration files. Global configuration options are + discussed later in this section. + + + # my.cnf # example additions to my.cnf for MySQL Cluster @@ -533,10 +541,10 @@ - The configuration file is named config.ini - by default. It is read by ndb_mgmd at startup - and can be placed anywhere. Its location and name are specified - by using + The MySQL Cluster global configuration file is named + config.ini by default. It is read by + ndb_mgmd at startup and can be placed + anywhere. Its location and name are specified by using on the ndb_mgmd command line. If the configuration file is not specified, ndb_mgmd @@ -546,40 +554,44 @@ - Currently, the configuration file is in INI format, which - consists of sections preceded by section headings (surrounded by - square brackets), followed by the appropriate parameter names - and values. One deviation from the standard INI format is that - the parameter name and value can be separated by a colon - (:) as well as the equals sign - (=); however, the equals sign - is preferred. Another deviation is that sections are not - uniquely identified by section name. Instead, unique sections - (such as two different nodes of the same type) are identified by - a unique ID specified as a parameter within the section. + The global configuration file for MySQL Cluster uses INI format, + which consists of sections preceded by section headings + (surrounded by square brackets), followed by the appropriate + parameter names and values. One deviation from the standard INI + format is that the parameter name and value can be separated by + a colon (:) as well as the + equals sign (=); however, the + equals sign is preferred. Another deviation is that sections are + not uniquely identified by section name. Instead, unique + sections (such as two different nodes of the same type) are + identified by a unique ID specified as a parameter within the + section. Default values are defined for most parameters, and can also be - specified in config.ini. To create a - default value section, simply add the word - default to the section name. For example, an - [ndbd] section contains parameters that apply - to a particular data node, whereas an [ndbd - default] section contains parameters that apply to all - data nodes. Suppose that all data nodes should use the same data - memory size. To configure them all, create an [ndbd - default] section that contains a - DataMemory line to specify the data memory - size. + specified in config.ini. + (Exception: The + NoOfReplicas configuration parameter has no + default value, and must always be specified explicitly in the + [ndbd default] section.) To create a default + value section, simply add the word default to + the section name. For example, an [ndbd] + section contains parameters that apply to a particular data + node, whereas an [ndbd default] section + contains parameters that apply to all data nodes. Suppose that + all data nodes should use the same data memory size. To + configure them all, create an [ndbd default] + section that contains a DataMemory line to + specify the data memory size. - At a minimum, the configuration file must define the computers - and nodes involved in the cluster and on which computers these - nodes are located. An example of a simple configuration file for - a cluster consisting of one management server, two data nodes - and two MySQL servers is shown here: + The global configuration file must define the computers and + nodes involved in the cluster and on which computers these nodes + are located. An example of a simple configuration file for a + cluster consisting of one management server, two data nodes and + two MySQL servers is shown here: Modified: trunk/refman-5.1/mysql-cluster-configuration.xml =================================================================== --- trunk/refman-5.1/mysql-cluster-configuration.xml 2008-12-06 14:38:37 UTC (rev 12819) +++ trunk/refman-5.1/mysql-cluster-configuration.xml 2008-12-06 15:08:02 UTC (rev 12820) Changed blocks: 4, Lines Added: 51, Lines Deleted: 39; 6997 bytes @@ -413,12 +413,13 @@ - config.ini: This file is read only by the - MySQL Cluster management server, which then distributes the - information contained therein to all processes participating - in the cluster. config.ini contains a - description of each node involved in the cluster. This - includes configuration parameters for data nodes and + config.ini: This file, sometimes known as + the global configuration file, is read + only by the MySQL Cluster management server, which then + distributes the information contained therein to all processes + participating in the cluster. config.ini + contains a description of each node involved in the cluster. + This includes configuration parameters for data nodes and configuration parameters for connections between all nodes in the cluster. For a quick reference to the sections that can appear in this file, and what sorts of configuration @@ -462,12 +463,19 @@ To support MySQL Cluster, you will need to update my.cnf as shown in the following example. - Note that the options shown here should not be confused with - those that are used in config.ini files. You may also specify these parameters on the command line when invoking the executables. + + + The options shown here should not be confused with those that + are used in config.ini global + configuration files. Global configuration options are + discussed later in this section. + + + # my.cnf # example additions to my.cnf for MySQL Cluster @@ -544,10 +552,10 @@ - The configuration file is named config.ini - by default. It is read by ndb_mgmd at startup - and can be placed anywhere. Its location and name are specified - by using + The MySQL Cluster global configuration file is named + config.ini by default. It is read by + ndb_mgmd at startup and can be placed + anywhere. Its location and name are specified by using on the ndb_mgmd command line. If the configuration file is not specified, ndb_mgmd @@ -557,40 +565,44 @@ - Currently, the configuration file is in INI format, which - consists of sections preceded by section headings (surrounded by - square brackets), followed by the appropriate parameter names - and values. One deviation from the standard INI format is that - the parameter name and value can be separated by a colon - (:) as well as the equals sign - (=); however, the equals sign - is preferred. Another deviation is that sections are not - uniquely identified by section name. Instead, unique sections - (such as two different nodes of the same type) are identified by - a unique ID specified as a parameter within the section. + The global configuration file for MySQL Cluster uses INI format, + which consists of sections preceded by section headings + (surrounded by square brackets), followed by the appropriate + parameter names and values. One deviation from the standard INI + format is that the parameter name and value can be separated by + a colon (:) as well as the + equals sign (=); however, the + equals sign is preferred. Another deviation is that sections are + not uniquely identified by section name. Instead, unique + sections (such as two different nodes of the same type) are + identified by a unique ID specified as a parameter within the + section. Default values are defined for most parameters, and can also be - specified in config.ini. To create a - default value section, simply add the word - default to the section name. For example, an - [ndbd] section contains parameters that apply - to a particular data node, whereas an [ndbd - default] section contains parameters that apply to all - data nodes. Suppose that all data nodes should use the same data - memory size. To configure them all, create an [ndbd - default] section that contains a - DataMemory line to specify the data memory - size. + specified in config.ini. + (Exception: The + NoOfReplicas configuration parameter has no + default value, and must always be specified explicitly in the + [ndbd default] section.) To create a default + value section, simply add the word default to + the section name. For example, an [ndbd] + section contains parameters that apply to a particular data + node, whereas an [ndbd default] section + contains parameters that apply to all data nodes. Suppose that + all data nodes should use the same data memory size. To + configure them all, create an [ndbd default] + section that contains a DataMemory line to + specify the data memory size. - At a minimum, the configuration file must define the computers - and nodes involved in the cluster and on which computers these - nodes are located. An example of a simple configuration file for - a cluster consisting of one management server, two data nodes - and two MySQL servers is shown here: + The global configuration file must define the computers and + nodes involved in the cluster and on which computers these nodes + are located. An example of a simple configuration file for a + cluster consisting of one management server, two data nodes and + two MySQL servers is shown here: