clickhouse-format 实用工具

用于格式化输入的查询语句。

参数：

• --help 或 -h — 输出帮助信息。
• --query — 格式化任意长度和复杂度的查询。
• --hilite 或 --highlight — 使用 ANSI 终端转义序列添加语法高亮。
• --oneline — 格式化为单行。
• --max_line_length — 将长度小于指定值的查询格式化为单行。
• --comments — 在输出中保留注释。
• --quiet 或 -q — 仅检查语法，成功时不输出任何内容。
• --multiquery 或 -n — 允许在同一文件中包含多个查询。
• --obfuscate — 执行混淆而不是格式化。
• --seed <string> — 指定任意字符串作为种子，用于决定混淆结果。
• --backslash — 在格式化后的查询每一行末尾添加反斜杠。当你从网页或其他地方复制多行查询并希望在命令行中执行时，这会很有用。
• --semicolons_inline — 在多查询模式下，将分号写在查询的最后一行，而不是单独起一行。

示例

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 min(number) FROM numbers(5); SELECT max(number) FROM numbers(5);"

结果：

SELECT min(number)
FROM numbers(5)
;

SELECT max(number)
FROM numbers(5)
;

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 在 nutmeg 和 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 \
)