Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

ClickHouse CLI

View as MarkdownEdit this pageReport an issueSet up docs MCP

O ClickHouse CLI (clickhousectl) é uma ferramenta unificada de linha de comando para gerenciar recursos do ClickHouse Cloud e ambientes locais de desenvolvimento com ClickHouse. Ele também permite gerenciar os serviços do ClickHouse Cloud Postgres.

Instalação

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

Um alias chctl também é criado automaticamente para facilitar.

Gerenciamento da Cloud

Autentique-se no ClickHouse Cloud e gerencie seus serviços diretamente via linha de comando.

Autenticação

clickhousectl cloud auth

Isso solicita sua API key e seu segredo e os salva em .clickhouse/credentials.json (local ao projeto, ignorado pelo Git).

Você também pode usar variáveis de ambiente:

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

Serviços

# Listar serviços
clickhousectl cloud service list

# Criar um serviço
clickhousectl cloud service create --name my-service \
  --provider aws \
  --region us-east-1

# Obter detalhes do serviço
clickhousectl cloud service get <service-id>

# Escalar um serviço
clickhousectl cloud service scale <service-id> \
  --min-replica-memory-gb 24 \
  --max-replica-memory-gb 48 \
  --num-replicas 3

# Iniciar/parar um serviço
clickhousectl cloud service start <service-id>
clickhousectl cloud service stop <service-id>

# Excluir um serviço
clickhousectl cloud service delete <service-id>

Serviços Postgres (beta)

Crie e gerencie serviços 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>

Organizações

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

Chaves de API

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

Membros e convites

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

Backups

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

Saída em JSON

Use a opção --json para obter respostas em formato JSON de qualquer comando de cloud:

clickhousectl cloud --json service list

Desenvolvimento local

A CLI também gerencia instalações e servidores locais do ClickHouse. Consulte a página de clickhousectl (CLI) para dar os primeiros passos no desenvolvimento local.

Requisitos

Navigation