manpagez: man pages & more
Home | html | info | man               MySQL Database System    

NAME - NDBCLUSTER Size Requirement Estimator

SYNOPSIS arguments


       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.

       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

       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. can also be found in the MySQL sources in
       storage/ndb/tools. If this file is not present in your MySQL
       installation, you can obtain it from the MySQL Forge project page[1].

       The following table includes options that are specific to the MySQL
       Cluster program Additional descriptions follow the table.
       For options common to all MySQL Cluster programs, see Section 16.4.2,
       "Options Common to MySQL Cluster Programs".

           perl 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 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 (and possibly a port as well) can
       be specified using --hostname; the default is localhost: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> --database=test --socket=/tmp/mysql.sock
  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
           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 in this example:

           shell> --database=test --socket=/tmp/mysql.sock --format=html > ndb_size.html

       (Without the redirection, the output is sent to stdout.) This figure
       shows a portion of the generated ndb_size.html output file, as viewed
       in a Web browser:

           [IMAGE][2] Partial sample output from
              as viewed in a Web

       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 (C) 1997, 2012, Oracle and/or its affiliates. All rights

       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
       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


        1. MySQL Forge project page

        2. [set $man.base.url.for.relative.links]/../refman-


       For more information, please refer to the MySQL Reference Manual, which
       may already be installed locally and which is also available online at


       Oracle Corporation (

MySQL 5.5                         03/02/2012          

mysql 5.5.22 - Generated Fri Apr 6 12:54:39 CDT 2012
© 2000-2021
Individual documents may contain additional copyright information.