17.4.13. ndb_index_stat — NDB Index Statistics Utility

Usage

To obtain basic index statistics about a given NDB table, invoke ndb_index_stat as shown here, with the name of the table as the first argument and the name of the database containing this table specified immediately following it, using the --database (-d) option:

ndb_index_stat table -d database

In this example, we use ndb_index_stat to obtain such information about an NDB table named mytable in the test database:

shell> ndb_index_stat -d test mytabletable:mytable index:PRIMARY fragCount:4sampleVersion:2 loadTime:1336751773 sampleCount:0 keyBytes:0query cache: valid:1 sampleCount:0 totalBytes:0times in ms: save: 12.380 sort: 0.001NDBT_ProgramExit: 0 - OK

The --verbose option provides some additional output, as shown here:

shell> ndb_index_stat -d test mytable
        --verboserandom seed 1337010518connectedloop 1 of 1table:mytable index:PRIMARY fragCount:4sampleVersion:2 loadTime:1336751773 sampleCount:0 keyBytes:0read statsquery cache createdquery cache: valid:1 sampleCount:0 totalBytes:0times in ms: save: 20.766 sort: 0.001disconnectedNDBT_ProgramExit: 0 - OKshell>

Options

The following table includes options that are specific to the MySQL Cluster ndb_index_stat utility. Additional descriptions are listed following the table. For options common to most MySQL Cluster programs (including ndb_index_stat), see Section 17.4.25, "Options Common to MySQL Cluster Programs — Options Common to MySQL Cluster Programs".

Table 17.20. ndb_index_stat Options and Variables: MySQL ClusterNDB 7.3

Format	Description	Added / Removed
`--database=name`, `-d`	Name of the database containing the table.	All MySQL 5.6 based releases
`--delete`	Delete index statistics for the given table, stopping any auto-update previously configured.	All MySQL 5.6 based releases
`--update`	Update index statistics for the given table, restarting any auto-update previously configured.	All MySQL 5.6 based releases
`--dump`	Print the query cache.	All MySQL 5.6 based releases
`--query=#`	Perform a number of random range queries on first key attr (must be int unsigned).	All MySQL 5.6 based releases
`--sys-drop`	Drop any statistics tables and events in NDB kernel (all statistics are lost)	All MySQL 5.6 based releases
`--sys-create`	Create all statistics tables and events in NDB kernel, if none of them already exist	All MySQL 5.6 based releases
`--sys-create-if-not-exist`	Create any statistics tables and events in NDB kernel that do not already exist.	All MySQL 5.6 based releases
`--sys-create-if-not-valid`	Create any statistics tables or events that do not already exist in the NDB kernel. after dropping any that are invalid.	All MySQL 5.6 based releases
`--sys-check`	Verify that NDB system index statistics and event tables exist.	All MySQL 5.6 based releases
`--sys-skip-tables`	Do not apply sys-* options to tables.	All MySQL 5.6 based releases
`--sys-skip-events`	Do not apply sys-* options to events.	All MySQL 5.6 based releases
`--verbose`, `-v`	Turn on verbose output	All MySQL 5.6 based releases
`--loops=#`	Set the number of times to perform a given command. Default is 0.	All MySQL 5.6 based releases

ndb_index_stat statistics options. The following options are used to generate index statistics. They work with a given table and database. They cannot be mixed with ndb_index_stat system options.

--database=name, -d name

Command-Line Format	`--database=name`
	`-d`
	Permitted Values
	Type	`string`
	Default	`[none]`
	Range	`..`

The name of the database that contains the table being queried.

--delete

Command-Line Format	`--delete`
	Permitted Values
	Type	`boolean`
	Default	`true`
	Range	`..`

Delete the index statistics for the given table, stopping any auto-update that was previously configured.

--update

Command-Line Format	`--update`
	Permitted Values
	Type	`boolean`
	Default	`true`
	Range	`..`

Update the index statistics for the given table, and restart any auto-update that previously configured.

--dump

Command-Line Format	`--dump`
	Permitted Values
	Type	`boolean`
	Default	`true`
	Range	`..`

Dump the contents of the query cache.

--query=#

Command-Line Format	`--query=#`
	Permitted Values
	Type	`numeric`
	Default	`0`
	Range	`0 .. MAX_INT`

Perform random range queries on first key attribute (must be int unsigned).

ndb_index_stat system options. The following options are used to generate and update the statistics tables in the NDB kernel. They cannot be mixed with ndb_index_stat statistics options.

--sys-drop

Command-Line Format	`--sys-drop`
	Permitted Values
	Type	`boolean`
	Default	`true`
	Range	`..`

Drop all statistics tables and events in the NDB kernel. This causes all statistics to be lost.

--sys-create

Command-Line Format	`--sys-create`
	Permitted Values
	Type	`boolean`
	Default	`true`
	Range	`..`

Create all statistics tables and events in the NDB kernel. This works only if none of them exist previously.

sys-create-if-not-exist

Command-Line Format	`--sys-create-if-not-exist`
	Permitted Values
	Type	`boolean`
	Default	`true`
	Range	`..`

Create any NDB system statistics tables or events (or both) that do not already exist when the program is invoked.

--sys-create-if-not-valid

Command-Line Format	`--sys-create-if-not-valid`
	Permitted Values
	Type	`boolean`
	Default	`true`
	Range	`..`

Create any NDB system statistics tables or events that do not already exist, after dropping any that are invalid.

--sys-check

Command-Line Format	`--sys-check`
	Permitted Values
	Type	`boolean`
	Default	`true`
	Range	`..`

Verify that all required system statistics tables and events exist in the NDB kernel.

--sys-skip-tables

Command-Line Format	`--sys-skip-tables`
	Permitted Values
	Type	`boolean`
	Default	`true`
	Range	`..`

Do not apply any --sys-* options to any statistics tables.

--sys-skip-events

Command-Line Format	`--sys-skip-events`
	Permitted Values
	Type	`boolean`
	Default	`true`
	Range	`..`

Do not apply any --sys-* options to any events.

--verbose

Command-Line Format	`--verbose`
	`-v`
	Permitted Values
	Type	`boolean`
	Default	`true`
	Range	`..`

Turn on verbose output.

--loops=#

Command-Line Format	`--loops=#`
	Permitted Values
	Type	`numeric`
	Default	`0`
	Range	`0 .. MAX_INT`

Repeat commands this number of times (for use in testing).