Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

ClickHouse CLI

View as MarkdownEdit this pageReport an issueSet up docs MCP

ClickHouse CLI (clickhousectl) は、ClickHouse Cloud リソースの管理や、ClickHouse を使ったローカル開発を一元的に行えるコマンドラインツールです。ClickHouse Cloud Postgres サービスの管理にも対応しています。

インストール

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

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

Cloud 管理

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

認証

clickhousectl cloud auth

API key とシークレットの入力が求められ、これらは .clickhouse/credentials.json に保存されます (プロジェクトローカル、Git では無視されます) 。

環境変数を使用することもできます。

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

サービス

# サービスの一覧表示
clickhousectl cloud service list

# サービスの作成
clickhousectl cloud service create --name my-service \
  --provider aws \
  --region us-east-1

# サービスの詳細取得
clickhousectl cloud service get <service-id>

# サービスのスケール
clickhousectl cloud service scale <service-id> \
  --min-replica-memory-gb 24 \
  --max-replica-memory-gb 48 \
  --num-replicas 3

# サービスの起動/停止
clickhousectl cloud service start <service-id>
clickhousectl cloud service stop <service-id>

# サービスの削除
clickhousectl cloud service delete <service-id>

Postgres サービス (ベータ)

ClickHouse Cloud Postgres サービスの作成と管理を行います。

# List Postgres services
clickhousectl cloud postgres list

# Create a Postgres service
clickhousectl cloud postgres create \
  --name my-pg \
  --region us-east-1 \
  --size m6gd.xlarge \
  --pg-version 18

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

# Update a service
clickhousectl cloud postgres update <pg-id> --size m6gd.2xlarge --add-tag env=prod

# Reset the password
clickhousectl cloud postgres reset-password <pg-id> --generate

# Read replicas and point-in-time restore
clickhousectl cloud postgres read-replica create <pg-id> --name replica-1
clickhousectl cloud postgres restore <pg-id> --name restored --restore-target 2026-04-16T12:00:00Z

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

Organizations

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 インストールやサーバーの管理にも対応しています。ローカル開発を始めるには、clickhousectl (CLI) ページを参照してください。

要件

  • macOS (aarch64、x86_64) または Linux (aarch64、x86_64)
  • Cloud コマンドの実行には ClickHouse Cloud API key が必要です
Navigation