NDB_SIZE.PL(1) MySQL Database System NDB_SIZE.PL(1)
NAME
ndb_size.pl - NDBCLUSTER Size Requirement Estimator
SYNOPSIS
ndb_size.pl arguments
DESCRIPTION
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 NDBCLUSTER 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.
Requirements
o A running MySQL server. The server instance does not have to provide support for MySQL Cluster.
o A working installation of Perl.
o The DBI module, which can be obtained from CPAN if it is not already part of your Perl installation. (Many Linux and other operating
system distributions provide their own packages for this library.)
o A MySQL user account having the necessary privileges. If you do not wish to use an existing account, then creating one using GRANT
USAGE ON db_name.*--where db_name is the name of the database to be examined--is sufficient for this purpose.
ndb_size.pl can also be found in the MySQL sources in storage/ndb/tools.
The following table includes options that are specific to the MySQL Cluster program ndb_size.pl. Additional descriptions follow the table.
For options common to most MySQL Cluster programs (including ndb_size.pl), see Options Common to MySQL Cluster Programs(1).
Table 17.27. ndb_size.pl Options and Variables: MySQL Cluster NDB 7.2
+--------------------------------+--------------------------------------+-------------------------------------+
|Format | Description | Added / Removed |
+--------------------------------+--------------------------------------+-------------------------------------+
| | The database or databases to | |
| --database=dbname | examine; accepts a comma-delimited | All MySQL 5.5 based releases |
| | list; | |
| | the default is ALL (use | |
| | all databases found on the server) | |
+--------------------------------+--------------------------------------+-------------------------------------+
| | Specify host and optional port as | |
| --hostname[:port] | host[:port] | All MySQL 5.5 based releases |
+--------------------------------+--------------------------------------+-------------------------------------+
| | Specify a socket to connect to | |
| --socket=file | | All MySQL 5.5 based releases |
+--------------------------------+--------------------------------------+-------------------------------------+
| | Specify a MySQL user name | |
| --user=string | | All MySQL 5.5 based releases |
+--------------------------------+--------------------------------------+-------------------------------------+
| | Specify a MySQL user password | |
| --password=string | | All MySQL 5.5 based releases |
+--------------------------------+--------------------------------------+-------------------------------------+
| | Set output format (text or HTML) | |
| --format=string | | All MySQL 5.5 based releases |
+--------------------------------+--------------------------------------+-------------------------------------+
| | Skip any tables in a comma-separated | |
| --excludetables=tbl_list | list of tables | All MySQL 5.5 based releases |
+--------------------------------+--------------------------------------+-------------------------------------+
| | Skip any databases in a | |
| --excludedbs=db_list | comma-separated list of databases | All MySQL 5.5 based releases |
+--------------------------------+--------------------------------------+-------------------------------------+
| | Saves all queries to the database | |
| --savequeries=file | into the file specified | All MySQL 5.5 based releases |
+--------------------------------+--------------------------------------+-------------------------------------+
| | Loads all queries from the file | |
| --loadqueries=file | specified; does not connect to a | All MySQL 5.5 based releases |
| | database | |
+--------------------------------+--------------------------------------+-------------------------------------+
| | Designates a table to handle unique | |
| --real_table_name=table | index size calculations | All MySQL 5.5 based releases |
+--------------------------------+--------------------------------------+-------------------------------------+
Usage
perl ndb_size.pl [--database={db_name|ALL}] [--hostname=host[:port]] [--socket=socket]
[--user=user] [--password=password]
[--help|-h] [--format={html|text}]
[--loadqueries=file_name] [--savequeries=file_name]
By default, this utility attempts to analyze all databases on the server. You can specify a single database using the --database option;
the default behavior can be made explicit by using ALL for the name of the database. You can also exclude one or more databases by using
the --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 --excludetables option. A host name can be specified
using --hostname; the default is localhost. In MySQL Cluster NDB 7.2.6 and later, you can specify a port in addition to the host using
host:port format for the value of --hostname. The default port number is 3306. If necessary, you can also specify a socket; the default is
/var/lib/mysql.sock. A MySQL user name and password can be specified the corresponding options shown. It also possible to control the
format of the output using the --format option; this can take either of the values html or text, with text being the default. An example of
the text output is shown here:
shell> ndb_size.pl --database=test --socket=/tmp/mysql.sock
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
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 --savequeries; a file containing such arrays to be read in during script execution can be specified using --loadqueries.
Neither of these options has a default value.
To produce output in HTML format, use the --format option and redirect the output to a file, as shown here:
shell> ndb_size.pl --database=test --socket=/tmp/mysql.sock --format=html > ndb_size.html
(Without the redirection, the output is sent to stdout.)
The output from this script includes the following information:
o Minimum values for the DataMemory, IndexMemory, MaxNoOfTables, MaxNoOfAttributes, MaxNoOfOrderedIndexes, MaxNoOfUniqueHashIndexes, and
MaxNoOfTriggers configuration parameters required to accommodate the tables analyzed.
o Memory requirements for all of the tables, attributes, ordered indexes, and unique hash indexes defined in the database.
o The IndexMemory and DataMemory required per table and table row.
COPYRIGHT
Copyright (C) 1997, 2014, Oracle and/or its affiliates. All rights reserved.
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as
published by the Free Software Foundation; version 2 of the License.
This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation,
Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/.
SEE ALSO
For more information, please refer to the MySQL Reference Manual, which may already be installed locally and which is also available online
at http://dev.mysql.com/doc/.
AUTHOR
Oracle Corporation (http://dev.mysql.com/).
MySQL 5.5 01/30/2014 NDB_SIZE.PL(1)