Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

clickhouse-format

View as MarkdownEdit this pageReport an issueSet up docs MCP

支持对输入查询进行格式化。

选项：

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

示例

  1. 格式化查询：
Querybash
$ clickhouse-format --query "select number from numbers(10) where number%2 order by number desc;"
Responsebash
SELECT number
FROM numbers(10)
WHERE number % 2
ORDER BY number DESC
  1. 高亮与单行：
Querybash
$ clickhouse-format --oneline --hilite <<< "SELECT sum(number) FROM numbers(5);"
Responsesql
SELECT sum(number) FROM numbers(5)
  1. 多重查询：
Querybash
$ clickhouse-format -n <<< "SELECT min(number) FROM numbers(5); SELECT max(number) FROM numbers(5);"
Responsesql
SELECT min(number)
FROM numbers(5)
;

SELECT max(number)
FROM numbers(5)
;
  1. 混淆：
Querybash
$ clickhouse-format --seed Hello --obfuscate <<< "SELECT cost_first_screen BETWEEN a AND b, CASE WHEN x >= 123 THEN y ELSE NULL END;"
Responsesql
SELECT treasury_mammoth_hazelnut BETWEEN nutmeg AND span, CASE WHEN chive >= 116 THEN switching ELSE ANYTHING END;

相同的查询，另一个种子字符串：

Querybash
$ clickhouse-format --seed World --obfuscate <<< "SELECT cost_first_screen BETWEEN a AND b, CASE WHEN x >= 123 THEN y ELSE NULL END;"
Responsesql
SELECT horse_tape_summer BETWEEN folklore AND moccasins, CASE WHEN intestine >= 116 THEN nonconformist ELSE FORESTRY END;
  1. 添加反斜杠：
Querybash
$ clickhouse-format --backslash <<< "SELECT * FROM (SELECT 1 AS x UNION ALL SELECT 1 UNION DISTINCT SELECT 3);"
Responsesql
SELECT * \
Navigation