| List: | Commits | « Previous MessageNext Message » | |
| From: | jon | Date: | February 15 2007 1:50am |
| Subject: | svn commit - mysqldoc@docsrva: r4959 - branches/telcos/refman-5.1 trunk/refman-5.1 | ||
| View as plain text | |||
Author: jstephens Date: 2007-02-15 01:50:50 +0100 (Thu, 15 Feb 2007) New Revision: 4959 Log: Quick merges/fixes - merging manpage markup for ndb_size.pl. Modified: branches/telcos/refman-5.1/mysql-cluster.xml trunk/refman-5.1/mysql-cluster.xml Modified: branches/telcos/refman-5.1/mysql-cluster.xml =================================================================== --- branches/telcos/refman-5.1/mysql-cluster.xml 2007-02-14 23:42:31 UTC (rev 4958) +++ branches/telcos/refman-5.1/mysql-cluster.xml 2007-02-15 00:50:50 UTC (rev 4959) Changed blocks: 9, Lines Added: 169, Lines Deleted: 140; 16453 bytes @@ -217,7 +217,7 @@ <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 @@ -225,13 +225,13 @@ inexpensive hardware, and with a minimum of specific requirements for hardware or software. </para> - + <para> - MySQL Cluster is designed not to have any single point of - failure. For this reason, each component is expected to have its - own memory and disk, and the use of shared storage mechanisms such - as network shares, network filesystems, and SANs is not - recommended or supported. + MySQL Cluster is designed not to have any single point of failure. + For this reason, each component is expected to have its own memory + and disk, and the use of shared storage mechanisms such as network + shares, network filesystems, and SANs is not recommended or + supported. </para> <para> @@ -1328,8 +1328,8 @@ </programlisting> <para> - This installs the MySQL Max server binary - (<command>mysqld-max</command>) in the + This installs the MySQL server binary + (<command>mysqld</command>) in the <filename>/usr/sbin</filename> directory, as well as all needed MySQL Server support files. It also installs the <command>mysql.server</command> and @@ -1769,11 +1769,7 @@ If you used RPM files to install MySQL on the cluster host where the SQL node is to reside, you can (and should) use the supplied startup script to start the MySQL server - process on the SQL node. As mention previously, you must - install the <emphasis role="bold">Server / Max</emphasis> - RPM <emphasis>in addition to</emphasis> the - <emphasis role="bold">Server</emphasis> RPM to obtain and - run the <command>mysqld-max</command> server binary. + process on the SQL node. </para> </listitem> @@ -2576,7 +2572,7 @@ <programlisting> shell> <userinput>mysql</userinput> Welcome to the MySQL monitor. Commands end with ; or \g. -Your MySQL connection id is 1 to server version: ¤t-version;-Max +Your MySQL connection id is 1 to server version: ¤t-version; Type 'help;' or '\h' for help. Type '\c' to clear the buffer. @@ -2984,8 +2980,8 @@ <listitem> <para> <literal>[SHM]</literal>: Defines shared-memory - connections between nodes. In MySQL ¤t-series;-max, - it is enabled by default, but should still be considered + connections between nodes. In MySQL ¤t-series;, it + is enabled by default, but should still be considered experimental. For a discussion of SHM interconnects, see <xref linkend="mysql-cluster-shm-definition"/>. </para> @@ -6813,7 +6809,7 @@ <filename>config.ini</filename> file explicitly define SCI (Scalable Coherent Interface) connections between cluster nodes. Using SCI transporters in MySQL Cluster is supported - only when the MySQL-Max binaries are built using + only when the MySQL binaries are built using <option>--with-ndb-sci=<replaceable>/your/path/to/SCI</replaceable></option>. The <replaceable>path</replaceable> should point to a directory that contains at a minimum <filename>lib</filename> @@ -10686,7 +10682,7 @@ identified by the node ID <replaceable>node_id</replaceable> is allowed to access the database. </para> - + <para> It is not possible in MySQL ¤t-series; for data nodes to join the cluster while it is running in single user mode. @@ -14825,160 +14821,193 @@ </section> - <section id="mysql-cluster-utilities-ndb-size"> + <section id="fake-id-for-ndb-size-manpage-section-wrapper"> - <title><command>ndb_size.pl</command></title> + <title>fake title for ndb_size.pl manpage section wrapper</title> - <indexterm> - <primary><command>ndb_size.pl</command></primary> - </indexterm> + <refentry id="mysql-cluster-utilities-ndb-size"> - <para> - <emphasis role="bold">Description</emphasis>: This is a Perl - script that can be used to estimate the amount of space that - would be required by a MySQL database if it were converted to - use the <literal>NDBCluster</literal> storage engine. Unlike the - other utilities discussed in this section, it does not require - access to a MySQL Cluster (in fact, there is no reason for it to - do so). However, it does need to access the MySQL server on - which the database to be tested resides. - </para> + <indexterm> + <primary>ndb_size.pl</primary> + </indexterm> - <para> - <emphasis role="bold">Requirements</emphasis>: - </para> + <refmeta> + <refentrytitle><command>ndb_size.pl</command></refentrytitle> + + <manvolnum>1</manvolnum> + <refmiscinfo class="manual">MySQL Database System</refmiscinfo> + <refmiscinfo class="source">MySQL</refmiscinfo> + <refmiscinfo class="version">¤t-series;</refmiscinfo> + <refmiscinfo class="refman">NDBCluster Size Requirement Estimator</refmiscinfo> + </refmeta> - <itemizedlist> + <refnamediv> + <refname>ndb_size.pl</refname> + + <refpurpose>NDBCluster Size Requirement Estimator</refpurpose> + </refnamediv> - <listitem> - <para> - A running MySQL server. The server instance does not have to - provide support for MySQL Cluster. - </para> - </listitem> + <refsynopsisdiv> + <cmdsynopsis> + <command>ndb_size.pl <replaceable>arguments</replaceable></command> + </cmdsynopsis> + </refsynopsisdiv> - <listitem> - <para> - A working installation of Perl. - </para> - </listitem> + <refsection id="ndb-size-description"> - <listitem> - <para> - The <literal>DBI</literal> and - <literal>HTML::Template</literal> modules, both of which can - be obtained from CPAN if they are not already part of your - Perl installation. (Many Linux and other operating system - distribution provide their own packages for one or both of - these libraries.) - </para> - </listitem> + <title>Description</title> - <listitem> <para> - The <filename>ndb_size.tmpl</filename> template file, which - you should be able to find in the - <filename>share/mysql</filename> directory of your MySQL - installation. This file should be copied or moved into the - same directory as <filename>ndb_size.pl</filename> — - if it is not there already — before running the - script. + This is a Perl script that can be used to estimate the + amount of space that would be required by a MySQL database + if it were converted to use the + <literal>NDBCluster</literal> storage engine. Unlike the + other utilities discussed in this section, it does not + require access to a MySQL Cluster (in fact, there is no + reason for it to do so). However, it does need to access the + MySQL server on which the database to be tested resides. </para> - </listitem> - <listitem> <para> - A MySQL user account having the necessary privileges. If you - do not wish to use an existing account, then creating one - using <literal>GRANT USAGE ON - <replaceable>db_name</replaceable>.*</literal> — where - <replaceable>db_name</replaceable> is the name of the - database to be examined — is sufficient for this - purpose. + <emphasis role="bold">Requirements</emphasis>: </para> - </listitem> - </itemizedlist> + <itemizedlist> - <para> - <filename>ndb_size.pl</filename> and - <filename>ndb_size.tmpl</filename> can also be found in the - MySQL sources in <filename>storage/ndb/tools</filename>. If - these files are not present in your MySQL installation, you can - obtain them from the - <ulink url="http://forge.mysql.com/projects/view.php?id=88">MySQLForge - project page</ulink>. - </para> + <listitem> + <para> + A running MySQL server. The server instance does not + have to provide support for MySQL Cluster. + </para> + </listitem> - <para> - <emphasis role="bold">Usage</emphasis>: - </para> + <listitem> + <para> + A working installation of Perl. + </para> + </listitem> -<programlisting> -perl ndb_size.pl <replaceable>db_name</replaceable> <replaceable>hostname</replaceable> <replaceable>username</replaceable> <replaceable>password</replaceable> > <replaceable>file_name</replaceable>.html -</programlisting> + <listitem> + <para> + The <literal>DBI</literal> and + <literal>HTML::Template</literal> modules, both of which + can be obtained from CPAN if they are not already part + of your Perl installation. (Many Linux and other + operating system distribution provide their own packages + for one or both of these libraries.) + </para> + </listitem> - <para> - The command shown connects to the MySQL server at - <replaceable>hostname</replaceable> using the account of the - user <replaceable>username</replaceable> having the password - <replaceable>password</replaceable>, analyses all of the tables - in database <replaceable>db_name</replaceable>, and generates a - report in HTML format which is directed to the file - <filename><replaceable>file_name</replaceable>.html</filename>. - (Without the redirection, the output is sent to - <literal>stdout</literal>.) This figure shows partial sample - output as viewed in a Web browser: - </para> + <listitem> + <para> + The <filename>ndb_size.tmpl</filename> template file, + which you should be able to find in the + <filename>share/mysql</filename> directory of your MySQL + installation. This file should be copied or moved into + the same directory as <filename>ndb_size.pl</filename> + — if it is not there already — before + running the script. + </para> + </listitem> - <mediaobject> - <imageobject> - <imagedata fileref="images/ndb-size-pl-1.png" format="PNG"/> - </imageobject> - <textobject> - <phrase lang="en">Partial sample output from - <command>ndb_size.pl</command> as viewed in a Web - browser.</phrase> - </textobject> - </mediaobject> + <listitem> + <para> + A MySQL user account having the necessary privileges. If + you do not wish to use an existing account, then + creating one using <literal>GRANT USAGE ON + <replaceable>db_name</replaceable>.*</literal> — + where <replaceable>db_name</replaceable> is the name of + the database to be examined — is sufficient for + this purpose. + </para> + </listitem> - <para> - The output from this script includes: - </para> + </itemizedlist> - <itemizedlist> + <para> + <filename>ndb_size.pl</filename> and + <filename>ndb_size.tmpl</filename> can also be found in the + MySQL sources in <filename>storage/ndb/tools</filename>. If + these files are not present in your MySQL installation, you + can obtain them from the + <ulink url="http://forge.mysql.com/projects/view.php?id=88">MySQLForge + project page</ulink>. + </para> - <listitem> <para> - Minimum values for the <literal>DataMemory</literal>, - <literal>IndexMemory</literal>, - <literal>MaxNoOfTables</literal>, - <literal>MaxNoOfAttributes</literal>, - <literal>MaxNoOfOrderedIndexes</literal>, - <literal>MaxNoOfUniqueHashIndexes</literal>, and - <literal>MaxNoOfTriggers</literal> configuration parameters - required to accommodate the tables analysed. + <emphasis role="bold">Usage</emphasis>: </para> - </listitem> - <listitem> +<programlisting> +perl ndb_size.pl <replaceable>db_name</replaceable> <replaceable>hostname</replaceable> <replaceable>username</replaceable> <replaceable>password</replaceable> > <replaceable>file_name</replaceable>.html +</programlisting> + <para> - Memory requirements for all of the tables, attributes, - ordered indexes, and unique hash indexes defined in the - database. + The command shown connects to the MySQL server at + <replaceable>hostname</replaceable> using the account of the + user <replaceable>username</replaceable> having the password + <replaceable>password</replaceable>, analyses all of the + tables in database <replaceable>db_name</replaceable>, and + generates a report in HTML format which is directed to the + file + <filename><replaceable>file_name</replaceable>.html</filename>. + (Without the redirection, the output is sent to + <literal>stdout</literal>.) This figure shows partial sample + output as viewed in a Web browser: </para> - </listitem> - <listitem> + <mediaobject> + <imageobject> + <imagedata fileref="images/ndb-size-pl-1.png" format="PNG"/> + </imageobject> + <textobject> + <phrase lang="en">Partial sample output from + <command>ndb_size.pl</command> as viewed in a Web + browser.</phrase> + </textobject> + </mediaobject> + <para> - The <literal>IndexMemory</literal> and - <literal>DataMemory</literal> required per table and table - row. + The output from this script includes: </para> - </listitem> - </itemizedlist> + <itemizedlist> + <listitem> + <para> + Minimum values for the <literal>DataMemory</literal>, + <literal>IndexMemory</literal>, + <literal>MaxNoOfTables</literal>, + <literal>MaxNoOfAttributes</literal>, + <literal>MaxNoOfOrderedIndexes</literal>, + <literal>MaxNoOfUniqueHashIndexes</literal>, and + <literal>MaxNoOfTriggers</literal> configuration + parameters required to accommodate the tables analysed. + </para> + </listitem> + + <listitem> + <para> + Memory requirements for all of the tables, attributes, + ordered indexes, and unique hash indexes defined in the + database. + </para> + </listitem> + + <listitem> + <para> + The <literal>IndexMemory</literal> and + <literal>DataMemory</literal> required per table and + table row. + </para> + </listitem> + + </itemizedlist> + + </refsection> + + </refentry> + </section> <!-- Modified: trunk/refman-5.1/mysql-cluster.xml =================================================================== --- trunk/refman-5.1/mysql-cluster.xml 2007-02-14 23:42:31 UTC (rev 4958) +++ trunk/refman-5.1/mysql-cluster.xml 2007-02-15 00:50:50 UTC (rev 4959) Changed blocks: 3, Lines Added: 12, Lines Deleted: 1; 1554 bytes @@ -389,7 +389,7 @@ <emphasis role="bold">Note</emphasis>: In many contexts, the term <quote>node</quote> is used to indicate a computer, but when discussing MySQL Cluster it means a <emphasis>process</emphasis>. - It is posible to run any number of nodes on a single computer, for + It is possible to run any number of nodes on a single computer, for which we use the term <firstterm>cluster host</firstterm>. </para> @@ -1108,6 +1108,16 @@ <listitem> <para> + The <emphasis role="bold">Server/Max</emphasis> RPM (for + example, + <filename>MySQL-Max-¤t-version;-0.glibc23.i386.rpm</filename>), + which provides a MySQL Server binary with clustering + support. + </para> + </listitem> + + <listitem> + <para> The <emphasis role="bold">NDB Cluster - Storage engine</emphasis> RPM (for example, <filename>MySQL-ndb-storage-¤t-version;-0.glibc23.i386.rpm</filename>), @@ -1315,6 +1325,7 @@ <programlisting> shell> <userinput>rpm -Uhv MySQL-server-¤t-version;-0.glibc23.i386.rpm</userinput> +shell> <userinput>rpm -Uhv MySQL-Max-¤t-version;-0.glibc23.i386.rpm</userinput> </programlisting> <para>
| Thread | ||
|---|---|---|
| • svn commit - mysqldoc@docsrva: r4959 - branches/telcos/refman-5.1 trunk/refman-5.1 | jon | 15 Feb |
© 1995-2008 MySQL AB, 2008-2009 Sun Microsystems, Inc.
Page generated in 0.697 sec. using MySQL 5.1.14-beta-log