ClickHouse CLI

ClickHouse CLI (clickhousectl) は、ClickHouse Cloud リソースの管理と、ClickHouse を使ったローカル開発を行うための統合コマンドラインツールです。

インストール

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

便宜上、chctl のエイリアスも自動的に作成されます。

Cloud の管理

ClickHouse Cloud で認証し、コマンドラインから直接サービスを管理します。

認証

clickhousectl cloud auth

API キーとシークレットの入力が求められ、これらは .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 出力

任意の cloud コマンドで JSON 形式のレスポンスを取得するには、--json フラグを使用します:

clickhousectl cloud --json service list

ローカル開発

CLI では、ローカルの ClickHouse インストールやサーバーの管理も行えます。ローカル開発を始めるには、クイックインストールページを参照してください。

要件

macOS (aarch64, x86_64) または Linux (aarch64, x86_64)
Cloud コマンドの実行には ClickHouse Cloud API キーが必要です

インストール​

Cloud の管理​

認証​

サービス​

組織​

API キー​

メンバーと招待​

バックアップ​

JSON 出力​

ローカル開発​

要件​