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

ClickHouse CLI

ClickHouse CLI (clickhousectl) 是一款统一的命令行工具，用于管理 ClickHouse Cloud 资源，并支持基于 ClickHouse 的本地开发。

安装​

curl https://clickhouse.com/cli | sh

为方便起见，还会自动创建一个 chctl 别名。

Cloud 管理​

通过命令行完成 ClickHouse Cloud 身份验证，并直接管理您的服务。

身份验证​

clickhousectl cloud auth

这会提示您输入 API 密钥和 secret，并将其保存到 .clickhouse/credentials.json (项目本地，且已加入 git 忽略) 。

您也可以使用环境变量：

export CLICKHOUSE_CLOUD_API_KEY=your-key
export CLICKHOUSE_CLOUD_API_SECRET=your-secret

服务​

# List services
clickhousectl cloud service list

# Create a service
clickhousectl cloud service create --name my-service \
  --provider aws \
  --region us-east-1

# Get service details
clickhousectl cloud service get <service-id>

# Scale a service
clickhousectl cloud service scale <service-id> \
  --min-replica-memory-gb 24 \
  --max-replica-memory-gb 48 \
  --num-replicas 3

# Start/stop a service
clickhousectl cloud service start <service-id>
clickhousectl cloud service stop <service-id>

# Delete a service
clickhousectl cloud service delete <service-id>

组织​

clickhousectl cloud org list
clickhousectl cloud org get <org-id>

API 密钥​

clickhousectl cloud key list
clickhousectl cloud key create --name ci-key --role-id <role-id>
clickhousectl cloud key delete <key-id>

成员与邀请​

clickhousectl cloud member list
clickhousectl cloud invitation create --email dev@example.com --role-id <role-id>

备份​

clickhousectl cloud backup list <service-id>
clickhousectl cloud backup get <service-id> <backup-id>

JSON 输出​

使用 --json 标志可让任何 cloud 命令返回 JSON 格式的响应：

clickhousectl cloud --json service list

本地开发​

CLI 还可管理本地 ClickHouse 安装和服务器。要开始进行本地开发，请参阅快速安装页面。

要求​