構文

このセクションでは、ClickHouseのSQL構文について見ていきます。
ClickHouseはSQLに基づいた構文を使用していますが、多くの拡張機能と最適化を提供しています。

クエリ解析

ClickHouseには2つのタイプのパーサーがあります：

• フルSQLパーサー（再帰的下りパーサー）。
• データフォーマットパーサー（高速ストリームパーサー）。

フルSQLパーサーは、INSERTクエリ以外のすべての場合に使用され、INSERTクエリでは両方のパーサーが使用されます。

以下のクエリを見てみましょう：

INSERT INTO t VALUES (1, 'Hello, world'), (2, 'abc'), (3, 'def')

すでに述べたように、INSERTクエリは両方のパーサーを利用します。
INSERT INTO t VALUESの部分はフルパーサーによって解析され、
データ(1, 'Hello, world'), (2, 'abc'), (3, 'def')はデータフォーマットパーサー、または高速ストリームパーサーによって解析されます。

フルパーサーの有効化

データに対してフルパーサーを有効にするには、input_format_values_interpret_expressions設定を使用します。

前述の設定が1に設定されている場合、
ClickHouseは最初に値を高速ストリームパーサーで解析しようとします。
もし失敗した場合、ClickHouseはデータに対してフルパーサーを使用し、SQLの式のように扱います。

データは任意のフォーマットを持つことができます。
クエリを受け取ると、サーバーはリクエストのメモリ内のhttp://max_query_sizeバイトを計算し（デフォルトは1 MB）、残りはストリームパースされます。
これは、ClickHouseにデータを挿入する推奨方法である大きなINSERTクエリの問題を回避するためのものです。

INSERTクエリでValuesフォーマットを使用する場合、
データがSELECTクエリの式と同じように解析されるように見えるかもしれませんが、これは事実ではありません。
Valuesフォーマットははるかに制限されています。

このセクションの残りはフルパーサーについて扱います。

注記

フォーマットパーサーに関する詳細情報は、フォーマットセクションを参照してください。

スペース

• 構文構成要素間には任意の数のスペース記号を置くことができます（クエリの始めと終わりを含む）。
• スペース記号にはスペース、タブ、改行、CR、フォームフィードが含まれます。

コメント

ClickHouseはSQLスタイルおよびCスタイルのコメントの両方をサポートしています：

• SQLスタイルのコメントは--、#!または# で始まり、行の最後まで続きます。--と#!の後のスペースは省略可能です。
• Cスタイルのコメントは/*から*/までの間にあり、複数行にわたることができます。スペースは必要ありません。

キーワード

ClickHouseのキーワードは、コンテキストによって_ケースセンシティブ_または_ケースインセンシティブ_のいずれかです。

キーワードは次の場合にケースインセンシティブです：

• SQL標準の場合。たとえば、SELECT、select、およびSeLeCtはすべて有効です。
• 一部の一般的なDBMS（MySQLまたはPostgres）での実装。たとえば、DateTimeはdatetimeと同じです。

注記

データ型名がケースセンシティブであるかどうかは、system.data_type_familiesテーブルで確認できます。

標準SQLとは対照的に、他のすべてのキーワード（関数名を含む）はケースセンシティブです。

さらに、キーワードは予約語ではありません。
それらは対応するコンテキスト内でのみそのように扱われます。
キーワードと同じ名前の識別子を使用する場合は、二重引用符またはバッククォートで囲んでください。

たとえば、次のクエリは、table_nameというテーブルに"FROM"という名前のカラムがある場合に有効です：

SELECT "FROM" FROM table_name

識別子

識別子は次のものを指します：

• クラスター、データベース、テーブル、パーティション、およびカラム名。
• 関数。
• データ型。
• 式エイリアス。

識別子は引用符を使うことも、使用しないこともできますが、後者が好まれます。

引用符を使わない識別子は、正規表現^[a-zA-Z_][0-9a-zA-Z_]*$に一致し、キーワードと同じであってはいけません。
以下の表には、有効な識別子と無効な識別子の例が示されています：

有効な識別子	無効な識別子
xyz、_internal、Id_with_underscores_123_	1x、[email protected]、äußerst_schön

キーワードと同じ識別子や、他の記号を識別子に使用したい場合は、二重引用符またはバッククォートで囲んでください。たとえば、"id"、`id`。

注記

引用符を使用した識別子のエスケープに適用されるのと同じルールが文字列リテラルにも適用されます。詳細は文字列を参照してください。

リテラル

ClickHouseにおいて、リテラルはクエリ内で直接表現される値です。
言い換えれば、クエリの実行中に変わらない固定値です。

リテラルには次の種類があります：

• 文字列
• 数値
• 複合
• NULL
• ヒアドキュメント（カスタム文字列リテラル）

これらの詳細については、以下のセクションで見ていきます。

文字列

文字列リテラルはシングルクオートで囲む必要があります。ダブルクオートはサポートされていません。

エスケープは次のように動作します：

• シングルクオート文字'（この文字だけ）をエスケープするために前置きのシングルクオートを使用するか、または
• 次の表に記載されているサポートされたエスケープシーケンスを使用するための前置きのバックスラッシュを使用します。

注記

バックスラッシュは、その後に続く文字が以下に記載されている文字以外の場合は特別な意味を失います。即ち、文字通りに解釈されます。

サポートされたエスケープ	説明
\xHH	任意の数の16進数の数字（H）に続く8ビット文字指定。
\N	予約されており、何もしない（例：SELECT 'a\Nb'はabを返します）
\a	アラート
\b	バックスペース
\e	エスケープ文字
\f	フォームフィード
\n	改行
\r	キャリッジリターン
\t	水平タブ
\v	垂直タブ
\0	NULL文字
\\	バックスラッシュ
\'（または''）	シングルクオート
\"	ダブルクオート
`	バッククォート
\/	フォワードスラッシュ
\=	等号
ASCIIコントロール文字（c <= 31）

注記

文字列リテラル内では、少なくとも'と\をエスケープする必要があります。エスケープコードは\'（または：''）と\\です。

数値

数値リテラルは次のように解析されます：

• まず64ビット符号付き数値として、strtoull関数を使用して解析されます。
• 失敗した場合は、64ビット符号なし数値として、strtoll関数を使用して解析されます。
• それでも失敗した場合は、浮動小数点数として、strtod関数を使用して解析されます。
• それ以外の場合は、エラーが返されます。

リテラル値は、その値が収まる最小の型にキャストされます。
たとえば：

• 1はUInt8として解析されます。
• 256はUInt16として解析されます。

詳細についてはデータ型を参照してください。

数値リテラル内のアンダースコア_は無視され、可読性を向上させるために使用できます。

サポートされている数値リテラルは次の通りです：

数値リテラル	例
整数	1、10_000_000、18446744073709551615、01
小数	0.1
指数表記	1e100、-1e-100
浮動小数点数	123.456、inf、nan
16進数	0xc0fe
SQL標準互換の16進数文字列	x'c0fe'
2進数	0b1101
SQL標準互換の2進数文字列	b'1101'

注記

偶数リテラルは、意図しない解釈のエラーを避けるためにサポートされていません。

複合

配列は角括弧[1, 2, 3]で構成されます。タプルは丸括弧(1, 'Hello, world!', 2)で構成されます。
技術的には、これらはリテラルではなく、それぞれ配列作成演算子とタプル作成演算子を持つ式です。
配列は少なくとも1つのアイテムを含む必要があり、タプルは少なくとも2つのアイテムを持つ必要があります。

注記

タプルがSELECTクエリのIN句に出現する場合、別のケースがあります。
クエリ結果にはタプルが含まれますが、タプルはデータベースに保存できません（Memoryエンジンを使用するテーブルを除く）。

NULL

NULLは値が欠けていることを示すために使用されます。
テーブルフィールドにNULLを保存するには、その型はNullable型でなければなりません。

注記

NULLについて次のことに留意してください：

• データフォーマット（入力または出力）によって、NULLは異なる表現を持つ場合があります。詳細についてはdata formatsを参照してください。
• NULL処理は微妙です。たとえば、比較演算の引数のうち少なくとも1つがNULLである場合、この演算の結果もNULLになります。同様のことが乗算、加算、および他の演算にも当てはまります。各演算のドキュメントを読むことをお勧めします。
• クエリ内で、IS NULL及びIS NOT NULL演算子と関連する関数isNullおよびisNotNullを使用してNULLをチェックできます。

ヒアドキュメント

ヒアドキュメントは、オリジナルのフォーマットを維持しつつ、文字列（通常は複数行）を定義する方法です。
ヒアドキュメントは、2つの$記号の間に配置されたカスタム文字列リテラルとして定義されます。

例えば：

SELECT $heredoc$SHOW CREATE VIEW my_view$heredoc$;

┌─'SHOW CREATE VIEW my_view'─┐
│ SHOW CREATE VIEW my_view   │
└────────────────────────────┘

注記

• 2つのヒアドキュメント間の値は"そのまま"処理されます。

ヒント

• ヒアドキュメントを使用して、SQL、HTML、またはXMLコードのスニペットを埋め込むことができます。

クエリパラメータの定義と使用

クエリパラメータを使用することにより、具体的な識別子の代わりに抽象的なプレースホルダーを含む一般的なクエリを書くことができます。
クエリパラメータを含むクエリが実行されると、すべてのプレースホルダーが解決され、実際のクエリパラメータの値に置き換えられます。

クエリパラメータを定義する方法は2つあります：

• SET param_<name>=<value>
• --param_<name>='<value>'

第2の変種を使用する場合、それはコマンドラインでclickhouse-clientに渡されます。
ここで：

• <name>はクエリパラメータの名前です。
• <value>はその値です。

クエリパラメータは、{<name>: <datatype>}を使用してクエリ内で参照でき、<name>はクエリパラメータの名前で、<datatype>はそれが変換されるデータ型です。

SETコマンドの例

たとえば、以下のSQLは、異なるデータ型を持つa、b、c、およびdという名前のパラメータを定義します：

SET param_a = 13;
SET param_b = 'str';
SET param_c = '2022-08-04 18:30:53';
SET param_d = {'10': [11, 12], '13': [14, 15]};

SELECT
   {a: UInt32},
   {b: String},
   {c: DateTime},
   {d: Map(String, Array(UInt8))};

13    str    2022-08-04 18:30:53    {'10':[11,12],'13':[14,15]}

clickhouse-clientの例

clickhouse-clientを使用している場合、パラメータは--param_name=valueとして指定されます。たとえば、次のパラメータはmessageという名前で、Stringとして取得されます：

clickhouse-client --param_message='hello' --query="SELECT {message: String}"

hello

クエリパラメータがデータベース、テーブル、関数または他の識別子の名前を表す場合、その型としてIdentifierを使用します。
たとえば、次のクエリは、uk_price_paidという名前のテーブルから行を返します：

SET param_mytablename = "uk_price_paid";
SELECT * FROM {mytablename:Identifier};

注記

クエリパラメータは、任意のSQLクエリの任意の場所で使用できる一般的なテキスト置換ではありません。
主に識別子またはリテラルの代替としてSELECT文で機能するように設計されています。

関数

関数呼び出しは、引数（空である可能性もある）を持つ識別子のように書かれます。
標準SQLとは異なり、引数リストが空の場合でも括弧は必須です。
例えば：

now()

また、以下があります：

• 通常の関数。
• 集約関数。

一部の集約関数は、括弧内に2つの引数リストを含むことができます。たとえば：

quantile (0.9)(x) 

これらの集約関数は「パラメトリック」関数と呼ばれ、最初のリストの引数は「パラメータ」と呼ばれます。

注記

パラメータなしの集約関数の構文は、通常の関数と同じです。

演算子

演算子は、クエリ解析中に対応する関数に変換され、その優先順位と結合性を考慮されます。

たとえば、式

1 + 2 * 3 + 4

は次のように変換されます：

plus(plus(1, multiply(2, 3)), 4)`

データ型とデータベーステーブルエンジン

CREATEクエリ内のデータ型とテーブルエンジンは、識別子または関数のように書かれます。
言い換えれば、それらは括弧内の引数リストを含む場合と含まない場合があります。

詳細については以下のセクションを参照してください：

• データ型
• テーブルエンジン
• CREATE。

式

式は次のいずれかであることができます：

• 関数
• 識別子
• リテラル
• 演算子の適用
• 括弧内の式
• サブクエリ
• アスタリスク

それはエイリアスを含むこともできます。

式のリストは、カンマで区切られた1つ以上の式です。
関数や演算子も、引数として式を持つことができます。

定数式は、クエリ分析の際に結果が既知の式、すなわち実行前の式です。
たとえば、リテラル上の式は定数式です。

式エイリアス

エイリアスは、クエリ内の式のユーザー定義名です。

expr AS alias

上記の構文の部分については以下で説明します。

構文の部分	説明	例	メモ
AS	エイリアスを定義するためのキーワード。SELECT句内でテーブル名またはカラム名のエイリアスを定義する際にASキーワードを使用しなくてもよい。	SELECT table_name_alias.column_name FROM table_name table_name_alias.	CAST関数内で、ASキーワードは別の意味を持つ。関数の説明を参照。
expr	ClickHouseがサポートする任意の式。	SELECT column_name * 2 AS double FROM some_table
alias	exprのための名前。エイリアスは識別子の構文に従う必要がある。	SELECT "table t".column_name FROM table_name AS "table t"

使用に関するノート

• エイリアスはクエリまたはサブクエリに対してグローバルであり、クエリの任意の部分で任意の式のエイリアスを定義できます。たとえば：

SELECT (1 AS n) + 2, n`.

• エイリアスはサブクエリ内およびサブクエリ間では表示されません。たとえば、次のクエリを実行すると、ClickHouseはUnknown identifier: numという例外を生成します：

`SELECT (SELECT sum(b.a) + num FROM b) - a.a AS num FROM a`

• サブクエリのSELECT句で結果のカラムにエイリアスが定義されている場合、これらのカラムは外側のクエリで表示されます。たとえば：

SELECT n + m FROM (SELECT 1 AS n, 2 AS m)`.

• カラム名やテーブル名と同じエイリアスに注意してください。次の例を考えてみましょう：

CREATE TABLE t
(
    a Int,
    b Int
)
ENGINE = TinyLog();

SELECT
    argMax(a, b),
    sum(b) AS b
FROM t;

Received exception from server (version 18.14.17):
Code: 184. DB::Exception: Received from localhost:9000, 127.0.0.1. DB::Exception: Aggregate function sum(b) is found inside another aggregate function in query.

前の例では、カラムbを持つテーブルtを宣言しました。
その後、データを選択する際に、sum(b) AS bというエイリアスを定義しました。
エイリアスはグローバルであるため、ClickHouseは式argMax(a, b)内のリテラルbを式sum(b)に置き換えました。
この置き換えが例外を引き起こしました。

注記

このデフォルトの動作は、prefer_column_name_to_aliasを1に設定することによって変更できます。

アスタリスク

SELECTクエリ内では、アスタリスクが式の代わりに使用できます。
詳細については、SELECTセクションを参照してください。