Перейти к основному содержимому
Перейти к основному содержимому

ClickHouse CLI

ClickHouse CLI (clickhousectl) — это единый инструмент командной строки для управления ресурсами ClickHouse Cloud и локальной разработки на базе ClickHouse. Он также позволяет управлять сервисами ClickHouse Cloud Postgres.

Установка​

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

Для удобства также автоматически создаётся алиас chctl.

Управление ClickHouse 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>

Сервисы 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 c6gd.xlarge \
  --pg-version 18

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

# Update a service
clickhousectl cloud postgres update <pg-id> --size c6gd.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>

Организации​

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, чтобы получать ответы в формате JSON от любой команды cloud:

clickhousectl cloud --json service list

Локальная разработка​

CLI также управляет локальными установками ClickHouse и серверами. Чтобы начать работу с локальной разработкой, см. страницу clickhousectl (CLI).

Требования​