Author: jstephens
Date: 2006-07-13 12:57:48 +0200 (Thu, 13 Jul 2006)
New Revision: 2725
Log:
Added restart info to Cluster configuration parameter tables.
(Thanks Hartmut, Jeb, Sergei, Johan, and Bernd!)
Modified:
trunk/refman-4.1/mysql-cluster.xml
trunk/refman-5.0/mysql-cluster.xml
trunk/refman-5.1/mysql-cluster.xml
Modified: trunk/refman-4.1/mysql-cluster.xml
===================================================================
--- trunk/refman-4.1/mysql-cluster.xml 2006-07-13 10:55:47 UTC (rev 2724)
+++ trunk/refman-4.1/mysql-cluster.xml 2006-07-13 10:57:48 UTC (rev 2725)
Changed blocks: 86, Lines Added: 165, Lines Deleted: 345; 36940 bytes
@@ -6462,32 +6462,103 @@
<secondary>MySQL Cluster</secondary>
</indexterm>
- <remark role="todo">
- [js] Uncomment references to restarts once that info has been
- filled in.
+ <remark role="note">
+ [js] Prepared with the assistance of Johan Andersson, Hartmut
+ Holzgraefe, Sergei Kozlov, Jeb Miller, and Bernd Ocklin.
</remark>
<para>
- The next three sections provide summaries of MySQL Cluster
+ The next three sections provide summary tables of MySQL Cluster
configuration parameters used in the
<filename>config.ini</filename> file to govern the cluster's
- functioning. Each section lists the parameters for one of the
+ functioning. Each table lists the parameters for one of the
Cluster node process types (<command>ndbd</command>,
<command>ndb_mgmd</command>, and <command>mysqld</command>), and
includes the parameter's type as well as its default, mimimum,
and maximum values as applicable.
+ </para>
-<!--
- It is also stated whether a
- restart or initial restart of the cluster is required to change
- the value of a given configuration parameter.
--->
+ <para>
+ It is also stated what type of restart is required (node restart
+ or system restart) — and whether the restart must be done
+ with <option>--initial</option> — to change the value of a
+ given configuration parameter. This information is provided in
+ each table's <emphasis role="bold">Restart Type</emphasis>
+ column, which contains one of the values shown in this list:
</para>
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>N</literal>: Node Restart
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>IN</literal>: Initial Node Restart
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>S</literal>: System Restart
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>IS</literal>: Initial System Restart
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
<para>
+ When performing a node restart or an initial node restart, all
+ of the cluster's data nodes must be restarted in turn (also
+ referred to as a <firstterm>rolling restart</firstterm>). It is
+ possible to update cluster configuration parameters marked
+ <literal>N</literal> or <literal>IN</literal> online —
+ that is, without shutting down the cluster — in this
+ fashion. An initial node restart requires restarting each
+ <command>ndbd</command> process with the
+ <option>--initial</option> option.
+ </para>
+
+ <para>
+ A system restart requires a complete shutdown and restart of the
+ entire cluster. An initial system restart requires taking a
+ backup of the cluster, wiping the cluster filesystem after
+ shutdown, and then restoring from the backup following the
+ restart.
+ </para>
+
+ <para>
+ In any cluster restart, all of the cluster's management servers
+ must be restarted in order for them to read the updated
+ configuration parameter values.
+ </para>
+
+ <para>
+ <emphasis role="bold">Important</emphasis>: Values for numeric
+ cluster parameters can generally be increased without any
+ problems, although it is advisable to do so progressively,
+ making such adjustments in relatively small increments. However,
+ decreasing the values of such parameters — particularly
+ those relating to memory usage and disk space — is not to
+ be undertaken lightly, and it is recommended that you do so only
+ following careful planning and testing. In addition, it is the
+ generally the case that parameters relating to memory and disk
+ usage which can be raised using a simple node restart require an
+ initial node restart to be lowered.
+ </para>
+
+ <para>
Because some of these parameters can be used for configuring
more than one type of cluster node, they may appear in more than
- one of these summaries.
+ one of the tables.
</para>
<para>
@@ -6524,48 +6595,19 @@
<xref linkend="mysql-cluster-db-definition"/>.
</para>
-<!--
<para>
- The <emphasis role="bold">Restart Required</emphasis> column
- can have one of 3 values, whose meanings are as follows:
+ See <xref linkend="mysql-cluster-config-params-overview"/>,
+ for an explanation of the symbols used in the table.
</para>
- <itemizedlist>
-
- <listitem>
- <para>
- <literal>N</literal>: No restart is required to update the
- value of the parameter.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>Y</literal>: A simple restart is needed to update
- the parameter's value.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>I</literal>: An initial restart is necessary for
- updating the value of the parameter.
- </para>
- </listitem>
-
- </itemizedlist>
--->
-
<informaltable>
- <tgroup cols="5">
+ <tgroup cols="6">
<colspec colwidth="30*"/>
- <colspec colwidth="10*"/>
+ <colspec colwidth="5*"/>
<colspec colwidth="20*"/>
<colspec colwidth="20*"/>
<colspec colwidth="20*"/>
-<!--
<colspec colwidth="5*"/>
--->
<tbody>
<row>
<entry><emphasis role="bold">Parameter Name</emphasis></entry>
@@ -6573,9 +6615,7 @@
<entry><emphasis role="bold">Default Value</emphasis></entry>
<entry><emphasis role="bold">Minimum Value</emphasis></entry>
<entry><emphasis role="bold">Maximum Value</emphasis></entry>
-<!--
- <entry><emphasis role="bold">Restart Required</emphasis></entry>
--->
+ <entry><emphasis role="bold">Restart Type</emphasis></entry>
</row>
<row>
<entry><literal>ArbitrationTimeout</literal></entry>
@@ -6583,9 +6623,7 @@
<entry>1000</entry>
<entry>10</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>BackupDataBufferSize</literal></entry>
@@ -6593,9 +6631,7 @@
<entry>2M</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>BackupDataDir</literal></entry>
@@ -6603,9 +6639,7 @@
<entry><filename><literal>FileSystemPath</literal>/BACKUP</filename></entry>
<entry>N/A</entry>
<entry>N/A</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>BackupLogBufferSize</literal></entry>
@@ -6613,9 +6647,7 @@
<entry>2M</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>BackupMemory</literal></entry>
@@ -6623,9 +6655,7 @@
<entry>4M</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>BackupWriteSize</literal></entry>
@@ -6633,9 +6663,7 @@
<entry>32K</entry>
<entry>2K</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>BatchSizePerLocalScan</literal></entry>
@@ -6643,9 +6671,7 @@
<entry>64</entry>
<entry>1</entry>
<entry>992</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>DataDir</literal></entry>
@@ -6653,9 +6679,7 @@
<entry><filename>/var/lib/mysql-cluster</filename></entry>
<entry>N/A</entry>
<entry>N/A</entry>
-<!--
- <entry>N</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>DataMemory</literal></entry>
@@ -6664,9 +6688,7 @@
<entry>1M</entry>
<entry>1024G (subject to available system RAM and size of
<literal>IndexMemory</literal>)</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>Diskless</literal></entry>
@@ -6674,9 +6696,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>1</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IS</entry>
</row>
<row>
<entry><literal>ExecuteOnComputer</literal> — synonym for
@@ -6685,9 +6705,7 @@
<entry/>
<entry/>
<entry/>
-<!--
<entry/>
--->
</row>
<row>
<entry><literal>FileSystemPath</literal></entry>
@@ -6695,9 +6713,7 @@
<entry>value specified for <literal>DataDir</literal></entry>
<entry>N/A</entry>
<entry>N/A</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>HeartbeatIntervalDbApi</literal></entry>
@@ -6705,9 +6721,7 @@
<entry>1500</entry>
<entry>100</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>HeartbeatIntervalDbDb</literal></entry>
@@ -6715,9 +6729,7 @@
<entry>1500</entry>
<entry>10</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>HostName</literal></entry>
@@ -6725,9 +6737,7 @@
<entry><literal>localhost</literal></entry>
<entry>N/A</entry>
<entry>N/A</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>S</entry>
</row>
<row>
<entry><literal>Id</literal></entry>
@@ -6735,9 +6745,7 @@
<entry><emphasis>None</emphasis></entry>
<entry>1</entry>
<entry>63</entry>
-<!--
- <entry>Y</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>IndexMemory</literal></entry>
@@ -6746,9 +6754,7 @@
<entry>1M</entry>
<entry>1024G (subject to available system RAM and size of
<literal>DataMemory</literal>)</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>LockPagesInMainMemory</literal></entry>
@@ -6756,9 +6762,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>1</entry>
-<!--
- <entry>Y</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>LogDestination</literal></entry>
@@ -6767,9 +6771,7 @@
<entry>See <xref linkend="mysql-cluster-mgm-definition"/>.</entry>
<entry>N/A</entry>
<entry>N/A</entry>
-<!--
- <entry>Y</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>LogLevelCheckpoint</literal></entry>
@@ -6777,9 +6779,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>15</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>LogLevelConnection</literal></entry>
@@ -6787,9 +6787,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>15</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>LogLevelError</literal></entry>
@@ -6797,9 +6795,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>15</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>LogLevelInfo</literal></entry>
@@ -6807,9 +6803,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>15</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>LogLevelNodeRestart</literal></entry>
@@ -6817,9 +6811,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>15</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>LogLevelShutdown</literal></entry>
@@ -6827,9 +6819,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>15</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>LogLevelStartup</literal></entry>
@@ -6837,9 +6827,7 @@
<entry>1</entry>
<entry>0</entry>
<entry>15</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>LogLevelStatistic</literal></entry>
@@ -6847,9 +6835,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>15</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>LongMessageBuffer</literal></entry>
@@ -6857,9 +6843,7 @@
<entry>1M</entry>
<entry>512K</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfAttributes</literal></entry>
@@ -6867,9 +6851,7 @@
<entry>1000</entry>
<entry>32</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>MaxNoOfConcurrentIndexOperations</literal></entry>
@@ -6877,9 +6859,7 @@
<entry>8K</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfConcurrentOperations</literal></entry>
@@ -6887,9 +6867,7 @@
<entry>32768</entry>
<entry>32</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfConcurrentScans</literal></entry>
@@ -6897,9 +6875,7 @@
<entry>256</entry>
<entry>2</entry>
<entry>500</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfConcurrentTransactions</literal></entry>
@@ -6907,9 +6883,7 @@
<entry>4096</entry>
<entry>32</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>MaxNoOfFiredTriggers</literal></entry>
@@ -6917,9 +6891,7 @@
<entry>4000</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfIndexes</literal> (<emphasis>DEPRECATED</emphasis>
@@ -6930,9 +6902,7 @@
<entry>128</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>MaxNoOfLocalOperations</literal></entry>
@@ -6940,9 +6910,7 @@
<entry><literal>UNDEFINED</literal></entry>
<entry>32</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfLocalScans</literal></entry>
@@ -6950,9 +6918,7 @@
<entry><literal>UNDEFINED</literal></entry>
<entry>32</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfOrderedIndexes</literal></entry>
@@ -6960,9 +6926,7 @@
<entry>128</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>MaxNoOfSavedMessages</literal></entry>
@@ -6970,9 +6934,7 @@
<entry>25</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfTables</literal></entry>
@@ -6980,9 +6942,7 @@
<entry>128</entry>
<entry>8</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfTriggers</literal></entry>
@@ -6990,9 +6950,7 @@
<entry>768</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfUniqueHashIndexes</literal></entry>
@@ -7000,9 +6958,7 @@
<entry>64</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>NoOfDiskPagesToDiskAfterRestartACC</literal></entry>
@@ -7010,9 +6966,7 @@
<entry>20 (= 20 * 80KB = 1.6MB/second)</entry>
<entry>1</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>NoOfDiskPagesToDiskAfterRestartTUP</literal></entry>
@@ -7020,9 +6974,7 @@
<entry>40 (= 40 * 80KB = 3.2MB/second)</entry>
<entry>1</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>NoOfDiskPagesToDiskDuringRestartACC</literal></entry>
@@ -7030,9 +6982,7 @@
<entry>20 (= 20 * 80KB = 1.6MB/second)</entry>
<entry>1</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>NoOfDiskPagesToDiskDuringRestartTUP</literal></entry>
@@ -7040,9 +6990,7 @@
<entry>40 (= 40 * 80KB = 3.2MB/second)</entry>
<entry>1</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>NoOfFragmentLogFiles</literal></entry>
@@ -7050,9 +6998,7 @@
<entry>8</entry>
<entry>1</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>NoOfReplicas</literal></entry>
@@ -7060,9 +7006,7 @@
<entry><emphasis>None</emphasis></entry>
<entry>1</entry>
<entry>4</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IS</entry>
</row>
<row>
<entry><literal>PortNumber</literal></entry>
@@ -7070,9 +7014,7 @@
<entry>1186</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
<entry>N</entry>
--->
</row>
<row>
<entry><literal>RedoBuffer</literal></entry>
@@ -7080,9 +7022,7 @@
<entry>8M</entry>
<entry>1M</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>RestartOnErrorInsert</literal> (<emphasis>DEBUG BUILDS
@@ -7091,9 +7031,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>1</entry>
-<!--
- <entry>Y</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>StartFailureTimeout</literal></entry>
@@ -7101,9 +7039,7 @@
<entry>60000</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>StartPartialTimeout</literal></entry>
@@ -7111,9 +7047,7 @@
<entry>30000</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>StartPartitionedTimeout</literal></entry>
@@ -7121,9 +7055,7 @@
<entry>60000</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>StopOnError</literal></entry>
@@ -7131,9 +7063,7 @@
<entry>1</entry>
<entry>0</entry>
<entry>1</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>TimeBetweenGlobalCheckpoints</literal></entry>
@@ -7141,9 +7071,7 @@
<entry>2000</entry>
<entry>10</entry>
<entry>32000</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>TimeBetweenInactiveTransactionAbortCheck</literal></entry>
@@ -7151,9 +7079,7 @@
<entry>1000</entry>
<entry>1000</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>TimeBetweenLocalCheckpoints</literal></entry>
@@ -7162,9 +7088,7 @@
operations)</entry>
<entry>0</entry>
<entry>31</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>TimeBetweenWatchDogCheck</literal></entry>
@@ -7172,9 +7096,7 @@
<entry>4000</entry>
<entry>70</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>TransactionBufferMemory</literal></entry>
@@ -7182,9 +7104,7 @@
<entry>1M</entry>
<entry>1K</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>TransactionDeadlockDetectionTimeout</literal></entry>
@@ -7192,9 +7112,7 @@
<entry>1200</entry>
<entry>50</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>TransactionInactiveTimeout</literal></entry>
@@ -7202,9 +7120,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>UndoDataBuffer</literal></entry>
@@ -7212,9 +7128,7 @@
<entry>16M</entry>
<entry>1M</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>UndoIndexBuffer</literal></entry>
@@ -7222,9 +7136,7 @@
<entry>2M</entry>
<entry>1M</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
</tbody>
</tgroup>
@@ -7259,48 +7171,19 @@
<xref linkend="mysql-cluster-mgm-definition"/>.
</para>
-<!--
<para>
- The <emphasis role="bold">Restart Required</emphasis> column
- can have one of 3 values, whose meanings are as follows:
+ See <xref linkend="mysql-cluster-config-params-overview"/>,
+ for an explanation of the symbols used in the table.
</para>
- <itemizedlist>
-
- <listitem>
- <para>
- <literal>N</literal>: No restart is required to update the
- value of the parameter.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>Y</literal>: A simple restart is needed to update
- the parameter's value.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>I</literal>: An initial restart is necessary for
- updating the value of the parameter.
- </para>
- </listitem>
-
- </itemizedlist>
--->
-
<informaltable>
- <tgroup cols="5">
+ <tgroup cols="6">
<colspec colwidth="30*"/>
- <colspec colwidth="10*"/>
+ <colspec colwidth="5*"/>
<colspec colwidth="20*"/>
<colspec colwidth="20*"/>
<colspec colwidth="20*"/>
-<!--
<colspec colwidth="5*"/>
--->
<tbody>
<row>
<entry><emphasis role="bold">Parameter Name</emphasis></entry>
@@ -7308,9 +7191,7 @@
<entry><emphasis role="bold">Default Value</emphasis></entry>
<entry><emphasis role="bold">Minimum Value</emphasis></entry>
<entry><emphasis role="bold">Maximum Value</emphasis></entry>
-<!--
- <entry><emphasis role="bold">Restart Required</emphasis></entry>
--->
+ <entry><emphasis role="bold">Restart Type</emphasis></entry>
</row>
<row>
<entry><literal>ArbitrationDelay</literal></entry>
@@ -7318,9 +7199,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
<entry>N</entry>
--->
</row>
<row>
<entry><literal>ArbitrationRank</literal></entry>
@@ -7328,9 +7207,7 @@
<entry>1</entry>
<entry>0</entry>
<entry>2</entry>
-<!--
<entry>N</entry>
--->
</row>
<row>
<entry><literal>DataDir</literal></entry>
@@ -7338,9 +7215,7 @@
<entry>N/A</entry>
<entry>N/A</entry>
<entry>N/A</entry>
-<!--
- <entry>Y</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>ExecuteOnComputer</literal> — synonym for
@@ -7349,9 +7224,7 @@
<entry/>
<entry/>
<entry/>
-<!--
<entry/>
--->
</row>
<row>
<entry><literal>HostName</literal></entry>
@@ -7359,9 +7232,7 @@
<entry><literal>localhost</literal></entry>
<entry>N/A</entry>
<entry>N/A</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>Id</literal></entry>
@@ -7369,9 +7240,7 @@
<entry><emphasis>None</emphasis></entry>
<entry>1</entry>
<entry>63</entry>
-<!--
- <entry>N</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>LogDestination</literal></entry>
@@ -7380,9 +7249,7 @@
<entry>See <xref linkend="mysql-cluster-mgm-definition"/>.</entry>
<entry>N/A</entry>
<entry>N/A</entry>
-<!--
- <entry>Y</entry>
--->
+ <entry>N</entry>
</row>
</tbody>
</tgroup>
@@ -7412,48 +7279,19 @@
<xref linkend="mysql-cluster-api-definition"/>.
</para>
-<!--
<para>
- The <emphasis role="bold">Restart Required</emphasis> column
- can have one of 3 values, whose meanings are as follows:
+ See <xref linkend="mysql-cluster-config-params-overview"/>,
+ for an explanation of the symbols used in the table.
</para>
- <itemizedlist>
-
- <listitem>
- <para>
- <literal>N</literal>: No restart is required to update the
- value of the parameter.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>Y</literal>: A simple restart is needed to update
- the parameter's value.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>I</literal>: An initial restart is necessary for
- updating the value of the parameter.
- </para>
- </listitem>
-
- </itemizedlist>
--->
-
<informaltable>
- <tgroup cols="5">
+ <tgroup cols="6">
<colspec colwidth="30*"/>
- <colspec colwidth="10*"/>
+ <colspec colwidth="5*"/>
<colspec colwidth="20*"/>
<colspec colwidth="20*"/>
<colspec colwidth="20*"/>
-<!--
<colspec colwidth="5*"/>
--->
<tbody>
<row>
<entry><emphasis role="bold">Parameter Name</emphasis></entry>
@@ -7461,9 +7299,7 @@
<entry><emphasis role="bold">Default Value</emphasis></entry>
<entry><emphasis role="bold">Minimum Value</emphasis></entry>
<entry><emphasis role="bold">Maximum Value</emphasis></entry>
-<!--
- <entry><emphasis role="bold">Restart Required</emphasis></entry>
--->
+ <entry><emphasis role="bold">Restart Type</emphasis></entry>
</row>
<row>
<entry><literal>ArbitrationDelay</literal></entry>
@@ -7471,9 +7307,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
<entry>N</entry>
--->
</row>
<row>
<entry><literal>ArbitrationRank</literal></entry>
@@ -7481,9 +7315,7 @@
<entry>1</entry>
<entry>0</entry>
<entry>2</entry>
-<!--
<entry>N</entry>
--->
</row>
<row>
<entry><literal>BatchByteSize</literal></entry>
@@ -7491,9 +7323,7 @@
<entry>32K</entry>
<entry>1K</entry>
<entry>1M</entry>
-<!--
<entry>N</entry>
--->
</row>
<row>
<entry><literal>BatchSize</literal></entry>
@@ -7501,9 +7331,7 @@
<entry>64</entry>
<entry>1</entry>
<entry>992</entry>
-<!--
<entry>N</entry>
--->
</row>
<row>
<entry><literal>ExecuteOnComputer</literal> — synonym for
@@ -7512,9 +7340,7 @@
<entry/>
<entry/>
<entry/>
-<!--
<entry/>
--->
</row>
<row>
<entry><literal>HostName</literal></entry>
@@ -7522,9 +7348,7 @@
<entry><literal>localhost</literal></entry>
<entry>N/A</entry>
<entry>N/A</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>Id</literal></entry>
@@ -7532,9 +7356,7 @@
<entry><emphasis>None</emphasis></entry>
<entry>1</entry>
<entry>63</entry>
-<!--
- <entry>N</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>MaxScanBatchSize</literal></entry>
@@ -7542,9 +7364,7 @@
<entry>256K</entry>
<entry>32K</entry>
<entry>16M</entry>
-<!--
<entry>N</entry>
--->
</row>
</tbody>
</tgroup>
Modified: trunk/refman-5.0/mysql-cluster.xml
===================================================================
--- trunk/refman-5.0/mysql-cluster.xml 2006-07-13 10:55:47 UTC (rev 2724)
+++ trunk/refman-5.0/mysql-cluster.xml 2006-07-13 10:57:48 UTC (rev 2725)
Changed blocks: 86, Lines Added: 165, Lines Deleted: 345; 36940 bytes
@@ -6481,32 +6481,103 @@
<secondary>MySQL Cluster</secondary>
</indexterm>
- <remark role="todo">
- [js] Uncomment references to restarts once that info has been
- filled in.
+ <remark role="note">
+ [js] Prepared with the assistance of Johan Andersson, Hartmut
+ Holzgraefe, Sergei Kozlov, Jeb Miller, and Bernd Ocklin.
</remark>
<para>
- The next three sections provide summaries of MySQL Cluster
+ The next three sections provide summary tables of MySQL Cluster
configuration parameters used in the
<filename>config.ini</filename> file to govern the cluster's
- functioning. Each section lists the parameters for one of the
+ functioning. Each table lists the parameters for one of the
Cluster node process types (<command>ndbd</command>,
<command>ndb_mgmd</command>, and <command>mysqld</command>), and
includes the parameter's type as well as its default, mimimum,
and maximum values as applicable.
+ </para>
-<!--
- It is also stated whether a
- restart or initial restart of the cluster is required to change
- the value of a given configuration parameter.
--->
+ <para>
+ It is also stated what type of restart is required (node restart
+ or system restart) — and whether the restart must be done
+ with <option>--initial</option> — to change the value of a
+ given configuration parameter. This information is provided in
+ each table's <emphasis role="bold">Restart Type</emphasis>
+ column, which contains one of the values shown in this list:
</para>
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>N</literal>: Node Restart
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>IN</literal>: Initial Node Restart
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>S</literal>: System Restart
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>IS</literal>: Initial System Restart
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
<para>
+ When performing a node restart or an initial node restart, all
+ of the cluster's data nodes must be restarted in turn (also
+ referred to as a <firstterm>rolling restart</firstterm>). It is
+ possible to update cluster configuration parameters marked
+ <literal>N</literal> or <literal>IN</literal> online —
+ that is, without shutting down the cluster — in this
+ fashion. An initial node restart requires restarting each
+ <command>ndbd</command> process with the
+ <option>--initial</option> option.
+ </para>
+
+ <para>
+ A system restart requires a complete shutdown and restart of the
+ entire cluster. An initial system restart requires taking a
+ backup of the cluster, wiping the cluster filesystem after
+ shutdown, and then restoring from the backup following the
+ restart.
+ </para>
+
+ <para>
+ In any cluster restart, all of the cluster's management servers
+ must be restarted in order for them to read the updated
+ configuration parameter values.
+ </para>
+
+ <para>
+ <emphasis role="bold">Important</emphasis>: Values for numeric
+ cluster parameters can generally be increased without any
+ problems, although it is advisable to do so progressively,
+ making such adjustments in relatively small increments. However,
+ decreasing the values of such parameters — particularly
+ those relating to memory usage and disk space — is not to
+ be undertaken lightly, and it is recommended that you do so only
+ following careful planning and testing. In addition, it is the
+ generally the case that parameters relating to memory and disk
+ usage which can be raised using a simple node restart require an
+ initial node restart to be lowered.
+ </para>
+
+ <para>
Because some of these parameters can be used for configuring
more than one type of cluster node, they may appear in more than
- one of these summaries.
+ one of the tables.
</para>
<para>
@@ -6543,48 +6614,19 @@
<xref linkend="mysql-cluster-db-definition"/>.
</para>
-<!--
<para>
- The <emphasis role="bold">Restart Required</emphasis> column
- can have one of 3 values, whose meanings are as follows:
+ See <xref linkend="mysql-cluster-config-params-overview"/>,
+ for an explanation of the symbols used in the table.
</para>
- <itemizedlist>
-
- <listitem>
- <para>
- <literal>N</literal>: No restart is required to update the
- value of the parameter.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>Y</literal>: A simple restart is needed to update
- the parameter's value.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>I</literal>: An initial restart is necessary for
- updating the value of the parameter.
- </para>
- </listitem>
-
- </itemizedlist>
--->
-
<informaltable>
- <tgroup cols="5">
+ <tgroup cols="6">
<colspec colwidth="30*"/>
- <colspec colwidth="10*"/>
+ <colspec colwidth="5*"/>
<colspec colwidth="20*"/>
<colspec colwidth="20*"/>
<colspec colwidth="20*"/>
-<!--
<colspec colwidth="5*"/>
--->
<tbody>
<row>
<entry><emphasis role="bold">Parameter Name</emphasis></entry>
@@ -6592,9 +6634,7 @@
<entry><emphasis role="bold">Default Value</emphasis></entry>
<entry><emphasis role="bold">Minimum Value</emphasis></entry>
<entry><emphasis role="bold">Maximum Value</emphasis></entry>
-<!--
- <entry><emphasis role="bold">Restart Required</emphasis></entry>
--->
+ <entry><emphasis role="bold">Restart Type</emphasis></entry>
</row>
<row>
<entry><literal>ArbitrationTimeout</literal></entry>
@@ -6602,9 +6642,7 @@
<entry>1000</entry>
<entry>10</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>BackupDataBufferSize</literal></entry>
@@ -6612,9 +6650,7 @@
<entry>2M</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>BackupDataDir</literal></entry>
@@ -6622,9 +6658,7 @@
<entry><filename><literal>FileSystemPath</literal>/BACKUP</filename></entry>
<entry>N/A</entry>
<entry>N/A</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>BackupLogBufferSize</literal></entry>
@@ -6632,9 +6666,7 @@
<entry>2M</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>BackupMemory</literal></entry>
@@ -6642,9 +6674,7 @@
<entry>4M</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>BackupWriteSize</literal></entry>
@@ -6652,9 +6682,7 @@
<entry>32K</entry>
<entry>2K</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>BatchSizePerLocalScan</literal></entry>
@@ -6662,9 +6690,7 @@
<entry>64</entry>
<entry>1</entry>
<entry>992</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>DataDir</literal></entry>
@@ -6672,9 +6698,7 @@
<entry><filename>/var/lib/mysql-cluster</filename></entry>
<entry>N/A</entry>
<entry>N/A</entry>
-<!--
- <entry>N</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>DataMemory</literal></entry>
@@ -6683,9 +6707,7 @@
<entry>1M</entry>
<entry>1024G (subject to available system RAM and size of
<literal>IndexMemory</literal>)</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>Diskless</literal></entry>
@@ -6693,9 +6715,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>1</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IS</entry>
</row>
<row>
<entry><literal>ExecuteOnComputer</literal> — synonym for
@@ -6704,9 +6724,7 @@
<entry/>
<entry/>
<entry/>
-<!--
<entry/>
--->
</row>
<row>
<entry><literal>FileSystemPath</literal></entry>
@@ -6714,9 +6732,7 @@
<entry>value specified for <literal>DataDir</literal></entry>
<entry>N/A</entry>
<entry>N/A</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>HeartbeatIntervalDbApi</literal></entry>
@@ -6724,9 +6740,7 @@
<entry>1500</entry>
<entry>100</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>HeartbeatIntervalDbDb</literal></entry>
@@ -6734,9 +6748,7 @@
<entry>1500</entry>
<entry>10</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>HostName</literal></entry>
@@ -6744,9 +6756,7 @@
<entry><literal>localhost</literal></entry>
<entry>N/A</entry>
<entry>N/A</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>S</entry>
</row>
<row>
<entry><literal>Id</literal></entry>
@@ -6754,9 +6764,7 @@
<entry><emphasis>None</emphasis></entry>
<entry>1</entry>
<entry>63</entry>
-<!--
- <entry>Y</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>IndexMemory</literal></entry>
@@ -6765,9 +6773,7 @@
<entry>1M</entry>
<entry>1024G (subject to available system RAM and size of
<literal>DataMemory</literal>)</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>LockPagesInMainMemory</literal></entry>
@@ -6775,9 +6781,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>1</entry>
-<!--
- <entry>Y</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>LogDestination</literal></entry>
@@ -6786,9 +6790,7 @@
<entry>See <xref linkend="mysql-cluster-mgm-definition"/>.</entry>
<entry>N/A</entry>
<entry>N/A</entry>
-<!--
- <entry>Y</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>LogLevelCheckpoint</literal></entry>
@@ -6796,9 +6798,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>15</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>LogLevelConnection</literal></entry>
@@ -6806,9 +6806,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>15</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>LogLevelError</literal></entry>
@@ -6816,9 +6814,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>15</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>LogLevelInfo</literal></entry>
@@ -6826,9 +6822,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>15</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>LogLevelNodeRestart</literal></entry>
@@ -6836,9 +6830,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>15</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>LogLevelShutdown</literal></entry>
@@ -6846,9 +6838,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>15</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>LogLevelStartup</literal></entry>
@@ -6856,9 +6846,7 @@
<entry>1</entry>
<entry>0</entry>
<entry>15</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>LogLevelStatistic</literal></entry>
@@ -6866,9 +6854,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>15</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>LongMessageBuffer</literal></entry>
@@ -6876,9 +6862,7 @@
<entry>1M</entry>
<entry>512K</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfAttributes</literal></entry>
@@ -6886,9 +6870,7 @@
<entry>1000</entry>
<entry>32</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>MaxNoOfConcurrentIndexOperations</literal></entry>
@@ -6896,9 +6878,7 @@
<entry>8K</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfConcurrentOperations</literal></entry>
@@ -6906,9 +6886,7 @@
<entry>32768</entry>
<entry>32</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfConcurrentScans</literal></entry>
@@ -6916,9 +6894,7 @@
<entry>256</entry>
<entry>2</entry>
<entry>500</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfConcurrentTransactions</literal></entry>
@@ -6926,9 +6902,7 @@
<entry>4096</entry>
<entry>32</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>MaxNoOfFiredTriggers</literal></entry>
@@ -6936,9 +6910,7 @@
<entry>4000</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfIndexes</literal> (<emphasis>DEPRECATED</emphasis>
@@ -6949,9 +6921,7 @@
<entry>128</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>MaxNoOfLocalOperations</literal></entry>
@@ -6959,9 +6929,7 @@
<entry><literal>UNDEFINED</literal></entry>
<entry>32</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfLocalScans</literal></entry>
@@ -6969,9 +6937,7 @@
<entry><literal>UNDEFINED</literal></entry>
<entry>32</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfOrderedIndexes</literal></entry>
@@ -6979,9 +6945,7 @@
<entry>128</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>MaxNoOfSavedMessages</literal></entry>
@@ -6989,9 +6953,7 @@
<entry>25</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfTables</literal></entry>
@@ -6999,9 +6961,7 @@
<entry>128</entry>
<entry>8</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfTriggers</literal></entry>
@@ -7009,9 +6969,7 @@
<entry>768</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfUniqueHashIndexes</literal></entry>
@@ -7019,9 +6977,7 @@
<entry>64</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>NoOfDiskPagesToDiskAfterRestartACC</literal></entry>
@@ -7029,9 +6985,7 @@
<entry>20 (= 20 * 80KB = 1.6MB/second)</entry>
<entry>1</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>NoOfDiskPagesToDiskAfterRestartTUP</literal></entry>
@@ -7039,9 +6993,7 @@
<entry>40 (= 40 * 80KB = 3.2MB/second)</entry>
<entry>1</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>NoOfDiskPagesToDiskDuringRestartACC</literal></entry>
@@ -7049,9 +7001,7 @@
<entry>20 (= 20 * 80KB = 1.6MB/second)</entry>
<entry>1</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>NoOfDiskPagesToDiskDuringRestartTUP</literal></entry>
@@ -7059,9 +7009,7 @@
<entry>40 (= 40 * 80KB = 3.2MB/second)</entry>
<entry>1</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>NoOfFragmentLogFiles</literal></entry>
@@ -7069,9 +7017,7 @@
<entry>8</entry>
<entry>1</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>NoOfReplicas</literal></entry>
@@ -7079,9 +7025,7 @@
<entry><emphasis>None</emphasis></entry>
<entry>1</entry>
<entry>4</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IS</entry>
</row>
<row>
<entry><literal>PortNumber</literal></entry>
@@ -7089,9 +7033,7 @@
<entry>1186</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
<entry>N</entry>
--->
</row>
<row>
<entry><literal>RedoBuffer</literal></entry>
@@ -7099,9 +7041,7 @@
<entry>8M</entry>
<entry>1M</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>RestartOnErrorInsert</literal> (<emphasis>DEBUG BUILDS
@@ -7110,9 +7050,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>1</entry>
-<!--
- <entry>Y</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>StartFailureTimeout</literal></entry>
@@ -7120,9 +7058,7 @@
<entry>60000</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>StartPartialTimeout</literal></entry>
@@ -7130,9 +7066,7 @@
<entry>30000</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>StartPartitionedTimeout</literal></entry>
@@ -7140,9 +7074,7 @@
<entry>60000</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>StopOnError</literal></entry>
@@ -7150,9 +7082,7 @@
<entry>1</entry>
<entry>0</entry>
<entry>1</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>TimeBetweenGlobalCheckpoints</literal></entry>
@@ -7160,9 +7090,7 @@
<entry>2000</entry>
<entry>10</entry>
<entry>32000</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>TimeBetweenInactiveTransactionAbortCheck</literal></entry>
@@ -7170,9 +7098,7 @@
<entry>1000</entry>
<entry>1000</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>TimeBetweenLocalCheckpoints</literal></entry>
@@ -7181,9 +7107,7 @@
operations)</entry>
<entry>0</entry>
<entry>31</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>TimeBetweenWatchDogCheck</literal></entry>
@@ -7191,9 +7115,7 @@
<entry>4000</entry>
<entry>70</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>TransactionBufferMemory</literal></entry>
@@ -7201,9 +7123,7 @@
<entry>1M</entry>
<entry>1K</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>TransactionDeadlockDetectionTimeout</literal></entry>
@@ -7211,9 +7131,7 @@
<entry>1200</entry>
<entry>50</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>TransactionInactiveTimeout</literal></entry>
@@ -7221,9 +7139,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>UndoDataBuffer</literal></entry>
@@ -7231,9 +7147,7 @@
<entry>16M</entry>
<entry>1M</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>UndoIndexBuffer</literal></entry>
@@ -7241,9 +7155,7 @@
<entry>2M</entry>
<entry>1M</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
</tbody>
</tgroup>
@@ -7278,48 +7190,19 @@
<xref linkend="mysql-cluster-mgm-definition"/>.
</para>
-<!--
<para>
- The <emphasis role="bold">Restart Required</emphasis> column
- can have one of 3 values, whose meanings are as follows:
+ See <xref linkend="mysql-cluster-config-params-overview"/>,
+ for an explanation of the symbols used in the table.
</para>
- <itemizedlist>
-
- <listitem>
- <para>
- <literal>N</literal>: No restart is required to update the
- value of the parameter.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>Y</literal>: A simple restart is needed to update
- the parameter's value.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>I</literal>: An initial restart is necessary for
- updating the value of the parameter.
- </para>
- </listitem>
-
- </itemizedlist>
--->
-
<informaltable>
- <tgroup cols="5">
+ <tgroup cols="6">
<colspec colwidth="30*"/>
- <colspec colwidth="10*"/>
+ <colspec colwidth="5*"/>
<colspec colwidth="20*"/>
<colspec colwidth="20*"/>
<colspec colwidth="20*"/>
-<!--
<colspec colwidth="5*"/>
--->
<tbody>
<row>
<entry><emphasis role="bold">Parameter Name</emphasis></entry>
@@ -7327,9 +7210,7 @@
<entry><emphasis role="bold">Default Value</emphasis></entry>
<entry><emphasis role="bold">Minimum Value</emphasis></entry>
<entry><emphasis role="bold">Maximum Value</emphasis></entry>
-<!--
- <entry><emphasis role="bold">Restart Required</emphasis></entry>
--->
+ <entry><emphasis role="bold">Restart Type</emphasis></entry>
</row>
<row>
<entry><literal>ArbitrationDelay</literal></entry>
@@ -7337,9 +7218,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
<entry>N</entry>
--->
</row>
<row>
<entry><literal>ArbitrationRank</literal></entry>
@@ -7347,9 +7226,7 @@
<entry>1</entry>
<entry>0</entry>
<entry>2</entry>
-<!--
<entry>N</entry>
--->
</row>
<row>
<entry><literal>DataDir</literal></entry>
@@ -7357,9 +7234,7 @@
<entry>N/A</entry>
<entry>N/A</entry>
<entry>N/A</entry>
-<!--
- <entry>Y</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>ExecuteOnComputer</literal> — synonym for
@@ -7368,9 +7243,7 @@
<entry/>
<entry/>
<entry/>
-<!--
<entry/>
--->
</row>
<row>
<entry><literal>HostName</literal></entry>
@@ -7378,9 +7251,7 @@
<entry><literal>localhost</literal></entry>
<entry>N/A</entry>
<entry>N/A</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>Id</literal></entry>
@@ -7388,9 +7259,7 @@
<entry><emphasis>None</emphasis></entry>
<entry>1</entry>
<entry>63</entry>
-<!--
- <entry>N</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>LogDestination</literal></entry>
@@ -7399,9 +7268,7 @@
<entry>See <xref linkend="mysql-cluster-mgm-definition"/>.</entry>
<entry>N/A</entry>
<entry>N/A</entry>
-<!--
- <entry>Y</entry>
--->
+ <entry>N</entry>
</row>
</tbody>
</tgroup>
@@ -7431,48 +7298,19 @@
<xref linkend="mysql-cluster-api-definition"/>.
</para>
-<!--
<para>
- The <emphasis role="bold">Restart Required</emphasis> column
- can have one of 3 values, whose meanings are as follows:
+ See <xref linkend="mysql-cluster-config-params-overview"/>,
+ for an explanation of the symbols used in the table.
</para>
- <itemizedlist>
-
- <listitem>
- <para>
- <literal>N</literal>: No restart is required to update the
- value of the parameter.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>Y</literal>: A simple restart is needed to update
- the parameter's value.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>I</literal>: An initial restart is necessary for
- updating the value of the parameter.
- </para>
- </listitem>
-
- </itemizedlist>
--->
-
<informaltable>
- <tgroup cols="5">
+ <tgroup cols="6">
<colspec colwidth="30*"/>
- <colspec colwidth="10*"/>
+ <colspec colwidth="5*"/>
<colspec colwidth="20*"/>
<colspec colwidth="20*"/>
<colspec colwidth="20*"/>
-<!--
<colspec colwidth="5*"/>
--->
<tbody>
<row>
<entry><emphasis role="bold">Parameter Name</emphasis></entry>
@@ -7480,9 +7318,7 @@
<entry><emphasis role="bold">Default Value</emphasis></entry>
<entry><emphasis role="bold">Minimum Value</emphasis></entry>
<entry><emphasis role="bold">Maximum Value</emphasis></entry>
-<!--
- <entry><emphasis role="bold">Restart Required</emphasis></entry>
--->
+ <entry><emphasis role="bold">Restart Type</emphasis></entry>
</row>
<row>
<entry><literal>ArbitrationDelay</literal></entry>
@@ -7490,9 +7326,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
<entry>N</entry>
--->
</row>
<row>
<entry><literal>ArbitrationRank</literal></entry>
@@ -7500,9 +7334,7 @@
<entry>1</entry>
<entry>0</entry>
<entry>2</entry>
-<!--
<entry>N</entry>
--->
</row>
<row>
<entry><literal>BatchByteSize</literal></entry>
@@ -7510,9 +7342,7 @@
<entry>32K</entry>
<entry>1K</entry>
<entry>1M</entry>
-<!--
<entry>N</entry>
--->
</row>
<row>
<entry><literal>BatchSize</literal></entry>
@@ -7520,9 +7350,7 @@
<entry>64</entry>
<entry>1</entry>
<entry>992</entry>
-<!--
<entry>N</entry>
--->
</row>
<row>
<entry><literal>ExecuteOnComputer</literal> — synonym for
@@ -7531,9 +7359,7 @@
<entry/>
<entry/>
<entry/>
-<!--
<entry/>
--->
</row>
<row>
<entry><literal>HostName</literal></entry>
@@ -7541,9 +7367,7 @@
<entry><literal>localhost</literal></entry>
<entry>N/A</entry>
<entry>N/A</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>Id</literal></entry>
@@ -7551,9 +7375,7 @@
<entry><emphasis>None</emphasis></entry>
<entry>1</entry>
<entry>63</entry>
-<!--
- <entry>N</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>MaxScanBatchSize</literal></entry>
@@ -7561,9 +7383,7 @@
<entry>256K</entry>
<entry>32K</entry>
<entry>16M</entry>
-<!--
<entry>N</entry>
--->
</row>
</tbody>
</tgroup>
Modified: trunk/refman-5.1/mysql-cluster.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster.xml 2006-07-13 10:55:47 UTC (rev 2724)
+++ trunk/refman-5.1/mysql-cluster.xml 2006-07-13 10:57:48 UTC (rev 2725)
Changed blocks: 86, Lines Added: 165, Lines Deleted: 345; 36940 bytes
@@ -6482,32 +6482,103 @@
<secondary>MySQL Cluster</secondary>
</indexterm>
- <remark role="todo">
- [js] Uncomment references to restarts once that info has been
- filled in.
+ <remark role="note">
+ [js] Prepared with the assistance of Johan Andersson, Hartmut
+ Holzgraefe, Sergei Kozlov, Jeb Miller, and Bernd Ocklin.
</remark>
<para>
- The next three sections provide summaries of MySQL Cluster
+ The next three sections provide summary tables of MySQL Cluster
configuration parameters used in the
<filename>config.ini</filename> file to govern the cluster's
- functioning. Each section lists the parameters for one of the
+ functioning. Each table lists the parameters for one of the
Cluster node process types (<command>ndbd</command>,
<command>ndb_mgmd</command>, and <command>mysqld</command>), and
includes the parameter's type as well as its default, mimimum,
and maximum values as applicable.
+ </para>
-<!--
- It is also stated whether a
- restart or initial restart of the cluster is required to change
- the value of a given configuration parameter.
--->
+ <para>
+ It is also stated what type of restart is required (node restart
+ or system restart) — and whether the restart must be done
+ with <option>--initial</option> — to change the value of a
+ given configuration parameter. This information is provided in
+ each table's <emphasis role="bold">Restart Type</emphasis>
+ column, which contains one of the values shown in this list:
</para>
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>N</literal>: Node Restart
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>IN</literal>: Initial Node Restart
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>S</literal>: System Restart
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>IS</literal>: Initial System Restart
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
<para>
+ When performing a node restart or an initial node restart, all
+ of the cluster's data nodes must be restarted in turn (also
+ referred to as a <firstterm>rolling restart</firstterm>). It is
+ possible to update cluster configuration parameters marked
+ <literal>N</literal> or <literal>IN</literal> online —
+ that is, without shutting down the cluster — in this
+ fashion. An initial node restart requires restarting each
+ <command>ndbd</command> process with the
+ <option>--initial</option> option.
+ </para>
+
+ <para>
+ A system restart requires a complete shutdown and restart of the
+ entire cluster. An initial system restart requires taking a
+ backup of the cluster, wiping the cluster filesystem after
+ shutdown, and then restoring from the backup following the
+ restart.
+ </para>
+
+ <para>
+ In any cluster restart, all of the cluster's management servers
+ must be restarted in order for them to read the updated
+ configuration parameter values.
+ </para>
+
+ <para>
+ <emphasis role="bold">Important</emphasis>: Values for numeric
+ cluster parameters can generally be increased without any
+ problems, although it is advisable to do so progressively,
+ making such adjustments in relatively small increments. However,
+ decreasing the values of such parameters — particularly
+ those relating to memory usage and disk space — is not to
+ be undertaken lightly, and it is recommended that you do so only
+ following careful planning and testing. In addition, it is the
+ generally the case that parameters relating to memory and disk
+ usage which can be raised using a simple node restart require an
+ initial node restart to be lowered.
+ </para>
+
+ <para>
Because some of these parameters can be used for configuring
more than one type of cluster node, they may appear in more than
- one of these summaries.
+ one of the tables.
</para>
<para>
@@ -6544,48 +6615,19 @@
<xref linkend="mysql-cluster-db-definition"/>.
</para>
-<!--
<para>
- The <emphasis role="bold">Restart Required</emphasis> column
- can have one of 3 values, whose meanings are as follows:
+ See <xref linkend="mysql-cluster-config-params-overview"/>,
+ for an explanation of the symbols used in the table.
</para>
- <itemizedlist>
-
- <listitem>
- <para>
- <literal>N</literal>: No restart is required to update the
- value of the parameter.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>Y</literal>: A simple restart is needed to update
- the parameter's value.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>I</literal>: An initial restart is necessary for
- updating the value of the parameter.
- </para>
- </listitem>
-
- </itemizedlist>
--->
-
<informaltable>
- <tgroup cols="5">
+ <tgroup cols="6">
<colspec colwidth="30*"/>
- <colspec colwidth="10*"/>
+ <colspec colwidth="5*"/>
<colspec colwidth="20*"/>
<colspec colwidth="20*"/>
<colspec colwidth="20*"/>
-<!--
<colspec colwidth="5*"/>
--->
<tbody>
<row>
<entry><emphasis role="bold">Parameter Name</emphasis></entry>
@@ -6593,9 +6635,7 @@
<entry><emphasis role="bold">Default Value</emphasis></entry>
<entry><emphasis role="bold">Minimum Value</emphasis></entry>
<entry><emphasis role="bold">Maximum Value</emphasis></entry>
-<!--
- <entry><emphasis role="bold">Restart Required</emphasis></entry>
--->
+ <entry><emphasis role="bold">Restart Type</emphasis></entry>
</row>
<row>
<entry><literal>ArbitrationTimeout</literal></entry>
@@ -6603,9 +6643,7 @@
<entry>1000</entry>
<entry>10</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>BackupDataBufferSize</literal></entry>
@@ -6613,9 +6651,7 @@
<entry>2M</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>BackupDataDir</literal></entry>
@@ -6623,9 +6659,7 @@
<entry><filename><literal>FileSystemPath</literal>/BACKUP</filename></entry>
<entry>N/A</entry>
<entry>N/A</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>BackupLogBufferSize</literal></entry>
@@ -6633,9 +6667,7 @@
<entry>2M</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>BackupMemory</literal></entry>
@@ -6643,9 +6675,7 @@
<entry>4M</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>BackupWriteSize</literal></entry>
@@ -6653,9 +6683,7 @@
<entry>32K</entry>
<entry>2K</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>BatchSizePerLocalScan</literal></entry>
@@ -6663,9 +6691,7 @@
<entry>64</entry>
<entry>1</entry>
<entry>992</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>DataDir</literal></entry>
@@ -6673,9 +6699,7 @@
<entry><filename>/var/lib/mysql-cluster</filename></entry>
<entry>N/A</entry>
<entry>N/A</entry>
-<!--
- <entry>N</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>DataMemory</literal></entry>
@@ -6684,9 +6708,7 @@
<entry>1M</entry>
<entry>1024G (subject to available system RAM and size of
<literal>IndexMemory</literal>)</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>Diskless</literal></entry>
@@ -6694,9 +6716,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>1</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IS</entry>
</row>
<row>
<entry><literal>ExecuteOnComputer</literal> — synonym for
@@ -6705,9 +6725,7 @@
<entry/>
<entry/>
<entry/>
-<!--
<entry/>
--->
</row>
<row>
<entry><literal>FileSystemPath</literal></entry>
@@ -6715,9 +6733,7 @@
<entry>value specified for <literal>DataDir</literal></entry>
<entry>N/A</entry>
<entry>N/A</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>HeartbeatIntervalDbApi</literal></entry>
@@ -6725,9 +6741,7 @@
<entry>1500</entry>
<entry>100</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>HeartbeatIntervalDbDb</literal></entry>
@@ -6735,9 +6749,7 @@
<entry>1500</entry>
<entry>10</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>HostName</literal></entry>
@@ -6745,9 +6757,7 @@
<entry><literal>localhost</literal></entry>
<entry>N/A</entry>
<entry>N/A</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>S</entry>
</row>
<row>
<entry><literal>Id</literal></entry>
@@ -6755,9 +6765,7 @@
<entry><emphasis>None</emphasis></entry>
<entry>1</entry>
<entry>63</entry>
-<!--
- <entry>Y</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>IndexMemory</literal></entry>
@@ -6766,9 +6774,7 @@
<entry>1M</entry>
<entry>1024G (subject to available system RAM and size of
<literal>DataMemory</literal>)</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>LockPagesInMainMemory</literal></entry>
@@ -6776,9 +6782,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>1</entry>
-<!--
- <entry>Y</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>LogDestination</literal></entry>
@@ -6787,9 +6791,7 @@
<entry>See <xref linkend="mysql-cluster-mgm-definition"/>.</entry>
<entry>N/A</entry>
<entry>N/A</entry>
-<!--
- <entry>Y</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>LogLevelCheckpoint</literal></entry>
@@ -6797,9 +6799,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>15</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>LogLevelConnection</literal></entry>
@@ -6807,9 +6807,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>15</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>LogLevelError</literal></entry>
@@ -6817,9 +6815,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>15</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>LogLevelInfo</literal></entry>
@@ -6827,9 +6823,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>15</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>LogLevelNodeRestart</literal></entry>
@@ -6837,9 +6831,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>15</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>LogLevelShutdown</literal></entry>
@@ -6847,9 +6839,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>15</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>LogLevelStartup</literal></entry>
@@ -6857,9 +6847,7 @@
<entry>1</entry>
<entry>0</entry>
<entry>15</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>LogLevelStatistic</literal></entry>
@@ -6867,9 +6855,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>15</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>LongMessageBuffer</literal></entry>
@@ -6877,9 +6863,7 @@
<entry>1M</entry>
<entry>512K</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfAttributes</literal></entry>
@@ -6887,9 +6871,7 @@
<entry>1000</entry>
<entry>32</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>MaxNoOfConcurrentIndexOperations</literal></entry>
@@ -6897,9 +6879,7 @@
<entry>8K</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfConcurrentOperations</literal></entry>
@@ -6907,9 +6887,7 @@
<entry>32768</entry>
<entry>32</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfConcurrentScans</literal></entry>
@@ -6917,9 +6895,7 @@
<entry>256</entry>
<entry>2</entry>
<entry>500</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfConcurrentTransactions</literal></entry>
@@ -6927,9 +6903,7 @@
<entry>4096</entry>
<entry>32</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>MaxNoOfFiredTriggers</literal></entry>
@@ -6937,9 +6911,7 @@
<entry>4000</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfIndexes</literal> (<emphasis>DEPRECATED</emphasis>
@@ -6950,9 +6922,7 @@
<entry>128</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>MaxNoOfLocalOperations</literal></entry>
@@ -6960,9 +6930,7 @@
<entry><literal>UNDEFINED</literal></entry>
<entry>32</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfLocalScans</literal></entry>
@@ -6970,9 +6938,7 @@
<entry><literal>UNDEFINED</literal></entry>
<entry>32</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfOrderedIndexes</literal></entry>
@@ -6980,9 +6946,7 @@
<entry>128</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>MaxNoOfSavedMessages</literal></entry>
@@ -6990,9 +6954,7 @@
<entry>25</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfTables</literal></entry>
@@ -7000,9 +6962,7 @@
<entry>128</entry>
<entry>8</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfTriggers</literal></entry>
@@ -7010,9 +6970,7 @@
<entry>768</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>MaxNoOfUniqueHashIndexes</literal></entry>
@@ -7020,9 +6978,7 @@
<entry>64</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>NoOfDiskPagesToDiskAfterRestartACC</literal></entry>
@@ -7030,9 +6986,7 @@
<entry>20 (= 20 * 80KB = 1.6MB/second)</entry>
<entry>1</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>NoOfDiskPagesToDiskAfterRestartTUP</literal></entry>
@@ -7040,9 +6994,7 @@
<entry>40 (= 40 * 80KB = 3.2MB/second)</entry>
<entry>1</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>NoOfDiskPagesToDiskDuringRestartACC</literal></entry>
@@ -7050,9 +7002,7 @@
<entry>20 (= 20 * 80KB = 1.6MB/second)</entry>
<entry>1</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>NoOfDiskPagesToDiskDuringRestartTUP</literal></entry>
@@ -7060,9 +7010,7 @@
<entry>40 (= 40 * 80KB = 3.2MB/second)</entry>
<entry>1</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>NoOfFragmentLogFiles</literal></entry>
@@ -7070,9 +7018,7 @@
<entry>8</entry>
<entry>1</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>NoOfReplicas</literal></entry>
@@ -7080,9 +7026,7 @@
<entry><emphasis>None</emphasis></entry>
<entry>1</entry>
<entry>4</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IS</entry>
</row>
<row>
<entry><literal>PortNumber</literal></entry>
@@ -7090,9 +7034,7 @@
<entry>1186</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
<entry>N</entry>
--->
</row>
<row>
<entry><literal>RedoBuffer</literal></entry>
@@ -7100,9 +7042,7 @@
<entry>8M</entry>
<entry>1M</entry>
<entry>4294967039</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>RestartOnErrorInsert</literal> (<emphasis>DEBUG BUILDS
@@ -7111,9 +7051,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>1</entry>
-<!--
- <entry>Y</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>StartFailureTimeout</literal></entry>
@@ -7121,9 +7059,7 @@
<entry>60000</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>StartPartialTimeout</literal></entry>
@@ -7131,9 +7067,7 @@
<entry>30000</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>StartPartitionedTimeout</literal></entry>
@@ -7141,9 +7075,7 @@
<entry>60000</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>StopOnError</literal></entry>
@@ -7151,9 +7083,7 @@
<entry>1</entry>
<entry>0</entry>
<entry>1</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>TimeBetweenGlobalCheckpoints</literal></entry>
@@ -7161,9 +7091,7 @@
<entry>2000</entry>
<entry>10</entry>
<entry>32000</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>TimeBetweenInactiveTransactionAbortCheck</literal></entry>
@@ -7171,9 +7099,7 @@
<entry>1000</entry>
<entry>1000</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>TimeBetweenLocalCheckpoints</literal></entry>
@@ -7182,9 +7108,7 @@
operations)</entry>
<entry>0</entry>
<entry>31</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>TimeBetweenWatchDogCheck</literal></entry>
@@ -7192,9 +7116,7 @@
<entry>4000</entry>
<entry>70</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>TransactionBufferMemory</literal></entry>
@@ -7202,9 +7124,7 @@
<entry>1M</entry>
<entry>1K</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>TransactionDeadlockDetectionTimeout</literal></entry>
@@ -7212,9 +7132,7 @@
<entry>1200</entry>
<entry>50</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>TransactionInactiveTimeout</literal></entry>
@@ -7222,9 +7140,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>UndoDataBuffer</literal></entry>
@@ -7232,9 +7148,7 @@
<entry>16M</entry>
<entry>1M</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
<row>
<entry><literal>UndoIndexBuffer</literal></entry>
@@ -7242,9 +7156,7 @@
<entry>2M</entry>
<entry>1M</entry>
<entry>4294967039</entry>
-<!--
- <entry>?</entry>
--->
+ <entry>N</entry>
</row>
</tbody>
</tgroup>
@@ -7279,48 +7191,19 @@
<xref linkend="mysql-cluster-mgm-definition"/>.
</para>
-<!--
<para>
- The <emphasis role="bold">Restart Required</emphasis> column
- can have one of 3 values, whose meanings are as follows:
+ See <xref linkend="mysql-cluster-config-params-overview"/>,
+ for an explanation of the symbols used in the table.
</para>
- <itemizedlist>
-
- <listitem>
- <para>
- <literal>N</literal>: No restart is required to update the
- value of the parameter.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>Y</literal>: A simple restart is needed to update
- the parameter's value.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>I</literal>: An initial restart is necessary for
- updating the value of the parameter.
- </para>
- </listitem>
-
- </itemizedlist>
--->
-
<informaltable>
- <tgroup cols="5">
+ <tgroup cols="6">
<colspec colwidth="30*"/>
- <colspec colwidth="10*"/>
+ <colspec colwidth="5*"/>
<colspec colwidth="20*"/>
<colspec colwidth="20*"/>
<colspec colwidth="20*"/>
-<!--
<colspec colwidth="5*"/>
--->
<tbody>
<row>
<entry><emphasis role="bold">Parameter Name</emphasis></entry>
@@ -7328,9 +7211,7 @@
<entry><emphasis role="bold">Default Value</emphasis></entry>
<entry><emphasis role="bold">Minimum Value</emphasis></entry>
<entry><emphasis role="bold">Maximum Value</emphasis></entry>
-<!--
- <entry><emphasis role="bold">Restart Required</emphasis></entry>
--->
+ <entry><emphasis role="bold">Restart Type</emphasis></entry>
</row>
<row>
<entry><literal>ArbitrationDelay</literal></entry>
@@ -7338,9 +7219,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
<entry>N</entry>
--->
</row>
<row>
<entry><literal>ArbitrationRank</literal></entry>
@@ -7348,9 +7227,7 @@
<entry>1</entry>
<entry>0</entry>
<entry>2</entry>
-<!--
<entry>N</entry>
--->
</row>
<row>
<entry><literal>DataDir</literal></entry>
@@ -7358,9 +7235,7 @@
<entry>N/A</entry>
<entry>N/A</entry>
<entry>N/A</entry>
-<!--
- <entry>Y</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>ExecuteOnComputer</literal> — synonym for
@@ -7369,9 +7244,7 @@
<entry/>
<entry/>
<entry/>
-<!--
<entry/>
--->
</row>
<row>
<entry><literal>HostName</literal></entry>
@@ -7379,9 +7252,7 @@
<entry><literal>localhost</literal></entry>
<entry>N/A</entry>
<entry>N/A</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>Id</literal></entry>
@@ -7389,9 +7260,7 @@
<entry><emphasis>None</emphasis></entry>
<entry>1</entry>
<entry>63</entry>
-<!--
- <entry>N</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>LogDestination</literal></entry>
@@ -7400,9 +7269,7 @@
<entry>See <xref linkend="mysql-cluster-mgm-definition"/>.</entry>
<entry>N/A</entry>
<entry>N/A</entry>
-<!--
- <entry>Y</entry>
--->
+ <entry>N</entry>
</row>
</tbody>
</tgroup>
@@ -7432,48 +7299,19 @@
<xref linkend="mysql-cluster-api-definition"/>.
</para>
-<!--
<para>
- The <emphasis role="bold">Restart Required</emphasis> column
- can have one of 3 values, whose meanings are as follows:
+ See <xref linkend="mysql-cluster-config-params-overview"/>,
+ for an explanation of the symbols used in the table.
</para>
- <itemizedlist>
-
- <listitem>
- <para>
- <literal>N</literal>: No restart is required to update the
- value of the parameter.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>Y</literal>: A simple restart is needed to update
- the parameter's value.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>I</literal>: An initial restart is necessary for
- updating the value of the parameter.
- </para>
- </listitem>
-
- </itemizedlist>
--->
-
<informaltable>
- <tgroup cols="5">
+ <tgroup cols="6">
<colspec colwidth="30*"/>
- <colspec colwidth="10*"/>
+ <colspec colwidth="5*"/>
<colspec colwidth="20*"/>
<colspec colwidth="20*"/>
<colspec colwidth="20*"/>
-<!--
<colspec colwidth="5*"/>
--->
<tbody>
<row>
<entry><emphasis role="bold">Parameter Name</emphasis></entry>
@@ -7481,9 +7319,7 @@
<entry><emphasis role="bold">Default Value</emphasis></entry>
<entry><emphasis role="bold">Minimum Value</emphasis></entry>
<entry><emphasis role="bold">Maximum Value</emphasis></entry>
-<!--
- <entry><emphasis role="bold">Restart Required</emphasis></entry>
--->
+ <entry><emphasis role="bold">Restart Type</emphasis></entry>
</row>
<row>
<entry><literal>ArbitrationDelay</literal></entry>
@@ -7491,9 +7327,7 @@
<entry>0</entry>
<entry>0</entry>
<entry>4294967039</entry>
-<!--
<entry>N</entry>
--->
</row>
<row>
<entry><literal>ArbitrationRank</literal></entry>
@@ -7501,9 +7335,7 @@
<entry>1</entry>
<entry>0</entry>
<entry>2</entry>
-<!--
<entry>N</entry>
--->
</row>
<row>
<entry><literal>BatchByteSize</literal></entry>
@@ -7511,9 +7343,7 @@
<entry>32K</entry>
<entry>1K</entry>
<entry>1M</entry>
-<!--
<entry>N</entry>
--->
</row>
<row>
<entry><literal>BatchSize</literal></entry>
@@ -7521,9 +7351,7 @@
<entry>64</entry>
<entry>1</entry>
<entry>992</entry>
-<!--
<entry>N</entry>
--->
</row>
<row>
<entry><literal>ExecuteOnComputer</literal> — synonym for
@@ -7532,9 +7360,7 @@
<entry/>
<entry/>
<entry/>
-<!--
<entry/>
--->
</row>
<row>
<entry><literal>HostName</literal></entry>
@@ -7542,9 +7368,7 @@
<entry><literal>localhost</literal></entry>
<entry>N/A</entry>
<entry>N/A</entry>
-<!--
- <entry>I</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>Id</literal></entry>
@@ -7552,9 +7376,7 @@
<entry><emphasis>None</emphasis></entry>
<entry>1</entry>
<entry>63</entry>
-<!--
- <entry>N</entry>
--->
+ <entry>IN</entry>
</row>
<row>
<entry><literal>MaxScanBatchSize</literal></entry>
@@ -7562,9 +7384,7 @@
<entry>256K</entry>
<entry>32K</entry>
<entry>16M</entry>
-<!--
<entry>N</entry>
--->
</row>
</tbody>
</tgroup>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r2725 - in trunk: refman-4.1 refman-5.0 refman-5.1 | jstephens | 13 Jul |
