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

slug	title
/ja/operations/utilities/clickhouse-format	clickhouse-format

入力されたクエリをフォーマットします。

キー:

• --help または -h — ヘルプメッセージを生成します。
• --query — 任意の長さと複雑さのクエリをフォーマットします。
• --hilite — ANSI端末のエスケープシーケンスを使用して構文を強調表示します。
• --oneline — 1行でフォーマットします。
• --max_line_length — 指定された長さより短いクエリを1行でフォーマットします。
• --comments — 出力にコメントを保持します。
• --quiet または -q — 成功した場合は出力せずに構文だけをチェックします。
• --multiquery または -n — 同一ファイル内で複数のクエリを許可します。
• --obfuscate — フォーマットの代わりに難読化します。
• --seed <string> — 難読化の結果を決定する任意の文字列を設定します。
• --backslash — フォーマットされたクエリの各行の最後にバックスラッシュを追加します。Webや他のソースから複数行でクエリをコピーしてコマンドラインで実行したい場合に便利です。

例

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. ハイライトと1行表示:

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