clickhouse-format - ClickHouse Documentation

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 em uma única linha as consultas com comprimento menor que o especificado.
--comments — Mantém os 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> — String arbitrária que determina o resultado da ofuscação.
--backslash — Adiciona uma barra invertida ao final de cada linha da consulta formatada. Isso 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 ponto e vírgula na última linha da consulta em vez de em uma nova linha.

Exemplos

Query

$ clickhouse-format --query "select number from numbers(10) where number%2 order by number desc;"

Response

SELECT number
FROM numbers(10)
WHERE number % 2
ORDER BY number DESC

Query

$ clickhouse-format --oneline --hilite <<< "SELECT sum(number) FROM numbers(5);"

Response

SELECT sum(number) FROM numbers(5)

Query

$ clickhouse-format -n <<< "SELECT min(number) FROM numbers(5); SELECT max(number) FROM numbers(5);"

Response

SELECT min(number)
FROM numbers(5)
;

SELECT max(number)
FROM numbers(5)
;

Query

$ clickhouse-format --seed Hello --obfuscate <<< "SELECT cost_first_screen BETWEEN a AND b, CASE WHEN x >= 123 THEN y ELSE NULL END;"

Response

SELECT treasury_mammoth_hazelnut BETWEEN nutmeg AND span, CASE WHEN chive >= 116 THEN switching ELSE ANYTHING END;

A mesma consulta e outra string de seed:

Query

$ clickhouse-format --seed World --obfuscate <<< "SELECT cost_first_screen BETWEEN a AND b, CASE WHEN x >= 123 THEN y ELSE NULL END;"

Response

SELECT horse_tape_summer BETWEEN folklore AND moccasins, CASE WHEN intestine >= 116 THEN nonconformist ELSE FORESTRY END;

Query

$ clickhouse-format --backslash <<< "SELECT * FROM (SELECT 1 AS x UNION ALL SELECT 1 UNION DISTINCT SELECT 3);"

Response

SELECT * \
FROM  \
( \
    SELECT 1 AS x \
    UNION ALL \
    SELECT 1 \
    UNION DISTINCT \
    SELECT 3 \
)