文档首页
MySQL 8.4 参考手册
相关文档 下载本手册
PDF (美国信纸) - 39.9Mb
PDF (A4) - 40.0Mb
手册页 (TGZ) - 258.5Kb
手册页 (Zip) - 365.5Kb
Info (Gzip) - 4.0Mb
Info (Zip) - 4.0Mb


MySQL 8.4 参考手册  /  ...  /  ndb_mgm — NDB Cluster 管理客户端

25.5.5 ndb_mgm — NDB Cluster 管理客户端

实际上,运行集群并不需要 ndb_mgm 管理客户端进程。它的价值在于提供了一组命令,用于检查集群的状态、启动备份以及执行其他管理功能。管理客户端使用 C API 访问管理服务器。高级用户还可以使用此 API 为专门的管理进程编写代码,以执行与 ndb_mgm 相似的任务。

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

$> ndb_mgm [host_name [port_num]]

例如

$> ndb_mgm ndb_mgmd.mysql.com 1186

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

以下表格列出了所有可用于 ndb_mgm 的选项。表格下方是其他描述。

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

    命令行格式 --backup-password-from-stdin

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

  • --character-sets-dir

    命令行格式 --character-sets-dir=path

    包含字符集的目录。

  • --connect-retries=#

    命令行格式 --connect-retries=#
    类型 数字
    默认值 3
    最小值 0
    最大值 4294967295

    此选项指定在放弃之前重试连接的次数(客户端始终至少尝试连接一次)。每次尝试等待的时间长度使用 --connect-retry-delay 设置。

    此选项是 --try-reconnect 选项的同义词,现在已弃用。

  • --connect-retry-delay

    命令行格式 --connect-retry-delay=#
    类型 整数
    默认值 5
    最小值 0
    最大值 5

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

  • --connect-string

    命令行格式 --connect-string=connection_string
    类型 字符串
    默认值 [无]

    --ndb-connectstring 相同。

  • --core-file

    命令行格式 --core-file

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

  • --defaults-extra-file

    命令行格式 --defaults-extra-file=path
    类型 字符串
    默认值 [无]

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

  • --defaults-file

    命令行格式 --defaults-file=path
    类型 字符串
    默认值 [无]

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

  • --defaults-group-suffix

    命令行格式 --defaults-group-suffix=string
    类型 字符串
    默认值 [无]

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

  • --encrypt-backup

    命令行格式 --encrypt-backup

    使用此选项时,所有备份都将被加密。为了使每次运行 ndb_mgm 时都能实现这一点,请将此选项放在 my.cnf 文件的 [ndb_mgm] 部分中。

  • --execute=command, -e command

    命令行格式 --execute=command

    此选项可用于从系统 shell 向 NDB Cluster 管理客户端发送命令。例如,以下任一命令等效于在管理客户端中执行 SHOW

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

    这类似于 --execute-e 选项与 mysql 命令行客户端的用法。参见 第 6.2.2.1 节,“在命令行上使用选项”

    注意

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

  • --help

    命令行格式 --help

    显示帮助文本并退出。

  • --login-path

    命令行格式 --login-path=path
    类型 字符串
    默认值 [无]

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

  • --no-login-paths

    命令行格式 --no-login-paths

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

  • --ndb-connectstring

    命令行格式 --ndb-connectstring=connection_string
    类型 字符串
    默认值 [无]

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

  • --ndb-nodeid

    命令行格式 --ndb-nodeid=#
    类型 整数
    默认值 [无]

    设置此节点的节点 ID,覆盖 --ndb-connectstring 设置的任何 ID。

  • --ndb-mgm-tls

    命令行格式 --ndb-mgm-tls=level
    类型 枚举
    默认值 relaxed
    有效值

    relaxed

    strict

    设置连接到管理服务器所需的 TLS 支持级别;relaxedstrict 之一。 relaxed(默认值)表示尝试建立 TLS 连接,但成功不是必需的;strict 表示需要 TLS 连接才能连接。

  • --ndb-mgmd-host

    命令行格式 --ndb-mgmd-host=connection_string
    类型 字符串
    默认值 [无]

    --ndb-connectstring 相同。

  • --ndb-optimized-node-selection

    命令行格式 --ndb-optimized-node-selection

    启用针对事务节点选择的优化。默认情况下启用;使用 --skip-ndb-optimized-node-selection 禁用。

  • --ndb-tls-search-path

    命令行格式 --ndb-tls-search-path=list
    类型 路径名
    默认值 (Unix) $HOME/ndb-tls
    默认值 (Windows) $HOMEDIR/ndb-tls

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

    搜索从最左侧命名的目录开始,并从左到右进行,直到找到一个文件。空字符串表示空搜索路径,这会导致所有搜索失败。由单个点 (.) 组成的字符串表示搜索路径仅限于当前工作目录。

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

  • --no-defaults

    命令行格式 --no-defaults

    不要从除登录文件以外的任何选项文件中读取默认选项。

  • --print-defaults

    命令行格式 --print-defaults

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

  • --test-tls

    命令行格式 --test-tls

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

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

    有关更多信息,参见 第 25.6.15 节,“NDB Cluster 的 TLS 链接加密”

  • --try-reconnect=number

    命令行格式 --try-reconnect=#
    已弃用
    类型 数字
    类型 整数
    默认值 12
    默认值 3
    最小值 0
    最大值 4294967295

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

    此选项已弃用,将在将来的版本中删除。请使用 --connect-retries 替代。

  • --usage

    命令行格式 --usage

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

  • --version

    命令行格式 --version

    显示版本信息并退出。

有关使用 ndb_mgm 的其他信息,请参见 第 25.6.1 节,“NDB Cluster 管理客户端中的命令”