1307 lines
24 KiB
Groff
1307 lines
24 KiB
Groff
'\" t
|
|
.\" Title: ndb_desc
|
|
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
|
|
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
|
|
.\" Date: 12/13/2024
|
|
.\" Manual: MySQL Database System
|
|
.\" Source: MySQL 8.4
|
|
.\" Language: English
|
|
.\"
|
|
.TH "NDB_DESC" "1" "12/13/2024" "MySQL 8\&.4" "MySQL Database System"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * Define some portability stuff
|
|
.\" -----------------------------------------------------------------
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.\" http://bugs.debian.org/507673
|
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\" -----------------------------------------------------------------
|
|
.\" * set default formatting
|
|
.\" -----------------------------------------------------------------
|
|
.\" disable hyphenation
|
|
.nh
|
|
.\" disable justification (adjust text to left margin only)
|
|
.ad l
|
|
.\" -----------------------------------------------------------------
|
|
.\" * MAIN CONTENT STARTS HERE *
|
|
.\" -----------------------------------------------------------------
|
|
.SH "NAME"
|
|
ndb_desc \- describe NDB tables
|
|
.SH "SYNOPSIS"
|
|
.HP \w'\fBndb_desc\ \fR\fB\fIoptions\fR\fR\ 'u
|
|
\fBndb_desc \fR\fB\fIoptions\fR\fR
|
|
.SH "DESCRIPTION"
|
|
.PP
|
|
\fBndb_desc\fR
|
|
provides a detailed description of one or more
|
|
NDB
|
|
tables\&.
|
|
Usage
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
ndb_desc \-c \fIconnection_string\fR \fItbl_name\fR \-d \fIdb_name\fR [\fIoptions\fR]
|
|
ndb_desc \-c \fIconnection_string\fR \fIindex_name\fR \-d \fIdb_name\fR \-t \fItbl_name\fR
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
Additional options that can be used with
|
|
\fBndb_desc\fR
|
|
are listed later in this section\&.
|
|
Sample Output
|
|
.PP
|
|
MySQL table creation and population statements:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
USE test;
|
|
CREATE TABLE fish (
|
|
id INT NOT NULL AUTO_INCREMENT,
|
|
name VARCHAR(20) NOT NULL,
|
|
length_mm INT NOT NULL,
|
|
weight_gm INT NOT NULL,
|
|
PRIMARY KEY pk (id),
|
|
UNIQUE KEY uk (name)
|
|
) ENGINE=NDB;
|
|
INSERT INTO fish VALUES
|
|
(NULL, \*(Aqguppy\*(Aq, 35, 2), (NULL, \*(Aqtuna\*(Aq, 2500, 150000),
|
|
(NULL, \*(Aqshark\*(Aq, 3000, 110000), (NULL, \*(Aqmanta ray\*(Aq, 1500, 50000),
|
|
(NULL, \*(Aqgrouper\*(Aq, 900, 125000), (NULL ,\*(Aqpuffer\*(Aq, 250, 2500);
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
Output from
|
|
\fBndb_desc\fR:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
$> \fB\&./ndb_desc \-c localhost fish \-d test \-p\fR
|
|
\-\- fish \-\-
|
|
Version: 2
|
|
Fragment type: HashMapPartition
|
|
K Value: 6
|
|
Min load factor: 78
|
|
Max load factor: 80
|
|
Temporary table: no
|
|
Number of attributes: 4
|
|
Number of primary keys: 1
|
|
Length of frm data: 337
|
|
Max Rows: 0
|
|
Row Checksum: 1
|
|
Row GCI: 1
|
|
SingleUserMode: 0
|
|
ForceVarPart: 1
|
|
PartitionCount: 2
|
|
FragmentCount: 2
|
|
PartitionBalance: FOR_RP_BY_LDM
|
|
ExtraRowGciBits: 0
|
|
ExtraRowAuthorBits: 0
|
|
TableStatus: Retrieved
|
|
Table options:
|
|
HashMap: DEFAULT\-HASHMAP\-3840\-2
|
|
\-\- Attributes \-\-
|
|
id Int PRIMARY KEY DISTRIBUTION KEY AT=FIXED ST=MEMORY AUTO_INCR
|
|
name Varchar(20;latin1_swedish_ci) NOT NULL AT=SHORT_VAR ST=MEMORY DYNAMIC
|
|
length_mm Int NOT NULL AT=FIXED ST=MEMORY DYNAMIC
|
|
weight_gm Int NOT NULL AT=FIXED ST=MEMORY DYNAMIC
|
|
\-\- Indexes \-\-
|
|
PRIMARY KEY(id) \- UniqueHashIndex
|
|
PRIMARY(id) \- OrderedIndex
|
|
uk(name) \- OrderedIndex
|
|
uk$unique(name) \- UniqueHashIndex
|
|
\-\- Per partition info \-\-
|
|
Partition Row count Commit count Frag fixed memory Frag varsized memory Extent_space Free extent_space
|
|
0 2 2 32768 32768 0 0
|
|
1 4 4 32768 32768 0 0
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
Information about multiple tables can be obtained in a single invocation of
|
|
\fBndb_desc\fR
|
|
by using their names, separated by spaces\&. All of the tables must be in the same database\&.
|
|
.PP
|
|
You can obtain additional information about a specific index using the
|
|
\fB\-\-table\fR
|
|
(short form:
|
|
\fB\-t\fR) option and supplying the name of the index as the first argument to
|
|
\fBndb_desc\fR, as shown here:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
$> \fB\&./ndb_desc uk \-d test \-t fish\fR
|
|
\-\- uk \-\-
|
|
Version: 2
|
|
Base table: fish
|
|
Number of attributes: 1
|
|
Logging: 0
|
|
Index type: OrderedIndex
|
|
Index status: Retrieved
|
|
\-\- Attributes \-\-
|
|
name Varchar(20;latin1_swedish_ci) NOT NULL AT=SHORT_VAR ST=MEMORY
|
|
\-\- IndexTable 10/uk \-\-
|
|
Version: 2
|
|
Fragment type: FragUndefined
|
|
K Value: 6
|
|
Min load factor: 78
|
|
Max load factor: 80
|
|
Temporary table: yes
|
|
Number of attributes: 2
|
|
Number of primary keys: 1
|
|
Length of frm data: 0
|
|
Max Rows: 0
|
|
Row Checksum: 1
|
|
Row GCI: 1
|
|
SingleUserMode: 2
|
|
ForceVarPart: 0
|
|
PartitionCount: 2
|
|
FragmentCount: 2
|
|
FragmentCountType: ONE_PER_LDM_PER_NODE
|
|
ExtraRowGciBits: 0
|
|
ExtraRowAuthorBits: 0
|
|
TableStatus: Retrieved
|
|
Table options:
|
|
\-\- Attributes \-\-
|
|
name Varchar(20;latin1_swedish_ci) NOT NULL AT=SHORT_VAR ST=MEMORY
|
|
NDB$TNODE Unsigned [64] PRIMARY KEY DISTRIBUTION KEY AT=FIXED ST=MEMORY
|
|
\-\- Indexes \-\-
|
|
PRIMARY KEY(NDB$TNODE) \- UniqueHashIndex
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
When an index is specified in this way, the
|
|
\fB\-\-extra\-partition\-info\fR
|
|
and
|
|
\fB\-\-extra\-node\-info\fR
|
|
options have no effect\&.
|
|
.PP
|
|
The
|
|
Version
|
|
column in the output contains the table\*(Aqs schema object version\&. For information about interpreting this value, see
|
|
\m[blue]\fBNDB Schema Object Versions\fR\m[]\&\s-2\u[1]\d\s+2\&.
|
|
.PP
|
|
Three of the table properties that can be set using
|
|
NDB_TABLE
|
|
comments embedded in
|
|
CREATE TABLE
|
|
and
|
|
ALTER TABLE
|
|
statements are also visible in
|
|
\fBndb_desc\fR
|
|
output\&. The table\*(Aqs
|
|
FRAGMENT_COUNT_TYPE
|
|
is always shown in the
|
|
FragmentCountType
|
|
column\&.
|
|
READ_ONLY
|
|
and
|
|
FULLY_REPLICATED, if set to 1, are shown in the
|
|
Table options
|
|
column\&. You can see this after executing the following
|
|
ALTER TABLE
|
|
statement in the
|
|
\fBmysql\fR
|
|
client:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
mysql> \fBALTER TABLE fish COMMENT=\*(AqNDB_TABLE=READ_ONLY=1,FULLY_REPLICATED=1\*(Aq;\fR
|
|
1 row in set, 1 warning (0\&.00 sec)
|
|
mysql> \fBSHOW WARNINGS\eG\fR
|
|
+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
|
|
| Level | Code | Message |
|
|
+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
|
|
| Warning | 1296 | Got error 4503 \*(AqTable property is FRAGMENT_COUNT_TYPE=ONE_PER_LDM_PER_NODE but not in comment\*(Aq from NDB |
|
|
+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
|
|
1 row in set (0\&.00 sec)
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
The warning is issued because
|
|
READ_ONLY=1
|
|
requires that the table\*(Aqs fragment count type is (or be set to)
|
|
ONE_PER_LDM_PER_NODE_GROUP;
|
|
NDB
|
|
sets this automatically in such cases\&. You can check that the
|
|
ALTER TABLE
|
|
statement has the desired effect using
|
|
SHOW CREATE TABLE:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
mysql> \fBSHOW CREATE TABLE fish\eG\fR
|
|
*************************** 1\&. row ***************************
|
|
Table: fish
|
|
Create Table: CREATE TABLE `fish` (
|
|
`id` int(11) NOT NULL AUTO_INCREMENT,
|
|
`name` varchar(20) NOT NULL,
|
|
`length_mm` int(11) NOT NULL,
|
|
`weight_gm` int(11) NOT NULL,
|
|
PRIMARY KEY (`id`),
|
|
UNIQUE KEY `uk` (`name`)
|
|
) ENGINE=ndbcluster DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci
|
|
COMMENT=\*(AqNDB_TABLE=READ_BACKUP=1,FULLY_REPLICATED=1\*(Aq
|
|
1 row in set (0\&.01 sec)
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
Because
|
|
FRAGMENT_COUNT_TYPE
|
|
was not set explicitly, its value is not shown in the comment text printed by
|
|
SHOW CREATE TABLE\&.
|
|
\fBndb_desc\fR, however, displays the updated value for this attribute\&. The
|
|
Table options
|
|
column shows the binary properties just enabled\&. You can see this in the output shown here (emphasized text):
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
$> \fB\&./ndb_desc \-c localhost fish \-d test \-p\fR
|
|
\-\- fish \-\-
|
|
Version: 4
|
|
Fragment type: HashMapPartition
|
|
K Value: 6
|
|
Min load factor: 78
|
|
Max load factor: 80
|
|
Temporary table: no
|
|
Number of attributes: 4
|
|
Number of primary keys: 1
|
|
Length of frm data: 380
|
|
Max Rows: 0
|
|
Row Checksum: 1
|
|
Row GCI: 1
|
|
SingleUserMode: 0
|
|
ForceVarPart: 1
|
|
PartitionCount: 1
|
|
FragmentCount: 1
|
|
\fIFragmentCountType: ONE_PER_LDM_PER_NODE_GROUP\fR
|
|
ExtraRowGciBits: 0
|
|
ExtraRowAuthorBits: 0
|
|
TableStatus: Retrieved
|
|
\fITable options: readbackup, fullyreplicated\fR
|
|
HashMap: DEFAULT\-HASHMAP\-3840\-1
|
|
\-\- Attributes \-\-
|
|
id Int PRIMARY KEY DISTRIBUTION KEY AT=FIXED ST=MEMORY AUTO_INCR
|
|
name Varchar(20;latin1_swedish_ci) NOT NULL AT=SHORT_VAR ST=MEMORY DYNAMIC
|
|
length_mm Int NOT NULL AT=FIXED ST=MEMORY DYNAMIC
|
|
weight_gm Int NOT NULL AT=FIXED ST=MEMORY DYNAMIC
|
|
\-\- Indexes \-\-
|
|
PRIMARY KEY(id) \- UniqueHashIndex
|
|
PRIMARY(id) \- OrderedIndex
|
|
uk(name) \- OrderedIndex
|
|
uk$unique(name) \- UniqueHashIndex
|
|
\-\- Per partition info \-\-
|
|
Partition Row count Commit count Frag fixed memory Frag varsized memory Extent_space Free extent_space
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
For more information about these table properties, see
|
|
Section\ \&15.1.20.12, \(lqSetting NDB Comment Options\(rq\&.
|
|
.PP
|
|
The
|
|
Extent_space
|
|
and
|
|
Free extent_space
|
|
columns are applicable only to
|
|
NDB
|
|
tables having columns on disk; for tables having only in\-memory columns, these columns always contain the value
|
|
0\&.
|
|
.PP
|
|
To illustrate their use, we modify the previous example\&. First, we must create the necessary Disk Data objects, as shown here:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
CREATE LOGFILE GROUP lg_1
|
|
ADD UNDOFILE \*(Aqundo_1\&.log\*(Aq
|
|
INITIAL_SIZE 16M
|
|
UNDO_BUFFER_SIZE 2M
|
|
ENGINE NDB;
|
|
ALTER LOGFILE GROUP lg_1
|
|
ADD UNDOFILE \*(Aqundo_2\&.log\*(Aq
|
|
INITIAL_SIZE 12M
|
|
ENGINE NDB;
|
|
CREATE TABLESPACE ts_1
|
|
ADD DATAFILE \*(Aqdata_1\&.dat\*(Aq
|
|
USE LOGFILE GROUP lg_1
|
|
INITIAL_SIZE 32M
|
|
ENGINE NDB;
|
|
ALTER TABLESPACE ts_1
|
|
ADD DATAFILE \*(Aqdata_2\&.dat\*(Aq
|
|
INITIAL_SIZE 48M
|
|
ENGINE NDB;
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
(For more information on the statements just shown and the objects created by them, see
|
|
Section\ \&25.6.11.1, \(lqNDB Cluster Disk Data Objects\(rq, as well as
|
|
Section\ \&15.1.16, \(lqCREATE LOGFILE GROUP Statement\(rq, and
|
|
Section\ \&15.1.21, \(lqCREATE TABLESPACE Statement\(rq\&.)
|
|
.PP
|
|
Now we can create and populate a version of the
|
|
fish
|
|
table that stores 2 of its columns on disk (deleting the previous version of the table first, if it already exists):
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
DROP TABLE IF EXISTS fish;
|
|
CREATE TABLE fish (
|
|
id INT NOT NULL AUTO_INCREMENT,
|
|
name VARCHAR(20) NOT NULL,
|
|
length_mm INT NOT NULL,
|
|
weight_gm INT NOT NULL,
|
|
PRIMARY KEY pk (id),
|
|
UNIQUE KEY uk (name)
|
|
) TABLESPACE ts_1 STORAGE DISK
|
|
ENGINE=NDB;
|
|
INSERT INTO fish VALUES
|
|
(NULL, \*(Aqguppy\*(Aq, 35, 2), (NULL, \*(Aqtuna\*(Aq, 2500, 150000),
|
|
(NULL, \*(Aqshark\*(Aq, 3000, 110000), (NULL, \*(Aqmanta ray\*(Aq, 1500, 50000),
|
|
(NULL, \*(Aqgrouper\*(Aq, 900, 125000), (NULL ,\*(Aqpuffer\*(Aq, 250, 2500);
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
When run against this version of the table,
|
|
\fBndb_desc\fR
|
|
displays the following output:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
$> \fB\&./ndb_desc \-c localhost fish \-d test \-p\fR
|
|
\-\- fish \-\-
|
|
Version: 1
|
|
Fragment type: HashMapPartition
|
|
K Value: 6
|
|
Min load factor: 78
|
|
Max load factor: 80
|
|
Temporary table: no
|
|
Number of attributes: 4
|
|
Number of primary keys: 1
|
|
Length of frm data: 1001
|
|
Max Rows: 0
|
|
Row Checksum: 1
|
|
Row GCI: 1
|
|
SingleUserMode: 0
|
|
ForceVarPart: 1
|
|
PartitionCount: 2
|
|
FragmentCount: 2
|
|
PartitionBalance: FOR_RP_BY_LDM
|
|
ExtraRowGciBits: 0
|
|
ExtraRowAuthorBits: 0
|
|
TableStatus: Retrieved
|
|
Table options: readbackup
|
|
HashMap: DEFAULT\-HASHMAP\-3840\-2
|
|
Tablespace id: 16
|
|
Tablespace: ts_1
|
|
\-\- Attributes \-\-
|
|
id Int PRIMARY KEY DISTRIBUTION KEY AT=FIXED ST=MEMORY AUTO_INCR
|
|
name Varchar(80;utf8mb4_0900_ai_ci) NOT NULL AT=SHORT_VAR ST=MEMORY
|
|
length_mm Int NOT NULL AT=FIXED ST=DISK
|
|
weight_gm Int NOT NULL AT=FIXED ST=DISK
|
|
\-\- Indexes \-\-
|
|
PRIMARY KEY(id) \- UniqueHashIndex
|
|
PRIMARY(id) \- OrderedIndex
|
|
uk(name) \- OrderedIndex
|
|
uk$unique(name) \- UniqueHashIndex
|
|
\-\- Per partition info \-\-
|
|
Partition Row count Commit count Frag fixed memory Frag varsized memory Extent_space Free extent_space
|
|
0 2 2 32768 32768 1048576 1044440
|
|
1 4 4 32768 32768 1048576 1044400
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
This means that 1048576 bytes are allocated from the tablespace for this table on each partition, of which 1044440 bytes remain free for additional storage\&. In other words, 1048576 \- 1044440 = 4136 bytes per partition is currently being used to store the data from this table\*(Aqs disk\-based columns\&. The number of bytes shown as
|
|
Free extent_space
|
|
is available for storing on\-disk column data from the
|
|
fish
|
|
table only; for this reason, it is not visible when selecting from the Information Schema
|
|
FILES
|
|
table\&.
|
|
.PP
|
|
Tablespace id
|
|
and
|
|
Tablespace
|
|
are also displayed for Disk Data tables\&.
|
|
.PP
|
|
For fully replicated tables,
|
|
\fBndb_desc\fR
|
|
shows only the nodes holding primary partition fragment replicas; nodes with copy fragment replicas (only) are ignored\&. You can obtain such information, using the
|
|
\fBmysql\fR
|
|
client, from the
|
|
table_distribution_status,
|
|
table_fragments,
|
|
table_info, and
|
|
table_replicas
|
|
tables in the
|
|
ndbinfo
|
|
database\&.
|
|
.PP
|
|
All options that can be used with
|
|
\fBndb_desc\fR
|
|
are shown in the following table\&. Additional descriptions follow the table\&.
|
|
.PP
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-auto\-inc\fR,
|
|
\fB\-a\fR
|
|
Show the next value for a table\*(Aqs
|
|
AUTO_INCREMENT
|
|
column, if it has one\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-blob\-info\fR,
|
|
\fB\-b\fR
|
|
Include information about subordinate
|
|
BLOB
|
|
and
|
|
TEXT
|
|
columns\&.
|
|
.sp
|
|
Use of this option also requires the use of the
|
|
\fB\-\-extra\-partition\-info\fR
|
|
(\fB\-p\fR) option\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-character\-sets\-dir\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--character-sets-dir=path
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Directory containing character sets\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-connect\-retries\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--connect-retries=#
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Integer
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
12
|
|
T}
|
|
T{
|
|
Minimum Value
|
|
T}:T{
|
|
0
|
|
T}
|
|
T{
|
|
Maximum Value
|
|
T}:T{
|
|
12
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Number of times to retry connection before giving up\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-connect\-retry\-delay\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--connect-retry-delay=#
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Integer
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
5
|
|
T}
|
|
T{
|
|
Minimum Value
|
|
T}:T{
|
|
0
|
|
T}
|
|
T{
|
|
Maximum Value
|
|
T}:T{
|
|
5
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Number of seconds to wait between attempts to contact management server\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-connect\-string\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--connect-string=connection_string
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
[none]
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Same as
|
|
\fB\-\-ndb\-connectstring\fR\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-context\fR,
|
|
\fB\-x\fR
|
|
Show additional contextual information for the table such as schema, database name, table name, and the table\*(Aqs internal ID\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-core\-file\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--core-file
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Write core file on error; used in debugging\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-database=\fR\fB\fIdb_name\fR\fR,
|
|
\fB\-d\fR
|
|
Specify the database in which the table should be found\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-defaults\-extra\-file\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--defaults-extra-file=path
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
[none]
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Read given file after global files are read\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-defaults\-file\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--defaults-file=path
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
[none]
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Read default options from given file only\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-defaults\-group\-suffix\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--defaults-group-suffix=string
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
[none]
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Also read groups with concat(group, suffix)\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-extra\-node\-info\fR,
|
|
\fB\-n\fR
|
|
Include information about the mappings between table partitions and the data nodes upon which they reside\&. This information can be useful for verifying distribution awareness mechanisms and supporting more efficient application access to the data stored in NDB Cluster\&.
|
|
.sp
|
|
Use of this option also requires the use of the
|
|
\fB\-\-extra\-partition\-info\fR
|
|
(\fB\-p\fR) option\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-extra\-partition\-info\fR,
|
|
\fB\-p\fR
|
|
Print additional information about the table\*(Aqs partitions\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-help\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--help
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Display help text and exit\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-login\-path\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--login-path=path
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
[none]
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Read given path from login file\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-no\-login\-paths\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--no-login-paths
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Skips reading options from the login path file\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-ndb\-connectstring\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--ndb-connectstring=connection_string
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
[none]
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Set connect string for connecting to
|
|
\fBndb_mgmd\fR\&. Syntax:
|
|
[nodeid=\fIid\fR;][host=]\fIhostname\fR[:\fIport\fR]\&. Overrides entries in
|
|
NDB_CONNECTSTRING
|
|
and
|
|
my\&.cnf\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-ndb\-mgm\-tls\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--ndb-mgm-tls=level
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Enumeration
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
relaxed
|
|
T}
|
|
T{
|
|
Valid Values
|
|
T}:T{
|
|
.PP
|
|
relaxed
|
|
.PP
|
|
strict
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Sets the level of TLS support required to connect to the management server; one of
|
|
relaxed
|
|
or
|
|
strict\&.
|
|
relaxed
|
|
(the default) means that a TLS connection is attempted, but success is not required;
|
|
strict
|
|
means that TLS is required to connect\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-ndb\-mgmd\-host\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--ndb-mgmd-host=connection_string
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
[none]
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Same as
|
|
\fB\-\-ndb\-connectstring\fR\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-ndb\-nodeid\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--ndb-nodeid=#
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Integer
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
[none]
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Set node ID for this node, overriding any ID set by
|
|
\fB\-\-ndb\-connectstring\fR\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-ndb\-optimized\-node\-selection\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--ndb-optimized-node-selection
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Enable optimizations for selection of nodes for transactions\&. Enabled by default; use
|
|
\fB\-\-skip\-ndb\-optimized\-node\-selection\fR
|
|
to disable\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-ndb\-tls\-search\-path\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--ndb-tls-search-path=list
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Path name
|
|
T}
|
|
T{
|
|
Default Value (Unix)
|
|
T}:T{
|
|
$HOME/ndb-tls
|
|
T}
|
|
T{
|
|
Default Value (Windows)
|
|
T}:T{
|
|
$HOMEDIR/ndb-tls
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Specify a list of directories to search for a CA file\&. On Unix platforms, the directory names are separated by colons (:); on Windows systems, the semicolon character (;) is used as the separator\&. A directory reference may be relative or absolute; it may contain one or more environment variables, each denoted by a prefixed dollar sign ($), and expanded prior to use\&.
|
|
.sp
|
|
Searching begins with the leftmost named directory and proceeds from left to right until a file is found\&. An empty string denotes an empty search path, which causes all searches to fail\&. A string consisting of a single dot (\&.) indicates that the search path limited to the current working directory\&.
|
|
.sp
|
|
If no search path is supplied, the compiled\-in default value is used\&. This value depends on the platform used: On Windows, this is
|
|
\endb\-tls; on other platforms (including Linux), it is
|
|
$HOME/ndb\-tls\&. This can be overridden by compiling NDB Cluster using
|
|
\fB\-DWITH_NDB_TLS_SEARCH_PATH\fR\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-no\-defaults\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--no-defaults
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Do not read default options from any option file other than login file\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-print\-defaults\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--print-defaults
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Print program argument list and exit\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-retries=\fR\fB\fI#\fR\fR,
|
|
\fB\-r\fR
|
|
Try to connect this many times before giving up\&. One connect attempt is made per second\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-table=\fR\fB\fItbl_name\fR\fR,
|
|
\fB\-t\fR
|
|
Specify the table in which to look for an index\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-unqualified\fR,
|
|
\fB\-u\fR
|
|
Use unqualified table names\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-usage\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--usage
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Display help text and exit; same as
|
|
\fB\-\-help\fR\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-version\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--version
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Display version information and exit\&.
|
|
.RE
|
|
.PP
|
|
Table indexes listed in the output are ordered by ID\&.
|
|
.SH "COPYRIGHT"
|
|
.br
|
|
.PP
|
|
Copyright \(co 1997, 2024, Oracle and/or its affiliates.
|
|
.PP
|
|
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.
|
|
.PP
|
|
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.
|
|
.PP
|
|
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/.
|
|
.sp
|
|
.SH "NOTES"
|
|
.IP " 1." 4
|
|
NDB Schema Object Versions
|
|
.RS 4
|
|
\%https://dev.mysql.com/doc/ndb-internals/en/ndb-internals-schema-object-versions.html
|
|
.RE
|
|
.SH "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/.
|
|
.SH AUTHOR
|
|
Oracle Corporation (http://dev.mysql.com/).
|