Ignite命令行工具

1.概述

Ignite 命令行工具使用 REST API 作为通信协议。其可以配置整个集群，也可以调整某个节点的参数。该工具可以运行于交互模式，也可以不需要输入直接执行命令。

1.1.交互式模式

要使用交互模式的命令行，先启动命令行，然后就可以使用update命令对集群或者节点进行配置。

例如，要给集群添加一个新的用户：

shell

cluster config update ignite.security.authentication.providers.default.users=[{username=newuser,displayName=newuser,password="newpassword",passwordEncoding=PLAIN,roles=[system]}]

1.2.非交互模式

非交互模式主要用于快速更新，或者在脚本中执行命令的场景。

以非交互方式执行命令时，将参数括在引号中，以确保正确解释特殊的POSIX字符（例如{和} ）：

LinuxWindows

shell

bin/ignite3 cluster config update "ignite.schemaSync={delayDurationMillis=500,maxClockSkewMillis=500}"

shell

bin/ignite3.bat cluster config update "ignite.schemaSync={delayDurationMillis=500,maxClockSkewMillis=500}"

或者，也可以使用反斜杠（\）来转义命令中的所有特殊字符，例如：

LinuxWindows

shell

bin/ignite3 cluster config update ignite.security.authentication.providers.default.users=\[\{username\=newuser,displayName\=newuser,password\=\"newpassword\",passwordEncoding\=PLAIN,roles\=\[system\]\}\]

shell

bin/ignite3.bat cluster config update ignite.security.authentication.providers.default.users=\[\{username\=newuser,displayName\=newuser,password\=\"newpassword\",passwordEncoding\=PLAIN,roles\=\[system\]\}\]

非交互模式在自动化脚本中也很有用。例如可以在脚本中设置配置项，如下所示：

shell

#!/bin/bash

...

bin/ignite3 cluster config update "ignite.schemaSync={delayDurationMillis=500,maxClockSkewMillis=500}"

bin/ignite3 cluster config update "ignite.security.authentication.providers.default.users=[{username=newuser,displayName=newuser,password=\"newpassword\",passwordEncoding=PLAIN,roles=[system]}]"

1.3.详细输出

所有命令都可以提供有助于调试的附加输出，可以多次指定-v选项以增加输出详细程度。单个选项显示 REST 请求和响应，第二个选项（-vv）显示请求标头，第三个选项（-vvv）显示请求体。

1.4.命令行工具日志

命令行工具会存储操作的扩展日志，这些日志包含正常操作期间未显示的其他信息，可以通过以下方式配置目录：

配置IGNITE_CLI_LOGS_DIR环境变量，值为存储日志的目录；
通过配置$XDG_STATE_HOME环境变量来指定命令行主文件夹，该变量遵循 XDG 基本目录规范，并且不会覆盖IGNITE_CLI_LOGS_DIR，如果配置了$XDG_STATE_HOME但未配置IGNITE_CLI_LOGS_DIR，则日志将存储在$XDG_STATE_HOME/ignitecli/logs目录中。

如果上述参数都未指定，则日志将存储在以下位置：

在 Unix 系统和 MacOS 上，在~/.local/state/ignitecli/logs目录中；
在 Windows 上，在%USERPROFILE%\.local\state\ignitecli\logs目录中。

2.SQL 命令

这些命令可以在集群内执行 SQL 查询。

2.1.sql

执行 SQL 查询，如果未指定 SQL 则进入交互式 SQL 编辑器模式。

语法

shell

sql [--jdbc-url=<jdbc>] [--plain] [--file=<file>] [--profile=<profileName>] [--verbose] <command>

参数

参数	类型	必填	描述
`‑‑jdbc‑url`	`Option`	否	Ignite 集群的 JDBC URL（例如，`jdbc:ignite:thin://127.0.0.1:10800`）。
`‑‑plain`	`Flag`	否	以简易格式显示输出。
`‑‑file`	`Option`	否	包含要执行的 SQL 命令的文件的路径。
`‑‑profile`	`Option`	否	本地命令行配置文件名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。
`<command>`	`Argument`	是	要执行的 SQL 查询。

示例

shell

sql "SELECT * FROM PUBLIC.PERSON"

2.2.sql planner invalidate-cache

使 SQL 执行计划器缓存失效。

语法

shell

sql planner invalidate-cache [--tables=<tables>] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

参数

参数	类型	必填	描述
`‑‑tables`	`Option`	否	以逗号分隔的表列表。
`‑‑url`	`Option`	否	集群端点的 URL，可以是任何节点的 URL。如果未指定，将使用配置文件设置中的默认 URL。
`‑‑profile`	`Option`	否	本地命令行配置文件名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。

示例

shell

sql planner invalidate-cache --tables=PUBLIC.PERSON,PUBLIC.ORDERS

3.命令行配置命令

这些命令用于配置 Ignite 的命令行工具配置文件和设置。

3.1.cli config profile create

使用指定名称创建配置。

语法

shell

cli config profile create [--activate] [--copy-from=<copyFrom>] [--verbose] <profileName>

参数

参数	类型	必填	描述
`‑‑activate`	`Flag`	否	激活新配置作为当前配置。
`‑‑copy-from`	`Option`	否	内容将复制到新配置的配置。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。
`<profileName>`	`Argument`	是	新配置的名称。

示例

shell

cli config profile create --activate --copy-from=default myprofile

3.2.cli config profile activate

激活指定名字的配置。

语法

shell

cli config profile activate [--verbose] <profileName>

参数

参数	类型	必填	描述
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。
`<profileName>`	`Argument`	是	要激活的配置名。

示例

shell

cli config profile activate myprofile

3.3.cli config profile list

列出已有的配置。

语法

shell

cli config profile list [--verbose]

参数

参数	类型	必填	描述
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。

示例

shell

cli config profile list

3.4.cli config profile show

获取当前配置的详细信息。

语法

shell

cli config profile show [--verbose]

参数

参数	类型	必填	描述
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。

示例

shell

cli config profile show

3.5.cli config get

获取指定配置的内容。

语法

shell

cli config get [--profile=<profileName>] [--verbose] <key>

参数

参数	类型	必填	描述
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。
`<key>`	`Argument`	是	配置名。

示例

shell

cli config get ignite.jdbc-url

3.6.cli config set

使用逗号分隔的键值对设定配置参数。

语法

shell

cli config set [--profile=<profileName>] [--verbose] <String=String>...

参数

参数	类型	必填	描述
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。
`<String=String>`	`Argument`	是	命令行配置参数。

示例

shell

cli config set ignite.jdbc-url=http://localhost:10300

3.7.cli config show

显示当前的配置信息。

语法

shell

cli config show [--profile=<profileName>] [--verbose]

参数

参数	类型	必填	描述
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。

示例

shell

cli config show

3.8.cli config remove

删除指定的配置项。

语法

shell

cli config remove [--profile=<profileName>] [--verbose] <key>

参数

参数	类型	必填	描述
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。
`<key>`	`Argument`	是	配置名。

示例

shell

cli config remove ignite.jdbc-url

4.集群命令

这些命令用于管理集群。

4.1.cluster config show

显示由端点 URL 指定的集群配置，也可以选择由配置路径选择器指定。

语法

shell

cluster config show [--url=<clusterUrl>] [--format=<format>] [--profile=<profileName>] [--verbose] [<selector>]

参数

参数	类型	必填	描述
`‑‑url`	`Option`	否	集群端点的 URL。
`‑‑format`	`Option`	否	输出格式。有效值：`JSON`、`HOCON`（默认：`HOCON`）。
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。
`<selector>`	`Argument`	否	配置路径选择器。

示例

shell

cluster config show

4.2.cluster config update

使用提供的参数值更新端点 URL 指定的集群配置。

语法

shell

cluster config update [--url=<clusterUrl>] [--file=<configFile>] [--profile=<profileName>] [--verbose] [<args>...]

参数

参数	类型	必填	描述
`‑‑url`	`Option`	否	集群端点的 URL。
`‑‑file`	`Option`	否	包含要执行的配置更新命令的文件路径。
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。
`<args>`	`Argument`	否	要更新的配置参数和值。

示例

shell

cluster config update ignite.system.idleSafeTimeSyncIntervalMillis=250

4.3.cluster init

初始化 Ignite 集群。

语法

shell

cluster init --name=<clusterName> [--metastorage-group=<nodeNames>] [--cluster-management-group=<nodeNames>] [--config=<config>] [--config-files=<filePaths>] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

参数

参数	类型	必填	描述
`‑‑name`	`Option`	是	集群的方便记忆的名称。
`‑‑metastorage-group`	`Option`	否	元存储组节点（逗号分隔的列表）。
`‑‑cluster-management-group`	`Option`	否	将负责集群管理组的节点的名称（逗号分隔的列表）。
`‑‑config`	`Option`	否	初始化期间将应用的集群配置。
`‑‑config-files`	`Option`	否	初始化期间将应用的集群配置文件（逗号分隔的列表）。
`‑‑url`	`Option`	否	集群端点的 URL。
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。

示例

shell

cluster init --name myCluster

4.4.cluster status

输出集群的状态。

语法

shell

cluster status [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

参数

参数	类型	必填	描述
`‑‑url`	`Option`	否	集群端点的 URL。
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。

示例

shell

cluster status --url http://localhost:10300

4.5.cluster topology physical

显示指定集群的物理拓扑。

语法

shell

cluster topology physical [--plain] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

参数

参数	类型	必填	描述
`‑‑plain`	`Flag`	否	简易格式显示输出。
`‑‑url`	`Option`	否	集群端点的 URL。
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。

示例

shell

cluster topology physical --url http://localhost:10300

4.6.cluster topology logical

显示指定集群的逻辑拓扑。

语法

shell

cluster topology logical [--plain] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

参数

参数	类型	必填	描述
`‑‑plain`	`Flag`	否	简易格式显示输出。
`‑‑url`	`Option`	否	集群端点的 URL。
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。

示例

shell

cluster topology logical --url http://localhost:10300

4.7.cluster unit deploy

从文件或目录（非递归方式）部署单元。

语法

shell

cluster unit deploy --version=<version> --path=<path> [--nodes=<nodes>] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose] <id>

参数

参数	类型	必填	描述
`‑‑version`	`Option`	是	单元版本（x.y.z）。
`‑‑path`	`Option`	是	部署单元文件或目录的路径。
`‑‑nodes`	`Option`	否	将部署单元的初始节点集（逗号分隔）。
`‑‑url`	`Option`	否	集群端点的 URL。
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。
`<id>`	`Argument`	是	部署单元标识符。

示例

shell

cluster unit deploy --version=1.0.0 --path=/path/to/unit.jar myunit

4.8.cluster unit undeploy

将一个单元卸载。

语法

shell

cluster unit undeploy --version=<version> [--url=<clusterUrl>] [--profile=<profileName>] [--verbose] <id>

参数

参数	类型	必填	描述
`‑‑version`	`Option`	是	单元版本（x.y.z）。
`‑‑url`	`Option`	否	集群端点的 URL。
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。
`<id>`	`Argument`	是	部署单元标识符。

示例

shell

cluster unit undeploy --version=1.0.0 --url http://localhost:10300 myunit

4.9.cluster unit list

显示已部署单元列表。

语法

shell

cluster unit list [--version=<version>] [--status=<statuses>] [--plain] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose] <unitId>

参数

参数	类型	必填	描述
`‑‑version`	`Option`	否	按版本筛选出部署单元（假定完全匹配）。
`‑‑status`	`Option`	否	按状态（逗号分隔）筛选出部署单元。
`‑‑plain`	`Flag`	否	以简易格式显示输出。
`‑‑url`	`Option`	否	集群端点的 URL。
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。
`<unitId>`	`Argument`	是	部署单元标识符。

示例

shell

cluster unit list --status=DEPLOYED,STARTING myunit

4.10.cluster metric source enable

启用集群指标源。

语法

shell

cluster metric source enable [--url=<clusterUrl>] [--profile=<profileName>] [--verbose] <srcName>

参数

参数	类型	必填	描述
`‑‑url`	`Option`	否	集群端点的 URL。
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。
`<srcName>`	`Argument`	是	指标源名称。

示例

shell

cluster metric source enable jvm

4.11.cluster metric source disable

禁用集群指标源。

语法

shell

cluster metric source disable [--url=<clusterUrl>] [--profile=<profileName>] [--verbose] <srcName>

参数

参数	类型	必填	描述
`‑‑url`	`Option`	否	集群端点的 URL。
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。
`<srcName>`	`Argument`	是	指标源名称。

示例

shell

cluster metric source disable jvm

4.12.cluster metric source list

列出集群指标源。

语法

shell

cluster metric source list [--plain] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

参数

参数	类型	必填	描述
`‑‑plain`	`Flag`	否	以简易格式显示输出。
`‑‑url`	`Option`	否	集群端点的 URL。
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。

示例

shell

cluster metric source list

5.节点命令

这些命令用于管理各个节点。

5.1.node config show

显示节点配置。

语法

shell

node config show [--url=<nodeUrl>] [--format=<format>] [--profile=<profileName>] [--verbose] [<selector>]

参数

参数	类型	必填	描述
`‑‑url`	`Option`	否	将用作通信端点的节点的 URL。
`‑‑format`	`Option`	否	输出格式。有效值：`JSON`、`HOCON`（默认：`HOCON`）。
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。
`<selector>`	`Argument`	否	配置选择器。

示例

shell

node config show ignite.clientConnector

5.2.node config update

更新节点配置。

语法

shell

node config update [--url=<nodeUrl>] [--file=<configFile>] [--profile=<profileName>] [--verbose] [<args>...]

参数

参数	类型	必填	描述
`‑‑url`	`Option`	否	将用作通信端点的节点的 URL。
`‑‑file`	`Option`	否	包含要执行的配置更新命令的文件路径。
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。
`<args>`	`Argument`	否	要更新的配置参数和值。

示例

shell

node config update --url http://localhost:10300 ignite.clientConnector.connectTimeoutMillis=5000

5.3.node status

输出节点的状态。

语法

shell

node status [--url=<nodeUrl>] [--profile=<profileName>] [--verbose]

参数

参数	类型	必填	描述
`‑‑url`	`Option`	否	将用作通信端点的节点的 URL。
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。

示例

shell

node status

5.4.node version

输出节点构建版本。

语法

shell

node version [--url=<nodeUrl>] [--profile=<profileName>] [--verbose]

参数

参数	类型	必填	描述
`‑‑url`	`Option`	否	将用作通信端点的节点的 URL。
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。

示例

shell

node version

5.5.node metric list

列出节点指标。

语法

shell

node metric list [--url=<nodeUrl>] [--plain] [--profile=<profileName>] [--verbose]

参数

参数	类型	必填	描述
`‑‑url`	`Option`	否	将用作通信端点的节点的 URL。
`‑‑plain`	`Flag`	否	以简易格式显示输出。
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。

示例

shell

node metric list

5.6.node metric source enable

启用节点指标源。

语法

shell

node metric source enable [--url=<nodeUrl>] [--profile=<profileName>] [--verbose] <srcName>

参数

参数	类型	必填	描述
`‑‑url`	`Option`	否	将用作通信端点的节点的 URL。
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。
`<srcName>`	`Argument`	是	指标源名称。

示例

shell

node metric source enable jvm

5.7.node metric source disable

禁用节点指标源。

语法

shell

node metric source disable [--url=<nodeUrl>] [--profile=<profileName>] [--verbose] <srcName>

参数

参数	类型	必填	描述
`‑‑url`	`Option`	否	将用作通信端点的节点的 URL。
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。
`<srcName>`	`Argument`	是	指标源名称。

示例

shell

node metric source disable jvm

5.8.node metric source list

列出节点指标源。

语法

shell

node metric source list [--url=<nodeUrl>] [--plain] [--profile=<profileName>] [--verbose]

参数

参数	类型	必填	描述
`‑‑url`	`Option`	否	将用作通信端点的节点的 URL。
`‑‑plain`	`Flag`	否	以简易格式显示输出。
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。

示例

shell

node metric source list --plain

5.9.node unit list

输出已部署单元的列表。

语法

shell

node unit list [--version=<version>] [--status=<statuses>] [--url=<nodeUrl>] [--plain] [--profile=<profileName>] [--verbose] <unitId>

参数

参数	类型	必填	描述
`‑‑version`	`Option`	否	选择按版本筛选出部署单元（假定完全匹配）。
`‑‑status`	`Option`	否	选择按状态（逗号分隔）筛选出部署单元。
`‑‑url`	`Option`	否	将用作通信端点的节点的 URL。
`‑‑plain`	`Flag`	否	以简易格式显示输出。
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。
`<unitId>`	`Argument`	是	部署单元标识符。

示例

shell

node unit list --status=DEPLOYED myunit

6.灾难恢复命令

这些命令可以在灾难场景中恢复数据分区并恢复系统 RAFT 组。

6.1.recovery partitions restart

重启分区。

语法

shell

recovery partitions restart --zone=<zoneName> --table=<tableName> [--partitions=<partitionIds>] [--nodes=<nodeNames>] [--with-cleanup] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

参数

参数	类型	必填	描述
`‑‑zone`	`Option`	是	要重置分区的分布区名，区分大小写，不带引号。
`‑‑table`	`Option`	是	要重置其分区的表的全限定名，区分大小写，不带引号。
`‑‑partitions`	`Option`	否	用于获取状态的分区 ID。如果未指定则为所有分区（逗号分隔）。
`‑‑nodes`	`Option`	否	指定要从中获取分区状态的节点名，区分大小写，不带引号，如果未指定则为所有节点（逗号分隔）。
`‑‑with-cleanup`	`Flag`	否	在重启之前从分区存储中删除所有数据。
`‑‑url`	`Option`	否	集群端点的 URL。
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。

示例

shell

recovery partitions restart --zone=default --table=PUBLIC.PERSON --with-cleanup

6.2.recovery partitions reset

重置分区。

语法

shell

recovery partitions reset --zone=<zoneName> [--table=<tableName>] [--partitions=<partitionIds>] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

参数

参数	类型	必填	描述
`‑‑zone`	`Option`	是	要重置分区的分布区名，区分大小写，不带引号。
`‑‑table`	`Option`	否	要重置其分区的表的全限定名，区分大小写，不带引号。
`‑‑partitions`	`Option`	否	用于获取状态的分区 ID。如果未指定则为所有分区（逗号分隔）。
`‑‑url`	`Option`	否	集群端点的 URL。
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。

示例

shell

recovery partitions reset --zone=default --table=PUBLIC.PERSON

6.3.recovery partitions states

返回分区状态。

语法

shell

recovery partitions states (--global | --local) [--nodes=<nodeNames>] [--partitions=<partitionIds>] [--zones=<zoneNames>] [--plain] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

参数

参数	类型	必填	描述
`‑‑global`	`Flag`	是	获取全局分区状态，需要`global`或`local`之一。
`‑‑local`	`Flag`	是	获取本地分区状态，需要`global`或`local`之一。
`‑‑nodes`	`Option`	否	指定要从中获取分区状态的节点名，区分大小写，不带引号，如果未指定则为所有节点（逗号分隔）。
`‑‑partitions`	`Option`	否	用于获取状态的分区 ID。如果未指定则为所有分区（逗号分隔）。
`‑‑zones`	`Option`	否	用于获取状态的分布区名。如果未指定则为所有分布区（逗号分隔）。
`‑‑plain`	`Flag`	否	以简易格式显示输出。
`‑‑url`	`Option`	否	集群端点的 URL。
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。

示例

shell

recovery partitions states --local --zones=default

6.4.recovery cluster reset

重置集群。

语法

shell

recovery cluster reset [--cluster-management-group=<cmgNodeNames>] [--metastorage-replication-factor=<metastorageReplicationFactor>] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

参数

参数	类型	必填	描述
`‑‑cluster-management-group`	`Option`	否	将负责集群管理组的节点名（逗号分隔）。
`‑‑metastorage-replication-factor`	`Option`	否	元存储组的投票成员集中的节点数。
`‑‑url`	`Option`	否	集群端点的 URL。
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。

示例

shell

recovery cluster reset

6.5.recovery cluster migrate

将修复期间丢失的节点迁移到修复的集群。

语法

shell

recovery cluster migrate --old-cluster-url=<oldClusterUrl> --new-cluster-url=<newClusterUrl> [--verbose]

参数

参数	类型	必填	描述
`‑‑old-cluster-url`	`Option`	是	旧集群端点的 URL（此集群的节点将迁移到新集群）。
`‑‑new-cluster-url`	`Option`	是	新集群端点的 URL（旧集群的节点将迁移到此集群）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。

示例

shell

recovery cluster migrate --old-cluster-url=http://old-cluster:10300 --new-cluster-url=http://new-cluster:10300

7.分区分布命令

这些命令可以管理表分区分布。

7.1.distribution reset

重置分区的分布。

语法

shell

distribution reset --zones=<zoneNames> [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

参数

参数	类型	必填	描述
`‑‑zones`	`Option`	是	指定要重置分布状态的分布区名（逗号分隔）。
`‑‑url`	`Option`	否	集群端点的 URL。
`‑‑profile`	`Option`	否	本地命令行配置名（仅在非交互模式下可用）。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。

示例

shell

distribution reset --zones=default

8.其他命令

这些是通用命令。

8.1.connect

接入 Ignite 3 节点。

语法

shell

connect --username=<username> --password=<password> [--verbose] <nodeUrl>

参数

参数	类型	必填	描述
`‑‑username`	`Option`	是	接入集群的用户名。
`‑‑password`	`Option`	是	接入集群的密码。
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。
`<nodeUrl>`	`Argument`	是	将用作通信端点的节点的 URL。

示例

shell

connect --username=admin --password=password http://localhost:10300

8.2.disconnect

断开与 Ignite 3 节点的连接。

语法

shell

disconnect [--verbose]

参数

参数	类型	必填	描述
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。

示例

shell

disconnect

8.3.clear

清除屏幕。

语法

shell

clear

参数

参数	类型	必填	描述
无	无	无	该命令无参数。

示例

shell

clear

8.4.cls

清除屏幕。

语法

shell

cls [--verbose]

参数

参数	类型	必填	描述
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。

示例

shell

cls

8.5.exit

退出命令行工具。

语法

shell

exit [--verbose]

参数

参数	类型	必填	描述
`‑‑verbose`	`Flag`	否	显示其他信息：日志、REST 调用。

示例

shell

exit

8.6.help

显示有关指定命令的帮助信息。

语法

shell

help [COMMAND]

参数

参数	类型	必填	描述
`[COMMAND]`	`Argument`	否	要显示帮助消息的命令。

示例

shell

help cluster config show

8.7.version

显示当前命令行工具的版本。

语法

shell

version

参数	类型	必填	描述
无	无	无	该命令无参数。

示例

shell

version

18624049226

Ignite命令行工具 ​

1.概述 ​

1.1.交互式模式 ​

1.2.非交互模式 ​

1.3.详细输出 ​

1.4.命令行工具日志 ​

2.SQL 命令 ​

2.1.sql ​

2.2.sql planner invalidate-cache ​

3.命令行配置命令 ​

3.1.cli config profile create ​

3.2.cli config profile activate ​

3.3.cli config profile list ​

3.4.cli config profile show ​

3.5.cli config get ​

3.6.cli config set ​

3.7.cli config show ​

3.8.cli config remove ​

4.集群命令 ​

4.1.cluster config show ​

4.2.cluster config update ​

4.3.cluster init ​

4.4.cluster status ​

4.5.cluster topology physical ​

4.6.cluster topology logical ​

4.7.cluster unit deploy ​

4.8.cluster unit undeploy ​

4.9.cluster unit list ​

4.10.cluster metric source enable ​

4.11.cluster metric source disable ​

4.12.cluster metric source list ​

5.节点命令 ​

5.1.node config show ​

5.2.node config update ​

5.3.node status ​

5.4.node version ​

5.5.node metric list ​

5.6.node metric source enable ​

5.7.node metric source disable ​

5.8.node metric source list ​

5.9.node unit list ​

6.灾难恢复命令 ​

6.1.recovery partitions restart ​

6.2.recovery partitions reset ​

6.3.recovery partitions states ​

6.4.recovery cluster reset ​

6.5.recovery cluster migrate ​

7.分区分布命令 ​

7.1.distribution reset ​

8.其他命令 ​

8.1.connect ​

8.2.disconnect ​

8.3.clear ​

8.4.cls ​

8.5.exit ​

8.6.help ​

8.7.version ​

Ignite命令行工具

1.概述

1.1.交互式模式

1.2.非交互模式

1.3.详细输出

1.4.命令行工具日志

2.SQL 命令

2.1.sql

2.2.sql planner invalidate-cache

3.命令行配置命令

3.1.cli config profile create

3.2.cli config profile activate

3.3.cli config profile list

3.4.cli config profile show

3.5.cli config get

3.6.cli config set

3.7.cli config show

3.8.cli config remove

4.集群命令

4.1.cluster config show

4.2.cluster config update

4.3.cluster init

4.4.cluster status

4.5.cluster topology physical

4.6.cluster topology logical

4.7.cluster unit deploy

4.8.cluster unit undeploy

4.9.cluster unit list

4.10.cluster metric source enable

4.11.cluster metric source disable

4.12.cluster metric source list

5.节点命令

5.1.node config show

5.2.node config update

5.3.node status

5.4.node version

5.5.node metric list

5.6.node metric source enable

5.7.node metric source disable

5.8.node metric source list

5.9.node unit list

6.灾难恢复命令

6.1.recovery partitions restart

6.2.recovery partitions reset

6.3.recovery partitions states

6.4.recovery cluster reset

6.5.recovery cluster migrate

7.分区分布命令

7.1.distribution reset

8.其他命令

8.1.connect

8.2.disconnect

8.3.clear

8.4.cls

8.5.exit

8.6.help

8.7.version