> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-vortex-format.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Início rápido do ClickHouse Cloud

> Guia de início rápido do ClickHouse Cloud

Esta página aborda o provisionamento de um serviço do ClickHouse Cloud, a conexão a ele e o carregamento de dados, tudo pela linha de comando com a [CLI do ClickHouse](/pt-BR/products/cloud/features/cli) (`clickhousectl`). Os comandos são não interativos; o `clickhousectl` gera JSON com `--json`.

<div id="prerequisites">
  ## Pré-requisitos
</div>

Instale a CLI do ClickHouse:

```bash theme={null}
curl https://clickhouse.com/cli | sh
```

Você também precisa do `jq`.

Você precisa de uma conta do ClickHouse Cloud. Se ainda não tiver uma, `clickhousectl cloud auth signup` abre a página de cadastro no navegador.

Operações de gravação (criação, exclusão) exigem [autenticação por chave de API](/pt-BR/products/cloud/features/admin-features/api/openapi); o login via OAuth é somente leitura:

```bash theme={null}
clickhousectl cloud auth login --api-key <YOUR_KEY> --api-secret <YOUR_SECRET>
```

Como alternativa, defina as variáveis de ambiente `CLICKHOUSE_CLOUD_API_KEY` e `CLICKHOUSE_CLOUD_API_SECRET`. Verifique usando `clickhousectl cloud auth status`; deve haver uma entrada com o escopo `read/write`.

<div id="create-service">
  ## Crie um serviço do ClickHouse
</div>

Crie o serviço e salve a resposta; a senha do usuário `default` é exibida apenas uma vez:

```bash theme={null}
clickhousectl cloud service create \
  --name quickstart-ch \
  --region us-east-1 \
  --json > ch.json
```

A resposta inclui o ID do serviço, os endpoints e a senha gerada (truncada aqui; a resposta completa também contém as configurações de scaling, a lista de acesso por IP e as tags):

```json theme={null}
{
  "password": "dK7mPq2x_-TzrL9vNw0s",
  "service": {
    "id": "4f7b92f3-4163-403a-b538-b9bc6e2e8f66",
    "name": "quickstart-ch",
    "provider": "aws",
    "region": "us-east-1",
    "state": "provisioning",
    "endpoints": [
      {
        "host": "quickstart-abc123.us-east-1.aws.clickhouse.cloud",
        "port": 9440,
        "protocol": "nativesecure"
      },
      {
        "host": "quickstart-abc123.us-east-1.aws.clickhouse.cloud",
        "port": 8443,
        "protocol": "https"
      }
    ],
    "numReplicas": 3,
    "minReplicaMemoryGb": 16.0,
    "maxReplicaMemoryGb": 120.0
  }
}
```

Extraia o que será necessário para o restante deste guia:

```bash theme={null}
CH_ID=$(jq -r .service.id ch.json)
CH_PASSWORD=$(jq -r .password ch.json)
CH_HOST=$(jq -r '.service.endpoints[] | select(.protocol=="nativesecure") | .host' ch.json)
```

Se perder a senha, gere uma nova com `clickhousectl cloud service reset-password "$CH_ID"`.

Por padrão, os serviços criados com `clickhousectl` têm uma lista de acesso por IP que permite todos os endereços (`0.0.0.0/0`). Para restringir o acesso, informe `--ip-allow` ao criar o serviço; consulte ["Configurar filtros de IP"](/pt-BR/products/cloud/guides/security/connectivity/setting-ip-filters).

<div id="wait-for-provisioning">
  ## Aguarde o provisionamento do serviço
</div>

O provisionamento leva cerca de um minuto. Consulte o status até que o estado seja `running`:

```bash theme={null}
while [ "$(clickhousectl cloud service get "$CH_ID" --json | jq -r .state)" != "running" ]; do
  sleep 15
done
```

<div id="run-sql">
  ## Execute SQL com a Query API
</div>

`clickhousectl cloud service query` executa SQL por HTTP — não requer um binário `clickhouse` local nem a senha do serviço. A primeira chamada provisiona automaticamente um endpoint da Query API e uma chave de API com escopo de serviço:

```bash theme={null}
clickhousectl cloud service query --id "$CH_ID" --query "SHOW databases"
```

```text theme={null}
Provisioning Query API endpoint + key for service 'quickstart-ch'...
{"name":"INFORMATION_SCHEMA"}
{"name":"default"}
{"name":"information_schema"}
{"name":"system"}
```

A saída via pipe usa `JSONEachRow` por padrão; para obter uma saída em formato de tabela, passe `--format PrettyCompact`.

<div id="create-database-and-table">
  ## Crie um banco de dados e uma tabela
</div>

```bash theme={null}
clickhousectl cloud service query --id "$CH_ID" \
  --query "CREATE DATABASE IF NOT EXISTS helloworld"

clickhousectl cloud service query --id "$CH_ID" \
  --query "CREATE TABLE helloworld.my_first_table (
    user_id UInt32,
    message String,
    timestamp DateTime,
    metric Float32
  ) ENGINE = MergeTree()
  PRIMARY KEY (user_id, timestamp)"
```

Ambos os comandos exibem `OK`. Insira algumas linhas:

```bash theme={null}
clickhousectl cloud service query --id "$CH_ID" \
  --query "INSERT INTO helloworld.my_first_table (user_id, message, timestamp, metric) VALUES
    (101, 'Hello, ClickHouse!', now(), -1.0),
    (102, 'Insert a lot of rows per batch', yesterday(), 1.41421),
    (102, 'Sort your data based on your commonly-used queries', today(), 2.718),
    (101, 'Granules are the smallest chunks of data read', now() + 5, 3.14159)"
```

Verifique se funcionou:

```bash theme={null}
clickhousectl cloud service query --id "$CH_ID" \
  --query "SELECT * FROM helloworld.my_first_table ORDER BY timestamp"
```

```text theme={null}
{"user_id":102,"message":"Insert a lot of rows per batch","timestamp":"2026-08-26 00:00:00","metric":1.41421}
{"user_id":102,"message":"Sort your data based on your commonly-used queries","timestamp":"2026-08-27 00:00:00","metric":2.718}
{"user_id":101,"message":"Hello, ClickHouse!","timestamp":"2026-08-27 10:41:28","metric":-1}
{"user_id":101,"message":"Granules are the smallest chunks of data read","timestamp":"2026-08-27 10:41:33","metric":3.14159}
```

Os timestamps dependem de quando você executou o insert, portanto serão diferentes.

<div id="load-csv-file">
  ## Carregue um arquivo CSV
</div>

Suponha que o seguinte texto esteja em um arquivo CSV chamado `data.csv`:

```text title="data.csv" theme={null}
102,This is data in a file,2022-02-22 10:43:28,123.45
101,It is comma-separated,2022-02-23 00:00:00,456.78
103,Use FORMAT to specify the format,2022-02-21 10:43:30,678.90
```

`INSERT ... FORMAT` lê os dados da stdin, portanto encadeie a consulta e o arquivo:

```bash theme={null}
printf 'INSERT INTO helloworld.my_first_table FORMAT CSV\n' | cat - data.csv \
  | clickhousectl cloud service query --id "$CH_ID"
```

Verifique se as novas linhas foram carregadas:

```bash theme={null}
clickhousectl cloud service query --id "$CH_ID" \
  --query "SELECT count() FROM helloworld.my_first_table"
```

```text theme={null}
{"count()":7}
```

<div id="native-client">
  ## Conecte-se usando o clickhouse client
</div>

Você também pode se conectar pelo protocolo nativo usando o [**clickhouse client**](/pt-BR/concepts/features/interfaces/client). A ClickHouse CLI gerencia o binário `clickhouse` para você, portanto não é necessário instalar um cliente separadamente:

```bash theme={null}
clickhousectl local use latest
```

Isso instala o binário `clickhouse` mais recente e cria um link simbólico em `~/.local/bin/clickhouse`, para que o comando `clickhouse` possa ser usado globalmente no seu `PATH`.

Em seguida, conecte-se usando o hostname e a senha da resposta de criação. Com `--query`, o resultado é exibido e o cliente é encerrado; sem essa opção, você entra no prompt interativo (`:)`), do qual sai com `exit`:

```bash theme={null}
clickhouse client --host "$CH_HOST" --secure --port 9440 \
  --user default --password "$CH_PASSWORD" \
  --query "SELECT * FROM helloworld.my_first_table ORDER BY timestamp FORMAT TabSeparated"
```

```text theme={null}
102	Insert a lot of rows per batch	2026-08-26 00:00:00	1.41421
102	Sort your data based on your commonly-used queries	2026-08-27 00:00:00	2.718
101	Hello, ClickHouse!	2026-08-27 10:41:28	-1
101	Granules are the smallest chunks of data read	2026-08-27 10:41:33	3.14159
103	Use FORMAT to specify the format	2022-02-21 10:43:30	678.9
102	This is data in a file	2022-02-22 10:43:28	123.45
101	It is comma-separated	2022-02-23 00:00:00	456.78
```

O mesmo formato de comando faz upload de arquivos:

```bash theme={null}
clickhouse client --host "$CH_HOST" --secure --port 9440 \
  --user default --password "$CH_PASSWORD" \
  --query='INSERT INTO helloworld.my_first_table FORMAT CSV' < data.csv
```

<div id="cleanup">
  ## Limpeza
</div>

A exclusão de um serviço remove permanentemente todos os seus dados. `--force` primeiro interrompe um serviço em execução:

```bash theme={null}
clickhousectl cloud service delete "$CH_ID" --force
```

Para manter os dados sem continuar pagando por recursos computacionais, interrompa o serviço com `clickhousectl cloud service stop "$CH_ID"`.
