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