Documentation Home
MySQL 8.3 Reference Manual
Related Documentation Download this Manual
PDF (US Ltr) - 40.8Mb
PDF (A4) - 40.9Mb
Man Pages (TGZ) - 294.0Kb
Man Pages (Zip) - 409.0Kb
Info (Gzip) - 4.0Mb
Info (Zip) - 4.0Mb
Excerpts from this Manual

MySQL 8.3 Reference Manual  /  ...  /  ndb_mgm — The NDB Cluster Management Client

25.5.5 ndb_mgm — NDB 集群管理客户端

管理客户端进程 ndb_mgm 实际上不需要运行集群。其价值在于提供一组命令来检查集群的状态、启动备份和执行其他管理功能。管理客户端使用 C API 访问管理服务器。高级用户也可以使用此 API 编程专门的管理进程来执行类似于 ndb_mgm 的任务。

要启动管理客户端,需要提供管理服务器的主机名和端口号:

$> ndb_mgm [host_name [port_num]]

例如:

$> ndb_mgm ndb_mgmd.mysql.com 1186

默认的主机名和端口号分别是 localhost 和 1186。

所有可以与 ndb_mgm 一起使用的选项都显示在以下表格中。表格后面是每个选项的详细描述。

表 25.26 与程序 ndb_mgm 一起使用的命令行选项

Format Description Added, Deprecated, or Removed

--backup-password-from-stdin

以安全方式从 STDIN 获取解密密码;与 --execute 和 ndb_mgm START BACKUP 命令一起使用

(在所有基于 MySQL 8.3 的 NDB 版本中支持)

--connect-retries=#

设置连接尝试次数;0 表示仅尝试一次(不重试)

(在所有基于 MySQL 8.3 的 NDB 版本中支持)

--connect-retry-delay=#

在尝试联系管理服务器之间等待的秒数

(在所有基于 MySQL 8.3 的 NDB 版本中支持)

--connect-string=connection_string,

-c connection_string

与 --ndb-connectstring 相同

(在所有基于 MySQL 8.3 的 NDB 版本中支持)

--defaults-extra-file=path

在读取全局文件后读取给定的文件

(在所有基于 MySQL 8.3 的 NDB 版本中支持)

--defaults-file=path

仅从给定的文件中读取默认选项

(在所有基于 MySQL 8.3 的 NDB 版本中支持)

--defaults-group-suffix=string

也读取组名与 suffix 连接的组

(在所有基于 MySQL 8.3 的 NDB 版本中支持)

--encrypt-backup

使 START BACKUP 命令总是加密备份,提示用户输入密码(如果未提供)

(在所有基于 MySQL 8.3 的 NDB 版本中支持)

--execute=command,

-e command

执行命令并退出

(在所有基于 MySQL 8.3 的 NDB 版本中支持)

--help,

-?

显示帮助文本并退出

(在所有基于 MySQL 8.3 的 NDB 版本中支持)

--login-path=path

从登录文件中读取给定的路径

(在所有基于 MySQL 8.3 的 NDB 版本中支持)

--no-login-paths

不要从登录路径文件中读取登录路径

(在所有基于 MySQL 8.3 的 NDB 版本中支持)

--ndb-connectstring=连接字符串,

-c 连接字符串

设置连接到 ndb_mgmd 的连接字符串。语法:"[nodeid=id;][host=]主机名[:端口]"。覆盖 NDB_CONNECTSTRING 和 my.cnf 中的条目

(在所有基于 MySQL 8.3 的 NDB 版本中支持)

--ndb-mgm-tls=级别

ndb_mgm 客户端 TLS 要求级别

ADDED: 8.3.0

--ndb-mgmd-host=连接字符串,

-c 连接字符串

与 --ndb-connectstring 相同

(在所有基于 MySQL 8.3 的 NDB 版本中支持)

--ndb-nodeid=#

设置该节点的节点 ID,覆盖 --ndb-connectstring 中设置的 ID

(在所有基于 MySQL 8.3 的 NDB 版本中支持)

--test-tls

使用 TLS 连接,然后退出

ADDED: 8.3.0

--ndb-tls-search-path=列表

包含 TLS 密钥和证书的目录列表

ADDED: 8.3.0

--no-defaults

不从任何选项文件中读取默认选项,除了登录文件

(在所有基于 MySQL 8.3 的 NDB 版本中支持)

--print-defaults

打印程序参数列表并退出

(在所有基于 MySQL 8.3 的 NDB 版本中支持)

--try-reconnect=#,

-t #

设置在放弃之前重试连接的次数;同义词 --connect-retries

(在所有基于 MySQL 8.3 的 NDB 版本中支持)

--usage,

-?

显示帮助文本并退出;同义词 --help

(在所有基于 MySQL 8.3 的 NDB 版本中支持)

--version,

-V

显示版本信息并退出

(在所有基于 MySQL 8.3 的 NDB 版本中支持)


  • --backup-password-from-stdin[=TRUE|FALSE]

    Command-Line Format --backup-password-from-stdin

    启用从系统 shell (stdin) 输入备份密码时使用 --execute "START BACKUP" 或类似命令创建备份。使用此选项需要同时使用 --execute

  • --character-sets-dir

    Command-Line Format --character-sets-dir=路径

    包含字符集的目录。

  • --connect-retries=#

    Command-Line Format --connect-retries=#
    Type 数字
    Default Value 3
    Minimum Value 0
    Maximum Value 4294967295

    该选项指定了在第一次尝试连接失败后重试连接的次数(客户端总是至少尝试连接一次)。每次尝试的等待时间设置使用 --connect-retry-delay

    该选项与 --try-reconnect 选项相同,现在已弃用。

  • --connect-retry-delay

    Command-Line Format --connect-retry-delay=#
    Type 整数
    Default Value 5
    Minimum Value 0
    Maximum Value 5

    等待管理服务器之间的秒数。

  • --connect-string

    Command-Line Format --connect-string=connection_string
    Type 字符串
    Default Value [none]

    --ndb-connectstring 相同。

  • --core-file

    Command-Line Format --core-file

    在错误时写入核心文件;用于调试。

  • --defaults-extra-file

    Command-Line Format --defaults-extra-file=path
    Type 字符串
    Default Value [none]

    在读取全局文件后读取给定的文件。

  • --defaults-file

    Command-Line Format --defaults-file=path
    Type 字符串
    Default Value [none]

    仅从给定的文件中读取默认选项。

  • --defaults-group-suffix

    Command-Line Format --defaults-group-suffix=string
    Type 字符串
    Default Value [none]

    还读取带有concat(group,suffix)的组。

  • --encrypt-backup

    Command-Line Format --encrypt-backup

    使用该选项时,所有备份都将被加密。要使其在每次运行 ndb_mgm 时生效,请将选项添加到 [ndb_mgm] 部分的 my.cnf 文件中。

  • --execute=command, -e command

    Command-Line Format --execute=command

    该选项可用于从系统 shell 中将命令发送到 NDB 集群管理客户端。例如,以下任一命令都等同于在管理客户端中执行 SHOW

    $> ndb_mgm -e "SHOW"
    
    $> ndb_mgm --execute="SHOW"

    这与 --execute-e 选项与 mysql 命令行客户端一起使用类似。

    Note

    如果管理客户端命令包含任何空格字符,则该命令 必须 用引号括起来。可以使用单引号或双引号。如果管理客户端命令不包含空格字符,则引号是可选的。

  • --help

    Command-Line Format --help

    显示帮助文本并退出。

  • --登录路径

    Command-Line Format --登录路径=path
    Type 字符串
    Default Value [none]

    从登录文件中读取给定的路径。

  • --不使用登录路径

    Command-Line Format --不使用登录路径

    跳过从登录路径文件中读取选项。

  • --连接字符串

    Command-Line Format --连接字符串=connection_string
    Type 字符串
    Default Value [none]

    设置连接到 ndb_mgmd 的连接字符串。语法:[nodeid=id;][host=]hostname[:port]. 覆盖 NDB_CONNECTSTRINGmy.cnf 中的条目。

  • --节点 ID

    Command-Line Format --节点 ID=#
    Type 整数
    Default Value [none]

    设置该节点的节点 ID,覆盖 --连接字符串 中设置的 ID。

  • --TLS 支持级别

    Command-Line Format --TLS 支持级别=level
    Type 枚举
    Default Value relaxed
    Valid Values

    relaxed

    strict

    设置连接到管理服务器所需的 TLS 支持级别;可以是 relaxedstrictrelaxed(默认)表示尝试使用 TLS 连接,但不要求成功; strict 表示需要 TLS 连接。

  • --管理服务器主机

    Command-Line Format --管理服务器主机=connection_string
    Type 字符串
    Default Value [none]

    --连接字符串 相同。

  • --优化节点选择

    Command-Line Format --优化节点选择

    启用事务节点选择的优化。默认启用;使用 --skip-优化节点选择 禁用。

  • --TLS 搜索路径

    Command-Line Format --TLS 搜索路径=list
    Type 路径名
    Default Value (Unix) $HOME/ndb-tls
    Default Value (Windows) $HOMEDIR/ndb-tls

    指定要搜索 CA 文件的目录列表。在 Unix 平台上,目录名之间用冒号 (:) 分隔;在 Windows 系统上,分号 (;) 用作分隔符。目录引用可以是相对的或绝对的,可以包含一个或多个环境变量,每个变量以美元符号 ($) 开头,并在使用前展开。

    搜索从左到右进行,直到找到文件。空字符串表示空搜索路径,导致所有搜索失败。点 (.) 表示当前工作目录。

    如果不提供搜索路径,默认使用编译时的默认值。该值取决于平台:在 Windows 上为 \ndb-tls;在其他平台(包括 Linux)上为 $HOME/ndb-tls。这可以通过使用 -DWITH_NDB_TLS_SEARCH_PATH 编译 NDB 集群来覆盖。

  • --不使用默认值

    Command-Line Format --不使用默认值

    不从任何选项文件中读取默认选项,除了登录文件。

  • --打印默认值

    Command-Line Format --打印默认值

    打印程序参数列表并退出。

  • --测试TLS

    Command-Line Format --测试TLS

    使用TLS连接,然后退出。如果成功,输出类似于以下内容:

    >$ ndb_mgm --test-tls
    Connected to Management Server at: sakila:1186
    >$

    从NDB 8.3.0开始添加了--测试TLS选项。

    请参阅第 25.6.15 节,“NDB 集群 TLS 链接加密”,以获取更多信息。

  • --尝试重新连接=数字

    Command-Line Format --尝试重新连接=#
    Deprecated
    Type 数字
    Type 整数
    Default Value 12
    Default Value 3
    Minimum Value 0
    Maximum Value 4294967295

    如果与管理服务器的连接断开,节点将每 5 秒尝试重新连接,直到成功。使用此选项,可以将尝试次数限制为 数字,然后报告错误。

    此选项已弃用,并将在未来版本中删除。请使用 --connect-retries instead。

  • --使用帮助

    Command-Line Format --使用帮助

    显示帮助文本并退出;与 --help相同。

  • --版本

    Command-Line Format --版本

    显示版本信息并退出。

有关使用 ndb_mgm 的更多信息,请参阅 第 25.6.1 节,“NDB 集群管理客户端命令”