第 5 章 MySQL Cluster Manager 客户端命令

客户端命令中的标识符

客户端命令的区分大小写规则

客户端命令通用的选项

本章各节描述了 MySQL Cluster Manager 8.0.31 客户端中用于定义站点、包和 MySQL NDB Cluster 实例（“集群”）等任务的命令；配置 MySQL NDB Cluster；并获取正在运行的 MySQL NDB Cluster 的状态。这些命令使用 MySQL NDB Cluster 发行版中包含的mysql 客户端程序向管理代理发出（有关不特定于使用 MySQL Cluster Manager的mysql客户端的信息，请参阅mysql — MySQL 命令行客户端）。每个 MySQL Cluster Manager 客户端命令都采用此处显示的形式：

instruction [options] [arguments]

options:
    option [option] [...]

option:
        --option-long-name[=value-list]
    |   -option-short-name [value-list]

value-list:
    value[,value[,...]]

arguments:
    argument [argument] [...]

考虑以下 MySQL Cluster Manager 命令，它启动一个名为 MySQL NDB Cluster mycluster并在后台删除过程，以便客户端可以同时用于执行其他命令，而不必等待start cluster命令完成：

start cluster --background mycluster;

在此示例中，命令包含一条start cluster指令。一条指令由一个或两个关键字组成，例如set, 或show status。该指令由其后的 --background选项修改；但是，此选项不分配任何值。

大多数命令选项除了长格式外，还有由单个字母组成的短格式。使用 --background选项的缩写形式，前面的例子也可以这样写：

start cluster -B mycluster;

选项的长形式必须以双破折号 ( --) 开头，并且不区分大小写（小写是规范形式）。选项的缩写形式必须以单个破折号 ( -) 开头，并且区分大小写。在任何一种情况下，破折号或字符必须紧接在选项名称之前，并且它们之间不能有空格字符。否则，MySQL Cluster Manager 客户端无法正确解析命令。本节稍后将提供有关多头和空头期权形式的更多信息。

刚才显示的指令采用参数 mysite。参数通常是一个标识符，用于命名要影响的对象；在这种情况下，该命令会删除名称与参数匹配的站点。（有关更多信息，请参阅第 5.2.6 节“create site命令”。）

--verbose可以为 create cluster 、add process和 list hosts命令使用 附加选项。在这两种情况下，使用该选项都会导致命令返回受命令影响的 MySQL NDB Cluster 进程的列表；这包括它们的节点 ID、进程类型和它们所在的主机。

客户端命令中的标识符。  合法的 MySQL Cluster Manager 标识符由以下字符的任意序列组成：

MySQL Cluster Manager 标识符必须以字母或数字开头。

客户端命令的区分大小写规则。  MySQL Cluster Manager 标识符、命令、命令选项、进程名称和配置属性区分大小写的规则如下：

每个命令必须以终止符结尾。默认情况下，这是分号 ( ;) 字符。但是，序列\g和\G也支持作为命令终止符。\G 终止符导致输出被垂直格式化（与标准 mysql 客户端相同），如本例所示：

mcm> get DataMemory mycluster\G
*************************** 1. row ***************************
    Name: DataMemory
   Value: 500M
Process1: ndbd
     Id1: 2
Process2:
     Id2:
   Level: Process
 Comment:
*************************** 2. row ***************************
    Name: DataMemory
   Value: 500M
Process1: ndbd
     Id1: 3
Process2:
     Id2:
   Level: Process
 Comment:
2 rows in set (0.22 sec)

按照惯例（出于可读性原因），当以 Backus-Naur 格式显示命令的语法或在本文中内联包含 MySQL Cluster Manager 命令时，我们通常不包含命令终止符。但是，如果在 MySQL Cluster Manager 客户端中输入命令时不使用语句终止符，客户端会显示特殊的“ waiting... ”提示-> ，直到您提供终止符，如下所示：

mcm> list sites
  ->
  ->
  ->
  -> ;
Empty set (1.50 sec)

（当你不能用终止符结束语句时 ，这与mysql客户端 的行为相同。）

在许多情况下，命令选项也可以接受（甚至需要）一组一个或多个values. 下一个示例包括这样一个选项，并且还通过将它们作为逗号分隔列表传递给选项来演示在单个选项中设置多个值：

mcm> create site --hosts=tonfisk,flundra mysite;
+---------------------------+
| Command result            |
+---------------------------+
| Site created successfully |
+---------------------------+
1 row in set (7.41 sec)

刚刚显示的命令创建了一个名为 的站点 ，该站点由两个名为和mysite的主机组成 。（有关此命令的更多信息，请参阅 第 5.2.6 节“命令”。）由于我们使用了 选项的长格式，因此我们需要使用等号 ( ) 来标记选项名称的结尾和值列表的开头。不得在等号前后插入任何空格字符；这样做会导致错误，如下所示： tonfiskflundracreate site--hosts=

mcm> create site --hosts =grindval,haj yoursite;
ERROR 7 (00MGR): Option --hosts requires a value
mcm> create site --hosts= grindval,haj yoursite;
ERROR 7 (00MGR): Option --hosts requires a value

选项的缩写形式不使用等号。相反，值列表与选项之间用空格隔开。使用 -h选项，这是选项的缩写形式， 可以像这样输入和执行 --hosts前面的 命令：create site

mcm> create site -h tonfisk,flundra mysite;
+---------------------------+
| Command result            |
+---------------------------+
| Site created successfully |
+---------------------------+
1 row in set (7.41 sec)

选项的缩写形式实际上在选项名称和值列表之间接受多个空格；但是，一个空间就足够了。如果省略空格或尝试使用等号，命令将失败并出现错误，如下所示：

mcm> create site -htonfisk,flundra mysite;
ERROR 6 (00MGR): Illegal number of operands
mcm> create site -h=tonfisk,flundra mysite;
ERROR 3 (00MGR): Illegal syntax

任何包含一个或多个空白字符、一个或多个短划线字符 ( -) 或两者的选项值都必须使用单引号引起来。多个值只能用逗号分隔；不要在任何逗号前后插入空格。在值列表中的逗号前后使用空格会导致命令失败并出现错误，如下所示：

mcm> create site --hosts=tonfisk, flundra mysite;
ERROR 6 (00MGR): Illegal number of operands

从刚刚显示的示例中可以看出，MySQL Cluster Manager 客户端命令返回一个结果集，就像标准 mysql客户端中的 SQL 语句一样。MySQL Cluster Manager 客户端命令返回的结果集包含以下内容之一：

每个命令必须单独输入；不可能在一行中组合多个命令。

客户端命令通用的选项。  以下三个选项对于大多数 MySQL Cluster Manager 客户端命令是通用的：