ClickHouse/docs/ru/operations/utilities/clickhouse-format.md

toc_priority	toc_title
65	clickhouse-format

clickhouse-format

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

Ключи:

• --help или-h — выводит описание ключей.
• --query — форматирует запрос любой длины и сложности.
• --hilite — добавляет подсветку синтаксиса с экранированием символов.
• --oneline — форматирование в одну строку.
• --quiet или -q — проверяет синтаксис без вывода результата.
• --multiquery or -n — поддерживает несколько запросов в одной строке.
• --obfuscate — обфусцирует вместо форматирования.
• --seed <строка> — задает строку, которая определяет результат обфускации.
• --backslash — добавляет обратный слеш в конце каждой строки отформатированного запроса. Удобно использовать если многострочный запрос скопирован из интернета или другого источника и его нужно выполнить из командной строки.

Примеры

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

$ 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

2. Подсветка синтаксиса и форматирование в одну строку:

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

Результат:

SELECT sum(number) FROM numbers(5)

3. Несколько запросов в одной строке:

$ clickhouse-format -n <<< "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
)
;

4. Обфускация:

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

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

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