> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-fbfa8bee.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> ClickHouseのデータフォーマットを扱うための format ユーティリティガイド

# clickhouse-format

入力クエリをフォーマットできます。

オプション:

* `--help` or`-h` — ヘルプメッセージを表示します。
* `--query` — 長さや複雑さを問わずクエリをフォーマットします。
* `--hilite` or `--highlight` — ANSI 端末のエスケープシーケンスを使用して構文ハイライトを追加します。
* `--oneline` — 1 行でフォーマットします。
* `--max_line_length` — 指定した長さ未満のクエリを 1 行でフォーマットします。
* `--comments` — 出力内のコメントを保持します。
* `--quiet` or `-q` — 構文のみをチェックし、成功時は何も出力しません。
* `--multiquery` or `-n` — 同じファイル内で複数のクエリを許可します。
* `--obfuscate` — フォーマットの代わりに難読化します。
* `--seed <string>` — 難読化の結果を決定する任意の文字列シードです。
* `--backslash` — フォーマット済みクエリの各行末にバックスラッシュを追加します。Web などから複数行のクエリをコピーしてコマンドラインで実行したい場合に便利です。
* `--semicolons_inline` — マルチクエリモードでは、セミコロンを新しい行ではなくクエリの最終行に記述します。

<div id="examples">
  ## 例
</div>

1. クエリのフォーマット:

```bash title="Query" theme={null}
$ clickhouse-format --query "select number from numbers(10) where number%2 order by number desc;"
```

```bash title="Response" theme={null}
SELECT number
FROM numbers(10)
WHERE number % 2
ORDER BY number DESC
```

2. 強調表示と1行表示:

```bash title="Query" theme={null}
$ clickhouse-format --oneline --hilite <<< "SELECT sum(number) FROM numbers(5);"
```

```sql title="Response" theme={null}
SELECT sum(number) FROM numbers(5)
```

3. 複数クエリ:

```bash title="Query" theme={null}
$ clickhouse-format -n <<< "SELECT min(number) FROM numbers(5); SELECT max(number) FROM numbers(5);"
```

```sql title="Response" theme={null}
SELECT min(number)
FROM numbers(5)
;

SELECT max(number)
FROM numbers(5)
;

```

4. 難読化:

```bash title="Query" theme={null}
$ clickhouse-format --seed Hello --obfuscate <<< "SELECT cost_first_screen BETWEEN a AND b, CASE WHEN x >= 123 THEN y ELSE NULL END;"
```

```sql title="Response" theme={null}
SELECT treasury_mammoth_hazelnut BETWEEN nutmeg AND span, CASE WHEN chive >= 116 THEN switching ELSE ANYTHING END;
```

同じクエリと別のseed文字列:

```bash title="Query" theme={null}
$ clickhouse-format --seed World --obfuscate <<< "SELECT cost_first_screen BETWEEN a AND b, CASE WHEN x >= 123 THEN y ELSE NULL END;"
```

```sql title="Response" theme={null}
SELECT horse_tape_summer BETWEEN folklore AND moccasins, CASE WHEN intestine >= 116 THEN nonconformist ELSE FORESTRY END;
```

5. バックスラッシュを追加:

```bash title="Query" theme={null}
$ clickhouse-format --backslash <<< "SELECT * FROM (SELECT 1 AS x UNION ALL SELECT 1 UNION DISTINCT SELECT 3);"
```

```sql title="Response" theme={null}
SELECT * \
FROM  \
( \
    SELECT 1 AS x \
    UNION ALL \
    SELECT 1 \
    UNION DISTINCT \
    SELECT 3 \
)
```