Author: jstephens
Date: 2008-06-24 14:59:14 +0200 (Tue, 24 Jun 2008)
New Revision: 11014
Log:
Update ndb_size.pl description:
No longer requires ndb_size.tmpl
Rearranged to put description of current behaviour first (5.1)
Updated associated changelog entry (Bug #24228)
Wording, spelling, formatting fixes
Fixes Docs Bug #37332 (Thanks, Geert!)
Modified:
trunk/dynamic-docs/changelog/mysqld.xml
trunk/refman-4.1/mysql-cluster-utilities.xml
trunk/refman-5.0/mysql-cluster-utilities.xml
trunk/refman-5.1/mysql-cluster-utilities.xml
trunk/refman-6.0/mysql-cluster-utilities.xml
Modified: trunk/dynamic-docs/changelog/mysqld.xml
===================================================================
--- trunk/dynamic-docs/changelog/mysqld.xml 2008-06-24 10:44:32 UTC (rev 11013)
+++ trunk/dynamic-docs/changelog/mysqld.xml 2008-06-24 12:59:14 UTC (rev 11014)
Changed blocks: 1, Lines Added: 3, Lines Deleted: 1; 620 bytes
@@ -9919,7 +9919,9 @@
<listitem>
<para>
The dependency on <literal>HTML::Template</literal> was
- removed.
+ removed, with the result that the file
+ <filename>ndb_size.tmpl</filename> is no longer needed or
+ included.
</para>
</listitem>
Modified: trunk/refman-4.1/mysql-cluster-utilities.xml
===================================================================
--- trunk/refman-4.1/mysql-cluster-utilities.xml 2008-06-24 10:44:32 UTC (rev 11013)
+++ trunk/refman-4.1/mysql-cluster-utilities.xml 2008-06-24 12:59:14 UTC (rev 11014)
Changed blocks: 2, Lines Added: 2, Lines Deleted: 2; 1185 bytes
@@ -2478,7 +2478,7 @@
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
+ <replaceable>password</replaceable>, analyzes all of the
tables in database <replaceable>db_name</replaceable>, and
generates a report in HTML format which is directed to the
file
@@ -2514,7 +2514,7 @@
<literal>MaxNoOfOrderedIndexes</literal>,
<literal>MaxNoOfUniqueHashIndexes</literal>, and
<literal>MaxNoOfTriggers</literal> configuration
- parameters required to accommodate the tables analysed.
+ parameters required to accommodate the tables analyzed.
</para>
</listitem>
Modified: trunk/refman-5.0/mysql-cluster-utilities.xml
===================================================================
--- trunk/refman-5.0/mysql-cluster-utilities.xml 2008-06-24 10:44:32 UTC (rev 11013)
+++ trunk/refman-5.0/mysql-cluster-utilities.xml 2008-06-24 12:59:14 UTC (rev 11014)
Changed blocks: 2, Lines Added: 2, Lines Deleted: 2; 1185 bytes
@@ -2479,7 +2479,7 @@
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
+ <replaceable>password</replaceable>, analyzes all of the
tables in database <replaceable>db_name</replaceable>, and
generates a report in HTML format which is directed to the
file
@@ -2515,7 +2515,7 @@
<literal>MaxNoOfOrderedIndexes</literal>,
<literal>MaxNoOfUniqueHashIndexes</literal>, and
<literal>MaxNoOfTriggers</literal> configuration
- parameters required to accommodate the tables analysed.
+ parameters required to accommodate the tables analyzed.
</para>
</listitem>
Modified: trunk/refman-5.1/mysql-cluster-utilities.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster-utilities.xml 2008-06-24 10:44:32 UTC (rev 11013)
+++ trunk/refman-5.1/mysql-cluster-utilities.xml 2008-06-24 12:59:14 UTC (rev 11014)
Changed blocks: 4, Lines Added: 88, Lines Deleted: 101; 9148 bytes
@@ -2672,25 +2672,17 @@
<para>
Previous to MySQL 5.1.18, <command>ndb_size.pl</command>
also required the <literal>HTML::Template</literal>
- module.
+ module and an associated template file
+ <filename>share/mysql/ndb_size.tmpl</filename>.
+ Beginning with MySQL 5.1.18,
+ <filename>ndb_size.tmpl</filename> is no longer needed
+ (or included).
</para>
</note>
</listitem>
<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>
-
- <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
@@ -2704,11 +2696,10 @@
</itemizedlist>
<para>
- <filename>ndb_size.pl</filename> and
- <filename>ndb_size.tmpl</filename> can also be found in the
+ <filename>ndb_size.pl</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
+ this file is not present in your MySQL installation, you can
+ obtain it from the
<ulink url="http://forge.mysql.com/projects/project.php?id=88">MySQL
Forge project page</ulink>.
</para>
@@ -2717,93 +2708,11 @@
<emphasis role="bold">Usage</emphasis>:
</para>
-<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>
- 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>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="../refman-common/images/published/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 output from this script includes:
-
- <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>
- </para>
-
- <note>
- <para>
- Beginning with MySQL 5.1.23 and MySQL Cluster NDB 6.2.5, the
- behavior of this utility and its available options have
- changed. (Bug #28683, Bug #28253)
- </para>
- </note>
-
- <para>
- Typical usage is shown here:
-
<programlisting>
-ndb_size.pl [--database=<replaceable>db_name</replaceable>|ALL] [--hostname=<replaceable>host</replaceable>[:<replaceable>port</replaceable>]] [--socket=<replaceable>socket</replaceable>] [--user=<replaceable>user</replaceable>] [--password=<replaceable>password</replaceable>] [--help|-h] [--format=(html|text)] [--loadqueries=<replaceable>file_name</replaceable>] [--savequeries=<replaceable>file_name</replaceable>]
+ndb_size.pl [--database=<replaceable>db_name</replaceable>|ALL] [--hostname=<replaceable>host</replaceable>[:<replaceable>port</replaceable>]] [--socket=<replaceable>socket</replaceable>] [--user=<replaceable>user</replaceable>] \
+ [--password=<replaceable>password</replaceable>] [--help|-h] [--format=(html|text)] [--loadqueries=<replaceable>file_name</replaceable>] [--savequeries=<replaceable>file_name</replaceable>]
</programlisting>
-
- <important>
- <para>
- <command>ndb_size.pl</command> now takes named options,
- each of which is optional.
- </para>
- </important>
</para>
<para>
@@ -2907,6 +2816,84 @@
default value.
</para>
+ <para>
+ To produce output in HTML format, use the
+ <option>--format</option> option and redirect the output to a
+ file, as shown in this example:
+
+<programlisting>
+shell> <userinput>ndb_size.pl --database=test --socket=/tmp/mysql.sock --format=html > ndb_size.html</userinput>
+</programlisting>
+
+ (Without the redirection, the output is sent to
+ <literal>stdout</literal>.) This figure shows a portion of the
+ generated <filename>ndb_size.html</filename> output file, as
+ viewed in a Web browser:
+ </para>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../refman-common/images/published/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 output from this script includes:
+
+ <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 analyzed.
+ </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>
+ </para>
+
+ <note>
+ <para>
+ Prior to MySQL 5.1.23, MySQL Cluster NDB 6.2.5, and MySQL
+ Cluster NDB 6.3.7, <filename>ndb_size.pl</filename> was
+ invoked as shown here:
+
+<programlisting>
+perl ndb_size.pl <replaceable>db_name</replaceable> <replaceable>hostname</replaceable> <replaceable>username</replaceable> <replaceable>password</replaceable> > <replaceable>file_name</replaceable>.html
+</programlisting>
+
+ For more information about this change, see Bug #28683 and
+ Bug #28253.
+ </para>
+ </note>
+
</refsection>
</refentry>
Modified: trunk/refman-6.0/mysql-cluster-utilities.xml
===================================================================
--- trunk/refman-6.0/mysql-cluster-utilities.xml 2008-06-24 10:44:32 UTC (rev 11013)
+++ trunk/refman-6.0/mysql-cluster-utilities.xml 2008-06-24 12:59:14 UTC (rev 11014)
Changed blocks: 4, Lines Added: 148, Lines Deleted: 56; 11365 bytes
@@ -2669,18 +2669,6 @@
<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>
-
- <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
@@ -2694,11 +2682,10 @@
</itemizedlist>
<para>
- <filename>ndb_size.pl</filename> and
- <filename>ndb_size.tmpl</filename> can also be found in the
+ <filename>ndb_size.pl</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
+ this file is not present in your MySQL installation, you can
+ obtain it from the
<ulink url="http://forge.mysql.com/projects/project.php?id=88">MySQL
Forge project page</ulink>.
</para>
@@ -2707,22 +2694,127 @@
<emphasis role="bold">Usage</emphasis>:
</para>
+ <para>
<programlisting>
-perl ndb_size.pl <replaceable>db_name</replaceable> <replaceable>hostname</replaceable> <replaceable>username</replaceable> <replaceable>password</replaceable> > <replaceable>file_name</replaceable>.html
+ndb_size.pl [--database=<replaceable>db_name</replaceable>|ALL] [--hostname=<replaceable>host</replaceable>[:<replaceable>port</replaceable>]] [--socket=<replaceable>socket</replaceable>] [--user=<replaceable>user</replaceable>] \
+ [--password=<replaceable>password</replaceable>] [--help|-h] [--format=(html|text)] [--loadqueries=<replaceable>file_name</replaceable>] [--savequeries=<replaceable>file_name</replaceable>]
</programlisting>
+ </para>
<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>.
+ By default, this utility attempts to analyze all databases on
+ the server. You can specify a single database using the
+ <option>--database</option> option; the default behavior can
+ be made explicit by using <literal>ALL</literal> for the name
+ of the database. You can also exclude one or more databases by
+ using the <option>--excludedbs</option> with a comma-separated
+ list of the names of the databases to be skipped. Similarly,
+ you can cause specific tables to be skipped by listing their
+ names, separated by commas, following the optional
+ <option>--excludetables</option> option. A hostname (and
+ possibly a port as well) can be specified using
+ <option>--hostname</option>; the default is
+ <literal>localhost:3306</literal>. If necessary, you can
+ specify a socket; the default is
+ <filename>/var/lib/mysql.sock</filename>. A MySQL username and
+ password can be specified the corresponding options shown. It
+ also possible to control the format of the output using the
+ <option>--format</option> option; this can take either of the
+ values <literal>html</literal> or <literal>text</literal>,
+ with <literal>text</literal> being the default. An example of
+ the text output is shown here:
+
+<programlisting>
+shell> <userinput>ndb_size.pl --database=test --socket=/tmp/mysql.sock</userinput>
+ndb_size.pl report for database: 'test' (1 tables)
+--------------------------------------------------
+Connected to: DBI:mysql:host=localhost;mysql_socket=/tmp/mysql.sock
+
+Including information for versions: 4.1, 5.0, 5.1
+
+test.t1
+-------
+
+DataMemory for Columns (* means varsized DataMemory):
+ Column Name Type Varsized Key 4.1 5.0 5.1
+ HIDDEN_NDB_PKEY bigint PRI 8 8 8
+ c2 varchar(50) Y 52 52 4*
+ c1 int(11) 4 4 4
+ -- -- --
+Fixed Size Columns DM/Row 64 64 12
+ Varsize Columns DM/Row 0 0 4
+
+DataMemory for Indexes:
+ Index Name Type 4.1 5.0 5.1
+ PRIMARY BTREE 16 16 16
+ -- -- --
+ Total Index DM/Row 16 16 16
+
+IndexMemory for Indexes:
+ Index Name 4.1 5.0 5.1
+ PRIMARY 33 16 16
+ -- -- --
+ Indexes IM/Row 33 16 16
+
+Summary (for THIS table):
+ 4.1 5.0 5.1
+ Fixed Overhead DM/Row 12 12 16
+ NULL Bytes/Row 4 4 4
+ DataMemory/Row 96 96 48 (Includes overhead, bitmap and indexes)
+
+ Varsize Overhead DM/Row 0 0 8
+ Varsize NULL Bytes/Row 0 0 4
+ Avg Varside DM/Row 0 0 16
+
+ No. Rows 0 0 0
+
+ Rows/32kb DM Page 340 340 680
+Fixedsize DataMemory (KB) 0 0 0
+
+Rows/32kb Varsize DM Page 0 0 2040
+ Varsize DataMemory (KB) 0 0 0
+
+ Rows/8kb IM Page 248 512 512
+ IndexMemory (KB) 0 0 0
+
+Parameter Minimum Requirements
+------------------------------
+* indicates greater than default
+
+ Parameter Default 4.1 5.0 5.1
+ DataMemory (KB) 81920 0 0 0
+ NoOfOrderedIndexes 128 1 1 1
+ NoOfTables 128 1 1 1
+ IndexMemory (KB) 18432 0 0 0
+ NoOfUniqueHashIndexes 64 0 0 0
+ NoOfAttributes 1000 3 3 3
+ NoOfTriggers 768 5 5 5
+</programlisting>
+ </para>
+
+ <para>
+ For debugging purposes, the Perl arrays containing the queries
+ run by this script can be read from the file specified using
+ can be saved to a file using <option>--savequeries</option>; a
+ file containing such arrays to be read in during script
+ execution can be specified using
+ <option>--loadqueries</option>. Neither of these options has a
+ default value.
+ </para>
+
+ <para>
+ To produce output in HTML format, use the
+ <option>--format</option> option and redirect the output to a
+ file, as shown in this example:
+
+<programlisting>
+shell> <userinput>ndb_size.pl --database=test --socket=/tmp/mysql.sock --format=html > ndb_size.html</userinput>
+</programlisting>
+
(Without the redirection, the output is sent to
- <literal>stdout</literal>.) This figure shows partial sample
- output as viewed in a Web browser:
+ <literal>stdout</literal>.) This figure shows a portion of the
+ generated <filename>ndb_size.html</filename> output file, as
+ viewed in a Web browser:
</para>
<mediaobject>
@@ -2738,40 +2830,40 @@
<para>
The output from this script includes:
- </para>
- <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>
+ 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 analyzed.
+ </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>
+ 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>
+ <listitem>
+ <para>
+ The <literal>IndexMemory</literal> and
+ <literal>DataMemory</literal> required per table and
+ table row.
+ </para>
+ </listitem>
- </itemizedlist>
+ </itemizedlist>
+ </para>
</refsection>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r11014 - in trunk: dynamic-docs/changelog refman-4.1 refman-5.0 refman-5.1 refman-6.0 | jon | 24 Jun |
