Author: jstephens
Date: 2010-11-02 12:51:31 +0100 (Tue, 02 Nov 2010)
New Revision: 23520
Log:
Add auto-link markup
Modified:
trunk/refman-5.1/mysql-cluster-overview.xml
Modified: trunk/refman-5.1/mysql-cluster-overview.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster-overview.xml 2010-11-02 06:02:49 UTC (rev 23519)
+++ trunk/refman-5.1/mysql-cluster-overview.xml 2010-11-02 11:51:31 UTC (rev 23520)
Changed blocks: 26, Lines Added: 121, Lines Deleted: 127; 24036 bytes
@@ -675,7 +675,8 @@
<para>
The number of node groups in a MySQL Cluster is not directly
configurable; it is a function of the number of data nodes and of
- the number of replicas (<literal>NoOfReplicas</literal>
+ the number of replicas
+ (<literal role="ndbparam:ndbd">NoOfReplicas</literal>
configuration parameter), as shown here:
</para>
@@ -685,12 +686,13 @@
<para>
Thus, a MySQL Cluster with 4 data nodes has 4 node groups if
- <literal>NoOfReplicas</literal> is set to 1 in the
- <filename>config.ini</filename> file, 2 node groups if
- <literal>NoOfReplicas</literal> is set to 2, and 1 node group if
- <literal>NoOfReplicas</literal> is set to 4. Replicas are
- discussed later in this section; for more information about
- <literal>NoOfReplicas</literal>, see
+ <literal role="ndbparam:ndbd">NoOfReplicas</literal> is set to 1
+ in the <filename>config.ini</filename> file, 2 node groups if
+ <literal role="ndbparam:ndbd">NoOfReplicas</literal> is set to 2,
+ and 1 node group if
+ <literal role="ndbparam:ndbd">NoOfReplicas</literal> is set to 4.
+ Replicas are discussed later in this section; for more information
+ about <literal role="ndbparam:ndbd">NoOfReplicas</literal>, see
<xref linkend="mysql-cluster-ndbd-definition"/>.
</para>
@@ -760,18 +762,19 @@
When using <command>ndbd</command>, the maximum number of
partitions that may be defined explicitly for any
<literal role="se">NDBCLUSTER</literal> table is 4 per node
- group, times <literal>NoOfReplicas</literal>. (The number of
- node groups in a MySQL Cluster is determined as discussed
- previously in this section.)
+ group, times
+ <literal role="ndbparam:ndbd">NoOfReplicas</literal>. (The
+ number of node groups in a MySQL Cluster is determined as
+ discussed previously in this section.)
</para>
<para>
When using <command>ndbmtd</command>, this maximum is also
affected by the number of local query handler threads, which
is determined by the value of the
- <literal>MaxNoOfExecutionThreads</literal> configuration
- parameter. In such cases, the maxmimum number of partitions
- that may be defined explicitly for an
+ <literal role="ndbparam:ndbmtd">MaxNoOfExecutionThreads</literal>
+ configuration parameter. In such cases, the maxmimum number of
+ partitions that may be defined explicitly for an
<literal role="se">NDB</literal> table is equal to
<literal>MaxNoOfExecutionThreads * NoOfReplicas *
[<replaceable>number of data nodes</replaceable>]</literal>.
@@ -1125,8 +1128,8 @@
</row>
<row>
<entry>Increased flexibility in determining arbitration handling, using a new
- <literal>Arbitration</literal> data node configuration
- parameter</entry>
+ <literal role="ndbparam:ndbd">Arbitration</literal> data
+ node configuration parameter</entry>
</row>
</tbody>
</tgroup>
@@ -1192,8 +1195,8 @@
<tbody>
<row>
<entry>Improved backup status reporting
- (<literal>BackupReportFrequency</literal>, <literal>REPORT
- BackupStatus</literal>)</entry>
+ (<literal role="ndbparam:ndbd">BackupReportFrequency</literal>,
+ <literal>REPORT BackupStatus</literal>)</entry>
</row>
<row>
<entry>Multiple connections per SQL node</entry>
@@ -1670,7 +1673,7 @@
Beginning with MySQL Cluster NDB 7.1.5, it is possible to
set a specific order for transmission of heartbeats
between datat nodes, using the
- <link linkend="ndbparam-ndbd-heartbeatorder"><literal>HeartbeatOrder</literal></link>
+ <literal role="ndbparam:ndbd">HeartbeatOrder</literal>
data node configuration parameter introduced in this
version. This parameter can be useful in situations where
multiple data nodes are running on the same host and a
@@ -1914,10 +1917,10 @@
functions in the same way as <command>ndbd</command>, and
can use the same command-line options and configuration
parameters. In addition, the new
- <literal>MaxNoOfExecutionThreads</literal> configuration
- parameter can be used to determine the number of data node
- process threads for <command>ndbmtd</command>. For more
- information, see
+ <literal role="ndbparam:ndbmtd">MaxNoOfExecutionThreads</literal>
+ configuration parameter can be used to determine the
+ number of data node process threads for
+ <command>ndbmtd</command>. For more information, see
<xref linkend="mysql-cluster-programs-ndbmtd"/>.
</para>
@@ -2018,10 +2021,11 @@
that the size of the send buffer can be adjusted as
necessary. This change is reflected by the addition of the
configuration parameters
- <literal>TotalSendBufferMemory</literal>,
- <literal>ReservedSendBufferMemory</literal>, and
- <literal>OverLoadLimit</literal>, as well as a change in
- how the existing <literal>SendBufferMemory</literal>
+ <literal role="ndbparam:ndbd">TotalSendBufferMemory</literal>,
+ <literal role="ndbparam:ndbd">ReservedSendBufferMemory</literal>,
+ and <literal>OverLoadLimit</literal>, as well as a change
+ in how the existing
+ <literal role="ndbparam:tcp">SendBufferMemory</literal>
configuration parameter is used. For more information, see
<xref linkend="mysql-cluster-config-send-buffers"/>.
</para>
@@ -2105,11 +2109,12 @@
As of MySQL Cluster NDB 6.4.3, you can specify default
locations for MySQL Cluster Disk Data data files and undo
log files using the data node configuration parameters
- <literal>FileSystemPathDD</literal>,
- <literal>FileSystemPathDataFiles</literal>, and
- <literal>FileSystemPathUndoFiles</literal>. This
- eliminates the need to use symbolic links to place Disk
- Data files separately from other files in data node
+ <literal role="ndbparam:ndbd">FileSystemPathDD</literal>,
+ <literal role="ndbparam:ndbd">FileSystemPathDataFiles</literal>,
+ and
+ <literal role="ndbparam:ndbd">FileSystemPathUndoFiles</literal>.
+ This eliminates the need to use symbolic links to place
+ Disk Data files separately from other files in data node
filesystems to improve Disk Data performance. For more
information, see
<xref linkend="mysql-cluster-ndbd-disk-data-filesystem-parameters"/>.
@@ -2126,13 +2131,14 @@
<para>
Beginning with MySQL Cluster NDB 6.4.3, using the data
node configuration parameters
- <literal>InitialLogFileGroup</literal> and
- <literal>InitialTablespace</literal>, you can cause the
- creation of a MySQL Cluster Disk Data log file group,
- tablespace, or both, when the cluster is first started.
- When using these parameters, no SQL statements are
- required to create these Disk Data objects. For more
- information, see
+ <literal role="ndbparam:ndbd">InitialLogFileGroup</literal>
+ and
+ <literal role="ndbparam:ndbd">InitialTablespace</literal>,
+ you can cause the creation of a MySQL Cluster Disk Data
+ log file group, tablespace, or both, when the cluster is
+ first started. When using these parameters, no SQL
+ statements are required to create these Disk Data objects.
+ For more information, see
<citetitle><link linkend="mysql-cluster-ndbd-disk-data-object-creation-parameters">Disk
Data object creation parameters</link></citetitle>.
</para>
@@ -2558,8 +2564,8 @@
<para>
Beginning with MySQL Cluster NDB 7.0.16, it is possible to
set a specific order for transmission of heartbeats
- between datat nodes, using the
- <link linkend="ndbparam-ndbd-heartbeatorder"><literal>HeartbeatOrder</literal></link>
+ between data nodes, using the
+ <literal role="ndbparam:ndbd">HeartbeatOrder</literal>
data node configuration parameter introduced in this
version. This parameter can be useful in situations where
multiple data nodes are running on the same host and a
@@ -2882,16 +2888,10 @@
more of the disk space used by uncompressed LCPs and
backups. These can be enabled using the two new data
node configuration parameters
- <literal>CompressedLCP</literal> and
- <literal>CompressedBackup</literal>, respectively. See
- <link linkend="ndbparam-ndbd-compressedbackup"><citetitle>MySQL
- Cluster Status Variables:
- <literal>CompressedBackup</literal></citetitle></link>,
+ <literal role="ndbparam:ndbd">CompressedLCP</literal>
and
- <link linkend="ndbparam-ndbd-compressedlcp"><citetitle>MySQL
- Cluster Status Variables:
- <literal>CompressedLCP</literal></citetitle></link>, for
- more information about these parameters.
+ <literal role="ndbparam:ndbd">CompressedBackup</literal>,
+ respectively.
</para>
</formalpara>
@@ -3133,12 +3133,13 @@
possible to give priority to the data node process and
control on which CPU cores it should operate. This can
be done using the data node configuration parameters
- <literal>RealtimeScheduler</literal>,
- <literal>SchedulerExecutionTimer</literal> and
- <literal>SchedulerSpinTimer</literal>. Doing so properly
- can significantly lower response times and make them
- much more predictable response. For more information
- about using these parameters, see
+ <literal role="ndbparam:ndbd">RealtimeScheduler</literal>,
+ <literal role="ndbparam:ndbd">SchedulerExecutionTimer</literal>,
+ and
+ <literal role="ndbparam:ndbd">SchedulerSpinTimer</literal>.
+ Doing so properly can significantly lower response times
+ and make them much more predictable response. For more
+ information about using these parameters, see
<link linkend="mysql-cluster-realtime-performance-parameters">Defining
Data Nodes: Realtime Performance Parameters</link>
</para>
@@ -3221,11 +3222,13 @@
As of MySQL Cluster NDB 6.3.22, you can specify default
locations for MySQL Cluster Disk Data data files and
undo log files using the data node configuration
- parameters <literal>FileSystemPathDD</literal>,
- <literal>FileSystemPathDataFiles</literal>, and
- <literal>FileSystemPathUndoFiles</literal>. This
- eliminates the need to use symbolic links to place Disk
- Data files separately from other files in data node
+ parameters
+ <literal role="ndbparam:ndbd">FileSystemPathDD</literal>,
+ <literal role="ndbparam:ndbd">FileSystemPathDataFiles</literal>,
+ and
+ <literal role="ndbparam:ndbd">FileSystemPathUndoFiles</literal>.
+ This eliminates the need to use symbolic links to place
+ Disk Data files separately from other files in data node
filesystems to improve Disk Data performance. For more
information, see
<xref linkend="mysql-cluster-ndbd-disk-data-filesystem-parameters"/>.
@@ -3242,13 +3245,14 @@
<para>
Beginning with MySQL Cluster NDB 6.3.22, using the data
node configuration parameters
- <literal>InitialLogFileGroup</literal> and
- <literal>InitialTablespace</literal>, you can cause the
- creation of a MySQL Cluster Disk Data log file group,
- tablespace, or both, when the cluster is first started.
- When using these parameters, no SQL statements are
- required to create these Disk Data objects. For more
- information, see
+ <literal role="ndbparam:ndbd">InitialLogFileGroup</literal>
+ and
+ <literal role="ndbparam:ndbd">InitialTablespace</literal>,
+ you can cause the creation of a MySQL Cluster Disk Data
+ log file group, tablespace, or both, when the cluster is
+ first started. When using these parameters, no SQL
+ statements are required to create these Disk Data
+ objects. For more information, see
<citetitle><link linkend="mysql-cluster-ndbd-disk-data-object-creation-parameters">Disk
Data object creation parameters</link></citetitle>.
</para>
@@ -3509,7 +3513,7 @@
Beginning with MySQL Cluster NDB 6.3.35, it is possible
to set a specific order for transmission of heartbeats
between datat nodes, using the
- <link linkend="ndbparam-ndbd-heartbeatorder"><literal>HeartbeatOrder</literal></link>
+ <literal role="ndbparam:ndbd">HeartbeatOrder</literal>
data node configuration parameter introduced in this
version. This parameter can be useful in situations
where multiple data nodes are running on the same host
@@ -3634,12 +3638,8 @@
<para>
Backup status reporting has been improved, aided in part
by the introduction of a
- <literal>BackupReportFrequency</literal> configuration
- parameter; see
- <link linkend="ndbparam-ndbd-backupreportfrequency"><citetitle>Defining
- Data Nodes:
- <literal>BackupReportFrequency</literal></citetitle></link>,
- for more information.
+ <literal role="ndbparam:ndbd">BackupReportFrequency</literal>
+ configuration parameter.
</para>
</formalpara>
@@ -3715,14 +3715,11 @@
page-by-page basis, which significantly reduces the
memory overhead required for maintaining
<literal role="se">NDBCLUSTER</literal> tables. In
- addition, the <literal>MaxAllocate</literal>
+ addition, the
+ <literal role="ndbparam:ndbd">MaxAllocate</literal>
configuration parameter now makes it possible to set the
maximum size of the allocation unit used for table
- memory; for more information about this configuration
- parameter, see
- <link linkend="ndbparam-ndbd-maxallocate"><citetitle>Defining
- Data Nodes:
- <literal>MaxAllocate</literal></citetitle></link>.
+ memory.
</para>
</formalpara>
@@ -3785,17 +3782,12 @@
referred to as <quote>micro-GCPs</quote>), it is now
possible to control how often the GCI number is updated,
and how often global checkpoints are written to disk,
- using the <literal>TimeBetweenEpochs</literal>
- configuration parameter. This improves the reliability
- and performance of MySQL Cluster Replication. For more
- information, see
- <link linkend="ndbparam-ndbd-timebetweenepochs"><citetitle>Defining
- Data Nodes:
- <literal>TimeBetweenEpochs</literal></citetitle></link>
+ using the
+ <literal role="ndbparam:ndbd">TimeBetweenEpochs</literal>
and
- <link linkend="ndbparam-ndbd-timebetweenepochstimeout"><citetitle>Defining
- Data Nodes:
- <literal>TimeBetweenEpochsTimeout</literal></citetitle></link>.
+ <literal role="ndbparam:ndbd">TimeBetweenEpochsTimeout</literal>
+ configuration parameters. This improves the reliability
+ and performance of MySQL Cluster Replication.
</para>
</formalpara>
@@ -3889,15 +3881,13 @@
<title>Epoch lag control</title>
<para>
- The <literal>MaxBufferedEpochs</literal> data node
- configuration parameter provides a means to control the
- maximum number of unprocessed epochs by which a
- subscribing node can lag. Subscribers which exceed this
- number are disconnected and forced to reconnect. For a
- discussion of this configuration parameter, see
- <link linkend="ndbparam-ndbd-maxbufferedepochs"><citetitle>Defining
- Data Nodes:
- <literal>MaxBufferedEpochs</literal></citetitle></link>.
+ The
+ <literal role="ndbparam:ndbd">MaxBufferedEpochs</literal>
+ data node configuration parameter provides a means to
+ control the maximum number of unprocessed epochs by
+ which a subscribing node can lag. Subscribers which
+ exceed this number are disconnected and forced to
+ reconnect.
</para>
</formalpara>
@@ -3964,11 +3954,13 @@
As of MySQL Cluster NDB 6.2.17, you can specify default
locations for MySQL Cluster Disk Data data files and
undo log files using the data node configuration
- parameters <literal>FileSystemPathDD</literal>,
- <literal>FileSystemPathDataFiles</literal>, and
- <literal>FileSystemPathUndoFiles</literal>. This
- eliminates the need to use symbolic links to place Disk
- Data files separately from other files in data node
+ parameters
+ <literal role="ndbparam:ndbd">FileSystemPathDD</literal>,
+ <literal role="ndbparam:ndbd">FileSystemPathDataFiles</literal>,
+ and
+ <literal role="ndbparam:ndbd">FileSystemPathUndoFiles</literal>.
+ This eliminates the need to use symbolic links to place
+ Disk Data files separately from other files in data node
filesystems to improve Disk Data performance. For more
information, see
<xref linkend="mysql-cluster-ndbd-disk-data-filesystem-parameters"/>.
@@ -3985,15 +3977,14 @@
<para>
Beginning with MySQL Cluster NDB 6.2.17, using the data
node configuration parameters
- <literal>InitialLogFileGroup</literal> and
- <literal>InitialTablespace</literal>, you can cause the
- creation of a MySQL Cluster Disk Data log file group,
- tablespace, or both, when the cluster is first started.
- When using these parameters, no SQL statements are
- required to create these Disk Data objects. For more
- information, see
- <citetitle><link linkend="mysql-cluster-ndbd-disk-data-object-creation-parameters">Disk
- Data object creation parameters</link></citetitle>.
+ <literal role="ndbparam:ndbd">InitialLogFileGroup</literal>
+ and
+ <literal role="ndbparam:ndbd">InitialTablespace</literal>,
+ you can cause the creation of a MySQL Cluster Disk Data
+ log file group, tablespace, or both, when the cluster is
+ first started. When using these parameters, no SQL
+ statements are required to create these Disk Data
+ objects.
</para>
</formalpara>
@@ -4978,22 +4969,23 @@
<listitem>
<para>
Database memory size and index memory size
- (<literal>DataMemory</literal> and
- <literal>IndexMemory</literal>, respectively).
+ (<literal role="ndbparam:ndbd">DataMemory</literal> and
+ <literal role="ndbparam:ndbd">IndexMemory</literal>,
+ respectively).
</para>
<para>
- <literal>DataMemory</literal> is allocated as 32KB
- pages. As each <literal>DataMemory</literal> page is
- used, it is assigned to a specific table; once
+ <literal role="ndbparam:ndbd">DataMemory</literal> is
+ allocated as 32KB pages. As each
+ <literal role="ndbparam:ndbd">DataMemory</literal> page
+ is used, it is assigned to a specific table; once
allocated, this memory cannot be freed except by
dropping the table.
</para>
<para>
See <xref linkend="mysql-cluster-ndbd-definition"/>, for
- further information about <literal>DataMemory</literal>
- and <literal>IndexMemory</literal>.
+ more information.
</para>
</listitem>
@@ -5002,8 +4994,9 @@
The maximum number of operations that can be performed
per transaction is set using the configuration
parameters
- <literal>MaxNoOfConcurrentOperations</literal> and
- <literal>MaxNoOfLocalOperations</literal>.
+ <literal role="ndbparam:ndbd">MaxNoOfConcurrentOperations</literal>
+ and
+ <literal role="ndbparam:ndbd">MaxNoOfLocalOperations</literal>.
</para>
<note>
@@ -5022,8 +5015,9 @@
Different limits related to tables and indexes. For
example, the maximum number of ordered indexes in the
cluster is determined by
- <literal>MaxNoOfOrderedIndexes</literal>, and the
- maximum number of ordered inexes per table is 16.
+ <literal role="ndbparam:ndbd">MaxNoOfOrderedIndexes</literal>,
+ and the maximum number of ordered indexes per table is
+ 16.
</para>
</listitem>
@@ -6765,9 +6759,9 @@
<para>
As in previous MySQL Cluster releases, it is not
possible to change online either the number of replicas
- (<literal>NoOfReplicas</literal> configuration
- parameter) or the number of data nodes per node group.
- These changes require a system restart.
+ (<literal role="ndbparam:ndbd">NoOfReplicas</literal>
+ configuration parameter) or the number of data nodes per
+ node group. These changes require a system restart.
</para>
</listitem>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r23520 - trunk/refman-5.1 | jon.stephens | 2 Nov |
