> ## Documentation Index
> Fetch the complete documentation index at: https://clickhouse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> Guia para usar o utilitário format ao trabalhar com formatos de dados do ClickHouse

# clickhouse-format

Permite formatar consultas de entrada.

Opções:

* `--help` ou `-h` — Exibe a mensagem de ajuda.
* `--query` — Formata consultas de qualquer tamanho e complexidade.
* `--hilite` ou `--highlight` — Adiciona realce de sintaxe com sequências de escape ANSI do terminal.
* `--oneline` — Formata em uma única linha.
* `--max_line_length` — Formata consultas em uma única linha com comprimento menor que o especificado.
* `--comments` — Mantém comentários na saída.
* `--quiet` ou `-q` — Apenas verifica a sintaxe, sem saída em caso de sucesso.
* `--multiquery` ou `-n` — Permite várias consultas no mesmo arquivo.
* `--obfuscate` — Ofusca em vez de formatar.
* `--seed <string>` — Define uma string arbitrária que determina o resultado da ofuscação.
* `--backslash` — Adiciona uma barra invertida ao final de cada linha da consulta formatada. Pode ser útil quando você copia uma consulta da web ou de outro lugar com várias linhas e quer executá-la na linha de comando.
* `--semicolons_inline` — No modo multiquery, escreve os pontos e vírgulas na última linha da consulta em vez de em uma nova linha.

<div id="examples">
  ## Exemplos
</div>

1. Formatação de uma consulta:

```bash title="Query" theme={null}
$ clickhouse-format --query "select number from numbers(10) where number%2 order by number desc;"
```

```bash title="Response" theme={null}
SELECT number
FROM numbers(10)
WHERE number % 2
ORDER BY number DESC
```

2. Destaque e linha única:

```bash title="Query" theme={null}
$ clickhouse-format --oneline --hilite <<< "SELECT sum(number) FROM numbers(5);"
```

```sql title="Response" theme={null}
SELECT sum(number) FROM numbers(5)
```

3. Múltiplas consultas:

```bash title="Query" theme={null}
$ clickhouse-format -n <<< "SELECT min(number) FROM numbers(5); SELECT max(number) FROM numbers(5);"
```

```sql title="Response" theme={null}
SELECT min(number)
FROM numbers(5)
;

SELECT max(number)
FROM numbers(5)
;

```

4. Ofuscação:

```bash title="Query" theme={null}
$ clickhouse-format --seed Hello --obfuscate <<< "SELECT cost_first_screen BETWEEN a AND b, CASE WHEN x >= 123 THEN y ELSE NULL END;"
```

```sql title="Response" theme={null}
SELECT treasury_mammoth_hazelnut BETWEEN nutmeg AND span, CASE WHEN chive >= 116 THEN switching ELSE ANYTHING END;
```

A mesma consulta e uma string de seed diferente:

```bash title="Query" theme={null}
$ clickhouse-format --seed World --obfuscate <<< "SELECT cost_first_screen BETWEEN a AND b, CASE WHEN x >= 123 THEN y ELSE NULL END;"
```

```sql title="Response" theme={null}
SELECT horse_tape_summer BETWEEN folklore AND moccasins, CASE WHEN intestine >= 116 THEN nonconformist ELSE FORESTRY END;
```

5. Adicionando um backslash:

```bash title="Query" theme={null}
$ clickhouse-format --backslash <<< "SELECT * FROM (SELECT 1 AS x UNION ALL SELECT 1 UNION DISTINCT SELECT 3);"
```

```sql title="Response" theme={null}
SELECT * \
FROM  \
( \
    SELECT 1 AS x \
    UNION ALL \
    SELECT 1 \
    UNION DISTINCT \
    SELECT 3 \
)
```