Skip to content

Ignite命令行工具

1.概述

Ignite 命令行工具使用 REST API 作为通信协议。该工具默认在交互模式下运行,但也可以在不进入工具交互界面的情况下执行命令。

使用该工具时,参数应放在引号中,字符串不应包含换行符。例如:

bash
cluster config update "ignite.security.authentication.providers.basic4={type=basic,username=name,password=pass}"

否则,字符串(上述命令中{})中的特殊 POSIX 字符将得到适当处理,从而导致可能无法预知的结果。

或者,也可以使用反斜杠\对命令中的所有特殊字符进行转义,例如:

bash
cluster config update ignite.security.authentication.providers.basic4=\{type=basic,username=name,password=pass\}

2.命令和选项

以下命令可以在交互式模式下执行。

2.1.cli命令

这些命令用于配置命令行工具和集群。

命令参数描述
cli config profile create[--activate] [--copy-from] <profileName>创建给定名称的配置,可以选择复制现有配置,也可以选择创建并激活新配置。
cli config profile activate<profileName>激活给定名称的配置。
cli config profile list列出已有的配置。
cli config profile show获取当前配置的详细信息。
cli config get<key>获取指定配置项的值。
cli config set<String=String>…​使用逗号分隔的键值对设置配置项。
cli config show显示当前激活的配置。
cli config remove<key>删除指定的配置项。

2.2.cluster命令

这些命令用于管理集群。

命令参数描述
cluster config show[--url] [<selector>]显示由端点 URL 和配置路径选择器(可选)指定的集群配置。
cluster config update[--url] <args>…​使用提供的参数值更新由端点 URL 指定的集群配置。
cluster init--name=<clusterName> [--url] [--cluster-management-group=<node name>[,<node name>…​]] [--metastorage-group=<node name>[,<node name>…​]] [--config=<config> | --config-files=<file path>[,<file path>…​]初始化集群,可选面向指定的群集 URL,可选指定集群管理组和集群元存储节点,可选在一个或多个文件中提供集群配置。配置文件的路径是相对于启动命令行工具的文件夹进行解析的。
cluster metrics source disable<srcName>在集群的所有节点上禁用来自指定源的指标。
cluster metrics source enable<srcName>在集群的所有节点上启用指定源的指标。
cluster metrics source list输出每个集群节点的指标源列表,以及每个源的状态(启用或禁用)。
cluster status[--url]显示指定集群的详细状态。
cluster topology physical[--plain] [--url]显示该集群的物理拓扑,可选择纯文本格式。
cluster topology logical[--plain] [--url]显示该集群的逻辑拓扑,可选择纯文本格式。
cluster unit deploy--path [--url] --version [--nodes [, <nodes>…​]]…​ <id>从指定路径部署指定版本的单元,可选择部署到指定节点。
cluster unit undeploy[--url] --version <id>卸载指定的单元版本,可选用于指定的集群。
cluster unit list[--plain] [--url] [--status [,<statuses>…​]]…​ [<unitId> [--version]]列出集群的已部署单元,可选择按状态进行筛选。
connect[-u -p] <nodeUrl>接入指定的节点,可选择使用指定的用户名(u)和密码(p)。
disconnect断开与当前集群的连接。

2.3.node命令

这些命令用于管理集群中的节点。

命令参数描述
node config show[--url | -n] [<selector>]获取指定的节点(n)配置。
node config update[--url | -n] <args>…​使用 HOCON 格式的参数更新本地节点配置。
node status[--url | -n]显示默认节点的状态,或显示其他指定节点的状态。
node version[--url | -n]显示节点的构建版本。
node metric list[--plain][--url | -n]列出节点的指标。
node metric source enable[--url | -n] <srcName>启用指定节点的指标源。
node metric source disable[--url | -n] <srcName>禁用指定节点的指标源。
node metric source list[--plain] [--url | -n]列出指定节点的指标源。
node unit list[--plain] [--status [,<statuses>…​]]…​[<unitId> [--version]] [--url> | -n]列出节点的部署单元。

2.4.recovery命令

这些命令用于:

命令参数描述
recovery partitions restart--table [--url] --zone [--nodes [,<nodeNames>…​]]…​ [--partitions [, <partitionIds>…​]]…​]在指定分布区中的指定节点上重启指定表的指定分区(如果未指定,则为所有现有分区)。
recovery partitions reset--table [--url] --zone [--partitions [, <partitionIds>…​]]…​重置指定分布区(如果未指定,则重置所有现有分布区)中指示的分区(如果未指定,则重置所有现有分区)。此作是不可逆的,它可能导致数据丢失,因此请谨慎使用,仅在绝对必要时使用。
recovery partitions states[--plain] [--url] [--partitions [, <partitionIds>…​]]…​ [--zones [, <zoneNames>…​]]…​ (--global | [--local [--nodes [,<nodeNames>…​]]…​])返回分区状态 (本地或全局),可选择指定的节点和/或分布区和/或分区。
recovery cluster reset用于CMG--url=<node-url> --cluster-management-group=<new-cmg-nodes>发起CMG节点组修复以恢复丢失的多数。该命令被发送到--url参数指定的节点,该节点必须属于new-cmg-nodes Raft组(属于集群物理拓扑的逗号分隔的节点列表)。
recovery cluster reset用于MG--url=<existing-node-url> [--cluster-management-group=<new-cmg-nodes>] --metastorage-replication-factor=N发起MG节点组修复以恢复丢失的多数。N是修复后MG中投票Raft节点的请求数量。如果省略--cluster-management-group,则该命令将从CMG领导者获取当前CMG投票成员集;如果CMG不可用,则该命令失败。
recovery cluster migrate--old-cluster-url=<url-of-old-cluster-node> --new-cluster-url=<url-of-new-cluster-node>发起将未参与recovery cluster reset恢复执行的CMG或MG节点(因为它因网络分区而关闭或不可用)迁移到新的(已恢复的)集群。

2.5.distribution命令

这些命令用于分区分配。

命令参数描述
distribution reset[--zones <zoneNames>]重置指定分布区内所有表中分区分布的算法状态。重新生成分区分配(就像刚刚在数据节点上创建了相同的表(分布区)一样。这可确保分布区中表之间的数据并置。

2.6.其他命令

命令参数描述
cls清除终端中的信息。
exit终止当前的交互式会话。
help<command or command group>提供有关可用命令组、指定组中的命令或指定命令的信息。
sql[--plain] [--jdbc-url] [<command> | --file]在指定集群上执行指定的 SQL 查询(命令)或指定文件中包含的查询。
version显示当前命令行工具版本。

18624049226