跳转到主内容
跳转到主内容

clickhouse-keeper-client 工具

一个通过其原生协议与 clickhouse-keeper 交互的客户端工具。

参数​

  • -q QUERY, --query=QUERY — 要执行的查询。若未指定此参数，clickhouse-keeper-client 将以交互模式启动。
  • -h HOST, --host=HOST — 服务器地址。默认值：localhost。
  • -p N, --port=N — 服务器端口。默认值：9181
  • -c FILE_PATH, --config-file=FILE_PATH — 设置配置文件路径以获取连接字符串。默认值：config.xml。
  • --password=PASSWORD — 用于身份验证的密码。也可以通过 CLICKHOUSE_KEEPER_PASSWORD 环境变量设置，或在 XML 配置文件的 <zookeeper><password> 下设置。
  • --identity=IDENTITY — 用于 digest 身份验证方案的标识。也可以通过 CLICKHOUSE_KEEPER_IDENTITY 环境变量设置，或在 XML 配置文件的 <zookeeper><identity> 下设置。
  • --connection-timeout=TIMEOUT — 设置连接超时时间 (以秒为单位) 。默认值：10s。
  • --session-timeout=TIMEOUT — 设置会话超时时间 (以秒为单位) 。默认值：10s。
  • --operation-timeout=TIMEOUT — 设置操作超时时间 (以秒为单位) 。默认值：10s。
  • --history-file=FILE_PATH — 设置历史记录文件路径。默认值：~/.keeper-client-history。
  • --log-level=LEVEL — 设置日志级别。默认值：information。
  • --no-confirmation — 如果启用，则在若干命令上不再需要确认。交互模式下的默认值为 false，查询模式下的默认值为 true。
  • --help — 显示帮助信息。

环境变量​

  • CLICKHOUSE_KEEPER_PASSWORD — 如果未在命令行中提供 --password，则使用该值作为默认密码。
  • CLICKHOUSE_KEEPER_IDENTITY — 如果未在命令行中提供 --identity，则使用该值作为默认身份标识。

身份验证​

连接到需要身份验证的 Keeper 服务器时，password 按以下优先级顺序解析 (首先匹配者生效) ：

  1. --password 命令行参数
  2. CLICKHOUSE_KEEPER_PASSWORD 环境变量
  3. 由 --config-file 指定的 XML 配置 File 中的 <zookeeper><password>

相同的优先级也适用于 --identity / CLICKHOUSE_KEEPER_IDENTITY / <zookeeper><identity>。

包含身份验证 settings 的 XML 配置 File 示例：

<clickhouse>
    <zookeeper>
        <password>secret</password>
        <node index="1">
            <host>localhost</host>
            <port>9181</port>
        </node>
    </zookeeper>
</clickhouse>

示例​

./clickhouse-keeper-client -h localhost -p 9181 --connection-timeout 30 --session-timeout 30 --operation-timeout 30
Connected to ZooKeeper at [::1]:9181 with session_id 137
/ :) ls
keeper foo bar
/ :) cd 'keeper'
/keeper :) ls
api_version
/keeper :) cd 'api_version'
/keeper/api_version :) ls

/keeper/api_version :) cd 'xyz'
Path /keeper/api_version/xyz does not exist
/keeper/api_version :) cd ../../
/ :) ls
keeper foo bar
/ :) get 'keeper/api_version'
2

命令​

  • ls '[path]' -- 列出指定路径下的节点 (默认：当前工作目录)
  • cd '[path]' -- 切换工作路径 (默认 .)
  • cp '<src>' '<dest>' -- 将 src 节点复制到 dest 路径
  • cpr '<src>' '<dest>' -- 将 src 节点的子树复制到 dest 路径
  • mv '<src>' '<dest>' -- 将 src 节点移动到 dest 路径
  • mvr '<src>' '<dest>' -- 将 src 节点的子树移动到 dest 路径
  • exists '<path>' -- 如果节点存在返回 1，否则返回 0
  • set '<path>' <value> [version] -- 更新节点的值。仅当版本匹配时才更新 (默认：-1)
  • create '<path>' <value> [mode] -- 使用给定值创建新节点
  • touch '<path>' -- 创建一个值为空字符串的新节点。如果节点已存在则不会抛出异常
  • get '<path>' -- 返回节点的值
  • rm '<path>' [version] -- 仅在版本匹配时删除该节点 (默认：-1)
  • rmr '<path>' [limit] -- 当子树大小小于给定限制时递归删除路径。需要确认 (默认限制 = 100)
  • flwc <command> -- 执行 four-letter-word 命令
  • help -- 显示本帮助信息
  • get_direct_children_number '[path]' -- 获取指定路径下直接子节点的数量
  • get_all_children_number '[path]' -- 获取指定路径下所有子节点的数量
  • get_stat '[path]' -- 返回节点的状态信息 (默认 .)
  • find_super_nodes <threshold> '[path]' -- 查找在给定路径下子节点数量大于阈值的节点 (默认 .)
  • delete_stale_backups -- 删除用于备份但已处于非活动状态的 ClickHouse 节点
  • find_big_family [path] [n] -- 返回子树中子节点数量最多的前 n 个节点 (默认路径 = .，n = 10)
  • sync '<path>' -- 在进程与 leader 之间同步节点
  • reconfig <add|remove|set> "<arg>" [version] -- 重新配置 Keeper 集群。参见 /docs/en/guides/sre/keeper/clickhouse-keeper#reconfiguration