跳至主要内容

clickhouse-format

允许格式化输入查询。

  • --help-h — 生成帮助信息。
  • --query — 格式化任何长度和复杂度的查询。
  • --hilite — 使用 ANSI 终端转义序列添加语法高亮。
  • --oneline — 在单行中格式化。
  • --max_line_length — 在单行中格式化长度小于指定值的查询。
  • --comments — 在输出中保留注释。
  • --quiet-q — 仅检查语法,成功时不输出。
  • --multiquery-n — 允许在同一个文件中包含多个查询。
  • --obfuscate — 混淆而不是格式化。
  • --seed <string> — 种子任意字符串,决定混淆的结果。
  • --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
  1. 高亮和单行
$ clickhouse-format --oneline --hilite <<< "SELECT sum(number) FROM numbers(5);"

结果

SELECT sum(number) FROM numbers(5)
  1. 多查询
$ 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)
;

  1. 混淆
$ 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;
  1. 添加反斜杠
$ 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 \
)