Skip navigation links

Additional languages
MySQL 5.0 Reference Manual :: 16 MySQL Cluster :: 16.10 MySQL Cluster Utility Programs
16.10.1 ndb_config — Extract NDB Configuration Information »
Section Navigation      [Toggle]

16.10. MySQL Cluster Utility Programs

[+/-]

16.10.1. ndb_config — Extract NDB Configuration Information
16.10.2. ndb_cpcd — Automate Testing for NDB Development
16.10.3. ndb_delete_all — Delete All Rows from NDB Table
16.10.4. ndb_desc — Describe NDB Tables
16.10.5. ndb_drop_index — Drop Index from NDB Table
16.10.6. ndb_drop_table — Drop NDB Table
16.10.7. ndb_error_reporter — NDB Error-Reporting Utility
16.10.8. ndb_print_backup_file — Print NDB Backup File Contents
16.10.9. ndb_print_schema_file — Print NDB Schema File Contents
16.10.10. ndb_print_sys_file — Print NDB System File Contents
16.10.11. ndb_select_all — Print Rows from NDB Table
16.10.12. ndb_select_count — Print Row Counts for NDB Tables
16.10.13. ndb_show_tables — Display List of NDB Tables
16.10.14. ndb_size.pl — NDBCLUSTER Size Requirement Estimator
16.10.15. ndb_waiter — Wait for Cluster to Reach a Given Status

This section discusses the MySQL Cluster utility programs that can be found in the mysql/bin directory. Each of these — except for ndb_size.pl and ndb_error_reporter — is a standalone binary that can be used from a system shell, and that does not need to connect to a MySQL server (nor even requires that a MySQL server be connected to the cluster).

These utilities can also serve as examples for writing your own applications using the NDB API. The source code for most of these programs may be found in the ndb/tools directory of the MySQL 5.0 tree (see Section 2.16, “MySQL Installation Using a Source Distribution”). The NDB API is not covered in this manual; please refer to the NDB API Guide for information about this API.

All of the NDB utilities are listed here with brief descriptions:

  • ndb_config: Retrieves Cluster configuration option values.

  • ndb_cpcd: Used in testing and debugging MySQL Cluster.

  • ndb_delete_all: Deletes all rows from a given table.

  • ndb_desc: Lists all properties of an NDB table.

  • ndb_drop_index: Drops the specified index from an NDB table.

  • ndb_drop_table: Drops an NDB table.

  • ndb_error_reporter: Can be used to gather information useful for diagnosing problems with the cluster.

  • ndb_mgm: This is the MySQL Cluster management client, which is discussed in Section 16.7.2, “Commands in the MySQL Cluster Management Client”.

  • ndb_print_backup_file: Prints diagnostic information obtained from cluster backup files.

  • ndb_print_schema_file: Prints diagnostic information obtained from cluster schema files.

  • ndb_print_sys_file: Prints diagnostic information obtained from cluster system files.

  • ndb_restore: This utility is used to restore a cluster from backup. See Section 16.9.3, “ndb_restore — Restore a Cluster Backup”, for more information.

  • ndb_select_all: Prints all rows from an NDB table.

  • ndb_select_count: Gets the number of rows in one or more NDB tables.

  • ndb_show_tables: Shows all NDB tables anywhere in the cluster.

  • ndb_size.pl: Examines all the tables in a given non-Cluster database and calculates the amount of storage each would require if it were converted to use the NDB storage engine.

  • ndb_waiter: Reports on the status of cluster data nodes in a manner similar to that of the management client command ALL STATUS.

Most of these utilities need to connect to a Cluster management server in order to function. The exceptions are ndb_size.pl (see below), and the following utilities which access a cluster data node filesystem and so need to be run on a data node host:

  • ndb_print_backup_file

  • ndb_print_schema_file

  • ndb_print_sys_file

ndb_size.pl is a Perl script which is also intended to be used from the shell; however it is a MySQL application and must be able to connect to a MySQL server. See Section 16.10.14, “ndb_size.pl — NDBCLUSTER Size Requirement Estimator”, for additional requirements for using this script.

ndb_error_reporter is also a Perl script. It is used to gather cluster data node and management node logs together into a tarball to submit along with a bug report. It can use ssh or scp to access the node filesystems remotely.

Additional information about each of these utilities (except for ndb_mgm and ndb_restore) can be found in the sections that follow.

Note

All of these utilities (except for ndb_size.pl and ndb_config) can use the options discussed in Section 16.6.5, “Command Options for MySQL Cluster Processes”. Additional options specific to each utility program are discussed in the individual program listings.

The order in which these options are used is generally not important. For example, all of these commands produce exactly the same output:

  • ndb_desc -c localhost fish -d test

  • ndb_desc fish -c localhost -d test

  • ndb_desc -d test fish -c localhost