Утилита clickhouse-format

Позволяет форматировать входные запросы.

Ключи:

--help или -h — Вывести сообщение справки.
--query — Форматировать запросы любой длины и сложности.
--hilite или --highlight — Добавить подсветку синтаксиса с помощью ANSI-escape последовательностей терминала.
--oneline — Форматировать в одну строку.
--max_line_length — Форматировать в одну строку запросы с длиной менее указанной.
--comments — Сохранять комментарии в выводе.
--quiet или -q — Просто проверить синтаксис, без вывода при успешном выполнении.
--multiquery или -n — Разрешить несколько запросов в одном файле.
--obfuscate — Шифровать вместо форматирования.
--seed <string> — Сид, произвольная строка, определяющая результат шифрования.
--backslash — Добавить обратный слэш в конце каждой строки отформатированного запроса. Может быть полезно, когда вы копируете запрос из интернета или откуда-то ещё с несколькими строками и хотите выполнить его в командной строке.
--semicolons_inline — В режиме нескольких запросов, писать точку с запятой в последней строке запроса вместо новой строки.

Примеры

Форматирование запроса:

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

Результат:

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

Подсветка и одна строка:

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

Результат:

SELECT sum(number) FROM numbers(5)

Мультизапросы:

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

Результат:

SELECT min(number)
FROM numbers(5)
;

SELECT max(number)
FROM numbers(5)
;

Шифрование:

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

Результат:

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

Тот же запрос и другая строка сид:

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

Результат:

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

Добавление обратного слэша:

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

Результат:

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

Примеры​

Примеры