From: jon
Date: February 20 2008 2:00pm
Subject: svn commit - mysqldoc@docsrva: r9939 - in trunk: refman-4.1 refman-5.0 refman-5.1 refman-6.0
List-Archive: http://lists.mysql.com/commits/42654
Message-Id: <200802201400.m1KE0QRN013745@docsrva.mysql.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Author: jstephens
Date: 2008-02-20 15:00:25 +0100 (Wed, 20 Feb 2008)
New Revision: 9939
Log:
Start cluster optvars sections for RefMan 5.0/5.1/6.0
Added:
trunk/refman-5.0/mysql-cluster-optvar-core.xml
trunk/refman-5.1/mysql-cluster-optvar-core.xml
trunk/refman-6.0/mysql-cluster-optvar-core.xml
Modified:
trunk/refman-4.1/mysql-cluster-optvar-core.xml
Modified: trunk/refman-4.1/mysql-cluster-optvar-core.xml
===================================================================
--- trunk/refman-4.1/mysql-cluster-optvar-core.xml 2008-02-20 11:00:27 UTC (rev 9938)
+++ trunk/refman-4.1/mysql-cluster-optvar-core.xml 2008-02-20 14:00:25 UTC (rev 9939)
Changed blocks: 2, Lines Added: 209, Lines Deleted: 2; 8046 bytes
@@ -182,7 +182,180 @@
on using system variables, see
.
-
+
+
+
+
+
+
+ ndb_autoincrement_prefetch_sz
+
+
+
+ Determines the probability of gaps in an autoincremented
+ column. Set it to 1 to minimize this.
+ Setting it to a high value for optimization — makes
+ inserts faster, but decreases the likelihood that
+ consecutive autoincrement numbers will be used in a batch of
+ inserts. Default value: 32. Minimum
+ value: 1.
+
+
+
+
+
+ ndb_cache_check_time
+
+
+
+ The number of milliseconds that elapse between checks of
+ MySQL Cluster SQL nodes by the MySQL query cache. Setting
+ this to 0 (the default and minimum value) means that the
+ query cache checks for validation on every query.
+
+
+
+ The recommended maximum value for this variable is 1000,
+ which means that the check is performed once per second. A
+ larger value means that the check is performed and possibly
+ invalidated due to updates on different SQL nodes less
+ often. It is generally not desirable to set this to a value
+ greater than 2000.
+
+
+
+
+
+ ndb_force_send
+
+
+
+ Forces sending of buffers to NDB
+ immediately, without waiting for other threads. Defaults to
+ ON.
+
+
+
+
+
+ ndb_index_stat_cache_entries
+
+
+
+ Sets the granularity of the statistics by determining the
+ number of starting and ending keys to store in the
+ statistics memory cache. Zero means no caching takes place;
+ in this case, the data nodes are always queried directly.
+ Default value: 32.
+
+
+
+
+
+ ndb_index_stat_enable
+
+
+
+ Use NDB index statistics in query
+ optimization. Defaults to ON.
+
+
+
+
+
+ ndb_index_stat_update_freq
+
+
+
+ How often to query data nodes instead of the statistics
+ cache. For example, a value of 20 (the
+ default) means to direct every
+ 20th query to the data nodes.
+
+
+
+
+
+ ndb_optimized_node_selection
+
+
+
+ Causes an SQL node to use a data node on the same host
+ machine as transaction coordinator. Enabled by default. Set
+ to 0 or OFF to
+ disable, in which case the SQL node uses each data node in
+ the cluster in succession. When this option is disabled, or
+ if there is no data node process running on the same host as
+ the SQL node, the SQL node attempts to use a given data node
+ 8 times before proceeding to the next one.
+
+
+
+ Added in MySQL 4.1.9.
+
+
+
+
+
+ ndb_report_thresh_binlog_epoch_slip
+
+
+
+ This is a threshold on the number of epochs to be behind
+ before reporting binlog status. For example, a value of
+ 3 (the default) means that if the
+ difference between which epoch has been received from the
+ storage nodes and which epoch has been applied to the binlog
+ is 3 or more, a status message will be sent to the cluster
+ log.
+
+
+
+
+
+ ndb_report_thresh_binlog_mem_usage
+
+
+
+ This is a threshold on the percentage of free memory
+ remaining before reporting binlog status. For example, a
+ value of 10 (the default) means that if
+ the amount of available memory for receiving binlog data
+ from the data nodes falls below 10%, a status message will
+ be sent to the cluster log.
+
+
+
+
+
+ ndb_use_exact_count
+
+
+
+ Forces NDB to use a count of records
+ during SELECT COUNT(*) query planning to
+ speed up this type of query. The default value is
+ ON. For faster queries overall, disable
+ this feature by setting the value of
+ ndb_use_exact_count to
+ OFF.
+
+
+
+
+
+ ndb_use_transactions
+
+
+
+ You can disable NDB transaction support
+ by setting this variable's values to OFF
+ (not recommended). The default is ON.
+
+
+
+
+
@@ -196,7 +369,41 @@
specific to MySQL Cluster, and for general information on using
status variables, see .
-
+
+
+
+
+
+
+ have_ndbcluster
+
+
+
+ YES if mysqld supports
+ NDB Cluster tables.
+ DISABLED if
+ is used. This variable
+ was added in MySQL 4.1.2.
+
+
+
+
+
+ Handler_discover
+
+
+
+ The MySQL server can ask the NDB Cluster
+ storage engine if it knows about a table with a given name.
+ This is called discovery.
+ Handler_discover indicates the number of
+ times that tables have been discovered. This variable was
+ added in MySQL 4.1.2.
+
+
+
+
+
Added: trunk/refman-5.0/mysql-cluster-optvar-core.xml
===================================================================
--- trunk/refman-5.0/mysql-cluster-optvar-core.xml (rev 0)
+++ trunk/refman-5.0/mysql-cluster-optvar-core.xml 2008-02-20 14:00:25 UTC (rev 9939)
Changed blocks: 1, Lines Added: 202, Lines Deleted: 0; 7080 bytes
@@ -0,0 +1,202 @@
+
+
+ %all.entities;
+]>
+
+
+ MySQL Cluster Options and Variables
+
+
+
+
+ This section provides information about MySQL server options, server
+ and status variables that are specific to MySQL Cluster. For general
+ information on using these, and for other options and variables not
+ specific to MySQL Cluster, see .
+
+
+
+ For MySQL Cluster configuration parameters used in the cluster
+ confiuration file (usually named config.ini),
+ see .
+
+
+
+
+ MySQL Cluster Server Option and Variable Reference
+
+
+ The following table provides a list of the command line options,
+ server and status variables applicable within
+ mysqld when it is running as an SQL node in a
+ MySQL Cluster. For a table showing all
+ command line options, server and status variables available for
+ use with mysqld, see
+ .
+
+
+
+
+
+
+
+
+ MySQL Cluster-Related Command Options for <command>mysqld</command>
+
+
+ MySQL Cluster
+ administration
+
+
+
+ MySQL Cluster
+ commands
+
+
+
+ command options (MySQL Cluster)
+ mysqld
+
+
+
+ MySQL Cluster
+ mysqld process
+
+
+
+ mysqld
+ as MySQL Cluster process
+
+
+
+ This section provides descriptions of mysqld
+ server options relating to MySQL Cluster. For information about
+ mysqld options not specific to MySQL Cluster,
+ and for general information about the use of options with
+ mysqld, see .
+
+
+
+ For information about command line options used with other MySQL
+ Cluster processes (ndbd,
+ ndb_mgmd, and ndb_mgm), see
+ . For information
+ about command line options used with NDB
+ utility programs (such as ndb_desc,
+ ndb_size.pl, and
+ ndb_show_tables), see
+ .
+
+
+
+
+
+
+
+ mysqld
+ ndb-connectstring option
+
+
+
+ ndb-connectstring option
+ mysqld
+
+
+
+
+
+
+ When using the NDB Cluster storage engine,
+ this option specifies the management server that distributes
+ cluster configuration data.
+
+
+
+
+
+
+ mysqld
+ ndbcluster option
+
+
+
+ ndbcluster option
+ mysqld
+
+
+
+
+
+
+ The NDB Cluster storage engine is necessary
+ for using MySQL Cluster. If a mysqld binary
+ includes support for the NDB Cluster
+ storage engine, the engine is disabled by default. Use the
+ option to enable it. Use
+ to explicitly disable the
+ engine.
+
+
+
+
+
+
+ mysqld
+ skip-ndbcluster option
+
+
+
+ skip-ndbcluster option
+ mysqld
+
+
+
+
+
+
+ Disable the NDB Cluster storage engine.
+ This is the default for binaries that were built with
+ NDB Cluster storage engine support; the
+ server allocates memory and other resources for this storage
+ engine only if the option is
+ given explicitly. See ,
+ for an example of usage.
+
+
+
+
+
+
+
+
+
+ MySQL Cluster System Variables
+
+
+ This section provides detailed information about MySQL server
+ system variables that are specific to MySQL Cluster and the
+ NDB storage engine. For system variables not
+ specific to MySQL Cluster, see
+ . For general information
+ on using system variables, see
+ .
+
+
+
+
+
+
+ MySQL Cluster Status Variables
+
+
+ This section provides detailed information about MySQL server
+ status variables that relate to MySQL Cluster and the
+ NDB storage engine. For status variables not
+ specific to MySQL Cluster, and for general information on using
+ status variables, see .
+
+
+
+
+
Added: trunk/refman-5.1/mysql-cluster-optvar-core.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster-optvar-core.xml (rev 0)
+++ trunk/refman-5.1/mysql-cluster-optvar-core.xml 2008-02-20 14:00:25 UTC (rev 9939)
Changed blocks: 1, Lines Added: 202, Lines Deleted: 0; 7080 bytes
@@ -0,0 +1,202 @@
+
+
+ %all.entities;
+]>
+
+
+ MySQL Cluster Options and Variables
+
+
+
+
+ This section provides information about MySQL server options, server
+ and status variables that are specific to MySQL Cluster. For general
+ information on using these, and for other options and variables not
+ specific to MySQL Cluster, see .
+
+
+
+ For MySQL Cluster configuration parameters used in the cluster
+ confiuration file (usually named config.ini),
+ see .
+
+
+
+
+ MySQL Cluster Server Option and Variable Reference
+
+
+ The following table provides a list of the command line options,
+ server and status variables applicable within
+ mysqld when it is running as an SQL node in a
+ MySQL Cluster. For a table showing all
+ command line options, server and status variables available for
+ use with mysqld, see
+ .
+
+
+
+
+
+
+
+
+ MySQL Cluster-Related Command Options for <command>mysqld</command>
+
+
+ MySQL Cluster
+ administration
+
+
+
+ MySQL Cluster
+ commands
+
+
+
+ command options (MySQL Cluster)
+ mysqld
+
+
+
+ MySQL Cluster
+ mysqld process
+
+
+
+ mysqld
+ as MySQL Cluster process
+
+
+
+ This section provides descriptions of mysqld
+ server options relating to MySQL Cluster. For information about
+ mysqld options not specific to MySQL Cluster,
+ and for general information about the use of options with
+ mysqld, see .
+
+
+
+ For information about command line options used with other MySQL
+ Cluster processes (ndbd,
+ ndb_mgmd, and ndb_mgm), see
+ . For information
+ about command line options used with NDB
+ utility programs (such as ndb_desc,
+ ndb_size.pl, and
+ ndb_show_tables), see
+ .
+
+
+
+
+
+
+
+ mysqld
+ ndb-connectstring option
+
+
+
+ ndb-connectstring option
+ mysqld
+
+
+
+
+
+
+ When using the NDB Cluster storage engine,
+ this option specifies the management server that distributes
+ cluster configuration data.
+
+
+
+
+
+
+ mysqld
+ ndbcluster option
+
+
+
+ ndbcluster option
+ mysqld
+
+
+
+
+
+
+ The NDB Cluster storage engine is necessary
+ for using MySQL Cluster. If a mysqld binary
+ includes support for the NDB Cluster
+ storage engine, the engine is disabled by default. Use the
+ option to enable it. Use
+ to explicitly disable the
+ engine.
+
+
+
+
+
+
+ mysqld
+ skip-ndbcluster option
+
+
+
+ skip-ndbcluster option
+ mysqld
+
+
+
+
+
+
+ Disable the NDB Cluster storage engine.
+ This is the default for binaries that were built with
+ NDB Cluster storage engine support; the
+ server allocates memory and other resources for this storage
+ engine only if the option is
+ given explicitly. See ,
+ for an example of usage.
+
+
+
+
+
+
+
+
+
+ MySQL Cluster System Variables
+
+
+ This section provides detailed information about MySQL server
+ system variables that are specific to MySQL Cluster and the
+ NDB storage engine. For system variables not
+ specific to MySQL Cluster, see
+ . For general information
+ on using system variables, see
+ .
+
+
+
+
+
+
+ MySQL Cluster Status Variables
+
+
+ This section provides detailed information about MySQL server
+ status variables that relate to MySQL Cluster and the
+ NDB storage engine. For status variables not
+ specific to MySQL Cluster, and for general information on using
+ status variables, see .
+
+
+
+
+
Added: trunk/refman-6.0/mysql-cluster-optvar-core.xml
===================================================================
--- trunk/refman-6.0/mysql-cluster-optvar-core.xml (rev 0)
+++ trunk/refman-6.0/mysql-cluster-optvar-core.xml 2008-02-20 14:00:25 UTC (rev 9939)
Changed blocks: 1, Lines Added: 202, Lines Deleted: 0; 7080 bytes
@@ -0,0 +1,202 @@
+
+
+ %all.entities;
+]>
+
+
+ MySQL Cluster Options and Variables
+
+
+
+
+ This section provides information about MySQL server options, server
+ and status variables that are specific to MySQL Cluster. For general
+ information on using these, and for other options and variables not
+ specific to MySQL Cluster, see .
+
+
+
+ For MySQL Cluster configuration parameters used in the cluster
+ confiuration file (usually named config.ini),
+ see .
+
+
+
+
+ MySQL Cluster Server Option and Variable Reference
+
+
+ The following table provides a list of the command line options,
+ server and status variables applicable within
+ mysqld when it is running as an SQL node in a
+ MySQL Cluster. For a table showing all
+ command line options, server and status variables available for
+ use with mysqld, see
+ .
+
+
+
+
+
+
+
+
+ MySQL Cluster-Related Command Options for <command>mysqld</command>
+
+
+ MySQL Cluster
+ administration
+
+
+
+ MySQL Cluster
+ commands
+
+
+
+ command options (MySQL Cluster)
+ mysqld
+
+
+
+ MySQL Cluster
+ mysqld process
+
+
+
+ mysqld
+ as MySQL Cluster process
+
+
+
+ This section provides descriptions of mysqld
+ server options relating to MySQL Cluster. For information about
+ mysqld options not specific to MySQL Cluster,
+ and for general information about the use of options with
+ mysqld, see .
+
+
+
+ For information about command line options used with other MySQL
+ Cluster processes (ndbd,
+ ndb_mgmd, and ndb_mgm), see
+ . For information
+ about command line options used with NDB
+ utility programs (such as ndb_desc,
+ ndb_size.pl, and
+ ndb_show_tables), see
+ .
+
+
+
+
+
+
+
+ mysqld
+ ndb-connectstring option
+
+
+
+ ndb-connectstring option
+ mysqld
+
+
+
+
+
+
+ When using the NDB Cluster storage engine,
+ this option specifies the management server that distributes
+ cluster configuration data.
+
+
+
+
+
+
+ mysqld
+ ndbcluster option
+
+
+
+ ndbcluster option
+ mysqld
+
+
+
+
+
+
+ The NDB Cluster storage engine is necessary
+ for using MySQL Cluster. If a mysqld binary
+ includes support for the NDB Cluster
+ storage engine, the engine is disabled by default. Use the
+ option to enable it. Use
+ to explicitly disable the
+ engine.
+
+
+
+
+
+
+ mysqld
+ skip-ndbcluster option
+
+
+
+ skip-ndbcluster option
+ mysqld
+
+
+
+
+
+
+ Disable the NDB Cluster storage engine.
+ This is the default for binaries that were built with
+ NDB Cluster storage engine support; the
+ server allocates memory and other resources for this storage
+ engine only if the option is
+ given explicitly. See ,
+ for an example of usage.
+
+
+
+
+
+
+
+
+
+ MySQL Cluster System Variables
+
+
+ This section provides detailed information about MySQL server
+ system variables that are specific to MySQL Cluster and the
+ NDB storage engine. For system variables not
+ specific to MySQL Cluster, see
+ . For general information
+ on using system variables, see
+ .
+
+
+
+
+
+
+ MySQL Cluster Status Variables
+
+
+ This section provides detailed information about MySQL server
+ status variables that relate to MySQL Cluster and the
+ NDB storage engine. For status variables not
+ specific to MySQL Cluster, and for general information on using
+ status variables, see .
+
+
+
+
+