Author: paul
Date: 2006-01-11 06:18:17 +0100 (Wed, 11 Jan 2006)
New Revision: 760
Log:
r6071@frost: paul | 2006-01-10 23:16:44 -0600
Remove redundant config.ini section indicators.
Modified:
trunk/
trunk/refman-4.1/ndbcluster.xml
trunk/refman-5.0/ndbcluster.xml
trunk/refman-5.1/ndbcluster.xml
Property changes on: trunk
___________________________________________________________________
Name: svk:merge
- b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:6069
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:1994
+ b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:6071
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:1994
Modified: trunk/refman-4.1/ndbcluster.xml
===================================================================
--- trunk/refman-4.1/ndbcluster.xml 2006-01-11 04:43:25 UTC (rev 759)
+++ trunk/refman-4.1/ndbcluster.xml 2006-01-11 05:18:17 UTC (rev 760)
@@ -2270,7 +2270,7 @@
<listitem>
<para>
- <literal>[COMPUTER]Id</literal>
+ <literal>Id</literal>
</para>
<para>
@@ -2281,7 +2281,7 @@
<listitem>
<para>
- <literal>[COMPUTER]HostName</literal>
+ <literal>HostName</literal>
</para>
<para>
@@ -2298,10 +2298,11 @@
<title>&title-mysql-cluster-mgm-definition;</title>
<para>
- The <literal>[NDB_MGMD]</literal> section (or its alias
- <literal>[MGM]</literal>) is used to configure the behavior of
- the management server. All parameters in the following list
- can be omitted and, if so, will assume their default values.
+ The <literal>[NDB_MGMD]</literal> section is used to configure
+ the behavior of the management server.
+ <literal>[MGM]</literal> can be used as an alias; the two
+ section names are equivalent. All parameters in the following
+ list are optional and assume their default values if omitted.
<emphasis role="bold">Note</emphasis>: If neither the
<literal>ExecuteOnComputer</literal> nor the
<literal>HostName</literal> parameter is present, the default
@@ -2312,7 +2313,7 @@
<listitem>
<para>
- <literal>[NDB_MGMD]Id</literal>
+ <literal>Id</literal>
</para>
<para>
@@ -2325,7 +2326,7 @@
<listitem>
<para>
- <literal>[NDB_MGMD]ExecuteOnComputer</literal>
+ <literal>ExecuteOnComputer</literal>
</para>
<para>
@@ -2336,7 +2337,7 @@
<listitem>
<para>
- <literal>[NDB_MGMD]PortNumber</literal>
+ <literal>PortNumber</literal>
</para>
<para>
@@ -2348,7 +2349,7 @@
<listitem>
<para>
- <literal>[NDB_MGMD]LogDestination</literal>
+ <literal>LogDestination</literal>
</para>
<para>
@@ -2452,8 +2453,8 @@
The default value for the <literal>FILE</literal>
parameter is
<literal>FILE:filename=ndb_<replaceable>node_id</replaceable>_cluster.log,maxsize=1000000,maxfiles=6</literal>,
- where <literal>node_id</literal> is the ID of the
- node.
+ where <replaceable>node_id</replaceable> is the ID of
+ the node.
</para>
</listitem>
@@ -2462,7 +2463,7 @@
<listitem>
<para>
- <literal>[NDB_MGMD]ArbitrationRank</literal>
+ <literal>ArbitrationRank</literal>
</para>
<para>
@@ -2509,7 +2510,7 @@
<listitem>
<para>
- <literal>[NDB_MGMD]ArbitrationDelay</literal>
+ <literal>ArbitrationDelay</literal>
</para>
<para>
@@ -2522,7 +2523,7 @@
<listitem>
<para>
- <literal>[NDB_MGMD]DataDir</literal>
+ <literal>DataDir</literal>
</para>
<para>
@@ -2606,7 +2607,7 @@
<listitem>
<para>
- <literal>[NBDB]Id</literal>
+ <literal>Id</literal>
</para>
<para>
@@ -2618,7 +2619,7 @@
<listitem>
<para>
- <literal>[NDBD]ExecuteOnComputer</literal>
+ <literal>ExecuteOnComputer</literal>
</para>
<para>
@@ -2629,7 +2630,7 @@
<listitem>
<para>
- <literal>[NDBD]HostName</literal>
+ <literal>HostName</literal>
</para>
<para>
@@ -2645,8 +2646,8 @@
<listitem>
<para>
+ <literal>ServerPort</literal>
(<emphasis>OBSOLETE</emphasis>)
- <literal>[NDBD]ServerPort</literal>
</para>
<para>
@@ -2662,7 +2663,7 @@
<listitem>
<para>
- <literal>[NDBD]NoOfReplicas</literal>
+ <literal>NoOfReplicas</literal>
</para>
<para>
@@ -2706,7 +2707,7 @@
<listitem>
<para>
- <literal>[NDBD]DataDir</literal>
+ <literal>DataDir</literal>
</para>
<para>
@@ -2717,7 +2718,7 @@
<listitem>
<para>
- <literal>[NDBD]FileSystemPath</literal>
+ <literal>FileSystemPath</literal>
</para>
<para>
@@ -2742,7 +2743,7 @@
<listitem>
<para>
- <literal>[NDBD]BackupDataDir</literal>
+ <literal>BackupDataDir</literal>
</para>
<para>
@@ -2761,10 +2762,11 @@
<para>
<literal>DataMemory</literal> and
- <literal>IndexMemory</literal> are parameters specifying the
- size of memory segments used to store the actual records and
- their indexes. In setting values for these, it is important to
- understand how <literal>DataMemory</literal> and
+ <literal>IndexMemory</literal> are <literal>[NDBD]</literal>
+ parameters specifying the size of memory segments used to
+ store the actual records and their indexes. In setting values
+ for these, it is important to understand how
+ <literal>DataMemory</literal> and
<literal>IndexMemory</literal> are used, as they usually need
to be updated in order to reflect actual usage by the cluster:
</para>
@@ -2773,7 +2775,7 @@
<listitem>
<para>
- <literal>[NDBD]DataMemory</literal>
+ <literal>DataMemory</literal>
</para>
<para>
@@ -2892,7 +2894,7 @@
<listitem>
<para>
- <literal>[NDBD]IndexMemory</literal>
+ <literal>IndexMemory</literal>
</para>
<para>
@@ -3016,9 +3018,10 @@
</para>
<para>
- The next three parameters which we discuss are important
- because they affect the number of parallel transactions and
- the sizes of transactions that can be handled by the system.
+ The next three <literal>[NDBD]</literal> parameters that we
+ discuss are important because they affect the number of
+ parallel transactions and the sizes of transactions that can
+ be handled by the system.
<literal>MaxNoOfConcurrentTransactions</literal> sets the
number of parallel transactions possible in a node;
<literal>MaxNoOfConcurrentOperations</literal> sets the number
@@ -3039,7 +3042,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfConcurrentTransactions</literal>
+ <literal>MaxNoOfConcurrentTransactions</literal>
</para>
<para>
@@ -3088,7 +3091,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfConcurrentOperations</literal>
+ <literal>MaxNoOfConcurrentOperations</literal>
</para>
<para>
@@ -3168,7 +3171,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfLocalOperations</literal>
+ <literal>MaxNoOfLocalOperations</literal>
</para>
<para>
@@ -3189,11 +3192,11 @@
</para>
<para>
- The next set of parameters is used to determine temporary
- storage when executing a query which is part of a Cluster
- transaction. All records are released when the query is
- completed and the cluster is waiting for the commit or
- rollback.
+ The next set of <literal>[NDBD]</literal> parameters is used
+ to determine temporary storage when executing a query which is
+ part of a Cluster transaction. All records are released when
+ the query is completed and the cluster is waiting for the
+ commit or rollback.
</para>
<para>
@@ -3209,7 +3212,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfConcurrentIndexOperations</literal>
+ <literal>MaxNoOfConcurrentIndexOperations</literal>
</para>
<para>
@@ -3236,7 +3239,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfFiredTriggers</literal>
+ <literal>MaxNoOfFiredTriggers</literal>
</para>
<para>
@@ -3264,7 +3267,7 @@
<listitem>
<para>
- <literal>[NDBD]TransactionBufferMemory</literal>
+ <literal>TransactionBufferMemory</literal>
</para>
<para>
@@ -3298,8 +3301,8 @@
<itemizedlist>
<para>
- There are additional parameters in the
- <literal>Dblqh</literal> module (in
+ There are additional <literal>[NDBD]</literal> parameters in
+ the <literal>Dblqh</literal> module (in
<filename>ndb/src/kernel/blocks/Dblqh/Dblqh.hpp</filename>)
which affect reads and updates. These include
<literal>ZATTRINBUF_FILESIZE</literal>, set by default to
@@ -3318,7 +3321,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfConcurrentScans</literal>
+ <literal>MaxNoOfConcurrentScans</literal>
</para>
<para>
@@ -3364,7 +3367,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfLocalScans</literal>
+ <literal>MaxNoOfLocalScans</literal>
</para>
<para>
@@ -3375,7 +3378,7 @@
<listitem>
<para>
- <literal>[NDBD]BatchSizePerLocalScan</literal>
+ <literal>BatchSizePerLocalScan</literal>
</para>
<para>
@@ -3397,7 +3400,7 @@
<listitem>
<para>
- <literal>[NDBD]LongMessageBuffer</literal>
+ <literal>LongMessageBuffer</literal>
</para>
<para>
@@ -3414,11 +3417,16 @@
<emphasis role="bold">Logging and Checkpointing</emphasis>
</para>
+ <para>
+ These <literal>[NDBD]</literal> paramaters control log and
+ checkpoint behavior.
+ </para>
+
<itemizedlist>
<listitem>
<para>
- <literal>[NDBD]NoOfFragmentLogFiles</literal>
+ <literal>NoOfFragmentLogFiles</literal>
</para>
<para>
@@ -3482,7 +3490,7 @@
</remark>
<para>
- <literal>[NDBD]MaxNoOfOpenFiles</literal>
+ <literal>MaxNoOfOpenFiles</literal>
</para>
<para>
@@ -3500,7 +3508,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfSavedMessages</literal>
+ <literal>MaxNoOfSavedMessages</literal>
</para>
<para>
@@ -3521,19 +3529,20 @@
</para>
<para>
- The next set of parameters defines pool sizes for metadata
- objects, used to define the maximum number of attributes,
- tables, indexes, and trigger objects used by indexes, events,
- and replication between clusters. Note that these act merely
- as <quote>suggestions</quote> to the cluster, and any that are
- not specified revert to the default values shown.
+ The next set of <literal>[NDBD]</literal> parameters defines
+ pool sizes for metadata objects, used to define the maximum
+ number of attributes, tables, indexes, and trigger objects
+ used by indexes, events, and replication between clusters.
+ Note that these act merely as <quote>suggestions</quote> to
+ the cluster, and any that are not specified revert to the
+ default values shown.
</para>
<itemizedlist>
<listitem>
<para>
- <literal>[NDBD]MaxNoOfAttributes</literal>
+ <literal>MaxNoOfAttributes</literal>
</para>
<para>
@@ -3573,7 +3582,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfTables</literal>
+ <literal>MaxNoOfTables</literal>
</para>
<para>
@@ -3599,7 +3608,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfOrderedIndexes</literal>
+ <literal>MaxNoOfOrderedIndexes</literal>
</para>
<para>
@@ -3618,7 +3627,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfUniqueHashIndexes</literal>
+ <literal>MaxNoOfUniqueHashIndexes</literal>
</para>
<para>
@@ -3638,7 +3647,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfTriggers</literal>
+ <literal>MaxNoOfTriggers</literal>
</para>
<para>
@@ -3662,7 +3671,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfIndexes</literal>
+ <literal>MaxNoOfIndexes</literal>
</para>
<para>
@@ -3691,9 +3700,10 @@
<para>
The behavior of data nodes is also affected by a set of
- parameters taking on boolean values. These parameters can each
- be specified as <literal>TRUE</literal> by setting them equal
- to <literal>1</literal> or <literal>Y</literal>, and as
+ <literal>[NDBD]</literal> parameters taking on boolean values.
+ These parameters can each be specified as
+ <literal>TRUE</literal> by setting them equal to
+ <literal>1</literal> or <literal>Y</literal>, and as
<literal>FALSE</literal> by setting them equal to
<literal>0</literal> or <literal>N</literal>.
</para>
@@ -3702,7 +3712,7 @@
<listitem>
<para>
- <literal>[NDBD]LockPagesInMainMemory</literal>
+ <literal>LockPagesInMainMemory</literal>
</para>
<para>
@@ -3719,7 +3729,7 @@
<listitem>
<para>
- <literal>[NDBD]StopOnError</literal>
+ <literal>StopOnError</literal>
</para>
<para>
@@ -3735,7 +3745,7 @@
<listitem>
<para>
- <literal>[NDBD]Diskless</literal>
+ <literal>Diskless</literal>
</para>
<para>
@@ -3771,7 +3781,7 @@
<listitem>
<para>
- <literal>[NDBD]RestartOnErrorInsert</literal>
+ <literal>RestartOnErrorInsert</literal>
</para>
<para>
@@ -3793,17 +3803,18 @@
</para>
<para>
- There are a number of parameters specifying timeouts and
- intervals between various actions in Cluster data nodes. Most
- of the timeout values are specified in milliseconds. Any
- exceptions to this will be mentioned where applicable below.
+ There are a number of <literal>[NDBD]</literal> parameters
+ specifying timeouts and intervals between various actions in
+ Cluster data nodes. Most of the timeout values are specified
+ in milliseconds. Any exceptions to this will be mentioned
+ where applicable below.
</para>
<itemizedlist>
<listitem>
<para>
- <literal>[NDBD]TimeBetweenWatchDogCheck</literal>
+ <literal>TimeBetweenWatchDogCheck</literal>
</para>
<para>
@@ -3829,7 +3840,7 @@
<listitem>
<para>
- <literal>[NDBD]StartPartialTimeout</literal>
+ <literal>StartPartialTimeout</literal>
</para>
<para>
@@ -3849,7 +3860,7 @@
<listitem>
<para>
- <literal>[NDBD]StartPartitionedTimeout</literal>
+ <literal>StartPartitionedTimeout</literal>
</para>
<para>
@@ -3866,7 +3877,7 @@
<listitem>
<para>
- <literal>[NDBD]StartFailureTimeout</literal>
+ <literal>StartFailureTimeout</literal>
</para>
<para>
@@ -3890,7 +3901,7 @@
<listitem>
<para>
- <literal>[NDBD]HeartbeatIntervalDbDb</literal>
+ <literal>HeartbeatIntervalDbDb</literal>
</para>
<para>
@@ -3916,7 +3927,7 @@
<listitem>
<para>
- <literal>[NDBD]HeartbeatIntervalDbApi</literal>
+ <literal>HeartbeatIntervalDbApi</literal>
</para>
<para>
@@ -3942,7 +3953,7 @@
<listitem>
<para>
- <literal>[NDBD]TimeBetweenLocalCheckpoints</literal>
+ <literal>TimeBetweenLocalCheckpoints</literal>
</para>
<para>
@@ -3978,7 +3989,7 @@
<listitem>
<para>
- <literal>[NDBD]TimeBetweenGlobalCheckpoints</literal>
+ <literal>TimeBetweenGlobalCheckpoints</literal>
</para>
<para>
@@ -4013,7 +4024,7 @@
<listitem>
<para>
- <literal>[NDBD]TimeBetweenInactiveTransactionAbortCheck</literal>
+ <literal>TimeBetweenInactiveTransactionAbortCheck</literal>
</para>
<para>
@@ -4032,7 +4043,7 @@
<listitem>
<para>
- <literal>[NDBD]TransactionInactiveTimeout</literal>
+ <literal>TransactionInactiveTimeout</literal>
</para>
<para>
@@ -4053,7 +4064,7 @@
<listitem>
<para>
- <literal>[NDBD]TransactionDeadlockDetectionTimeout</literal>
+ <literal>TransactionDeadlockDetectionTimeout</literal>
</para>
<para>
@@ -4103,7 +4114,7 @@
<listitem>
<para>
- <literal>[NDBD]NoOfDiskPagesToDiskAfterRestartTUP</literal>
+ <literal>NoOfDiskPagesToDiskAfterRestartTUP</literal>
</para>
<para>
@@ -4149,7 +4160,7 @@
<listitem>
<para>
- <literal>[NDBD]NoOfDiskPagesToDiskAfterRestartACC</literal>
+ <literal>NoOfDiskPagesToDiskAfterRestartACC</literal>
</para>
<para>
@@ -4167,7 +4178,7 @@
<listitem>
<para>
- <literal>[NDBD]NoOfDiskPagesToDiskDuringRestartTUP</literal>
+ <literal>NoOfDiskPagesToDiskDuringRestartTUP</literal>
</para>
<para>
@@ -4193,7 +4204,7 @@
<listitem>
<para>
- <literal>[NDBD]NoOfDiskPagesToDiskDuringRestartACC</literal>
+ <literal>NoOfDiskPagesToDiskDuringRestartACC</literal>
</para>
<para>
@@ -4217,7 +4228,7 @@
<listitem>
<para>
- <literal>[NDBD]ArbitrationTimeout</literal>
+ <literal>ArbitrationTimeout</literal>
</para>
<para>
@@ -4239,11 +4250,11 @@
</para>
<para>
- Several configuration parameters corresponding to former
- compile-time parameters were introduced in MySQL 4.1.5. These
- enable the advanced user to have more control over the
- resources used by node processes and to adjust various buffer
- sizes at need.
+ Several <literal>[NDBD]</literal> configuration parameters
+ corresponding to former compile-time parameters were
+ introduced in MySQL 4.1.5. These enable the advanced user to
+ have more control over the resources used by node processes
+ and to adjust various buffer sizes at need.
</para>
<para>
@@ -4259,7 +4270,7 @@
<listitem>
<para>
- <literal>[NDBD]UndoIndexBuffer</literal>
+ <literal>UndoIndexBuffer</literal>
</para>
<para>
@@ -4305,7 +4316,7 @@
<listitem>
<para>
- <literal>[NDBD]UndoDataBuffer</literal>
+ <literal>UndoDataBuffer</literal>
</para>
<para>
@@ -4345,7 +4356,7 @@
<listitem>
<para>
- <literal>[NDBD]RedoBuffer</literal>
+ <literal>RedoBuffer</literal>
</para>
<para>
@@ -4399,12 +4410,12 @@
<listitem>
<para>
- <literal>[NDBD]LogLevelStartup</literal>
+ <literal>LogLevelStartup</literal>
</para>
<para>
- Reporting level for events generated during startup of the
- process.
+ The reporting level for events generated during startup of
+ the process.
</para>
<para>
@@ -4414,12 +4425,12 @@
<listitem>
<para>
- <literal>[NDBD]LogLevelShutdown</literal>
+ <literal>LogLevelShutdown</literal>
</para>
<para>
- Reporting level for events generated as part of graceful
- shutdown of a node.
+ The reporting level for events generated as part of
+ graceful shutdown of a node.
</para>
<para>
@@ -4429,13 +4440,13 @@
<listitem>
<para>
- <literal>[NDBD]LogLevelStatistic</literal>
+ <literal>LogLevelStatistic</literal>
</para>
<para>
- Reporting level for statistical events such as number of
- primary key reads, number of updates, number of inserts,
- information relating to buffer usage, and so on.
+ The reporting level for statistical events such as number
+ of primary key reads, number of updates, number of
+ inserts, information relating to buffer usage, and so on.
</para>
<para>
@@ -4445,12 +4456,12 @@
<listitem>
<para>
- <literal>[NDBD]LogLevelCheckpoint</literal>
+ <literal>LogLevelCheckpoint</literal>
</para>
<para>
- Reporting level for events generated by local and global
- checkpoints.
+ The reporting level for events generated by local and
+ global checkpoints.
</para>
<para>
@@ -4460,11 +4471,12 @@
<listitem>
<para>
- <literal>[NDBD]LogLevelNodeRestart</literal>
+ <literal>LogLevelNodeRestart</literal>
</para>
<para>
- Reporting level for events generated during node restart.
+ The reporting level for events generated during node
+ restart.
</para>
<para>
@@ -4474,11 +4486,11 @@
<listitem>
<para>
- <literal>[NDBD]LogLevelConnection</literal>
+ <literal>LogLevelConnection</literal>
</para>
<para>
- Reporting level for events generated by connections
+ The reporting level for events generated by connections
between cluster nodes.
</para>
@@ -4489,11 +4501,11 @@
<listitem>
<para>
- <literal>[NDBD]LogLevelError</literal>
+ <literal>LogLevelError</literal>
</para>
<para>
- Reporting level for events generated by errors and
+ The reporting level for events generated by errors and
warnings by the cluster as a whole. These errors do not
cause any node failure but are still considered worth
reporting.
@@ -4506,12 +4518,12 @@
<listitem>
<para>
- <literal>[NDBD]LogLevelInfo</literal>
+ <literal>LogLevelInfo</literal>
</para>
<para>
- Reporting level for events generated for information about
- the general state of the cluster.
+ The reporting level for events generated for information
+ about the general state of the cluster.
</para>
<para>
@@ -4526,15 +4538,16 @@
</para>
<para>
- The parameters discussed in this section define memory buffers
- set aside for execution of online backups.
+ The <literal>[NDBD]</literal> parameters discussed in this
+ section define memory buffers set aside for execution of
+ online backups.
</para>
<itemizedlist>
<listitem>
<para>
- <literal>[NDBD]BackupDataBufferSize</literal>
+ <literal>BackupDataBufferSize</literal>
</para>
<para>
@@ -4557,7 +4570,7 @@
<listitem>
<para>
- <literal>[NDBD]BackupLogBufferSize</literal>
+ <literal>BackupLogBufferSize</literal>
</para>
<para>
@@ -4600,7 +4613,7 @@
</remark>
<para>
- <literal>[NDBD]BackupMemory</literal>
+ <literal>BackupMemory</literal>
</para>
<para>
@@ -4616,7 +4629,7 @@
<listitem>
<para>
- <literal>[NDBD]BackupWriteSize</literal>
+ <literal>BackupWriteSize</literal>
</para>
<para>
@@ -4649,7 +4662,7 @@
<listitem>
<para>
- <literal>[MYSQLD]Id</literal>
+ <literal>Id</literal>
</para>
<para>
@@ -4662,7 +4675,7 @@
<listitem>
<para>
- <literal>[MYSQLD]ExecuteOnComputer</literal>
+ <literal>ExecuteOnComputer</literal>
</para>
<para>
@@ -4674,7 +4687,7 @@
<listitem>
<para>
- <literal>[MYSQLD]ArbitrationRank</literal>
+ <literal>ArbitrationRank</literal>
</para>
<para>
@@ -4694,7 +4707,7 @@
<listitem>
<para>
- <literal>[MYSQLD]ArbitrationDelay</literal>
+ <literal>ArbitrationDelay</literal>
</para>
<para>
@@ -4708,7 +4721,7 @@
<listitem>
<para>
- <literal>[MYSQLD]BatchByteSize</literal>
+ <literal>BatchByteSize</literal>
</para>
<remark role="todo">
@@ -4742,7 +4755,7 @@
<listitem>
<para>
- <literal>[MYSQLD]BatchSize</literal>
+ <literal>BatchSize</literal>
</para>
<para>
@@ -4753,7 +4766,7 @@
<listitem>
<para>
- <literal>[MYSQLD]MaxScanBatchSize</literal>
+ <literal>MaxScanBatchSize</literal>
</para>
<para>
@@ -4786,6 +4799,9 @@
node and all MySQL server nodes, and between each data node
and the management server. (For one exception to this rule,
see <xref linkend="mysql-cluster-direct-tcp-definition"/>.)
+ <literal>[TCP]</literal> sections in the
+ <filename>config.ini</filename> file explicitly define TCP/IP
+ connections between nodes in the cluster.
</para>
<para>
@@ -4807,8 +4823,8 @@
<listitem>
<para>
- <literal>[TCP]<replaceable>NodeId1</replaceable></literal>,
- <literal>[TCP]<replaceable>NodeId2</replaceable></literal>
+ <literal><replaceable>NodeId1</replaceable></literal>,
+ <literal><replaceable>NodeId2</replaceable></literal>
</para>
<para>
@@ -4821,7 +4837,7 @@
<listitem>
<para>
- <literal>[TCP]SendBufferMemory</literal>
+ <literal>SendBufferMemory</literal>
</para>
<para>
@@ -4837,7 +4853,7 @@
<listitem>
<para>
- <literal>[TCP]SendSignalId</literal>
+ <literal>SendSignalId</literal>
</para>
<para>
@@ -4851,7 +4867,7 @@
<listitem>
<para>
- <literal>[TCP]Checksum</literal>
+ <literal>Checksum</literal>
</para>
<para>
@@ -4872,14 +4888,14 @@
</remark>
<para>
- <literal>[TCP]PortNumber</literal>
+ <literal>PortNumber</literal>
+ (<emphasis>OBSOLETE</emphasis>)
</para>
<para>
- (<emphasis role="bold">OBSOLETE</emphasis>.) This formerly
- specified the port number to be used for listening for
- connections from other nodes. This parameter should no
- longer be used.
+ This formerly specified the port number to be used for
+ listening for connections from other nodes. This parameter
+ should no longer be used.
</para>
</listitem>
@@ -4975,12 +4991,14 @@
runs concurrently on the same cluster host. (In previous
versions of MySQL Cluster, shared memory segments functioned
only when the <literal>-max</literal> binary was built using
- <option>--with-ndb-shm</option>.) When explicitly defining
- shared memory as the connection method, it is necessary to
- define at least <literal>NodeId1</literal>,
- <literal>NodeId2</literal> and <literal>ShmKey</literal>. All
- other parameters have default values that should work well in
- most cases.
+ <option>--with-ndb-shm</option>.) <literal>[SHM]</literal>
+ sections in the <filename>config.ini</filename> file
+ explicitly define shared-memory connections between nodes in
+ the cluster. When explicitly defining shared memory as the
+ connection method, it is necessary to define at least
+ <literal>NodeId1</literal>, <literal>NodeId2</literal> and
+ <literal>ShmKey</literal>. All other parameters have default
+ values that should work well in most cases.
</para>
<para>
@@ -4996,8 +5014,7 @@
<listitem>
<para>
- <literal>[SHM]NodeId1</literal>,
- <literal>[SHM]NodeId2</literal>
+ <literal>NodeId1</literal>, <literal>NodeId2</literal>
</para>
<para>
@@ -5009,7 +5026,7 @@
<listitem>
<para>
- <literal>[SHM]ShmKey</literal>
+ <literal>ShmKey</literal>
</para>
<para>
@@ -5022,7 +5039,7 @@
<listitem>
<para>
- <literal>[SHM]ShmSize</literal>
+ <literal>ShmSize</literal>
</para>
<para>
@@ -5035,7 +5052,7 @@
<listitem>
<para>
- <literal>[SHM]SendSignalId</literal>
+ <literal>SendSignalId</literal>
</para>
<para>
@@ -5049,7 +5066,7 @@
<listitem>
<para>
- <literal>[SHM]Checksum</literal>
+ <literal>Checksum</literal>
</para>
<para>
@@ -5076,8 +5093,11 @@
<title>&title-mysql-cluster-sci-definition;</title>
<para>
- Using SCI transporters to connect nodes in a MySQL Cluster is
- supported only when the MySQL-Max binaries are built using
+ <literal>[SCI]</literal> sections in the
+ <filename>config.ini</filename> file explicitly define SCI
+ connections between nodes in the cluster. Using SCI
+ transporters to connect nodes in a MySQL Cluster is supported
+ only when the MySQL-Max binaries are built using
<option>--with-ndb-sci=<replaceable>/your/path/to/SCI</replaceable></option>.
The <replaceable>path</replaceable> should point to a
directory that contains at a minimum <filename>lib</filename>
@@ -5105,8 +5125,7 @@
<listitem>
<para>
- <literal>[SCI]NodeId1</literal>,
- <literal>[SCI]NodeId2</literal>
+ <literal>NodeId1</literal>, <literal>NodeId2</literal>
</para>
<para>
@@ -5118,7 +5137,7 @@
<listitem>
<para>
- <literal>[SCI]Host1SciId0</literal>
+ <literal>Host1SciId0</literal>
</para>
<para>
@@ -5129,7 +5148,7 @@
<listitem>
<para>
- <literal>[SCI]Host1SciId1</literal>
+ <literal>Host1SciId1</literal>
</para>
<para>
@@ -5142,7 +5161,7 @@
<listitem>
<para>
- <literal>[SCI]Host2SciId0</literal>
+ <literal>Host2SciId0</literal>
</para>
<para>
@@ -5153,7 +5172,7 @@
<listitem>
<para>
- <literal>[SCI]Host2SciId1</literal>
+ <literal>Host2SciId1</literal>
</para>
<para>
@@ -5165,7 +5184,7 @@
<listitem>
<para>
- <literal>[SCI]SharedBufferSize</literal>
+ <literal>SharedBufferSize</literal>
</para>
<para>
@@ -5181,7 +5200,7 @@
<listitem>
<para>
- <literal>[SCI]SendLimit</literal>
+ <literal>SendLimit</literal>
</para>
<para>
@@ -5196,7 +5215,7 @@
<listitem>
<para>
- <literal>[SCI]SendSignalId</literal>
+ <literal>SendSignalId</literal>
</para>
<para>
@@ -5209,7 +5228,7 @@
<listitem>
<para>
- <literal>[SCI]Checksum</literal>
+ <literal>Checksum</literal>
</para>
<para>
Modified: trunk/refman-5.0/ndbcluster.xml
===================================================================
--- trunk/refman-5.0/ndbcluster.xml 2006-01-11 04:43:25 UTC (rev 759)
+++ trunk/refman-5.0/ndbcluster.xml 2006-01-11 05:18:17 UTC (rev 760)
@@ -2267,7 +2267,7 @@
<listitem>
<para>
- <literal>[COMPUTER]Id</literal>
+ <literal>Id</literal>
</para>
<para>
@@ -2278,7 +2278,7 @@
<listitem>
<para>
- <literal>[COMPUTER]HostName</literal>
+ <literal>HostName</literal>
</para>
<para>
@@ -2295,10 +2295,11 @@
<title>&title-mysql-cluster-mgm-definition;</title>
<para>
- The <literal>[NDB_MGMD]</literal> section (or its alias
- <literal>[MGM]</literal>) is used to configure the behavior of
- the management server. All parameters in the following list
- can be omitted and, if so, will assume their default values.
+ The <literal>[NDB_MGMD]</literal> section is used to configure
+ the behavior of the management server.
+ <literal>[MGM]</literal> can be used as an alias; the two
+ section names are equivalent. All parameters in the following
+ list are optional and assume their default values if omitted.
<emphasis role="bold">Note</emphasis>: If neither the
<literal>ExecuteOnComputer</literal> nor the
<literal>HostName</literal> parameter is present, the default
@@ -2309,7 +2310,7 @@
<listitem>
<para>
- <literal>[NDB_MGMD]Id</literal>
+ <literal>Id</literal>
</para>
<para>
@@ -2322,7 +2323,7 @@
<listitem>
<para>
- <literal>[NDB_MGMD]ExecuteOnComputer</literal>
+ <literal>ExecuteOnComputer</literal>
</para>
<para>
@@ -2333,7 +2334,7 @@
<listitem>
<para>
- <literal>[NDB_MGMD]PortNumber</literal>
+ <literal>PortNumber</literal>
</para>
<para>
@@ -2345,7 +2346,7 @@
<listitem>
<para>
- <literal>[NDB_MGMD]LogDestination</literal>
+ <literal>LogDestination</literal>
</para>
<para>
@@ -2449,8 +2450,8 @@
The default value for the <literal>FILE</literal>
parameter is
<literal>FILE:filename=ndb_<replaceable>node_id</replaceable>_cluster.log,maxsize=1000000,maxfiles=6</literal>,
- where <literal>node_id</literal> is the ID of the
- node.
+ where <replaceable>node_id</replaceable> is the ID of
+ the node.
</para>
</listitem>
@@ -2459,7 +2460,7 @@
<listitem>
<para>
- <literal>[NDB_MGMD]ArbitrationRank</literal>
+ <literal>ArbitrationRank</literal>
</para>
<para>
@@ -2506,7 +2507,7 @@
<listitem>
<para>
- <literal>[NDB_MGMD]ArbitrationDelay</literal>
+ <literal>ArbitrationDelay</literal>
</para>
<para>
@@ -2519,7 +2520,7 @@
<listitem>
<para>
- <literal>[NDB_MGMD]DataDir</literal>
+ <literal>DataDir</literal>
</para>
<para>
@@ -2603,7 +2604,7 @@
<listitem>
<para>
- <literal>[NBDB]Id</literal>
+ <literal>Id</literal>
</para>
<para>
@@ -2615,7 +2616,7 @@
<listitem>
<para>
- <literal>[NDBD]ExecuteOnComputer</literal>
+ <literal>ExecuteOnComputer</literal>
</para>
<para>
@@ -2626,7 +2627,7 @@
<listitem>
<para>
- <literal>[NDBD]HostName</literal>
+ <literal>HostName</literal>
</para>
<para>
@@ -2642,8 +2643,8 @@
<listitem>
<para>
+ <literal>ServerPort</literal>
(<emphasis>OBSOLETE</emphasis>)
- <literal>[NDBD]ServerPort</literal>
</para>
<para>
@@ -2659,7 +2660,7 @@
<listitem>
<para>
- <literal>[NDBD]NoOfReplicas</literal>
+ <literal>NoOfReplicas</literal>
</para>
<para>
@@ -2703,7 +2704,7 @@
<listitem>
<para>
- <literal>[NDBD]DataDir</literal>
+ <literal>DataDir</literal>
</para>
<para>
@@ -2714,7 +2715,7 @@
<listitem>
<para>
- <literal>[NDBD]FileSystemPath</literal>
+ <literal>FileSystemPath</literal>
</para>
<para>
@@ -2739,7 +2740,7 @@
<listitem>
<para>
- <literal>[NDBD]BackupDataDir</literal>
+ <literal>BackupDataDir</literal>
</para>
<para>
@@ -2758,10 +2759,11 @@
<para>
<literal>DataMemory</literal> and
- <literal>IndexMemory</literal> are parameters specifying the
- size of memory segments used to store the actual records and
- their indexes. In setting values for these, it is important to
- understand how <literal>DataMemory</literal> and
+ <literal>IndexMemory</literal> are <literal>[NDBD]</literal>
+ parameters specifying the size of memory segments used to
+ store the actual records and their indexes. In setting values
+ for these, it is important to understand how
+ <literal>DataMemory</literal> and
<literal>IndexMemory</literal> are used, as they usually need
to be updated in order to reflect actual usage by the cluster:
</para>
@@ -2770,7 +2772,7 @@
<listitem>
<para>
- <literal>[NDBD]DataMemory</literal>
+ <literal>DataMemory</literal>
</para>
<para>
@@ -2893,7 +2895,7 @@
<listitem>
<para>
- <literal>[NDBD]IndexMemory</literal>
+ <literal>IndexMemory</literal>
</para>
<para>
@@ -3021,9 +3023,10 @@
</para>
<para>
- The next three parameters which we discuss are important
- because they affect the number of parallel transactions and
- the sizes of transactions that can be handled by the system.
+ The next three <literal>[NDBD]</literal> parameters that we
+ discuss are important because they affect the number of
+ parallel transactions and the sizes of transactions that can
+ be handled by the system.
<literal>MaxNoOfConcurrentTransactions</literal> sets the
number of parallel transactions possible in a node;
<literal>MaxNoOfConcurrentOperations</literal> sets the number
@@ -3044,7 +3047,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfConcurrentTransactions</literal>
+ <literal>MaxNoOfConcurrentTransactions</literal>
</para>
<para>
@@ -3093,7 +3096,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfConcurrentOperations</literal>
+ <literal>MaxNoOfConcurrentOperations</literal>
</para>
<para>
@@ -3173,7 +3176,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfLocalOperations</literal>
+ <literal>MaxNoOfLocalOperations</literal>
</para>
<para>
@@ -3194,11 +3197,11 @@
</para>
<para>
- The next set of parameters is used to determine temporary
- storage when executing a query which is part of a Cluster
- transaction. All records are released when the query is
- completed and the cluster is waiting for the commit or
- rollback.
+ The next set of <literal>[NDBD]</literal> parameters is used
+ to determine temporary storage when executing a query which is
+ part of a Cluster transaction. All records are released when
+ the query is completed and the cluster is waiting for the
+ commit or rollback.
</para>
<para>
@@ -3214,7 +3217,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfConcurrentIndexOperations</literal>
+ <literal>MaxNoOfConcurrentIndexOperations</literal>
</para>
<para>
@@ -3241,7 +3244,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfFiredTriggers</literal>
+ <literal>MaxNoOfFiredTriggers</literal>
</para>
<para>
@@ -3269,7 +3272,7 @@
<listitem>
<para>
- <literal>[NDBD]TransactionBufferMemory</literal>
+ <literal>TransactionBufferMemory</literal>
</para>
<para>
@@ -3307,8 +3310,8 @@
<itemizedlist>
<para>
- There are additional parameters in the
- <literal>Dblqh</literal> module (in
+ There are additional <literal>[NDBD]</literal> parameters in
+ the <literal>Dblqh</literal> module (in
<filename>ndb/src/kernel/blocks/Dblqh/Dblqh.hpp</filename>)
which affect reads and updates. These include
<literal>ZATTRINBUF_FILESIZE</literal>, set by default to
@@ -3327,7 +3330,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfConcurrentScans</literal>
+ <literal>MaxNoOfConcurrentScans</literal>
</para>
<para>
@@ -3373,7 +3376,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfLocalScans</literal>
+ <literal>MaxNoOfLocalScans</literal>
</para>
<para>
@@ -3384,7 +3387,7 @@
<listitem>
<para>
- <literal>[NDBD]BatchSizePerLocalScan</literal>
+ <literal>BatchSizePerLocalScan</literal>
</para>
<para>
@@ -3406,7 +3409,7 @@
<listitem>
<para>
- <literal>[NDBD]LongMessageBuffer</literal>
+ <literal>LongMessageBuffer</literal>
</para>
<para>
@@ -3423,11 +3426,16 @@
<emphasis role="bold">Logging and Checkpointing</emphasis>
</para>
+ <para>
+ These <literal>[NDBD]</literal> paramaters control log and
+ checkpoint behavior.
+ </para>
+
<itemizedlist>
<listitem>
<para>
- <literal>[NDBD]NoOfFragmentLogFiles</literal>
+ <literal>NoOfFragmentLogFiles</literal>
</para>
<para>
@@ -3491,7 +3499,7 @@
</remark>
<para>
- <literal>[NDBD]MaxNoOfOpenFiles</literal>
+ <literal>MaxNoOfOpenFiles</literal>
</para>
<para>
@@ -3509,7 +3517,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfSavedMessages</literal>
+ <literal>MaxNoOfSavedMessages</literal>
</para>
<para>
@@ -3530,19 +3538,20 @@
</para>
<para>
- The next set of parameters defines pool sizes for metadata
- objects, used to define the maximum number of attributes,
- tables, indexes, and trigger objects used by indexes, events,
- and replication between clusters. Note that these act merely
- as <quote>suggestions</quote> to the cluster, and any that are
- not specified revert to the default values shown.
+ The next set of <literal>[NDBD]</literal> parameters defines
+ pool sizes for metadata objects, used to define the maximum
+ number of attributes, tables, indexes, and trigger objects
+ used by indexes, events, and replication between clusters.
+ Note that these act merely as <quote>suggestions</quote> to
+ the cluster, and any that are not specified revert to the
+ default values shown.
</para>
<itemizedlist>
<listitem>
<para>
- <literal>[NDBD]MaxNoOfAttributes</literal>
+ <literal>MaxNoOfAttributes</literal>
</para>
<para>
@@ -3582,7 +3591,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfTables</literal>
+ <literal>MaxNoOfTables</literal>
</para>
<para>
@@ -3608,7 +3617,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfOrderedIndexes</literal>
+ <literal>MaxNoOfOrderedIndexes</literal>
</para>
<para>
@@ -3627,7 +3636,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfUniqueHashIndexes</literal>
+ <literal>MaxNoOfUniqueHashIndexes</literal>
</para>
<para>
@@ -3647,7 +3656,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfTriggers</literal>
+ <literal>MaxNoOfTriggers</literal>
</para>
<para>
@@ -3677,7 +3686,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfIndexes</literal>
+ <literal>MaxNoOfIndexes</literal>
</para>
<para>
@@ -3705,9 +3714,10 @@
<para>
The behavior of data nodes is also affected by a set of
- parameters taking on boolean values. These parameters can each
- be specified as <literal>TRUE</literal> by setting them equal
- to <literal>1</literal> or <literal>Y</literal>, and as
+ <literal>[NDBD]</literal> parameters taking on boolean values.
+ These parameters can each be specified as
+ <literal>TRUE</literal> by setting them equal to
+ <literal>1</literal> or <literal>Y</literal>, and as
<literal>FALSE</literal> by setting them equal to
<literal>0</literal> or <literal>N</literal>.
</para>
@@ -3716,7 +3726,7 @@
<listitem>
<para>
- <literal>[NDBD]LockPagesInMainMemory</literal>
+ <literal>LockPagesInMainMemory</literal>
</para>
<para>
@@ -3733,7 +3743,7 @@
<listitem>
<para>
- <literal>[NDBD]StopOnError</literal>
+ <literal>StopOnError</literal>
</para>
<para>
@@ -3749,7 +3759,7 @@
<listitem>
<para>
- <literal>[NDBD]Diskless</literal>
+ <literal>Diskless</literal>
</para>
<para>
@@ -3784,7 +3794,7 @@
<listitem>
<para>
- <literal>[NDBD]RestartOnErrorInsert</literal>
+ <literal>RestartOnErrorInsert</literal>
</para>
<para>
@@ -3806,17 +3816,18 @@
</para>
<para>
- There are a number of parameters specifying timeouts and
- intervals between various actions in Cluster data nodes. Most
- of the timeout values are specified in milliseconds. Any
- exceptions to this will be mentioned where applicable below.
+ There are a number of <literal>[NDBD]</literal> parameters
+ specifying timeouts and intervals between various actions in
+ Cluster data nodes. Most of the timeout values are specified
+ in milliseconds. Any exceptions to this will be mentioned
+ where applicable below.
</para>
<itemizedlist>
<listitem>
<para>
- <literal>[NDBD]TimeBetweenWatchDogCheck</literal>
+ <literal>TimeBetweenWatchDogCheck</literal>
</para>
<para>
@@ -3842,7 +3853,7 @@
<listitem>
<para>
- <literal>[NDBD]StartPartialTimeout</literal>
+ <literal>StartPartialTimeout</literal>
</para>
<para>
@@ -3862,7 +3873,7 @@
<listitem>
<para>
- <literal>[NDBD]StartPartitionedTimeout</literal>
+ <literal>StartPartitionedTimeout</literal>
</para>
<para>
@@ -3879,7 +3890,7 @@
<listitem>
<para>
- <literal>[NDBD]StartFailureTimeout</literal>
+ <literal>StartFailureTimeout</literal>
</para>
<para>
@@ -3903,7 +3914,7 @@
<listitem>
<para>
- <literal>[NDBD]HeartbeatIntervalDbDb</literal>
+ <literal>HeartbeatIntervalDbDb</literal>
</para>
<para>
@@ -3929,7 +3940,7 @@
<listitem>
<para>
- <literal>[NDBD]HeartbeatIntervalDbApi</literal>
+ <literal>HeartbeatIntervalDbApi</literal>
</para>
<para>
@@ -3955,7 +3966,7 @@
<listitem>
<para>
- <literal>[NDBD]TimeBetweenLocalCheckpoints</literal>
+ <literal>TimeBetweenLocalCheckpoints</literal>
</para>
<para>
@@ -3991,7 +4002,7 @@
<listitem>
<para>
- <literal>[NDBD]TimeBetweenGlobalCheckpoints</literal>
+ <literal>TimeBetweenGlobalCheckpoints</literal>
</para>
<para>
@@ -4026,7 +4037,7 @@
<listitem>
<para>
- <literal>[NDBD]TimeBetweenInactiveTransactionAbortCheck</literal>
+ <literal>TimeBetweenInactiveTransactionAbortCheck</literal>
</para>
<para>
@@ -4045,7 +4056,7 @@
<listitem>
<para>
- <literal>[NDBD]TransactionInactiveTimeout</literal>
+ <literal>TransactionInactiveTimeout</literal>
</para>
<para>
@@ -4066,7 +4077,7 @@
<listitem>
<para>
- <literal>[NDBD]TransactionDeadlockDetectionTimeout</literal>
+ <literal>TransactionDeadlockDetectionTimeout</literal>
</para>
<para>
@@ -4116,7 +4127,7 @@
<listitem>
<para>
- <literal>[NDBD]NoOfDiskPagesToDiskAfterRestartTUP</literal>
+ <literal>NoOfDiskPagesToDiskAfterRestartTUP</literal>
</para>
<para>
@@ -4162,7 +4173,7 @@
<listitem>
<para>
- <literal>[NDBD]NoOfDiskPagesToDiskAfterRestartACC</literal>
+ <literal>NoOfDiskPagesToDiskAfterRestartACC</literal>
</para>
<para>
@@ -4180,7 +4191,7 @@
<listitem>
<para>
- <literal>[NDBD]NoOfDiskPagesToDiskDuringRestartTUP</literal>
+ <literal>NoOfDiskPagesToDiskDuringRestartTUP</literal>
</para>
<para>
@@ -4206,7 +4217,7 @@
<listitem>
<para>
- <literal>[NDBD]NoOfDiskPagesToDiskDuringRestartACC</literal>
+ <literal>NoOfDiskPagesToDiskDuringRestartACC</literal>
</para>
<para>
@@ -4230,7 +4241,7 @@
<listitem>
<para>
- <literal>[NDBD]ArbitrationTimeout</literal>
+ <literal>ArbitrationTimeout</literal>
</para>
<para>
@@ -4252,10 +4263,11 @@
</para>
<para>
- Several configuration parameters corresponding to former
- compile-time parameters are also available. These enable the
- advanced user to have more control over the resources used by
- node processes and to adjust various buffer sizes at need.
+ Several <literal>[NDBD]</literal> configuration parameters
+ corresponding to former compile-time parameters are also
+ available. These enable the advanced user to have more control
+ over the resources used by node processes and to adjust
+ various buffer sizes at need.
</para>
<para>
@@ -4271,7 +4283,7 @@
<listitem>
<para>
- <literal>[NDBD]UndoIndexBuffer</literal>
+ <literal>UndoIndexBuffer</literal>
</para>
<para>
@@ -4317,7 +4329,7 @@
<listitem>
<para>
- <literal>[NDBD]UndoDataBuffer</literal>
+ <literal>UndoDataBuffer</literal>
</para>
<para>
@@ -4357,7 +4369,7 @@
<listitem>
<para>
- <literal>[NDBD]RedoBuffer</literal>
+ <literal>RedoBuffer</literal>
</para>
<para>
@@ -4411,12 +4423,12 @@
<listitem>
<para>
- <literal>[NDBD]LogLevelStartup</literal>
+ <literal>LogLevelStartup</literal>
</para>
<para>
- Reporting level for events generated during startup of the
- process.
+ The reporting level for events generated during startup of
+ the process.
</para>
<para>
@@ -4426,12 +4438,12 @@
<listitem>
<para>
- <literal>[NDBD]LogLevelShutdown</literal>
+ <literal>LogLevelShutdown</literal>
</para>
<para>
- Reporting level for events generated as part of graceful
- shutdown of a node.
+ The reporting level for events generated as part of
+ graceful shutdown of a node.
</para>
<para>
@@ -4441,13 +4453,13 @@
<listitem>
<para>
- <literal>[NDBD]LogLevelStatistic</literal>
+ <literal>LogLevelStatistic</literal>
</para>
<para>
- Reporting level for statistical events such as number of
- primary key reads, number of updates, number of inserts,
- information relating to buffer usage, and so on.
+ The reporting level for statistical events such as number
+ of primary key reads, number of updates, number of
+ inserts, information relating to buffer usage, and so on.
</para>
<para>
@@ -4457,12 +4469,12 @@
<listitem>
<para>
- <literal>[NDBD]LogLevelCheckpoint</literal>
+ <literal>LogLevelCheckpoint</literal>
</para>
<para>
- Reporting level for events generated by local and global
- checkpoints.
+ The reporting level for events generated by local and
+ global checkpoints.
</para>
<para>
@@ -4472,11 +4484,12 @@
<listitem>
<para>
- <literal>[NDBD]LogLevelNodeRestart</literal>
+ <literal>LogLevelNodeRestart</literal>
</para>
<para>
- Reporting level for events generated during node restart.
+ The reporting level for events generated during node
+ restart.
</para>
<para>
@@ -4486,11 +4499,11 @@
<listitem>
<para>
- <literal>[NDBD]LogLevelConnection</literal>
+ <literal>LogLevelConnection</literal>
</para>
<para>
- Reporting level for events generated by connections
+ The reporting level for events generated by connections
between cluster nodes.
</para>
@@ -4501,11 +4514,11 @@
<listitem>
<para>
- <literal>[NDBD]LogLevelError</literal>
+ <literal>LogLevelError</literal>
</para>
<para>
- Reporting level for events generated by errors and
+ The reporting level for events generated by errors and
warnings by the cluster as a whole. These errors do not
cause any node failure but are still considered worth
reporting.
@@ -4518,12 +4531,12 @@
<listitem>
<para>
- <literal>[NDBD]LogLevelInfo</literal>
+ <literal>LogLevelInfo</literal>
</para>
<para>
- Reporting level for events generated for information about
- the general state of the cluster.
+ The reporting level for events generated for information
+ about the general state of the cluster.
</para>
<para>
@@ -4538,15 +4551,16 @@
</para>
<para>
- The parameters discussed in this section define memory buffers
- set aside for execution of online backups.
+ The <literal>[NDBD]</literal> parameters discussed in this
+ section define memory buffers set aside for execution of
+ online backups.
</para>
<itemizedlist>
<listitem>
<para>
- <literal>[NDBD]BackupDataBufferSize</literal>
+ <literal>BackupDataBufferSize</literal>
</para>
<para>
@@ -4569,7 +4583,7 @@
<listitem>
<para>
- <literal>[NDBD]BackupLogBufferSize</literal>
+ <literal>BackupLogBufferSize</literal>
</para>
<para>
@@ -4612,7 +4626,7 @@
</remark>
<para>
- <literal>[NDBD]BackupMemory</literal>
+ <literal>BackupMemory</literal>
</para>
<para>
@@ -4628,7 +4642,7 @@
<listitem>
<para>
- <literal>[NDBD]BackupWriteSize</literal>
+ <literal>BackupWriteSize</literal>
</para>
<para>
@@ -4661,7 +4675,7 @@
<listitem>
<para>
- <literal>[MYSQLD]Id</literal>
+ <literal>Id</literal>
</para>
<para>
@@ -4674,7 +4688,7 @@
<listitem>
<para>
- <literal>[MYSQLD]ExecuteOnComputer</literal>
+ <literal>ExecuteOnComputer</literal>
</para>
<para>
@@ -4686,7 +4700,7 @@
<listitem>
<para>
- <literal>[MYSQLD]ArbitrationRank</literal>
+ <literal>ArbitrationRank</literal>
</para>
<para>
@@ -4706,7 +4720,7 @@
<listitem>
<para>
- <literal>[MYSQLD]ArbitrationDelay</literal>
+ <literal>ArbitrationDelay</literal>
</para>
<para>
@@ -4720,7 +4734,7 @@
<listitem>
<para>
- <literal>[MYSQLD]BatchByteSize</literal>
+ <literal>BatchByteSize</literal>
</para>
<remark role="todo">
@@ -4754,7 +4768,7 @@
<listitem>
<para>
- <literal>[MYSQLD]BatchSize</literal>
+ <literal>BatchSize</literal>
</para>
<para>
@@ -4765,7 +4779,7 @@
<listitem>
<para>
- <literal>[MYSQLD]MaxScanBatchSize</literal>
+ <literal>MaxScanBatchSize</literal>
</para>
<para>
@@ -4798,6 +4812,9 @@
node and all MySQL server nodes, and between each data node
and the management server. (For one exception to this rule,
see <xref linkend="mysql-cluster-direct-tcp-definition"/>.)
+ <literal>[TCP]</literal> sections in the
+ <filename>config.ini</filename> file explicitly define TCP/IP
+ connections between nodes in the cluster.
</para>
<para>
@@ -4819,8 +4836,8 @@
<listitem>
<para>
- <literal>[TCP]<replaceable>NodeId1</replaceable></literal>,
- <literal>[TCP]<replaceable>NodeId2</replaceable></literal>
+ <literal><replaceable>NodeId1</replaceable></literal>,
+ <literal><replaceable>NodeId2</replaceable></literal>
</para>
<para>
@@ -4833,7 +4850,7 @@
<listitem>
<para>
- <literal>[TCP]SendBufferMemory</literal>
+ <literal>SendBufferMemory</literal>
</para>
<para>
@@ -4849,7 +4866,7 @@
<listitem>
<para>
- <literal>[TCP]SendSignalId</literal>
+ <literal>SendSignalId</literal>
</para>
<para>
@@ -4863,7 +4880,7 @@
<listitem>
<para>
- <literal>[TCP]Checksum</literal>
+ <literal>Checksum</literal>
</para>
<para>
@@ -4884,14 +4901,14 @@
</remark>
<para>
- <literal>[TCP]PortNumber</literal>
+ <literal>PortNumber</literal>
+ (<emphasis>OBSOLETE</emphasis>)
</para>
<para>
- (<emphasis role="bold">OBSOLETE</emphasis>.) This formerly
- specified the port number to be used for listening for
- connections from other nodes. This parameter should no
- longer be used.
+ This formerly specified the port number to be used for
+ listening for connections from other nodes. This parameter
+ should no longer be used.
</para>
</listitem>
@@ -4986,7 +5003,10 @@
more than one node runs concurrently on the same cluster host.
(In very early versions of MySQL Cluster, shared memory
segments functioned only when the <literal>-max</literal>
- binary was built using <option>--with-ndb-shm</option>.) When
+ binary was built using <option>--with-ndb-shm</option>.)
+ <literal>[SHM]</literal> sections in the
+ <filename>config.ini</filename> file explicitly define
+ shared-memory connections between nodes in the cluster. When
explicitly defining shared memory as the connection method, it
is necessary to define at least <literal>NodeId1</literal>,
<literal>NodeId2</literal> and <literal>ShmKey</literal>. All
@@ -5008,8 +5028,7 @@
<listitem>
<para>
- <literal>[SHM]NodeId1</literal>,
- <literal>[SHM]NodeId2</literal>
+ <literal>NodeId1</literal>, <literal>NodeId2</literal>
</para>
<para>
@@ -5021,7 +5040,7 @@
<listitem>
<para>
- <literal>[SHM]ShmKey</literal>
+ <literal>ShmKey</literal>
</para>
<para>
@@ -5034,7 +5053,7 @@
<listitem>
<para>
- <literal>[SHM]ShmSize</literal>
+ <literal>ShmSize</literal>
</para>
<para>
@@ -5047,7 +5066,7 @@
<listitem>
<para>
- <literal>[SHM]SendSignalId</literal>
+ <literal>SendSignalId</literal>
</para>
<para>
@@ -5061,7 +5080,7 @@
<listitem>
<para>
- <literal>[SHM]Checksum</literal>
+ <literal>Checksum</literal>
</para>
<para>
@@ -5088,8 +5107,11 @@
<title>&title-mysql-cluster-sci-definition;</title>
<para>
- Using SCI transporters to connect nodes in a MySQL Cluster is
- supported only when the MySQL-Max binaries are built using
+ <literal>[SCI]</literal> sections in the
+ <filename>config.ini</filename> file explicitly define SCI
+ connections between nodes in the cluster. Using SCI
+ transporters to connect nodes in a MySQL Cluster is supported
+ only when the MySQL-Max binaries are built using
<option>--with-ndb-sci=<replaceable>/your/path/to/SCI</replaceable></option>.
The <replaceable>path</replaceable> should point to a
directory that contains at a minimum <filename>lib</filename>
@@ -5117,8 +5139,7 @@
<listitem>
<para>
- <literal>[SCI]NodeId1</literal>,
- <literal>[SCI]NodeId2</literal>
+ <literal>NodeId1</literal>, <literal>NodeId2</literal>
</para>
<para>
@@ -5130,7 +5151,7 @@
<listitem>
<para>
- <literal>[SCI]Host1SciId0</literal>
+ <literal>Host1SciId0</literal>
</para>
<para>
@@ -5141,7 +5162,7 @@
<listitem>
<para>
- <literal>[SCI]Host1SciId1</literal>
+ <literal>Host1SciId1</literal>
</para>
<para>
@@ -5154,7 +5175,7 @@
<listitem>
<para>
- <literal>[SCI]Host2SciId0</literal>
+ <literal>Host2SciId0</literal>
</para>
<para>
@@ -5165,7 +5186,7 @@
<listitem>
<para>
- <literal>[SCI]Host2SciId1</literal>
+ <literal>Host2SciId1</literal>
</para>
<para>
@@ -5177,7 +5198,7 @@
<listitem>
<para>
- <literal>[SCI]SharedBufferSize</literal>
+ <literal>SharedBufferSize</literal>
</para>
<para>
@@ -5193,7 +5214,7 @@
<listitem>
<para>
- <literal>[SCI]SendLimit</literal>
+ <literal>SendLimit</literal>
</para>
<para>
@@ -5208,7 +5229,7 @@
<listitem>
<para>
- <literal>[SCI]SendSignalId</literal>
+ <literal>SendSignalId</literal>
</para>
<para>
@@ -5221,7 +5242,7 @@
<listitem>
<para>
- <literal>[SCI]Checksum</literal>
+ <literal>Checksum</literal>
</para>
<para>
Modified: trunk/refman-5.1/ndbcluster.xml
===================================================================
--- trunk/refman-5.1/ndbcluster.xml 2006-01-11 04:43:25 UTC (rev 759)
+++ trunk/refman-5.1/ndbcluster.xml 2006-01-11 05:18:17 UTC (rev 760)
@@ -2265,7 +2265,7 @@
<listitem>
<para>
- <literal>[COMPUTER]Id</literal>
+ <literal>Id</literal>
</para>
<para>
@@ -2276,7 +2276,7 @@
<listitem>
<para>
- <literal>[COMPUTER]HostName</literal>
+ <literal>HostName</literal>
</para>
<para>
@@ -2293,10 +2293,11 @@
<title>&title-mysql-cluster-mgm-definition;</title>
<para>
- The <literal>[NDB_MGMD]</literal> section (or its alias
- <literal>[MGM]</literal>) is used to configure the behavior of
- the management server. All parameters in the following list
- can be omitted and, if so, will assume their default values.
+ The <literal>[NDB_MGMD]</literal> section is used to configure
+ the behavior of the management server.
+ <literal>[MGM]</literal> can be used as an alias; the two
+ section names are equivalent. All parameters in the following
+ list are optional and assume their default values if omitted.
<emphasis role="bold">Note</emphasis>: If neither the
<literal>ExecuteOnComputer</literal> nor the
<literal>HostName</literal> parameter is present, the default
@@ -2307,7 +2308,7 @@
<listitem>
<para>
- <literal>[NDB_MGMD]Id</literal>
+ <literal>Id</literal>
</para>
<para>
@@ -2320,7 +2321,7 @@
<listitem>
<para>
- <literal>[NDB_MGMD]ExecuteOnComputer</literal>
+ <literal>ExecuteOnComputer</literal>
</para>
<para>
@@ -2331,7 +2332,7 @@
<listitem>
<para>
- <literal>[NDB_MGMD]PortNumber</literal>
+ <literal>PortNumber</literal>
</para>
<para>
@@ -2343,7 +2344,7 @@
<listitem>
<para>
- <literal>[NDB_MGMD]LogDestination</literal>
+ <literal>LogDestination</literal>
</para>
<para>
@@ -2447,8 +2448,8 @@
The default value for the <literal>FILE</literal>
parameter is
<literal>FILE:filename=ndb_<replaceable>node_id</replaceable>_cluster.log,maxsize=1000000,maxfiles=6</literal>,
- where <literal>node_id</literal> is the ID of the
- node.
+ where <replaceable>node_id</replaceable> is the ID of
+ the node.
</para>
</listitem>
@@ -2457,7 +2458,7 @@
<listitem>
<para>
- <literal>[NDB_MGMD]ArbitrationRank</literal>
+ <literal>ArbitrationRank</literal>
</para>
<para>
@@ -2504,7 +2505,7 @@
<listitem>
<para>
- <literal>[NDB_MGMD]ArbitrationDelay</literal>
+ <literal>ArbitrationDelay</literal>
</para>
<para>
@@ -2517,7 +2518,7 @@
<listitem>
<para>
- <literal>[NDB_MGMD]DataDir</literal>
+ <literal>DataDir</literal>
</para>
<para>
@@ -2601,7 +2602,7 @@
<listitem>
<para>
- <literal>[NBDB]Id</literal>
+ <literal>Id</literal>
</para>
<para>
@@ -2613,7 +2614,7 @@
<listitem>
<para>
- <literal>[NDBD]ExecuteOnComputer</literal>
+ <literal>ExecuteOnComputer</literal>
</para>
<para>
@@ -2624,7 +2625,7 @@
<listitem>
<para>
- <literal>[NDBD]HostName</literal>
+ <literal>HostName</literal>
</para>
<para>
@@ -2640,8 +2641,8 @@
<listitem>
<para>
+ <literal>ServerPort</literal>
(<emphasis>OBSOLETE</emphasis>)
- <literal>[NDBD]ServerPort</literal>
</para>
<para>
@@ -2657,7 +2658,7 @@
<listitem>
<para>
- <literal>[NDBD]NoOfReplicas</literal>
+ <literal>NoOfReplicas</literal>
</para>
<para>
@@ -2701,7 +2702,7 @@
<listitem>
<para>
- <literal>[NDBD]DataDir</literal>
+ <literal>DataDir</literal>
</para>
<para>
@@ -2712,7 +2713,7 @@
<listitem>
<para>
- <literal>[NDBD]FileSystemPath</literal>
+ <literal>FileSystemPath</literal>
</para>
<para>
@@ -2737,7 +2738,7 @@
<listitem>
<para>
- <literal>[NDBD]BackupDataDir</literal>
+ <literal>BackupDataDir</literal>
</para>
<para>
@@ -2756,10 +2757,11 @@
<para>
<literal>DataMemory</literal> and
- <literal>IndexMemory</literal> are parameters specifying the
- size of memory segments used to store the actual records and
- their indexes. In setting values for these, it is important to
- understand how <literal>DataMemory</literal> and
+ <literal>IndexMemory</literal> are <literal>[NDBD]</literal>
+ parameters specifying the size of memory segments used to
+ store the actual records and their indexes. In setting values
+ for these, it is important to understand how
+ <literal>DataMemory</literal> and
<literal>IndexMemory</literal> are used, as they usually need
to be updated in order to reflect actual usage by the cluster:
</para>
@@ -2768,7 +2770,7 @@
<listitem>
<para>
- <literal>[NDBD]DataMemory</literal>
+ <literal>DataMemory</literal>
</para>
<para>
@@ -2891,7 +2893,7 @@
<listitem>
<para>
- <literal>[NDBD]IndexMemory</literal>
+ <literal>IndexMemory</literal>
</para>
<para>
@@ -3019,9 +3021,10 @@
</para>
<para>
- The next three parameters which we discuss are important
- because they affect the number of parallel transactions and
- the sizes of transactions that can be handled by the system.
+ The next three <literal>[NDBD]</literal> parameters that we
+ discuss are important because they affect the number of
+ parallel transactions and the sizes of transactions that can
+ be handled by the system.
<literal>MaxNoOfConcurrentTransactions</literal> sets the
number of parallel transactions possible in a node;
<literal>MaxNoOfConcurrentOperations</literal> sets the number
@@ -3042,7 +3045,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfConcurrentTransactions</literal>
+ <literal>MaxNoOfConcurrentTransactions</literal>
</para>
<para>
@@ -3091,7 +3094,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfConcurrentOperations</literal>
+ <literal>MaxNoOfConcurrentOperations</literal>
</para>
<para>
@@ -3171,7 +3174,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfLocalOperations</literal>
+ <literal>MaxNoOfLocalOperations</literal>
</para>
<para>
@@ -3192,11 +3195,11 @@
</para>
<para>
- The next set of parameters is used to determine temporary
- storage when executing a query which is part of a Cluster
- transaction. All records are released when the query is
- completed and the cluster is waiting for the commit or
- rollback.
+ The next set of <literal>[NDBD]</literal> parameters is used
+ to determine temporary storage when executing a query which is
+ part of a Cluster transaction. All records are released when
+ the query is completed and the cluster is waiting for the
+ commit or rollback.
</para>
<para>
@@ -3212,7 +3215,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfConcurrentIndexOperations</literal>
+ <literal>MaxNoOfConcurrentIndexOperations</literal>
</para>
<para>
@@ -3239,7 +3242,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfFiredTriggers</literal>
+ <literal>MaxNoOfFiredTriggers</literal>
</para>
<para>
@@ -3267,7 +3270,7 @@
<listitem>
<para>
- <literal>[NDBD]TransactionBufferMemory</literal>
+ <literal>TransactionBufferMemory</literal>
</para>
<para>
@@ -3305,8 +3308,8 @@
<itemizedlist>
<para>
- There are additional parameters in the
- <literal>Dblqh</literal> module (in
+ There are additional <literal>[NDBD]</literal> parameters in
+ the <literal>Dblqh</literal> module (in
<filename>ndb/src/kernel/blocks/Dblqh/Dblqh.hpp</filename>)
which affect reads and updates. These include
<literal>ZATTRINBUF_FILESIZE</literal>, set by default to
@@ -3325,7 +3328,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfConcurrentScans</literal>
+ <literal>MaxNoOfConcurrentScans</literal>
</para>
<para>
@@ -3371,7 +3374,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfLocalScans</literal>
+ <literal>MaxNoOfLocalScans</literal>
</para>
<para>
@@ -3382,7 +3385,7 @@
<listitem>
<para>
- <literal>[NDBD]BatchSizePerLocalScan</literal>
+ <literal>BatchSizePerLocalScan</literal>
</para>
<para>
@@ -3404,7 +3407,7 @@
<listitem>
<para>
- <literal>[NDBD]LongMessageBuffer</literal>
+ <literal>LongMessageBuffer</literal>
</para>
<para>
@@ -3421,11 +3424,16 @@
<emphasis role="bold">Logging and Checkpointing</emphasis>
</para>
+ <para>
+ These <literal>[NDBD]</literal> paramaters control log and
+ checkpoint behavior.
+ </para>
+
<itemizedlist>
<listitem>
<para>
- <literal>[NDBD]NoOfFragmentLogFiles</literal>
+ <literal>NoOfFragmentLogFiles</literal>
</para>
<para>
@@ -3489,7 +3497,7 @@
</remark>
<para>
- <literal>[NDBD]MaxNoOfOpenFiles</literal>
+ <literal>MaxNoOfOpenFiles</literal>
</para>
<para>
@@ -3507,7 +3515,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfSavedMessages</literal>
+ <literal>MaxNoOfSavedMessages</literal>
</para>
<para>
@@ -3528,19 +3536,20 @@
</para>
<para>
- The next set of parameters defines pool sizes for metadata
- objects, used to define the maximum number of attributes,
- tables, indexes, and trigger objects used by indexes, events,
- and replication between clusters. Note that these act merely
- as <quote>suggestions</quote> to the cluster, and any that are
- not specified revert to the default values shown.
+ The next set of <literal>[NDBD]</literal> parameters defines
+ pool sizes for metadata objects, used to define the maximum
+ number of attributes, tables, indexes, and trigger objects
+ used by indexes, events, and replication between clusters.
+ Note that these act merely as <quote>suggestions</quote> to
+ the cluster, and any that are not specified revert to the
+ default values shown.
</para>
<itemizedlist>
<listitem>
<para>
- <literal>[NDBD]MaxNoOfAttributes</literal>
+ <literal>MaxNoOfAttributes</literal>
</para>
<para>
@@ -3580,7 +3589,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfTables</literal>
+ <literal>MaxNoOfTables</literal>
</para>
<para>
@@ -3606,7 +3615,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfOrderedIndexes</literal>
+ <literal>MaxNoOfOrderedIndexes</literal>
</para>
<para>
@@ -3625,7 +3634,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfUniqueHashIndexes</literal>
+ <literal>MaxNoOfUniqueHashIndexes</literal>
</para>
<para>
@@ -3645,7 +3654,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfTriggers</literal>
+ <literal>MaxNoOfTriggers</literal>
</para>
<para>
@@ -3675,7 +3684,7 @@
<listitem>
<para>
- <literal>[NDBD]MaxNoOfIndexes</literal>
+ <literal>MaxNoOfIndexes</literal>
</para>
<para>
@@ -3703,9 +3712,10 @@
<para>
The behavior of data nodes is also affected by a set of
- parameters taking on boolean values. These parameters can each
- be specified as <literal>TRUE</literal> by setting them equal
- to <literal>1</literal> or <literal>Y</literal>, and as
+ <literal>[NDBD]</literal> parameters taking on boolean values.
+ These parameters can each be specified as
+ <literal>TRUE</literal> by setting them equal to
+ <literal>1</literal> or <literal>Y</literal>, and as
<literal>FALSE</literal> by setting them equal to
<literal>0</literal> or <literal>N</literal>.
</para>
@@ -3714,7 +3724,7 @@
<listitem>
<para>
- <literal>[NDBD]LockPagesInMainMemory</literal>
+ <literal>LockPagesInMainMemory</literal>
</para>
<para>
@@ -3731,7 +3741,7 @@
<listitem>
<para>
- <literal>[NDBD]StopOnError</literal>
+ <literal>StopOnError</literal>
</para>
<para>
@@ -3747,7 +3757,7 @@
<listitem>
<para>
- <literal>[NDBD]Diskless</literal>
+ <literal>Diskless</literal>
</para>
<para>
@@ -3782,7 +3792,7 @@
<listitem>
<para>
- <literal>[NDBD]RestartOnErrorInsert</literal>
+ <literal>RestartOnErrorInsert</literal>
</para>
<para>
@@ -3804,17 +3814,18 @@
</para>
<para>
- There are a number of parameters specifying timeouts and
- intervals between various actions in Cluster data nodes. Most
- of the timeout values are specified in milliseconds. Any
- exceptions to this will be mentioned where applicable below.
+ There are a number of <literal>[NDBD]</literal> parameters
+ specifying timeouts and intervals between various actions in
+ Cluster data nodes. Most of the timeout values are specified
+ in milliseconds. Any exceptions to this will be mentioned
+ where applicable below.
</para>
<itemizedlist>
<listitem>
<para>
- <literal>[NDBD]TimeBetweenWatchDogCheck</literal>
+ <literal>TimeBetweenWatchDogCheck</literal>
</para>
<para>
@@ -3840,7 +3851,7 @@
<listitem>
<para>
- <literal>[NDBD]StartPartialTimeout</literal>
+ <literal>StartPartialTimeout</literal>
</para>
<para>
@@ -3860,7 +3871,7 @@
<listitem>
<para>
- <literal>[NDBD]StartPartitionedTimeout</literal>
+ <literal>StartPartitionedTimeout</literal>
</para>
<para>
@@ -3877,7 +3888,7 @@
<listitem>
<para>
- <literal>[NDBD]StartFailureTimeout</literal>
+ <literal>StartFailureTimeout</literal>
</para>
<para>
@@ -3901,7 +3912,7 @@
<listitem>
<para>
- <literal>[NDBD]HeartbeatIntervalDbDb</literal>
+ <literal>HeartbeatIntervalDbDb</literal>
</para>
<para>
@@ -3927,7 +3938,7 @@
<listitem>
<para>
- <literal>[NDBD]HeartbeatIntervalDbApi</literal>
+ <literal>HeartbeatIntervalDbApi</literal>
</para>
<para>
@@ -3953,7 +3964,7 @@
<listitem>
<para>
- <literal>[NDBD]TimeBetweenLocalCheckpoints</literal>
+ <literal>TimeBetweenLocalCheckpoints</literal>
</para>
<para>
@@ -3989,7 +4000,7 @@
<listitem>
<para>
- <literal>[NDBD]TimeBetweenGlobalCheckpoints</literal>
+ <literal>TimeBetweenGlobalCheckpoints</literal>
</para>
<para>
@@ -4024,7 +4035,7 @@
<listitem>
<para>
- <literal>[NDBD]TimeBetweenInactiveTransactionAbortCheck</literal>
+ <literal>TimeBetweenInactiveTransactionAbortCheck</literal>
</para>
<para>
@@ -4043,7 +4054,7 @@
<listitem>
<para>
- <literal>[NDBD]TransactionInactiveTimeout</literal>
+ <literal>TransactionInactiveTimeout</literal>
</para>
<para>
@@ -4064,7 +4075,7 @@
<listitem>
<para>
- <literal>[NDBD]TransactionDeadlockDetectionTimeout</literal>
+ <literal>TransactionDeadlockDetectionTimeout</literal>
</para>
<para>
@@ -4114,7 +4125,7 @@
<listitem>
<para>
- <literal>[NDBD]NoOfDiskPagesToDiskAfterRestartTUP</literal>
+ <literal>NoOfDiskPagesToDiskAfterRestartTUP</literal>
</para>
<para>
@@ -4160,7 +4171,7 @@
<listitem>
<para>
- <literal>[NDBD]NoOfDiskPagesToDiskAfterRestartACC</literal>
+ <literal>NoOfDiskPagesToDiskAfterRestartACC</literal>
</para>
<para>
@@ -4178,7 +4189,7 @@
<listitem>
<para>
- <literal>[NDBD]NoOfDiskPagesToDiskDuringRestartTUP</literal>
+ <literal>NoOfDiskPagesToDiskDuringRestartTUP</literal>
</para>
<para>
@@ -4204,7 +4215,7 @@
<listitem>
<para>
- <literal>[NDBD]NoOfDiskPagesToDiskDuringRestartACC</literal>
+ <literal>NoOfDiskPagesToDiskDuringRestartACC</literal>
</para>
<para>
@@ -4228,7 +4239,7 @@
<listitem>
<para>
- <literal>[NDBD]ArbitrationTimeout</literal>
+ <literal>ArbitrationTimeout</literal>
</para>
<para>
@@ -4250,10 +4261,11 @@
</para>
<para>
- Several configuration parameters corresponding to former
- compile-time parameters are also available. These enable the
- advanced user to have more control over the resources used by
- node processes and to adjust various buffer sizes at need.
+ Several <literal>[NDBD]</literal> configuration parameters
+ corresponding to former compile-time parameters are also
+ available. These enable the advanced user to have more control
+ over the resources used by node processes and to adjust
+ various buffer sizes at need.
</para>
<para>
@@ -4269,7 +4281,7 @@
<listitem>
<para>
- <literal>[NDBD]UndoIndexBuffer</literal>
+ <literal>UndoIndexBuffer</literal>
</para>
<para>
@@ -4315,7 +4327,7 @@
<listitem>
<para>
- <literal>[NDBD]UndoDataBuffer</literal>
+ <literal>UndoDataBuffer</literal>
</para>
<para>
@@ -4355,7 +4367,7 @@
<listitem>
<para>
- <literal>[NDBD]RedoBuffer</literal>
+ <literal>RedoBuffer</literal>
</para>
<para>
@@ -4409,12 +4421,12 @@
<listitem>
<para>
- <literal>[NDBD]LogLevelStartup</literal>
+ <literal>LogLevelStartup</literal>
</para>
<para>
- Reporting level for events generated during startup of the
- process.
+ The reporting level for events generated during startup of
+ the process.
</para>
<para>
@@ -4424,12 +4436,12 @@
<listitem>
<para>
- <literal>[NDBD]LogLevelShutdown</literal>
+ <literal>LogLevelShutdown</literal>
</para>
<para>
- Reporting level for events generated as part of graceful
- shutdown of a node.
+ The reporting level for events generated as part of
+ graceful shutdown of a node.
</para>
<para>
@@ -4439,13 +4451,13 @@
<listitem>
<para>
- <literal>[NDBD]LogLevelStatistic</literal>
+ <literal>LogLevelStatistic</literal>
</para>
<para>
- Reporting level for statistical events such as number of
- primary key reads, number of updates, number of inserts,
- information relating to buffer usage, and so on.
+ The reporting level for statistical events such as number
+ of primary key reads, number of updates, number of
+ inserts, information relating to buffer usage, and so on.
</para>
<para>
@@ -4455,12 +4467,12 @@
<listitem>
<para>
- <literal>[NDBD]LogLevelCheckpoint</literal>
+ <literal>LogLevelCheckpoint</literal>
</para>
<para>
- Reporting level for events generated by local and global
- checkpoints.
+ The reporting level for events generated by local and
+ global checkpoints.
</para>
<para>
@@ -4470,11 +4482,12 @@
<listitem>
<para>
- <literal>[NDBD]LogLevelNodeRestart</literal>
+ <literal>LogLevelNodeRestart</literal>
</para>
<para>
- Reporting level for events generated during node restart.
+ The reporting level for events generated during node
+ restart.
</para>
<para>
@@ -4484,11 +4497,11 @@
<listitem>
<para>
- <literal>[NDBD]LogLevelConnection</literal>
+ <literal>LogLevelConnection</literal>
</para>
<para>
- Reporting level for events generated by connections
+ The reporting level for events generated by connections
between cluster nodes.
</para>
@@ -4499,11 +4512,11 @@
<listitem>
<para>
- <literal>[NDBD]LogLevelError</literal>
+ <literal>LogLevelError</literal>
</para>
<para>
- Reporting level for events generated by errors and
+ The reporting level for events generated by errors and
warnings by the cluster as a whole. These errors do not
cause any node failure but are still considered worth
reporting.
@@ -4516,12 +4529,12 @@
<listitem>
<para>
- <literal>[NDBD]LogLevelInfo</literal>
+ <literal>LogLevelInfo</literal>
</para>
<para>
- Reporting level for events generated for information about
- the general state of the cluster.
+ The reporting level for events generated for information
+ about the general state of the cluster.
</para>
<para>
@@ -4536,15 +4549,16 @@
</para>
<para>
- The parameters discussed in this section define memory buffers
- set aside for execution of online backups.
+ The <literal>[NDBD]</literal> parameters discussed in this
+ section define memory buffers set aside for execution of
+ online backups.
</para>
<itemizedlist>
<listitem>
<para>
- <literal>[NDBD]BackupDataBufferSize</literal>
+ <literal>BackupDataBufferSize</literal>
</para>
<para>
@@ -4567,7 +4581,7 @@
<listitem>
<para>
- <literal>[NDBD]BackupLogBufferSize</literal>
+ <literal>BackupLogBufferSize</literal>
</para>
<para>
@@ -4610,7 +4624,7 @@
</remark>
<para>
- <literal>[NDBD]BackupMemory</literal>
+ <literal>BackupMemory</literal>
</para>
<para>
@@ -4626,7 +4640,7 @@
<listitem>
<para>
- <literal>[NDBD]BackupWriteSize</literal>
+ <literal>BackupWriteSize</literal>
</para>
<para>
@@ -4659,7 +4673,7 @@
<listitem>
<para>
- <literal>[MYSQLD]Id</literal>
+ <literal>Id</literal>
</para>
<para>
@@ -4672,7 +4686,7 @@
<listitem>
<para>
- <literal>[MYSQLD]ExecuteOnComputer</literal>
+ <literal>ExecuteOnComputer</literal>
</para>
<para>
@@ -4684,7 +4698,7 @@
<listitem>
<para>
- <literal>[MYSQLD]ArbitrationRank</literal>
+ <literal>ArbitrationRank</literal>
</para>
<para>
@@ -4704,7 +4718,7 @@
<listitem>
<para>
- <literal>[MYSQLD]ArbitrationDelay</literal>
+ <literal>ArbitrationDelay</literal>
</para>
<para>
@@ -4718,7 +4732,7 @@
<listitem>
<para>
- <literal>[MYSQLD]BatchByteSize</literal>
+ <literal>BatchByteSize</literal>
</para>
<remark role="todo">
@@ -4752,7 +4766,7 @@
<listitem>
<para>
- <literal>[MYSQLD]BatchSize</literal>
+ <literal>BatchSize</literal>
</para>
<para>
@@ -4763,7 +4777,7 @@
<listitem>
<para>
- <literal>[MYSQLD]MaxScanBatchSize</literal>
+ <literal>MaxScanBatchSize</literal>
</para>
<para>
@@ -4796,6 +4810,9 @@
node and all MySQL server nodes, and between each data node
and the management server. (For one exception to this rule,
see <xref linkend="mysql-cluster-direct-tcp-definition"/>.)
+ <literal>[TCP]</literal> sections in the
+ <filename>config.ini</filename> file explicitly define TCP/IP
+ connections between nodes in the cluster.
</para>
<para>
@@ -4817,8 +4834,8 @@
<listitem>
<para>
- <literal>[TCP]<replaceable>NodeId1</replaceable></literal>,
- <literal>[TCP]<replaceable>NodeId2</replaceable></literal>
+ <literal><replaceable>NodeId1</replaceable></literal>,
+ <literal><replaceable>NodeId2</replaceable></literal>
</para>
<para>
@@ -4831,7 +4848,7 @@
<listitem>
<para>
- <literal>[TCP]SendBufferMemory</literal>
+ <literal>SendBufferMemory</literal>
</para>
<para>
@@ -4847,7 +4864,7 @@
<listitem>
<para>
- <literal>[TCP]SendSignalId</literal>
+ <literal>SendSignalId</literal>
</para>
<para>
@@ -4861,7 +4878,7 @@
<listitem>
<para>
- <literal>[TCP]Checksum</literal>
+ <literal>Checksum</literal>
</para>
<para>
@@ -4882,14 +4899,14 @@
</remark>
<para>
- <literal>[TCP]PortNumber</literal>
+ <literal>PortNumber</literal>
+ (<emphasis>OBSOLETE</emphasis>)
</para>
<para>
- (<emphasis role="bold">OBSOLETE</emphasis>.) This formerly
- specified the port number to be used for listening for
- connections from other nodes. This parameter should no
- longer be used.
+ This formerly specified the port number to be used for
+ listening for connections from other nodes. This parameter
+ should no longer be used.
</para>
</listitem>
@@ -4984,7 +5001,10 @@
more than one node runs concurrently on the same cluster host.
(In very early versions of MySQL Cluster, shared memory
segments functioned only when the <literal>-max</literal>
- binary was built using <option>--with-ndb-shm</option>.) When
+ binary was built using <option>--with-ndb-shm</option>.)
+ <literal>[SHM]</literal> sections in the
+ <filename>config.ini</filename> file explicitly define
+ shared-memory connections between nodes in the cluster. When
explicitly defining shared memory as the connection method, it
is necessary to define at least <literal>NodeId1</literal>,
<literal>NodeId2</literal> and <literal>ShmKey</literal>. All
@@ -5006,8 +5026,7 @@
<listitem>
<para>
- <literal>[SHM]NodeId1</literal>,
- <literal>[SHM]NodeId2</literal>
+ <literal>NodeId1</literal>, <literal>NodeId2</literal>
</para>
<para>
@@ -5019,7 +5038,7 @@
<listitem>
<para>
- <literal>[SHM]ShmKey</literal>
+ <literal>ShmKey</literal>
</para>
<para>
@@ -5032,7 +5051,7 @@
<listitem>
<para>
- <literal>[SHM]ShmSize</literal>
+ <literal>ShmSize</literal>
</para>
<para>
@@ -5045,7 +5064,7 @@
<listitem>
<para>
- <literal>[SHM]SendSignalId</literal>
+ <literal>SendSignalId</literal>
</para>
<para>
@@ -5059,7 +5078,7 @@
<listitem>
<para>
- <literal>[SHM]Checksum</literal>
+ <literal>Checksum</literal>
</para>
<para>
@@ -5086,8 +5105,11 @@
<title>&title-mysql-cluster-sci-definition;</title>
<para>
- Using SCI transporters to connect nodes in a MySQL Cluster is
- supported only when the MySQL-Max binaries are built using
+ <literal>[SCI]</literal> sections in the
+ <filename>config.ini</filename> file explicitly define SCI
+ connections between nodes in the cluster. Using SCI
+ transporters to connect nodes in a MySQL Cluster is supported
+ only when the MySQL-Max binaries are built using
<option>--with-ndb-sci=<replaceable>/your/path/to/SCI</replaceable></option>.
The <replaceable>path</replaceable> should point to a
directory that contains at a minimum <filename>lib</filename>
@@ -5115,8 +5137,7 @@
<listitem>
<para>
- <literal>[SCI]NodeId1</literal>,
- <literal>[SCI]NodeId2</literal>
+ <literal>NodeId1</literal>, <literal>NodeId2</literal>
</para>
<para>
@@ -5128,7 +5149,7 @@
<listitem>
<para>
- <literal>[SCI]Host1SciId0</literal>
+ <literal>Host1SciId0</literal>
</para>
<para>
@@ -5139,7 +5160,7 @@
<listitem>
<para>
- <literal>[SCI]Host1SciId1</literal>
+ <literal>Host1SciId1</literal>
</para>
<para>
@@ -5152,7 +5173,7 @@
<listitem>
<para>
- <literal>[SCI]Host2SciId0</literal>
+ <literal>Host2SciId0</literal>
</para>
<para>
@@ -5163,7 +5184,7 @@
<listitem>
<para>
- <literal>[SCI]Host2SciId1</literal>
+ <literal>Host2SciId1</literal>
</para>
<para>
@@ -5175,7 +5196,7 @@
<listitem>
<para>
- <literal>[SCI]SharedBufferSize</literal>
+ <literal>SharedBufferSize</literal>
</para>
<para>
@@ -5191,7 +5212,7 @@
<listitem>
<para>
- <literal>[SCI]SendLimit</literal>
+ <literal>SendLimit</literal>
</para>
<para>
@@ -5206,7 +5227,7 @@
<listitem>
<para>
- <literal>[SCI]SendSignalId</literal>
+ <literal>SendSignalId</literal>
</para>
<para>
@@ -5219,7 +5240,7 @@
<listitem>
<para>
- <literal>[SCI]Checksum</literal>
+ <literal>Checksum</literal>
</para>
<para>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r760 - in trunk: . refman-4.1 refman-5.0 refman-5.1 | paul | 11 Jan |
