Documentation Home
MySQL 8.4 Reference Manual
Related Documentation Download this Manual
PDF (US Ltr) - 39.8Mb
PDF (A4) - 39.9Mb
Man Pages (TGZ) - 257.9Kb
Man Pages (Zip) - 364.9Kb
Info (Gzip) - 4.0Mb
Info (Zip) - 4.0Mb


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

25.5.5 NDB 集群管理客户端 — 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 一起使用的选项都显示在下表中。附加描述随后出现。

  • --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=path

    包含字符集的目录。

  • --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 [无]

    也可以读取concat(group, suffix)组。

  • --encrypt-backup

    Command-Line Format --encrypt-backup

    当使用此选项时,将使所有备份加密。要使ndb_mgm在运行时始终加密备份,请将选项放入my.cnf文件的[ndb_mgm]部分。

  • --execute=command, -e command

    Command-Line Format --execute=command

    此选项可用于从系统shell发送命令到NDB集群管理客户端。例如,以下两个示例等效于在管理客户端中执行SHOW

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

    这是类似于如何使用--execute-e选项与mysql命令行客户端工作的。请参阅第6.2.2.1节,“在命令行上使用选项”

    Note

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

  • --help

    Command-Line Format --help

    显示帮助文本并退出。

  • --login-path

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

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

  • --no-login-paths

    Command-Line Format --no-login-paths

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

  • --ndb-connectstring

    Command-Line Format --ndb-connectstring=connection_string
    Type 字符串
    Default Value [none]

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

  • --ndb-nodeid

    Command-Line Format --ndb-nodeid=#
    Type 整数
    Default Value [none]

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

  • --ndb-mgm-tls

    Command-Line Format --ndb-mgm-tls=level
    Type 枚举值
    Default Value relaxed
    Valid Values

    relaxed

    strict

    设置连接到管理服务器所需的TLS支持级别;可以是relaxedstrictrelaxed(默认)意味着尝试建立TLS连接,但成功不必要求;strict意味着必须使用TLS才能连接。

  • --ndb-mgmd-host

    Command-Line Format --ndb-mgmd-host=connection_string
    Type 字符串
    Default Value [none]

    --ndb-connectstring相同。

  • --ndb-optimized-node-selection

    Command-Line Format --ndb-optimized-node-selection

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

  • --ndb-tls-search-path

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

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

    搜索从左侧命名目录开始,自右向左依次进行,直到找到文件为止。空字符串表示空搜索路径,将导致所有搜索失败。一个包含单个点(.)的字符串表示搜索路径仅限于当前工作目录。

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

  • --no-defaults

    Command-Line Format --no-defaults

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

  • --print-defaults

    Command-Line Format --print-defaults

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

  • --test-tls

    Command-Line Format --test-tls

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

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

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

  • --try-reconnect=number

    Command-Line Format --try-reconnect=#
    Deprecated 是的
    Type 数值
    Type 整数
    Default Value 12
    Default Value 3
    Minimum Value 0
    Maximum Value 4294967295

    如果连接到管理服务器中断,节点将尝试每5秒重新连接一次,直到成功。通过使用此选项,可以限制重试次数为number之前报错而不是放弃。

    此选项已被弃用,并且在未来的版本中可能会删除。请改用--connect-retries

  • --usage

    Command-Line Format --usage

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

  • --version

    Command-Line Format --version

    显示版本信息并退出。

有关使用ndb_mgm的更多信息,可以在Section 25.6.1, “Commands in the NDB Cluster Management Client”中找到。