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

> Guía para usar la utilidad format para trabajar con formatos de datos de ClickHouse

# clickhouse-format

Permite dar formato a las consultas de entrada.

Opciones:

* `--help` o `-h` — Muestra el mensaje de ayuda.
* `--query` — Da formato a consultas de cualquier longitud y complejidad.
* `--hilite` o `--highlight` — Añade resaltado de sintaxis con secuencias de escape ANSI del terminal.
* `--oneline` — Da formato en una sola línea.
* `--max_line_length` — Da formato en una sola línea a las consultas cuya longitud sea inferior a la especificada.
* `--comments` — Mantiene los comentarios en la salida.
* `--quiet` o `-q` — Solo comprueba la sintaxis; no produce salida si se ejecuta correctamente.
* `--multiquery` o `-n` — Permite varias consultas en el mismo archivo.
* `--obfuscate` — Ofusca en lugar de dar formato.
* `--seed <string>` — Cadena semilla arbitraria que determina el resultado de la ofuscación.
* `--backslash` — Añade una barra invertida al final de cada línea de la consulta con formato. Puede ser útil cuando copias una consulta de la web o de otro lugar con varias líneas y quieres ejecutarla en la línea de comandos.
* `--semicolons_inline` — En el modo multiquery, escribe los puntos y coma en la última línea de la consulta en lugar de en una línea nueva.

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

1. Dar formato a una 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. Resaltado y en una sola línea:

```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. Consultas múltiples:

```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. Ofuscación:

```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;
```

La misma consulta y otra cadena semilla:

```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. Añadir la barra invertida:

```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 \
)
```