| List: | Commits | « Previous MessageNext Message » | |
| From: | jon | Date: | May 7 2006 7:40pm |
| Subject: | svn commit - mysqldoc@docsrva: r2049 - in trunk: ndbapi refman-4.1 refman-5.0 refman-5.1 | ||
| View as plain text | |||
Author: jstephens Date: 2006-05-07 19:40:14 +0200 (Sun, 07 May 2006) New Revision: 2049 Log: Cluster chapter: Adding index terms (first 1/3 or so of chapter) Made a couple of small fixes suggested by Paul and Stewart Fixed a few typos and merged some minor unneeded diffs between versions. NDB API doc: Fixed description in makefile. Modified: trunk/ndbapi/Makefile trunk/refman-4.1/ndbcluster.xml trunk/refman-5.0/ndbcluster.xml trunk/refman-5.1/ndbcluster.xml Modified: trunk/ndbapi/Makefile =================================================================== --- trunk/ndbapi/Makefile 2006-05-06 21:06:16 UTC (rev 2048) +++ trunk/ndbapi/Makefile 2006-05-07 17:40:14 UTC (rev 2049) @@ -36,7 +36,7 @@ depend:: ndbapi.depend -# Dependency list for MySQL User Guide document +# Dependency list for NDB API document # This variable is updated by "make depend" NDBAPI_SRCS = $(NDBAPI_SRCS_EXTRA) ndbapi.xml overview.xml tips-tricks-problems.xml mgm-api.xml ndb-classes.xml errors.xml examples.xml Modified: trunk/refman-4.1/ndbcluster.xml =================================================================== --- trunk/refman-4.1/ndbcluster.xml 2006-05-06 21:06:16 UTC (rev 2048) +++ trunk/refman-4.1/ndbcluster.xml 2006-05-07 17:40:14 UTC (rev 2049) @@ -13,6 +13,20 @@ <title>&title-ndbcluster;</title> + <indexterm> + <primary>MySQL Cluster</primary> + </indexterm> + + <indexterm> + <primary><literal>NDB</literal> storage engine</primary> + <see>MySQL Cluster</see> + </indexterm> + + <indexterm> + <primary>Clustering</primary> + <see>MySQL Cluster</see> + </indexterm> + <remark> Authors: Arjen Lentz, Lars Thalmann, Mikael Ronström, and Jon Stephens (Cluster FAQ, Cluster How-To, Cluster Glossary). Also @@ -51,6 +65,11 @@ site at <ulink url="http://www.mysql.com/products/cluster/"/>. </para> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>information sources</secondary> + </indexterm> + <para> <emphasis role="bold">Additional resources</emphasis> </para> @@ -94,6 +113,11 @@ <title>&title-mysql-cluster-overview;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>general description</secondary> + </indexterm> + <para> <firstterm>MySQL Cluster</firstterm> is a technology that enables clustering of in-memory databases in a shared-nothing system. The @@ -176,6 +200,74 @@ <title>&title-mysql-cluster-basics;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>concepts</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>nodes and types</secondary> + </indexterm> + + <indexterm> + <primary>data node (MySQL Cluster)</primary> + <secondary>defined</secondary> + </indexterm> + + <indexterm> + <primary>management node (MySQL Cluster)</primary> + <secondary>defined</secondary> + </indexterm> + + <indexterm> + <primary>SQL node (MySQL Cluster)</primary> + <secondary>defined</secondary> + </indexterm> + + <indexterm> + <primary><command>ndbd</command> (MySQL Cluster)</primary> + <secondary>defined</secondary> + <seealso>data node (MySQL Cluster)</seealso> + </indexterm> + + <indexterm> + <primary><command>mgmd</command> (MySQL Cluster)</primary> + <secondary>defined</secondary> + <seealso>management node (MySQL Cluster)</seealso> + </indexterm> + + <indexterm> + <primary><command>ndb_mgmd</command> (MySQL Cluster)</primary> + <secondary>defined</secondary> + <seealso>management node (MySQL Cluster)</seealso> + </indexterm> + + <indexterm> + <primary><command>mysqld</command></primary> + <secondary>role in MySQL Cluster</secondary> + <see>SQL Node (MySQL Cluster)</see> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>data node</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>management node</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>SQL node</secondary> + </indexterm> + + <indexterm> + <primary>Configuring MySQL Cluster (concepts)</primary> + </indexterm> + <para> <emphasis role="bold">NDB</emphasis> is an in-memory storage engine offering high-availability and data-persistence features. @@ -189,21 +281,11 @@ data within the cluster itself. </para> - <remark role="todo"> - [pd] Actually, this section does not show how to set up. That - seems a comment more applicable to following sections. - </remark> - <para> - We will now describe how to set up a MySQL Cluster consisting of - an NDB storage engine and some MySQL servers. - </para> - - <para> The cluster portion of MySQL Cluster is currently configured independently of the MySQL servers. In a MySQL Cluster, each part of the cluster is considered to be a - <emphasis role="bold">node</emphasis>. + <firstterm>node</firstterm>. </para> <para> @@ -263,6 +345,14 @@ </itemizedlist> <para> + <emphasis role="bold">Important</emphasis>: It is not realistic to + expect to employ a three-node setup in a production environment. + Such a configuration provides no redundancy; in order to benefit + from MySQL Cluster's high-availability features, you must use + multiple data and SQL nodes. + </para> + + <para> For a brief introduction to the relationships between nodes, node groups, replicas, and partitions in MySQL Cluster, see <xref linkend="mysql-cluster-nodes-groups"/>. @@ -369,6 +459,33 @@ <title>&title-mysql-cluster-nodes-groups;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>nodes and node groups</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>replicas</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>partitions</secondary> + </indexterm> + + <indexterm> + <primary>node groups (MySQL Cluster)</primary> + </indexterm> + + <indexterm> + <primary>replicas (MySQL Cluster)</primary> + </indexterm> + + <indexterm> + <primary>partitions (MySQL Cluster)</primary> + </indexterm> + <remark role="note"> Author: Jon Stephens, with valuable assistance from Tomas Ulin, Jeb Miller, and Hartmut Holzgraefe @@ -528,7 +645,7 @@ </itemizedlist> <para> - What this means so far as the continued operation of a MySQL + What this means regarding the continued operation of a MySQL Cluster is this: so long as each node group participating in the cluster has at least one node operating, the cluster has a complete copy of all data and remains viable. This is @@ -575,6 +692,28 @@ <title>&title-multi-computer;</title> + <indexterm> + <primary>MySQL Cluster How-To</primary> + </indexterm> + + <indexterm> + <primary>installing MySQL Cluster</primary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>installation</secondary> + </indexterm> + + <indexterm> + <primary>configuring MySQL Cluster</primary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration</secondary> + </indexterm> + <remark> Multi-Computer How-To, Version 1.0, 2005-02-08. Authors: Jon Stephens with Tomas Ulin. Technical Reviewers: Pekka Nouisainen, @@ -661,6 +800,16 @@ </textobject> </mediaobject> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>and IP addressing</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>and DNS</secondary> + </indexterm> + <para> <emphasis role="bold">Note</emphasis>: In the interest of simplicity (and reliability), this How-To uses only numeric IP @@ -741,6 +890,16 @@ <title>&title-multi-hardware-software-network;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>requirements</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>and networking</secondary> + </indexterm> + <para> One of the strengths of MySQL Cluster is that it can be run on commodity hardware and has no unusual requirements in this @@ -831,6 +990,24 @@ <title>&title-multi-install;</title> + <indexterm> + <primary>installing MySQL Cluster</primary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>installation</secondary> + </indexterm> + + <indexterm> + <primary>Obtaining MySQL Cluster</primary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>obtaining</secondary> + </indexterm> + <para> Each MySQL Cluster host computer running storage or SQL nodes must have installed on it a MySQL-max binary. For management @@ -1009,9 +1186,8 @@ Installation for the management (MGM) node does not require installation of the <command>mysqld</command> binary. Only the binaries for the MGM server and client are required, which can - be found in the downloaded <literal>-max</literal> archive. - Again, we assume that you have placed this file in - <filename>/var/tmp</filename>. + be found in the downloaded archive. Again, we assume that you + have placed this file in <filename>/var/tmp</filename>. </para> <para> @@ -1065,6 +1241,20 @@ <title>&title-multi-config;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration files</secondary> + </indexterm> + + <indexterm> + <primary><filename>my.cnf</filename></primary> + <secondary>and MySQL Cluster</secondary> + </indexterm> + + <indexterm> + <primary><filename>config.ini</filename> (MySQL Cluster)</primary> + </indexterm> + <para> For our four-node, four-host MySQL Cluster, we will need to write four configuration files, one per node/host. @@ -1266,6 +1456,11 @@ <title>&title-multi-initial;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>starting nodes</secondary> + </indexterm> + <para> Starting the cluster is not very difficult after it has been configured. Each cluster node process must be started @@ -1338,6 +1533,16 @@ </orderedlist> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary><command>ndb_mgm</command></secondary> + </indexterm> + + <indexterm> + <primary><command>ndb_mgm</command> (MySQL Cluster management + node client)</primary> + </indexterm> + <para> If all has gone well, and the cluster has been set up correctly, the cluster should now be operational. You can test this by @@ -1384,6 +1589,16 @@ <title>&title-multi-load-data-queries;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>using tables and data</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>performing queries</secondary> + </indexterm> + <remark role="todo"> Look into changing this section to use new sample DB once MikeH has it ready. @@ -1729,6 +1944,16 @@ <title>&title-multi-shutdown-restart;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>shutting down</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>restarting</secondary> + </indexterm> + <para> To shut down the cluster, enter the following command in a shell on the machine hosting the MGM node: @@ -1829,6 +2054,15 @@ <title>&title-mysql-cluster-configuration;</title> + <indexterm> + <primary>configuring MySQL Cluster</primary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration</secondary> + </indexterm> + <para> A MySQL server that is part of a MySQL Cluster differs in only one respect from a normal (non-clustered) MySQL server, in that it @@ -1861,6 +2095,11 @@ <title>&title-mysql-cluster-building;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>compiling from source</secondary> + </indexterm> + <para> <literal>NDB</literal>, the Cluster storage engine, is available in binary distributions for Linux, Mac OS X, and Solaris. We are @@ -1889,6 +2128,15 @@ <title>&title-mysql-cluster-installing;</title> + <indexterm> + <primary>installing MySQL Cluster</primary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>installation</secondary> + </indexterm> + <para> In the next few sections, we assume that you are already familiar with installing MySQL, and here we cover only the @@ -1912,6 +2160,21 @@ <title>&title-mysql-cluster-quick;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary><quote>quick</quote> configuration</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>starting with <option>--initial</option></secondary> + </indexterm> + <para> To familiarize you with the basics, we will describe the simplest possible configuration for a functional MySQL Cluster. @@ -2123,6 +2386,11 @@ shell> <userinput>ndb_mgm</userinput> </programlisting> + <indexterm> + <primary><literal>SHOW</literal></primary> + <secondary>in MySQL Cluster management client</secondary> + </indexterm> + <para> Use the <command>SHOW</command> command from within the management client to obtain a report on the cluster's status: @@ -2157,6 +2425,20 @@ <title>&title-mysql-cluster-config-file;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration files</secondary> + </indexterm> + + <indexterm> + <primary><filename>my.cnf</filename></primary> + <secondary>and MySQL Cluster</secondary> + </indexterm> + + <indexterm> + <primary><filename>config.ini</filename> (MySQL Cluster)</primary> + </indexterm> + <para> Configuring MySQL Cluster requires working with two files: </para> @@ -2202,6 +2484,20 @@ <title>&title-mysql-cluster-config-example;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration (example)</secondary> + </indexterm> + + <indexterm> + <primary><filename>my.cnf</filename></primary> + <secondary>and MySQL Cluster</secondary> + </indexterm> + + <indexterm> + <primary><filename>config.ini</filename> (MySQL Cluster)</primary> + </indexterm> + <para> To support MySQL Cluster, you will need to update <filename>my.cnf</filename> as shown in the following example. @@ -2448,6 +2744,16 @@ <title>&title-mysql-cluster-connectstring;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>connectstring</secondary> + </indexterm> + + <indexterm> + <primary>connectstring</primary> + <see>MySQL Cluster</see> + </indexterm> + <para> With the exception of the MySQL Cluster management server (<command>ndb_mgmd</command>), each node that is part of a @@ -2569,6 +2875,16 @@ <title>&title-mysql-cluster-computer-definition;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>defining node hosts</secondary> + </indexterm> + <para> The <literal>[COMPUTER]</literal> section has no real significance other than serving as a way to avoid the need of @@ -2607,6 +2923,22 @@ <title>&title-mysql-cluster-mgm-definition;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>management node</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration</secondary> + </indexterm> + + <remark role="todo"> + [js] This is a VERY long list and needs to be broken up into + subsections; using the existing headings would probably work + okay for this. + </remark> + <para> The <literal>[NDB_MGMD]</literal> section is used to configure the behavior of the management server. @@ -2622,6 +2954,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>Id</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>Id</literal> </para> @@ -2635,6 +2971,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ExecuteOnComputer</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ExecuteOnComputer</literal> </para> @@ -2646,6 +2986,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>PortNumber</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>PortNumber</literal> </para> @@ -2658,6 +3002,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>LogDestination</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LogDestination</literal> </para> @@ -2773,6 +3121,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ArbitrationRank</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ArbitrationRank</literal> </para> @@ -2820,6 +3172,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ArbitrationDelay</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ArbitrationDelay</literal> </para> @@ -2833,6 +3189,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>DataDir</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>DataDir</literal> </para> @@ -2856,6 +3216,16 @@ <title>&title-mysql-cluster-db-definition;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>data node</secondary> + </indexterm> + <para> The <literal>[NDBD]</literal> section is used to configure the behavior of the cluster's data nodes. There are many @@ -2917,6 +3287,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>Id</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>Id</literal> </para> @@ -2930,6 +3304,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ExecuteOnComputer</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ExecuteOnComputer</literal> </para> @@ -2941,6 +3319,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>HostName</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>HostName</literal> </para> @@ -2956,6 +3338,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ServerPort</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ServerPort</literal> (<emphasis>OBSOLETE</emphasis>) @@ -2973,6 +3359,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>NoOfReplicas</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>NoOfReplicas</literal> </para> @@ -3017,6 +3407,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>DataDir</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>DataDir</literal> </para> @@ -3028,6 +3422,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>FileSystemPath</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>FileSystemPath</literal> </para> @@ -3053,6 +3451,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>BackupDataDir</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>BackupDataDir</literal> </para> @@ -3086,6 +3488,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>DataMemory</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>DataMemory</literal> </para> @@ -3098,6 +3504,10 @@ physical memory to accommodate it. </para> + <remark role="todo"> + Is this still correct in 5.0? + </remark> + <para> The memory allocated by <literal>DataMemory</literal> is used to store both the actual records and indexes. Each @@ -3162,6 +3572,11 @@ smaller ones, for the following reasons: </para> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>transactions</secondary> + </indexterm> + <itemizedlist> <listitem> @@ -3206,6 +3621,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>IndexMemory</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>IndexMemory</literal> </para> @@ -3353,6 +3772,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>MaxNoOfConcurrentTransactions</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfConcurrentTransactions</literal> </para> @@ -3402,6 +3825,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxNoOfConcurrentOperations</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfConcurrentOperations</literal> </para> @@ -3482,6 +3909,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxNoOfLocalOperations</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfLocalOperations</literal> </para> @@ -3523,6 +3954,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>MaxNoOfConcurrentIndexOperations</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfConcurrentIndexOperations</literal> </para> @@ -3550,6 +3985,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxNoOfFiredTriggers</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfFiredTriggers</literal> </para> @@ -3578,6 +4017,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>TransactionBufferMemory</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>TransactionBufferMemory</literal> </para> @@ -3633,6 +4076,10 @@ </para> <listitem> + <indexterm> + <primary><literal>MaxNoOfConcurrentScans</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfConcurrentScans</literal> </para> @@ -3679,6 +4126,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxNoOfLocalScans</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfLocalScans</literal> </para> @@ -3690,6 +4141,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>BatchSizePerLocalScan</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>BatchSizePerLocalScan</literal> </para> @@ -3712,6 +4167,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>LongMessageBuffer</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LongMessageBuffer</literal> </para> @@ -3738,6 +4197,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>NoOfFragmentLogFiles</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>NoOfFragmentLogFiles</literal> </para> @@ -3754,11 +4217,11 @@ </para> <para> - A REDO log record is not removed until three local - checkpoints have been completed since that log record was - inserted. Checkpointing frequency is determined by its own - set of configuration parameters discussed elsewhere in - this chapter. + A <literal>REDO</literal> log record is not removed until + three local checkpoints have been completed since that log + record was inserted. Checkpointing frequency is determined + by its own set of configuration parameters discussed + elsewhere in this chapter. </para> <remark role="todo"> @@ -3797,6 +4260,10 @@ <!-- <listitem> + <indexterm> + <primary><literal>MaxNoOfOpenFiles</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <remark role="todo"> If this doesn't ever need to be changed, then why is it even mentioned? [js] @@ -3820,6 +4287,10 @@ --> <listitem> + <indexterm> + <primary><literal>MaxNoOfSavedMessages</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfSavedMessages</literal> </para> @@ -3854,6 +4325,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>MaxNoOfAttributes</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfAttributes</literal> </para> @@ -3894,6 +4369,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxNoOfTables</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfTables</literal> </para> @@ -3920,6 +4399,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxNoOfOrderedIndexes</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfOrderedIndexes</literal> </para> @@ -3939,6 +4422,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxNoOfUniqueHashIndexes</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfUniqueHashIndexes</literal> </para> @@ -3959,6 +4446,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxNoOfTriggers</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfTriggers</literal> </para> @@ -3971,6 +4462,7 @@ single trigger object. Backups also use three trigger objects for each normal table in the cluster. </para> + <para> This parameter sets the maximum number of trigger objects @@ -3983,6 +4475,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxNoOfIndexes</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfIndexes</literal> </para> @@ -4024,6 +4520,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>LockPagesInMainMemory</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LockPagesInMainMemory</literal> </para> @@ -4041,6 +4541,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>StopOnError</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>StopOnError</literal> </para> @@ -4057,6 +4561,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>Diskless</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>Diskless</literal> </para> @@ -4090,6 +4598,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>RestartOnErrorInsert</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>RestartOnErrorInsert</literal> </para> @@ -4123,6 +4635,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>TimeBetweenWatchDogCheck</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>TimeBetweenWatchDogCheck</literal> </para> @@ -4149,6 +4665,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>StartPartialTimeout</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>StartPartialTimeout</literal> </para> @@ -4168,6 +4688,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>StartPartitionedTimeout</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>StartPartitionedTimeout</literal> </para> @@ -4185,6 +4709,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>StartFailureTimeout</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>StartFailureTimeout</literal> </para> @@ -4208,6 +4736,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>HeartbeatIntervalDbDb</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>HeartbeatIntervalDbDb</literal> </para> @@ -4234,6 +4766,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>HeartbeatIntervalDbApi</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>HeartbeatIntervalDbApi</literal> </para> @@ -4260,6 +4796,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>TimeBetweenLocalCheckpoints</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>TimeBetweenLocalCheckpoints</literal> </para> @@ -4296,6 +4836,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>TimeBetweenGlobalCheckpoints</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>TimeBetweenGlobalCheckpoints</literal> </para> @@ -4331,6 +4875,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>TimeBetweenInactiveTransactionAbortCheck</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>TimeBetweenInactiveTransactionAbortCheck</literal> </para> @@ -4349,6 +4897,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>TransactionInactiveTimeout</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>TransactionInactiveTimeout</literal> </para> @@ -4369,6 +4921,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>TransactionDeadlockDetectionTimeout</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>TransactionDeadlockDetectionTimeout</literal> </para> @@ -4419,6 +4975,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>NoOfDiskPagesToDiskAfterRestartTUP</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>NoOfDiskPagesToDiskAfterRestartTUP</literal> </para> @@ -4465,6 +5025,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>NoOfDiskPagesToDiskAfterRestartACC</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>NoOfDiskPagesToDiskAfterRestartACC</literal> </para> @@ -4483,6 +5047,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>NoOfDiskPagesToDiskDuringRestartTUP</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>NoOfDiskPagesToDiskDuringRestartTUP</literal> </para> @@ -4509,6 +5077,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>NoOfDiskPagesToDiskDuringRestartACC</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>NoOfDiskPagesToDiskDuringRestartACC</literal> </para> @@ -4533,6 +5105,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ArbitrationTimeout</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ArbitrationTimeout</literal> </para> @@ -4574,6 +5150,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>UndoIndexBuffer</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>UndoIndexBuffer</literal> </para> @@ -4621,6 +5201,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>UndoDataBuffer</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>UndoDataBuffer</literal> </para> @@ -4663,6 +5247,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>RedoBuffer</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>RedoBuffer</literal> </para> @@ -4719,6 +5307,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>LogLevelStartup</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LogLevelStartup</literal> </para> @@ -4734,6 +5326,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>LogLevelShutdown</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LogLevelShutdown</literal> </para> @@ -4749,6 +5345,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>LogLevelStatistic</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LogLevelStatistic</literal> </para> @@ -4765,6 +5365,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>LogLevelCheckpoint</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LogLevelCheckpoint</literal> </para> @@ -4780,6 +5384,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>LogLevelNodeRestart</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LogLevelNodeRestart</literal> </para> @@ -4795,6 +5403,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>LogLevelConnection</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LogLevelConnection</literal> </para> @@ -4810,6 +5422,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>LogLevelError</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LogLevelError</literal> </para> @@ -4827,6 +5443,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>LogLevelInfo</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LogLevelInfo</literal> </para> @@ -4856,6 +5476,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>BackupDataBufferSize</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>BackupDataBufferSize</literal> </para> @@ -4879,6 +5503,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>BackupLogBufferSize</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>BackupLogBufferSize</literal> </para> @@ -4923,6 +5551,11 @@ it's merely the sum of two others. [js] </remark> + <indexterm> + <primary><literal>BackupMemory</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> + <para> <literal>BackupMemory</literal> </para> @@ -4939,6 +5572,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>BackupWriteSize</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>BackupWriteSize</literal> </para> @@ -4961,6 +5598,16 @@ <title>&title-mysql-cluster-api-definition;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>SQL node</secondary> + </indexterm> + <para> The <literal>[MYSQLD]</literal> sections in the <filename>config.ini</filename> file define the behavior of @@ -4972,6 +5619,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>Id</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>Id</literal> </para> @@ -4985,6 +5636,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ExecuteOnComputer</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ExecuteOnComputer</literal> </para> @@ -4997,6 +5652,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ArbitrationRank</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ArbitrationRank</literal> </para> @@ -5014,6 +5673,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ArbitrationDelay</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ArbitrationDelay</literal> </para> @@ -5028,6 +5691,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>BatchByteSize</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>BatchByteSize</literal> </para> @@ -5062,6 +5729,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>BatchSize</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>BatchSize</literal> </para> @@ -5073,6 +5744,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxScanBatchSize</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxScanBatchSize</literal> </para> @@ -5143,6 +5818,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>SendBufferMemory</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>SendBufferMemory</literal> </para> @@ -5159,6 +5838,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>SendSignalId</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>SendSignalId</literal> </para> @@ -5172,6 +5855,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>Checksum</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>Checksum</literal> </para> @@ -5193,6 +5880,11 @@ [js] Cut this parameter? </remark> + <indexterm> + <primary><literal>PortNumber</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> + <para> <literal>PortNumber</literal> (<emphasis>OBSOLETE</emphasis>) @@ -5206,6 +5898,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ReceiveBufferMemory</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ReceiveBufferMemory</literal> </para> @@ -5639,8 +6335,8 @@ <listitem> <para> - Use <option>--ndbcluster</option> as a startup option when - starting <command>mysqld</command> + Use <option>--ndbcluster</option> as a startup option on the + command line when starting <command>mysqld</command>. </para> </listitem> @@ -5778,7 +6474,7 @@ <para> These log files are listed below. <replaceable>node_id</replaceable> is the node's unique - identifier.Note that <replaceable>node_id</replaceable> + identifier. Note that <replaceable>node_id</replaceable> represents the node's unique identifier. For example, <filename>ndb_2_error.log</filename> is the error log generated by the data node whose node ID is <literal>2</literal>. Modified: trunk/refman-5.0/ndbcluster.xml =================================================================== --- trunk/refman-5.0/ndbcluster.xml 2006-05-06 21:06:16 UTC (rev 2048) +++ trunk/refman-5.0/ndbcluster.xml 2006-05-07 17:40:14 UTC (rev 2049) @@ -13,6 +13,20 @@ <title>&title-ndbcluster;</title> + <indexterm> + <primary>MySQL Cluster</primary> + </indexterm> + + <indexterm> + <primary><literal>NDB</literal> storage engine</primary> + <see>MySQL Cluster</see> + </indexterm> + + <indexterm> + <primary>Clustering</primary> + <see>MySQL Cluster</see> + </indexterm> + <remark> Authors: Arjen Lentz, Lars Thalmann, Mikael Ronström, and Jon Stephens (Cluster FAQ, Cluster How-To, Cluster Glossary). Also @@ -51,6 +65,11 @@ site at <ulink url="http://www.mysql.com/products/cluster/"/>. </para> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>information sources</secondary> + </indexterm> + <para> <emphasis role="bold">Additional resources</emphasis> </para> @@ -94,6 +113,11 @@ <title>&title-mysql-cluster-overview;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>general description</secondary> + </indexterm> + <para> <firstterm>MySQL Cluster</firstterm> is a technology that enables clustering of in-memory databases in a shared-nothing system. The @@ -176,6 +200,74 @@ <title>&title-mysql-cluster-basics;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>concepts</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>nodes and types</secondary> + </indexterm> + + <indexterm> + <primary>data node (MySQL Cluster)</primary> + <secondary>defined</secondary> + </indexterm> + + <indexterm> + <primary>management node (MySQL Cluster)</primary> + <secondary>defined</secondary> + </indexterm> + + <indexterm> + <primary>SQL node (MySQL Cluster)</primary> + <secondary>defined</secondary> + </indexterm> + + <indexterm> + <primary><command>ndbd</command> (MySQL Cluster)</primary> + <secondary>defined</secondary> + <seealso>data node (MySQL Cluster)</seealso> + </indexterm> + + <indexterm> + <primary><command>mgmd</command> (MySQL Cluster)</primary> + <secondary>defined</secondary> + <seealso>management node (MySQL Cluster)</seealso> + </indexterm> + + <indexterm> + <primary><command>ndb_mgmd</command> (MySQL Cluster)</primary> + <secondary>defined</secondary> + <seealso>management node (MySQL Cluster)</seealso> + </indexterm> + + <indexterm> + <primary><command>mysqld</command></primary> + <secondary>role in MySQL Cluster</secondary> + <see>SQL Node (MySQL Cluster)</see> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>data node</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>management node</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>SQL node</secondary> + </indexterm> + + <indexterm> + <primary>Configuring MySQL Cluster (concepts)</primary> + </indexterm> + <para> <emphasis role="bold">NDB</emphasis> is an in-memory storage engine offering high-availability and data-persistence features. @@ -189,21 +281,11 @@ data within the cluster itself. </para> - <remark role="todo"> - [pd] Actually, this section does not show how to set up. That - seems a comment more applicable to following sections. - </remark> - <para> - We will now describe how to set up a MySQL Cluster consisting of - an NDB storage engine and some MySQL servers. - </para> - - <para> The cluster portion of MySQL Cluster is currently configured independently of the MySQL servers. In a MySQL Cluster, each part of the cluster is considered to be a - <emphasis role="bold">node</emphasis>. + <firstterm>node</firstterm>. </para> <para> @@ -263,6 +345,14 @@ </itemizedlist> <para> + <emphasis role="bold">Important</emphasis>: It is not realistic to + expect to employ a three-node setup in a production environment. + Such a configuration provides no redundancy; in order to benefit + from MySQL Cluster's high-availability features, you must use + multiple data and SQL nodes. + </para> + + <para> For a brief introduction to the relationships between nodes, node groups, replicas, and partitions in MySQL Cluster, see <xref linkend="mysql-cluster-nodes-groups"/>. @@ -369,6 +459,33 @@ <title>&title-mysql-cluster-nodes-groups;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>nodes and node groups</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>replicas</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>partitions</secondary> + </indexterm> + + <indexterm> + <primary>node groups (MySQL Cluster)</primary> + </indexterm> + + <indexterm> + <primary>replicas (MySQL Cluster)</primary> + </indexterm> + + <indexterm> + <primary>partitions (MySQL Cluster)</primary> + </indexterm> + <remark role="note"> Author: Jon Stephens, with valuable assistance from Tomas Ulin, Jeb Miller, and Hartmut Holzgraefe @@ -528,7 +645,7 @@ </itemizedlist> <para> - What this means so far as the continued operation of a MySQL + What this means regarding the continued operation of a MySQL Cluster is this: so long as each node group participating in the cluster has at least one node operating, the cluster has a complete copy of all data and remains viable. This is @@ -575,6 +692,28 @@ <title>&title-multi-computer;</title> + <indexterm> + <primary>MySQL Cluster How-To</primary> + </indexterm> + + <indexterm> + <primary>installing MySQL Cluster</primary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>installation</secondary> + </indexterm> + + <indexterm> + <primary>configuring MySQL Cluster</primary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration</secondary> + </indexterm> + <remark> Multi-Computer How-To, Version 1.0, 2005-02-08. Authors: Jon Stephens with Tomas Ulin. Technical Reviewers: Pekka Nouisainen, @@ -661,6 +800,16 @@ </textobject> </mediaobject> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>and IP addressing</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>and DNS</secondary> + </indexterm> + <para> <emphasis role="bold">Note</emphasis>: In the interest of simplicity (and reliability), this How-To uses only numeric IP @@ -741,6 +890,16 @@ <title>&title-multi-hardware-software-network;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>requirements</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>and networking</secondary> + </indexterm> + <para> One of the strengths of MySQL Cluster is that it can be run on commodity hardware and has no unusual requirements in this @@ -831,6 +990,24 @@ <title>&title-multi-install;</title> + <indexterm> + <primary>installing MySQL Cluster</primary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>installation</secondary> + </indexterm> + + <indexterm> + <primary>Obtaining MySQL Cluster</primary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>obtaining</secondary> + </indexterm> + <para> Each MySQL Cluster host computer running storage or SQL nodes must have installed on it a MySQL-max binary. For management @@ -1009,9 +1186,8 @@ Installation for the management (MGM) node does not require installation of the <command>mysqld</command> binary. Only the binaries for the MGM server and client are required, which can - be found in the downloaded <literal>-max</literal> archive. - Again, we assume that you have placed this file in - <filename>/var/tmp</filename>. + be found in the downloaded archive. Again, we assume that you + have placed this file in <filename>/var/tmp</filename>. </para> <para> @@ -1065,6 +1241,20 @@ <title>&title-multi-config;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration files</secondary> + </indexterm> + + <indexterm> + <primary><filename>my.cnf</filename></primary> + <secondary>and MySQL Cluster</secondary> + </indexterm> + + <indexterm> + <primary><filename>config.ini</filename> (MySQL Cluster)</primary> + </indexterm> + <para> For our four-node, four-host MySQL Cluster, we will need to write four configuration files, one per node/host. @@ -1266,6 +1456,11 @@ <title>&title-multi-initial;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>starting nodes</secondary> + </indexterm> + <para> Starting the cluster is not very difficult after it has been configured. Each cluster node process must be started @@ -1338,6 +1533,16 @@ </orderedlist> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary><command>ndb_mgm</command></secondary> + </indexterm> + + <indexterm> + <primary><command>ndb_mgm</command> (MySQL Cluster management + node client)</primary> + </indexterm> + <para> If all has gone well, and the cluster has been set up correctly, the cluster should now be operational. You can test this by @@ -1384,6 +1589,16 @@ <title>&title-multi-load-data-queries;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>using tables and data</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>performing queries</secondary> + </indexterm> + <remark role="todo"> Look into changing this section to use new sample DB once MikeH has it ready. @@ -1731,6 +1946,16 @@ <title>&title-multi-shutdown-restart;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>shutting down</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>restarting</secondary> + </indexterm> + <para> To shut down the cluster, enter the following command in a shell on the machine hosting the MGM node: @@ -1831,6 +2056,15 @@ <title>&title-mysql-cluster-configuration;</title> + <indexterm> + <primary>configuring MySQL Cluster</primary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration</secondary> + </indexterm> + <para> A MySQL server that is part of a MySQL Cluster differs in only one respect from a normal (non-clustered) MySQL server, in that it @@ -1863,6 +2097,11 @@ <title>&title-mysql-cluster-building;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>compiling from source</secondary> + </indexterm> + <para> <literal>NDB</literal>, the Cluster storage engine, is available in binary distributions for Linux, Mac OS X, and Solaris. We are @@ -1891,6 +2130,15 @@ <title>&title-mysql-cluster-installing;</title> + <indexterm> + <primary>installing MySQL Cluster</primary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>installation</secondary> + </indexterm> + <para> In the next few sections, we assume that you are already familiar with installing MySQL, and here we cover only the @@ -1914,6 +2162,21 @@ <title>&title-mysql-cluster-quick;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary><quote>quick</quote> configuration</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>starting with <option>--initial</option></secondary> + </indexterm> + <para> To familiarize you with the basics, we will describe the simplest possible configuration for a functional MySQL Cluster. @@ -2124,6 +2387,11 @@ shell> <userinput>ndb_mgm</userinput> </programlisting> + <indexterm> + <primary><literal>SHOW</literal></primary> + <secondary>in MySQL Cluster management client</secondary> + </indexterm> + <para> Use the <command>SHOW</command> command from within the management client to obtain a report on the cluster's status: @@ -2158,6 +2426,20 @@ <title>&title-mysql-cluster-config-file;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration files</secondary> + </indexterm> + + <indexterm> + <primary><filename>my.cnf</filename></primary> + <secondary>and MySQL Cluster</secondary> + </indexterm> + + <indexterm> + <primary><filename>config.ini</filename> (MySQL Cluster)</primary> + </indexterm> + <para> Configuring MySQL Cluster requires working with two files: </para> @@ -2203,6 +2485,20 @@ <title>&title-mysql-cluster-config-example;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration (example)</secondary> + </indexterm> + + <indexterm> + <primary><filename>my.cnf</filename></primary> + <secondary>and MySQL Cluster</secondary> + </indexterm> + + <indexterm> + <primary><filename>config.ini</filename> (MySQL Cluster)</primary> + </indexterm> + <para> To support MySQL Cluster, you will need to update <filename>my.cnf</filename> as shown in the following example. @@ -2438,6 +2734,16 @@ <title>&title-mysql-cluster-connectstring;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>connectstring</secondary> + </indexterm> + + <indexterm> + <primary>connectstring</primary> + <see>MySQL Cluster</see> + </indexterm> + <para> With the exception of the MySQL Cluster management server (<command>ndb_mgmd</command>), each node that is part of a @@ -2561,6 +2867,16 @@ <title>&title-mysql-cluster-computer-definition;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>defining node hosts</secondary> + </indexterm> + <para> The <literal>[COMPUTER]</literal> section has no real significance other than serving as a way to avoid the need of @@ -2599,6 +2915,22 @@ <title>&title-mysql-cluster-mgm-definition;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>management node</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration</secondary> + </indexterm> + + <remark role="todo"> + [js] This is a VERY long list and needs to be broken up into + subsections; using the existing headings would probably work + okay for this. + </remark> + <para> The <literal>[NDB_MGMD]</literal> section is used to configure the behavior of the management server. @@ -2614,6 +2946,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>Id</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>Id</literal> </para> @@ -2627,6 +2963,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ExecuteOnComputer</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ExecuteOnComputer</literal> </para> @@ -2638,6 +2978,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>PortNumber</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>PortNumber</literal> </para> @@ -2650,6 +2994,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>LogDestination</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LogDestination</literal> </para> @@ -2765,6 +3113,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ArbitrationRank</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ArbitrationRank</literal> </para> @@ -2812,6 +3164,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ArbitrationDelay</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ArbitrationDelay</literal> </para> @@ -2825,6 +3181,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>DataDir</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>DataDir</literal> </para> @@ -2848,6 +3208,16 @@ <title>&title-mysql-cluster-db-definition;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>data node</secondary> + </indexterm> + <para> The <literal>[NDBD]</literal> section is used to configure the behavior of the cluster's data nodes. There are many @@ -2909,6 +3279,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>Id</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>Id</literal> </para> @@ -2922,6 +3296,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ExecuteOnComputer</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ExecuteOnComputer</literal> </para> @@ -2933,6 +3311,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>HostName</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>HostName</literal> </para> @@ -2948,6 +3330,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ServerPort</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ServerPort</literal> (<emphasis>OBSOLETE</emphasis>) @@ -2965,6 +3351,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>NoOfReplicas</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>NoOfReplicas</literal> </para> @@ -3009,6 +3399,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>DataDir</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>DataDir</literal> </para> @@ -3020,6 +3414,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>FileSystemPath</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>FileSystemPath</literal> </para> @@ -3045,6 +3443,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>BackupDataDir</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>BackupDataDir</literal> </para> @@ -3078,6 +3480,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>DataMemory</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>DataMemory</literal> </para> @@ -3158,6 +3564,11 @@ smaller ones, for the following reasons: </para> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>transactions</secondary> + </indexterm> + <itemizedlist> <listitem> @@ -3202,6 +3613,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>IndexMemory</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>IndexMemory</literal> </para> @@ -3353,6 +3768,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>MaxNoOfConcurrentTransactions</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfConcurrentTransactions</literal> </para> @@ -3402,6 +3821,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxNoOfConcurrentOperations</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfConcurrentOperations</literal> </para> @@ -3482,6 +3905,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxNoOfLocalOperations</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfLocalOperations</literal> </para> @@ -3523,6 +3950,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>MaxNoOfConcurrentIndexOperations</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfConcurrentIndexOperations</literal> </para> @@ -3550,6 +3981,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxNoOfFiredTriggers</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfFiredTriggers</literal> </para> @@ -3578,6 +4013,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>TransactionBufferMemory</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>TransactionBufferMemory</literal> </para> @@ -3637,6 +4076,10 @@ </para> <listitem> + <indexterm> + <primary><literal>MaxNoOfConcurrentScans</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfConcurrentScans</literal> </para> @@ -3683,6 +4126,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxNoOfLocalScans</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfLocalScans</literal> </para> @@ -3694,6 +4141,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>BatchSizePerLocalScan</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>BatchSizePerLocalScan</literal> </para> @@ -3716,6 +4167,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>LongMessageBuffer</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LongMessageBuffer</literal> </para> @@ -3742,6 +4197,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>NoOfFragmentLogFiles</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>NoOfFragmentLogFiles</literal> </para> @@ -3758,11 +4217,11 @@ </para> <para> - A REDO log record is not removed until three local - checkpoints have been completed since that log record was - inserted. Checkpointing frequency is determined by its own - set of configuration parameters discussed elsewhere in - this chapter. + A <literal>REDO</literal> log record is not removed until + three local checkpoints have been completed since that log + record was inserted. Checkpointing frequency is determined + by its own set of configuration parameters discussed + elsewhere in this chapter. </para> <remark role="todo"> @@ -3801,6 +4260,10 @@ <!-- <listitem> + <indexterm> + <primary><literal>MaxNoOfOpenFiles</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <remark role="todo"> If this doesn't ever need to be changed, then why is it even mentioned? [js] @@ -3824,6 +4287,10 @@ --> <listitem> + <indexterm> + <primary><literal>MaxNoOfSavedMessages</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfSavedMessages</literal> </para> @@ -3858,6 +4325,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>MaxNoOfAttributes</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfAttributes</literal> </para> @@ -3898,6 +4369,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxNoOfTables</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfTables</literal> </para> @@ -3924,6 +4399,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxNoOfOrderedIndexes</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfOrderedIndexes</literal> </para> @@ -3943,6 +4422,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxNoOfUniqueHashIndexes</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfUniqueHashIndexes</literal> </para> @@ -3963,6 +4446,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxNoOfTriggers</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfTriggers</literal> </para> @@ -3977,12 +4464,6 @@ </para> <para> - <emphasis role="bold">Note</emphasis>: When replication - between clusters is supported, this will also make use of - internal triggers. - </para> - - <para> This parameter sets the maximum number of trigger objects in the cluster. </para> @@ -3993,6 +4474,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxNoOfIndexes</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfIndexes</literal> </para> @@ -4033,6 +4518,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>LockPagesInMainMemory</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LockPagesInMainMemory</literal> </para> @@ -4050,6 +4539,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>StopOnError</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>StopOnError</literal> </para> @@ -4066,6 +4559,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>Diskless</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>Diskless</literal> </para> @@ -4099,6 +4596,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>RestartOnErrorInsert</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>RestartOnErrorInsert</literal> </para> @@ -4132,6 +4633,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>TimeBetweenWatchDogCheck</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>TimeBetweenWatchDogCheck</literal> </para> @@ -4158,6 +4663,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>StartPartialTimeout</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>StartPartialTimeout</literal> </para> @@ -4177,6 +4686,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>StartPartitionedTimeout</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>StartPartitionedTimeout</literal> </para> @@ -4194,6 +4707,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>StartFailureTimeout</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>StartFailureTimeout</literal> </para> @@ -4217,6 +4734,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>HeartbeatIntervalDbDb</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>HeartbeatIntervalDbDb</literal> </para> @@ -4243,6 +4764,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>HeartbeatIntervalDbApi</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>HeartbeatIntervalDbApi</literal> </para> @@ -4269,6 +4794,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>TimeBetweenLocalCheckpoints</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>TimeBetweenLocalCheckpoints</literal> </para> @@ -4305,6 +4834,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>TimeBetweenGlobalCheckpoints</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>TimeBetweenGlobalCheckpoints</literal> </para> @@ -4340,6 +4873,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>TimeBetweenInactiveTransactionAbortCheck</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>TimeBetweenInactiveTransactionAbortCheck</literal> </para> @@ -4358,6 +4895,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>TransactionInactiveTimeout</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>TransactionInactiveTimeout</literal> </para> @@ -4378,6 +4919,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>TransactionDeadlockDetectionTimeout</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>TransactionDeadlockDetectionTimeout</literal> </para> @@ -4428,6 +4973,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>NoOfDiskPagesToDiskAfterRestartTUP</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>NoOfDiskPagesToDiskAfterRestartTUP</literal> </para> @@ -4474,6 +5023,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>NoOfDiskPagesToDiskAfterRestartACC</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>NoOfDiskPagesToDiskAfterRestartACC</literal> </para> @@ -4492,6 +5045,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>NoOfDiskPagesToDiskDuringRestartTUP</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>NoOfDiskPagesToDiskDuringRestartTUP</literal> </para> @@ -4518,6 +5075,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>NoOfDiskPagesToDiskDuringRestartACC</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>NoOfDiskPagesToDiskDuringRestartACC</literal> </para> @@ -4542,6 +5103,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ArbitrationTimeout</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ArbitrationTimeout</literal> </para> @@ -4583,6 +5148,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>UndoIndexBuffer</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>UndoIndexBuffer</literal> </para> @@ -4630,6 +5199,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>UndoDataBuffer</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>UndoDataBuffer</literal> </para> @@ -4672,6 +5245,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>RedoBuffer</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>RedoBuffer</literal> </para> @@ -4728,6 +5305,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>LogLevelStartup</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LogLevelStartup</literal> </para> @@ -4743,6 +5324,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>LogLevelShutdown</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LogLevelShutdown</literal> </para> @@ -4758,6 +5343,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>LogLevelStatistic</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LogLevelStatistic</literal> </para> @@ -4774,6 +5363,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>LogLevelCheckpoint</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LogLevelCheckpoint</literal> </para> @@ -4789,6 +5382,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>LogLevelNodeRestart</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LogLevelNodeRestart</literal> </para> @@ -4804,6 +5401,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>LogLevelConnection</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LogLevelConnection</literal> </para> @@ -4819,6 +5420,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>LogLevelError</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LogLevelError</literal> </para> @@ -4836,6 +5441,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>LogLevelInfo</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LogLevelInfo</literal> </para> @@ -4865,6 +5474,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>BackupDataBufferSize</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>BackupDataBufferSize</literal> </para> @@ -4888,6 +5501,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>BackupLogBufferSize</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>BackupLogBufferSize</literal> </para> @@ -4932,6 +5549,11 @@ it's merely the sum of two others. [js] </remark> + <indexterm> + <primary><literal>BackupMemory</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> + <para> <literal>BackupMemory</literal> </para> @@ -4948,6 +5570,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>BackupWriteSize</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>BackupWriteSize</literal> </para> @@ -4970,6 +5596,16 @@ <title>&title-mysql-cluster-api-definition;</title> + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>SQL node</secondary> + </indexterm> + <para> The <literal>[MYSQLD]</literal> sections in the <filename>config.ini</filename> file define the behavior of @@ -4981,6 +5617,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>Id</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>Id</literal> </para> @@ -4994,6 +5634,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ExecuteOnComputer</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ExecuteOnComputer</literal> </para> @@ -5006,6 +5650,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ArbitrationRank</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ArbitrationRank</literal> </para> @@ -5023,6 +5671,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ArbitrationDelay</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ArbitrationDelay</literal> </para> @@ -5037,6 +5689,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>BatchByteSize</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>BatchByteSize</literal> </para> @@ -5071,6 +5727,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>BatchSize</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>BatchSize</literal> </para> @@ -5082,6 +5742,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxScanBatchSize</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxScanBatchSize</literal> </para> @@ -5152,6 +5816,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>SendBufferMemory</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>SendBufferMemory</literal> </para> @@ -5168,6 +5836,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>SendSignalId</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>SendSignalId</literal> </para> @@ -5181,6 +5853,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>Checksum</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>Checksum</literal> </para> @@ -5202,6 +5878,11 @@ [js] Cut this parameter? </remark> + <indexterm> + <primary><literal>PortNumber</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> + <para> <literal>PortNumber</literal> (<emphasis>OBSOLETE</emphasis>) @@ -5215,6 +5896,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ReceiveBufferMemory</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ReceiveBufferMemory</literal> </para> Modified: trunk/refman-5.1/ndbcluster.xml =================================================================== --- trunk/refman-5.1/ndbcluster.xml 2006-05-06 21:06:16 UTC (rev 2048) +++ trunk/refman-5.1/ndbcluster.xml 2006-05-07 17:40:14 UTC (rev 2049) @@ -12,6 +12,20 @@ <chapter id="ndbcluster"> <title>&title-ndbcluster;</title> + + <indexterm> + <primary>MySQL Cluster</primary> + </indexterm> + + <indexterm> + <primary><literal>NDB</literal> storage engine</primary> + <see>MySQL Cluster</see> + </indexterm> + + <indexterm> + <primary>Clustering</primary> + <see>MySQL Cluster</see> + </indexterm> <remark> Authors: Arjen Lentz, Lars Thalmann, Mikael Ronström, and Jon @@ -47,6 +61,11 @@ information regarding MySQL Cluster can be found on the MySQL AB Web site at <ulink url="http://www.mysql.com/products/cluster/"/>. </para> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>information sources</secondary> + </indexterm> <para> <emphasis role="bold">Additional resources</emphasis> @@ -90,6 +109,11 @@ <section id="mysql-cluster-overview"> <title>&title-mysql-cluster-overview;</title> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>general description</secondary> + </indexterm> <para> <firstterm>MySQL Cluster</firstterm> is a technology that enables @@ -172,6 +196,74 @@ <section id="mysql-cluster-basics"> <title>&title-mysql-cluster-basics;</title> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>concepts</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>nodes and types</secondary> + </indexterm> + + <indexterm> + <primary>data node (MySQL Cluster)</primary> + <secondary>defined</secondary> + </indexterm> + + <indexterm> + <primary>management node (MySQL Cluster)</primary> + <secondary>defined</secondary> + </indexterm> + + <indexterm> + <primary>SQL node (MySQL Cluster)</primary> + <secondary>defined</secondary> + </indexterm> + + <indexterm> + <primary><command>ndbd</command> (MySQL Cluster)</primary> + <secondary>defined</secondary> + <seealso>data node (MySQL Cluster)</seealso> + </indexterm> + + <indexterm> + <primary><command>mgmd</command> (MySQL Cluster)</primary> + <secondary>defined</secondary> + <seealso>management node (MySQL Cluster)</seealso> + </indexterm> + + <indexterm> + <primary><command>ndb_mgmd</command> (MySQL Cluster)</primary> + <secondary>defined</secondary> + <seealso>management node (MySQL Cluster)</seealso> + </indexterm> + + <indexterm> + <primary><command>mysqld</command></primary> + <secondary>role in MySQL Cluster</secondary> + <see>SQL Node (MySQL Cluster)</see> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>data node</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>management node</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>SQL node</secondary> + </indexterm> + + <indexterm> + <primary>Configuring MySQL Cluster (concepts)</primary> + </indexterm> <para> <emphasis role="bold">NDB</emphasis> is an in-memory storage @@ -186,21 +278,11 @@ data within the cluster itself. </para> - <remark role="todo"> - [pd] Actually, this section does not show how to set up. That - seems a comment more applicable to following sections. - </remark> - <para> - We will now describe how to set up a MySQL Cluster consisting of - an NDB storage engine and some MySQL servers. - </para> - - <para> The cluster portion of MySQL Cluster is currently configured independently of the MySQL servers. In a MySQL Cluster, each part of the cluster is considered to be a - <emphasis role="bold">node</emphasis>. + <firstterm>node</firstterm>. </para> <para> @@ -260,6 +342,14 @@ </itemizedlist> <para> + <emphasis role="bold">Important</emphasis>: It is not realistic to + expect to employ a three-node setup in a production environment. + Such a configuration provides no redundancy; in order to benefit + from MySQL Cluster's high-availability features, you must use + multiple data and SQL nodes. + </para> + + <para> For a brief introduction to the relationships between nodes, node groups, replicas, and partitions in MySQL Cluster, see <xref linkend="mysql-cluster-nodes-groups"/>. @@ -365,6 +455,33 @@ <section id="mysql-cluster-nodes-groups"> <title>&title-mysql-cluster-nodes-groups;</title> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>nodes and node groups</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>replicas</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>partitions</secondary> + </indexterm> + + <indexterm> + <primary>node groups (MySQL Cluster)</primary> + </indexterm> + + <indexterm> + <primary>replicas (MySQL Cluster)</primary> + </indexterm> + + <indexterm> + <primary>partitions (MySQL Cluster)</primary> + </indexterm> <remark role="note"> Author: Jon Stephens, with valuable assistance from Tomas Ulin, @@ -525,7 +642,7 @@ </itemizedlist> <para> - What this means so far as the continued operation of a MySQL + What this means regarding the continued operation of a MySQL Cluster is this: so long as each node group participating in the cluster has at least one node operating, the cluster has a complete copy of all data and remains viable. This is @@ -571,6 +688,28 @@ <section id="multi-computer"> <title>&title-multi-computer;</title> + + <indexterm> + <primary>MySQL Cluster How-To</primary> + </indexterm> + + <indexterm> + <primary>installing MySQL Cluster</primary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>installation</secondary> + </indexterm> + + <indexterm> + <primary>configuring MySQL Cluster</primary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration</secondary> + </indexterm> <remark> Multi-Computer How-To, Version 1.0, 2005-02-08. Authors: Jon @@ -657,6 +796,16 @@ Setup</phrase> </textobject> </mediaobject> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>and IP addressing</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>and DNS</secondary> + </indexterm> <para> <emphasis role="bold">Note</emphasis>: In the interest of @@ -737,6 +886,16 @@ <section id="multi-hardware-software-network"> <title>&title-multi-hardware-software-network;</title> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>requirements</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>and networking</secondary> + </indexterm> <para> One of the strengths of MySQL Cluster is that it can be run on @@ -825,6 +984,24 @@ <section id="multi-install"> <title>&title-multi-install;</title> + + <indexterm> + <primary>installing MySQL Cluster</primary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>installation</secondary> + </indexterm> + + <indexterm> + <primary>Obtaining MySQL Cluster</primary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>obtaining</secondary> + </indexterm> <para> Each MySQL Cluster host computer running storage or SQL nodes @@ -1051,6 +1228,20 @@ <section id="multi-config"> <title>&title-multi-config;</title> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration files</secondary> + </indexterm> + + <indexterm> + <primary><filename>my.cnf</filename></primary> + <secondary>and MySQL Cluster</secondary> + </indexterm> + + <indexterm> + <primary><filename>config.ini</filename> (MySQL Cluster)</primary> + </indexterm> <para> For our four-node, four-host MySQL Cluster, we will need to @@ -1252,6 +1443,11 @@ <section id="multi-initial"> <title>&title-multi-initial;</title> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>starting nodes</secondary> + </indexterm> <para> Starting the cluster is not very difficult after it has been @@ -1321,6 +1517,16 @@ </listitem> </orderedlist> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary><command>ndb_mgm</command></secondary> + </indexterm> + + <indexterm> + <primary><command>ndb_mgm</command> (MySQL Cluster management + node client)</primary> + </indexterm> <para> If all has gone well, and the cluster has been set up correctly, @@ -1367,6 +1573,16 @@ <section id="multi-load-data-queries"> <title>&title-multi-load-data-queries;</title> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>using tables and data</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>performing queries</secondary> + </indexterm> <remark role="todo"> Look into changing this section to use new sample DB once MikeH @@ -1712,6 +1928,16 @@ <section id="multi-shutdown-restart"> <title>&title-multi-shutdown-restart;</title> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>shutting down</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>restarting</secondary> + </indexterm> <para> To shut down the cluster, enter the following command in a shell @@ -1812,6 +2038,15 @@ <section id="mysql-cluster-configuration"> <title>&title-mysql-cluster-configuration;</title> + + <indexterm> + <primary>configuring MySQL Cluster</primary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration</secondary> + </indexterm> <para> A MySQL server that is part of a MySQL Cluster differs in only one @@ -1844,6 +2079,11 @@ <section id="mysql-cluster-building"> <title>&title-mysql-cluster-building;</title> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>compiling from source</secondary> + </indexterm> <para> <literal>NDB</literal>, the Cluster storage engine, is available @@ -1872,6 +2112,15 @@ <section id="mysql-cluster-installing"> <title>&title-mysql-cluster-installing;</title> + + <indexterm> + <primary>installing MySQL Cluster</primary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>installation</secondary> + </indexterm> <para> In the next few sections, we assume that you are already @@ -1895,6 +2144,21 @@ <section id="mysql-cluster-quick"> <title>&title-mysql-cluster-quick;</title> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary><quote>quick</quote> configuration</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>starting with <option>--initial</option></secondary> + </indexterm> <para> To familiarize you with the basics, we will describe the @@ -2105,6 +2369,11 @@ <programlisting> shell> <userinput>ndb_mgm</userinput> </programlisting> + + <indexterm> + <primary><literal>SHOW</literal></primary> + <secondary>in MySQL Cluster management client</secondary> + </indexterm> <para> Use the <command>SHOW</command> command from within the @@ -2139,6 +2408,20 @@ <section id="mysql-cluster-config-file"> <title>&title-mysql-cluster-config-file;</title> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration files</secondary> + </indexterm> + + <indexterm> + <primary><filename>my.cnf</filename></primary> + <secondary>and MySQL Cluster</secondary> + </indexterm> + + <indexterm> + <primary><filename>config.ini</filename> (MySQL Cluster)</primary> + </indexterm> <para> Configuring MySQL Cluster requires working with two files: @@ -2184,6 +2467,20 @@ <section id="mysql-cluster-config-example"> <title>&title-mysql-cluster-config-example;</title> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration (example)</secondary> + </indexterm> + + <indexterm> + <primary><filename>my.cnf</filename></primary> + <secondary>and MySQL Cluster</secondary> + </indexterm> + + <indexterm> + <primary><filename>config.ini</filename> (MySQL Cluster)</primary> + </indexterm> <para> To support MySQL Cluster, you will need to update @@ -2419,6 +2716,16 @@ <section id="mysql-cluster-connectstring"> <title>&title-mysql-cluster-connectstring;</title> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>connectstring</secondary> + </indexterm> + + <indexterm> + <primary>connectstring</primary> + <see>MySQL Cluster</see> + </indexterm> <para> With the exception of the MySQL Cluster management server @@ -2542,6 +2849,16 @@ <section id="mysql-cluster-computer-definition"> <title>&title-mysql-cluster-computer-definition;</title> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>defining node hosts</secondary> + </indexterm> <para> The <literal>[COMPUTER]</literal> section has no real @@ -2580,6 +2897,22 @@ <section id="mysql-cluster-mgm-definition"> <title>&title-mysql-cluster-mgm-definition;</title> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>management node</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration</secondary> + </indexterm> + + <remark role="todo"> + [js] This is a VERY long list and needs to be broken up into + subsections; using the existing headings would probably work + okay for this. + </remark> <para> The <literal>[NDB_MGMD]</literal> section is used to configure @@ -2596,6 +2929,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>Id</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>Id</literal> </para> @@ -2609,6 +2946,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ExecuteOnComputer</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ExecuteOnComputer</literal> </para> @@ -2620,6 +2961,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>PortNumber</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>PortNumber</literal> </para> @@ -2632,6 +2977,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>LogDestination</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LogDestination</literal> </para> @@ -2747,6 +3096,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ArbitrationRank</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ArbitrationRank</literal> </para> @@ -2794,6 +3147,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ArbitrationDelay</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ArbitrationDelay</literal> </para> @@ -2807,6 +3164,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>DataDir</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>DataDir</literal> </para> @@ -2829,6 +3190,16 @@ <section id="mysql-cluster-db-definition"> <title>&title-mysql-cluster-db-definition;</title> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>data node</secondary> + </indexterm> <para> The <literal>[NDBD]</literal> section is used to configure the @@ -2891,6 +3262,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>Id</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>Id</literal> </para> @@ -2904,6 +3279,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ExecuteOnComputer</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ExecuteOnComputer</literal> </para> @@ -2915,6 +3294,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>HostName</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>HostName</literal> </para> @@ -2930,6 +3313,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ServerPort</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ServerPort</literal> (<emphasis>OBSOLETE</emphasis>) @@ -2947,6 +3334,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>NoOfReplicas</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>NoOfReplicas</literal> </para> @@ -2991,6 +3382,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>DataDir</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>DataDir</literal> </para> @@ -3002,6 +3397,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>FileSystemPath</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>FileSystemPath</literal> </para> @@ -3027,6 +3426,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>BackupDataDir</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>BackupDataDir</literal> </para> @@ -3060,6 +3463,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>DataMemory</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>DataMemory</literal> </para> @@ -3148,6 +3555,11 @@ few large transactions holds no advantage over using many smaller ones, for the following reasons: </para> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>transactions</secondary> + </indexterm> <itemizedlist> @@ -3193,6 +3605,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>IndexMemory</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>IndexMemory</literal> </para> @@ -3344,6 +3760,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>MaxNoOfConcurrentTransactions</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfConcurrentTransactions</literal> </para> @@ -3393,6 +3813,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxNoOfConcurrentOperations</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfConcurrentOperations</literal> </para> @@ -3473,6 +3897,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxNoOfLocalOperations</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfLocalOperations</literal> </para> @@ -3514,6 +3942,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>MaxNoOfConcurrentIndexOperations</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfConcurrentIndexOperations</literal> </para> @@ -3541,6 +3973,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxNoOfFiredTriggers</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfFiredTriggers</literal> </para> @@ -3569,6 +4005,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>TransactionBufferMemory</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>TransactionBufferMemory</literal> </para> @@ -3628,6 +4068,10 @@ </para> <listitem> + <indexterm> + <primary><literal>MaxNoOfConcurrentScans</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfConcurrentScans</literal> </para> @@ -3674,6 +4118,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxNoOfLocalScans</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfLocalScans</literal> </para> @@ -3685,6 +4133,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>BatchSizePerLocalScan</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>BatchSizePerLocalScan</literal> </para> @@ -3707,6 +4159,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>LongMessageBuffer</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LongMessageBuffer</literal> </para> @@ -3733,6 +4189,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>NoOfFragmentLogFiles</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>NoOfFragmentLogFiles</literal> </para> @@ -3792,6 +4252,10 @@ <!-- <listitem> + <indexterm> + <primary><literal>MaxNoOfOpenFiles</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <remark role="todo"> If this doesn't ever need to be changed, then why is it even mentioned? [js] @@ -3815,6 +4279,10 @@ --> <listitem> + <indexterm> + <primary><literal>MaxNoOfSavedMessages</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfSavedMessages</literal> </para> @@ -3849,6 +4317,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>MaxNoOfAttributes</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfAttributes</literal> </para> @@ -3889,6 +4361,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxNoOfTables</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfTables</literal> </para> @@ -3915,6 +4391,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxNoOfOrderedIndexes</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfOrderedIndexes</literal> </para> @@ -3934,6 +4414,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxNoOfUniqueHashIndexes</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfUniqueHashIndexes</literal> </para> @@ -3954,6 +4438,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxNoOfTriggers</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfTriggers</literal> </para> @@ -3984,6 +4472,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxNoOfIndexes</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxNoOfIndexes</literal> </para> @@ -4024,6 +4516,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>LockPagesInMainMemory</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LockPagesInMainMemory</literal> </para> @@ -4041,6 +4537,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>StopOnError</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>StopOnError</literal> </para> @@ -4057,6 +4557,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>Diskless</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>Diskless</literal> </para> @@ -4090,6 +4594,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>RestartOnErrorInsert</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>RestartOnErrorInsert</literal> </para> @@ -4123,6 +4631,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>TimeBetweenWatchDogCheck</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>TimeBetweenWatchDogCheck</literal> </para> @@ -4149,6 +4661,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>StartPartialTimeout</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>StartPartialTimeout</literal> </para> @@ -4168,6 +4684,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>StartPartitionedTimeout</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>StartPartitionedTimeout</literal> </para> @@ -4185,6 +4705,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>StartFailureTimeout</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>StartFailureTimeout</literal> </para> @@ -4208,6 +4732,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>HeartbeatIntervalDbDb</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>HeartbeatIntervalDbDb</literal> </para> @@ -4234,6 +4762,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>HeartbeatIntervalDbApi</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>HeartbeatIntervalDbApi</literal> </para> @@ -4260,6 +4792,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>TimeBetweenLocalCheckpoints</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>TimeBetweenLocalCheckpoints</literal> </para> @@ -4296,6 +4832,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>TimeBetweenGlobalCheckpoints</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>TimeBetweenGlobalCheckpoints</literal> </para> @@ -4331,6 +4871,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>TimeBetweenInactiveTransactionAbortCheck</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>TimeBetweenInactiveTransactionAbortCheck</literal> </para> @@ -4349,6 +4893,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>TransactionInactiveTimeout</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>TransactionInactiveTimeout</literal> </para> @@ -4369,6 +4917,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>TransactionDeadlockDetectionTimeout</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>TransactionDeadlockDetectionTimeout</literal> </para> @@ -4419,6 +4971,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>NoOfDiskPagesToDiskAfterRestartTUP</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>NoOfDiskPagesToDiskAfterRestartTUP</literal> </para> @@ -4465,6 +5021,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>NoOfDiskPagesToDiskAfterRestartACC</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>NoOfDiskPagesToDiskAfterRestartACC</literal> </para> @@ -4483,6 +5043,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>NoOfDiskPagesToDiskDuringRestartTUP</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>NoOfDiskPagesToDiskDuringRestartTUP</literal> </para> @@ -4509,6 +5073,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>NoOfDiskPagesToDiskDuringRestartACC</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>NoOfDiskPagesToDiskDuringRestartACC</literal> </para> @@ -4533,6 +5101,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ArbitrationTimeout</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ArbitrationTimeout</literal> </para> @@ -4574,6 +5146,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>UndoIndexBuffer</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>UndoIndexBuffer</literal> </para> @@ -4621,6 +5197,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>UndoDataBuffer</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>UndoDataBuffer</literal> </para> @@ -4663,6 +5243,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>RedoBuffer</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>RedoBuffer</literal> </para> @@ -4719,6 +5303,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>LogLevelStartup</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LogLevelStartup</literal> </para> @@ -4734,6 +5322,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>LogLevelShutdown</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LogLevelShutdown</literal> </para> @@ -4749,6 +5341,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>LogLevelStatistic</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LogLevelStatistic</literal> </para> @@ -4765,6 +5361,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>LogLevelCheckpoint</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LogLevelCheckpoint</literal> </para> @@ -4780,6 +5380,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>LogLevelNodeRestart</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LogLevelNodeRestart</literal> </para> @@ -4795,6 +5399,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>LogLevelConnection</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LogLevelConnection</literal> </para> @@ -4810,6 +5418,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>LogLevelError</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LogLevelError</literal> </para> @@ -4827,6 +5439,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>LogLevelInfo</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>LogLevelInfo</literal> </para> @@ -4856,6 +5472,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>BackupDataBufferSize</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>BackupDataBufferSize</literal> </para> @@ -4879,6 +5499,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>BackupLogBufferSize</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>BackupLogBufferSize</literal> </para> @@ -4922,6 +5546,10 @@ Ask devs why there's a need for this param, given that it's merely the sum of two others. [js] </remark> + <indexterm> + <primary><literal>BackupMemory</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>BackupMemory</literal> @@ -4939,6 +5567,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>BackupWriteSize</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>BackupWriteSize</literal> </para> @@ -4960,6 +5592,16 @@ <section id="mysql-cluster-api-definition"> <title>&title-mysql-cluster-api-definition;</title> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>configuration</secondary> + </indexterm> + + <indexterm> + <primary>MySQL Cluster</primary> + <secondary>SQL node</secondary> + </indexterm> <para> The <literal>[MYSQLD]</literal> sections in the @@ -4972,6 +5614,10 @@ <itemizedlist> <listitem> + <indexterm> + <primary><literal>Id</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>Id</literal> </para> @@ -4985,6 +5631,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ExecuteOnComputer</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ExecuteOnComputer</literal> </para> @@ -4997,6 +5647,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ArbitrationRank</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ArbitrationRank</literal> </para> @@ -5014,6 +5668,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ArbitrationDelay</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ArbitrationDelay</literal> </para> @@ -5028,6 +5686,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>BatchByteSize</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>BatchByteSize</literal> </para> @@ -5062,6 +5724,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>BatchSize</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>BatchSize</literal> </para> @@ -5073,6 +5739,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>MaxScanBatchSize</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>MaxScanBatchSize</literal> </para> @@ -5143,6 +5813,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>SendBufferMemory</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>SendBufferMemory</literal> </para> @@ -5159,6 +5833,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>SendSignalId</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>SendSignalId</literal> </para> @@ -5172,6 +5850,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>Checksum</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>Checksum</literal> </para> @@ -5192,6 +5874,10 @@ <remark role="todo"> [js] Cut this parameter? </remark> + <indexterm> + <primary><literal>PortNumber</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>PortNumber</literal> @@ -5206,6 +5892,10 @@ </listitem> <listitem> + <indexterm> + <primary><literal>ReceiveBufferMemory</literal> (MySQL Cluster + configuration parameter)</primary> + </indexterm> <para> <literal>ReceiveBufferMemory</literal> </para>
| Thread | ||
|---|---|---|
| • svn commit - mysqldoc@docsrva: r2049 - in trunk: ndbapi refman-4.1 refman-5.0 refman-5.1 | jon | 7 May |
© 1995-2008 MySQL AB, 2008-2009 Sun Microsystems, Inc.
Page generated in 1.517 sec. using MySQL 5.1.14-beta-log