メインコンテンツへスキップ
メインコンテンツへスキップ

JSON 関数

JSON関数の種類​

JSONを解析するための関数セットは2種類あります:

  • simpleJSON* (visitParam*) - 限定されたJSONのサブセットを極めて高速に解析するために作られています。
  • JSONExtract* - 通常のJSONを解析するために作られています。

simpleJSON (visitParam) 関数​

ClickHouseには、簡略化されたJSONを扱うための特殊な関数があります。これらのJSON関数はすべて、JSONがどのような形式であるかについての強い前提に基づいています。可能な限り迅速に処理を完了するために、最小限の処理を行うように設計されています。

以下の前提が設けられています:

  1. フィールド名(関数の引数)は定数でなければなりません。
  2. フィールド名はJSON内で正規的にエンコードされている必要があります。例: simpleJSONHas('{"abc":"def"}', 'abc') = 1 ですが、simpleJSONHas('{"\\u0061\\u0062\\u0063":"def"}', 'abc') = 0 となります。
  3. フィールドは任意のネストレベルで無差別に検索されます。一致するフィールドが複数ある場合は、最初に出現したものが使用されます。
  4. JSONは文字列リテラルの外側に空白文字を含みません。

JSONExtract 関数​

これらの関数は simdjson に基づいており、より複雑なJSON解析要件に対応するように設計されています。

大文字小文字を区別しないJSONExtract関数​

これらの関数は、JSONオブジェクトから値を抽出する際にASCII大文字小文字を区別しないキーマッチングを実行します。 大文字小文字を区別する対応関数と同様に動作しますが、オブジェクトキーは大文字小文字を区別せずにマッチングされます。 異なる大文字小文字で複数のキーが一致する場合は、最初に一致したものが返されます。

注記

これらの関数は大文字小文字を区別する対応関数よりもパフォーマンスが低下する可能性があるため、可能であれば通常のJSONExtract関数を使用してください。

JSONAllPaths​

導入バージョン: v24.8

JSON列の各行に格納されているすべてのパスのリストを返します。

構文

JSONAllPaths(json)

引数

  • json — JSON列。JSON

戻り値

JSON列内のすべてのパスの配列を返します。Array(String)

例

使用例

CREATE TABLE test (json JSON(max_dynamic_paths=1)) ENGINE = Memory;
INSERT INTO test FORMAT JSONEachRow {"json" : {"a" : 42}}, {"json" : {"b" : "Hello"}}, {"json" : {"a" : [1, 2, 3], "c" : "2020-01-01"}}
SELECT json, JSONAllPaths(json) FROM test;

┌─json─────────────────────────────────┬─JSONAllPaths(json)─┐
│ {"a":"42"}                           │ ['a']              │
│ {"b":"Hello"}                        │ ['b']              │
│ {"a":["1","2","3"],"c":"2020-01-01"} │ ['a','c']          │
└──────────────────────────────────────┴────────────────────┘

JSONAllPathsWithTypes​

導入バージョン: v24.8

JSON列の各行に格納されているすべてのパスとそのデータ型のリストを返します。

構文

JSONAllPathsWithTypes(json)

引数

  • json — JSON列。JSON

戻り値

JSON列内のすべてのパスとそのデータ型のマップを返します。Map(String, String)

例

使用例

CREATE TABLE test (json JSON(max_dynamic_paths=1)) ENGINE = Memory;
INSERT INTO test FORMAT JSONEachRow {"json" : {"a" : 42}}, {"json" : {"b" : "Hello"}}, {"json" : {"a" : [1, 2, 3], "c" : "2020-01-01"}}
SELECT json, JSONAllPathsWithTypes(json) FROM test;

┌─json─────────────────────────────────┬─JSONAllPathsWithTypes(json)───────────────┐
│ {"a":"42"}                           │ {'a':'Int64'}                             │
│ {"b":"Hello"}                        │ {'b':'String'}                            │
│ {"a":["1","2","3"],"c":"2020-01-01"} │ {'a':'Array(Nullable(Int64))','c':'Date'} │
└──────────────────────────────────────┴───────────────────────────────────────────┘

JSONArrayLength​

導入バージョン: v23.2

最も外側のJSON配列の要素数を返します。 入力されたJSON文字列が無効な場合、この関数はNULLを返します。

構文

JSONArrayLength(json)

エイリアス: JSON_ARRAY_LENGTH

引数

  • json — 有効なJSON文字列。String

戻り値

jsonが有効なJSON配列文字列の場合は配列要素数を返し、それ以外の場合はNULLを返します。Nullable(UInt64)

例

使用例

SELECT
    JSONArrayLength(''),
    JSONArrayLength('[1,2,3]');

┌─JSONArrayLength('')─┬─JSONArrayLength('[1,2,3]')─┐
│                ᴺᵁᴸᴸ │                          3 │
└─────────────────────┴────────────────────────────┘

JSONDynamicPaths​

導入バージョン: v24.8

JSON列内で個別のサブカラムとして格納されている動的パスのリストを返します。

構文

JSONDynamicPaths(json)

引数

  • json — JSON列。JSON

戻り値

JSON列内の動的パスの配列を返します。Array(String)

例

使用例

CREATE TABLE test (json JSON(max_dynamic_paths=1)) ENGINE = Memory;
INSERT INTO test FORMAT JSONEachRow {"json" : {"a" : 42}}, {"json" : {"b" : "Hello"}}, {"json" : {"a" : [1, 2, 3], "c" : "2020-01-01"}}
SELECT json, JSONDynamicPaths(json) FROM test;

┌─json─────────────────────────────────┬─JSONDynamicPaths(json)─┐
│ {"a":"42"}                           │ ['a']                  │
│ {"b":"Hello"}                        │ []                     │
│ {"a":["1","2","3"],"c":"2020-01-01"} │ ['a']                  │
└──────────────────────────────────────┴────────────────────────┘

JSONDynamicPathsWithTypes​

導入バージョン: v24.8

JSON列の各行において、個別のサブカラムとして格納されている動的パスとその型のリストを返します。

構文

JSONDynamicPathsWithTypes(json)

引数

  • json — JSON列。JSON

戻り値

JSON列内の動的パスとそのデータ型のマップを返します。Map(String, String)

例

使用例

CREATE TABLE test (json JSON(max_dynamic_paths=1)) ENGINE = Memory;
INSERT INTO test FORMAT JSONEachRow {"json" : {"a" : 42}}, {"json" : {"b" : "Hello"}}, {"json" : {"a" : [1, 2, 3], "c" : "2020-01-01"}}
SELECT json, JSONDynamicPathsWithTypes(json) FROM test;

┌─json─────────────────────────────────┬─JSONDynamicPathsWithTypes(json)─┐
│ {"a":"42"}                           │ {'a':'Int64'}                   │
│ {"b":"Hello"}                        │ {}                              │
│ {"a":["1","2","3"],"c":"2020-01-01"} │ {'a':'Array(Nullable(Int64))'}  │
└──────────────────────────────────────┴─────────────────────────────────┘

JSONExtract​

導入バージョン: v19.14

JSONを解析し、指定されたClickHouseデータ型で値を抽出します。

構文

JSONExtract(json, return_type[, indices_or_keys, ...])

引数

  • json — 解析するJSON文字列。String
  • return_type — 返されるClickHouseデータ型。String
  • indices_or_keys — 文字列または整数を指定できる0個以上の引数のリスト。Stringまたは(U)Int*

戻り値

可能であれば指定されたClickHouseデータ型の値を返し、それ以外の場合はその型のデフォルト値を返します。

例

使用例

SELECT JSONExtract('{"a": "hello", "b": [-100, 200.0, 300]}', 'Tuple(String, Array(Float64))') AS res;

┌─res──────────────────────────────┐
│ ('hello',[-100,200,300])         │
└──────────────────────────────────┘

JSONExtractArrayRaw​

導入バージョン: v20.1

JSON配列の要素を含む配列を返します。各要素は未解析の文字列として表現されます。

構文

JSONExtractArrayRaw(json[, indices_or_keys, ...])

引数

  • json — 解析するJSON文字列。String
  • indices_or_keys — 文字列または整数を指定できる0個以上の引数のリスト。Stringまたは(U)Int*

戻り値

JSON配列要素を含む文字列の配列を返します。該当部分が配列でない場合、または存在しない場合は、空の配列が返されます。Array(String)

例

使用例

SELECT JSONExtractArrayRaw('{"a": "hello", "b": [-100, 200.0, "hello"]}', 'b') AS res;

┌─res──────────────────────────┐
│ ['-100','200.0','"hello"']   │
└──────────────────────────────┘

JSONExtractArrayRawCaseInsensitive​

導入バージョン: v25.8

大文字小文字を区別しないキーマッチングを使用して、JSON配列の各要素を未解析の文字列として表現した配列を返します。この関数はJSONExtractArrayRawと類似しています。

構文

JSONExtractArrayRawCaseInsensitive(json [, indices_or_keys]...)

引数

  • json — 解析するJSON文字列 String
  • indices_or_keys — オプション。配列へナビゲートするためのインデックスまたはキー。キーは大文字小文字を区別しないマッチングを使用します String または (U)Int*

返り値

未加工のJSON文字列の配列を返します。Array(String)

例

基本

SELECT JSONExtractArrayRawCaseInsensitive('{"Items": [1, 2, 3]}', 'ITEMS')

['1','2','3']

JSONExtractBool​

導入バージョン: v20.1

JSONを解析し、Bool型の値を抽出します。

構文

JSONExtractBool(json[, indices_or_keys, ...])

引数

  • json — 解析対象のJSON文字列。String
  • indices_or_keys — 文字列または整数を指定できる0個以上の引数のリスト。Stringまたは(U)Int*

戻り値

Bool値が存在する場合はその値を返し、存在しない場合は0を返します。Bool

例

使用例

SELECT JSONExtractBool('{"passed": true}', 'passed') AS res;

┌─res─┐
│   1 │
└─────┘

JSONExtractBoolCaseInsensitive​

導入バージョン: v25.8

JSONを解析し、大文字小文字を区別しないキーマッチングを使用してブール値を抽出します。この関数はJSONExtractBoolと同様の機能を持ちます。

構文

JSONExtractBoolCaseInsensitive(json [, indices_or_keys]...)

引数

  • json — 解析対象のJSON文字列 String
  • indices_or_keys — オプション。対象フィールドへ移動するためのインデックスまたはキー。キーは大文字小文字を区別しないマッチングを使用します String または (U)Int*

戻り値

抽出されたブール値を返します（trueの場合は1、falseの場合は0）。見つからない場合は0を返します。UInt8

例

基本

SELECT JSONExtractBoolCaseInsensitive('{"IsActive": true}', 'isactive')

1

JSONExtractCaseInsensitive​

導入バージョン: v25.8

JSONを解析し、大文字小文字を区別しないキーマッチングを使用して、指定されたClickHouseデータ型の値を抽出します。この関数はJSONExtractと類似しています。

構文

JSONExtractCaseInsensitive(json [, indices_or_keys...], return_type)

引数

  • json — 解析対象のJSON文字列 String
  • indices_or_keys — オプション。フィールドへナビゲートするためのインデックスまたはキー。キーは大文字小文字を区別しないマッチングを使用します String または (U)Int*
  • return_type — 抽出するClickHouseデータ型 String

戻り値

指定されたデータ型で抽出された値を返します。Any

例

int_type

SELECT JSONExtractCaseInsensitive('{"Number": 123}', 'number', 'Int32')

123

array_type

SELECT JSONExtractCaseInsensitive('{"List": [1, 2, 3]}', 'list', 'Array(Int32)')

[1,2,3]

JSONExtractFloat​

導入バージョン: v20.1

JSONを解析し、Float型の値を抽出します。

構文

JSONExtractFloat(json[, indices_or_keys, ...])

引数

  • json — 解析するJSON文字列。String
  • indices_or_keys — 文字列または整数を指定できる0個以上の引数のリスト。Stringまたは(U)Int*

戻り値

値が存在する場合はFloat値を返し、存在しない場合は0を返します。Float64

例

使用例

SELECT JSONExtractFloat('{"a": "hello", "b": [-100, 200.0, 300]}', 'b', 2) AS res;

┌─res─┐
│ 200 │
└─────┘

JSONExtractFloatCaseInsensitive​

導入バージョン: v25.8

JSONを解析し、大文字小文字を区別しないキーマッチングを使用してFloat型の値を抽出します。この関数はJSONExtractFloatと同様の機能を持ちます。

構文

JSONExtractFloatCaseInsensitive(json [, indices_or_keys]...)

引数

  • json — 解析対象のJSON文字列 String
  • indices_or_keys — オプション。対象フィールドへナビゲートするためのインデックスまたはキー。キーは大文字小文字を区別しないマッチングを使用します String または (U)Int*

戻り値

抽出されたFloat値を返します。値が見つからない場合または変換できない場合は0を返します。Float64

例

基本的な使用例

SELECT JSONExtractFloatCaseInsensitive('{"Price": 12.34}', 'PRICE')

12.34

JSONExtractInt​

導入バージョン: v20.1

JSONを解析し、Int型の値を抽出します。

構文

JSONExtractInt(json[, indices_or_keys, ...])

引数

  • json — 解析するJSON文字列。String
  • indices_or_keys — 文字列または整数を指定できる0個以上の引数のリスト。Stringまたは(U)Int*

戻り値

値が存在する場合はInt値を返し、存在しない場合は0を返します。Int64

例

使用例

SELECT JSONExtractInt('{"a": "hello", "b": [-100, 200.0, 300]}', 'b', 1) AS res;

┌─res─┐
│ 200 │
└─────┘

JSONExtractIntCaseInsensitive​

導入バージョン: v25.8

JSONを解析し、大文字小文字を区別しないキーマッチングを使用してInt型の値を抽出します。この関数はJSONExtractIntと同様です。

構文

JSONExtractIntCaseInsensitive(json [, indices_or_keys]...)

引数

  • json — 解析するJSON文字列 String
  • indices_or_keys — オプション。フィールドへナビゲートするためのインデックスまたはキー。キーは大文字小文字を区別しないマッチングを使用します String または (U)Int*

返り値

抽出されたInt値を返します。見つからない場合または変換できない場合は0を返します。Int64

例

基本

SELECT JSONExtractIntCaseInsensitive('{"Value": 123}', 'value')

123

ネスト

SELECT JSONExtractIntCaseInsensitive('{"DATA": {"COUNT": 42}}', 'data', 'Count')

42

JSONExtractKeys​

導入バージョン: v21.11

JSON文字列を解析してキーを抽出します。

構文

JSONExtractKeys(json[, indices_or_keys, ...])

引数

  • json — 解析するJSON文字列。String
  • indices_or_keys — 文字列または整数を指定できる0個以上の引数のリスト。Stringまたは(U)Int*

戻り値

JSONオブジェクトのキーを含む配列を返します。Array(String)

例

使用例

SELECT JSONExtractKeys('{"a": "hello", "b": [-100, 200.0, 300]}') AS res;

┌─res─────────┐
│ ['a','b']   │
└─────────────┘

JSONExtractKeysAndValues​

導入バージョン: v20.1

指定されたClickHouseデータ型の値を持つJSONからキーと値のペアを解析します。

構文

JSONExtractKeysAndValues(json, value_type[, indices_or_keys, ...])

引数

  • json — 解析するJSON文字列。String
  • value_type — 値のClickHouseデータ型。String
  • indices_or_keys — 文字列または整数のいずれかを指定できる0個以上の引数のリスト。Stringまたは(U)Int*

戻り値

解析されたキーと値のペアを含むタプルの配列を返します。Array(Tuple(String, value_type))

例

使用例

SELECT JSONExtractKeysAndValues('{"x": {"a": 5, "b": 7, "c": 11}}', 'Int8', 'x') AS res;

┌─res────────────────────┐
│ [('a',5),('b',7),('c',11)] │
└────────────────────────┘

JSONExtractKeysAndValuesCaseInsensitive​

導入バージョン: v25.8

大文字小文字を区別せずにキーをマッチングし、JSONからキーと値のペアを解析します。この関数はJSONExtractKeysAndValuesと類似しています。

構文

JSONExtractKeysAndValuesCaseInsensitive(json [, indices_or_keys...], value_type)

引数

  • json — 解析対象のJSON文字列 String
  • indices_or_keys — オプション。オブジェクトへ移動するためのインデックスまたはキー。キーは大文字小文字を区別せずにマッチングされます String または (U)Int*
  • value_type — 値のClickHouseデータ型 String

戻り値

キーと値のペアを含むタプルの配列を返します。Array(Tuple(String, T))

例

基本

SELECT JSONExtractKeysAndValuesCaseInsensitive('{"Name": "Alice", "AGE": 30}', 'String')

[('Name','Alice'),('AGE','30')]

JSONExtractKeysAndValuesRaw​

導入バージョン: v20.4

JSONオブジェクトからキーと値のタプルの配列を返します。すべての値は未解析の文字列として表現されます。

構文

JSONExtractKeysAndValuesRaw(json[, indices_or_keys, ...])

引数

  • json — 解析するJSON文字列。String
  • indices_or_keys — 文字列または整数のいずれかを指定できる0個以上の引数のリスト。String または (U)Int*

戻り値

キーと値のペアを含むタプルの配列を返します。値は未解析の文字列です。Array(Tuple(String, String))

例

使用例

SELECT JSONExtractKeysAndValuesRaw('{"a": [-100, 200.0], "b": "hello"}') AS res;

┌─res──────────────────────────────────┐
│ [('a','[-100,200.0]'),('b','"hello"')] │
└──────────────────────────────────────┘

JSONExtractKeysAndValuesRawCaseInsensitive​

導入バージョン: v25.8

大文字小文字を区別しないキーマッチングを使用して、JSONから生のキーと値のペアを抽出します。この関数はJSONExtractKeysAndValuesRawと類似しています。

構文

JSONExtractKeysAndValuesRawCaseInsensitive(json [, indices_or_keys]...)

引数

  • json — パースするJSON文字列 String
  • indices_or_keys — オプション。オブジェクトへ移動するためのインデックスまたはキー。キーは大文字小文字を区別しないマッチングを使用します String または (U)Int*

返り値

生の文字列としてキーと値のペアを含むタプルの配列を返します。Array(Tuple(String, String))

例

基本

SELECT JSONExtractKeysAndValuesRawCaseInsensitive('{"Name": "Alice", "AGE": 30}')

[('Name','"Alice"'),('AGE','30')]

JSONExtractKeysCaseInsensitive​

導入バージョン: v25.8

JSON文字列を解析し、大文字小文字を区別しないキーマッチングを使用してネストされたオブジェクトに移動し、キーを抽出します。この関数はJSONExtractKeysと類似しています。

構文

JSONExtractKeysCaseInsensitive(json [, indices_or_keys]...)

引数

  • json — 解析するJSON文字列 String
  • indices_or_keys — オプション。オブジェクトに移動するためのインデックスまたはキー。キーは大文字小文字を区別しないマッチングを使用します String または (U)Int*

戻り値

JSONオブジェクトからキーの配列を返します。Array(String)

例

基本

SELECT JSONExtractKeysCaseInsensitive('{"Name": "Alice", "AGE": 30}')

['Name','AGE']

ネスト

SELECT JSONExtractKeysCaseInsensitive('{"User": {"name": "John", "AGE": 25}}', 'user')

['name','AGE']

JSONExtractRaw​

導入バージョン: v20.1

JSONの一部を未解析の文字列として返します。

構文

JSONExtractRaw(json[, indices_or_keys, ...])

引数

  • json — 解析対象のJSON文字列。String
  • indices_or_keys — 文字列または整数を指定できる0個以上の引数のリスト。Stringまたは(U)Int*

戻り値

JSONの一部を未解析の文字列として返します。該当する部分が存在しない場合、または型が正しくない場合は、空の文字列が返されます。String

例

使用例

SELECT JSONExtractRaw('{"a": "hello", "b": [-100, 200.0, 300]}', 'b') AS res;

┌─res──────────────┐
│ [-100,200.0,300] │
└──────────────────┘

JSONExtractRawCaseInsensitive​

導入バージョン: v25.8

大文字小文字を区別しないキーマッチングを使用して、JSONの一部を未解析の文字列として返します。この関数はJSONExtractRawと同様です。

構文

JSONExtractRawCaseInsensitive(json [, indices_or_keys]...)

引数

  • json — 解析するJSON文字列 String
  • indices_or_keys — オプション。フィールドへナビゲートするためのインデックスまたはキー。キーは大文字小文字を区別しないマッチングを使用します String または (U)Int*

戻り値

抽出された要素の生のJSON文字列を返します。String

例

オブジェクト

SELECT JSONExtractRawCaseInsensitive('{"Object": {"key": "value"}}', 'OBJECT')

{"key":"value"}

JSONExtractString​

導入バージョン: v20.1

JSONを解析し、String型の値を抽出します。

構文

JSONExtractString(json[, indices_or_keys, ...])

引数

  • json — 解析対象のJSON文字列。String
  • indices_or_keys — 文字列または整数を指定できる0個以上の引数のリスト。String または (U)Int*

戻り値

値が存在する場合はString値を返し、存在しない場合は空文字列を返します。String

例

使用例

SELECT JSONExtractString('{"a": "hello", "b": [-100, 200.0, 300]}', 'a') AS res;

┌─res───┐
│ hello │
└───────┘

JSONExtractStringCaseInsensitive​

導入バージョン: v25.8

JSONを解析し、大文字小文字を区別しないキーマッチングを使用して文字列を抽出します。この関数はJSONExtractStringと同様です。

構文

JSONExtractStringCaseInsensitive(json [, indices_or_keys]...)

引数

  • json — 解析するJSON文字列 String
  • indices_or_keys — オプション。フィールドへナビゲートするためのインデックスまたはキー。キーは大文字小文字を区別しないマッチングを使用します String または (U)Int*

戻り値

抽出された文字列値を返します。見つからない場合は空文字列を返します。String

例

基本

SELECT JSONExtractStringCaseInsensitive('{"ABC": "def"}', 'abc')

def

ネスト構造

SELECT JSONExtractStringCaseInsensitive('{"User": {"Name": "John"}}', 'user', 'name')

John

JSONExtractUInt​

導入バージョン: v20.1

JSONを解析し、UInt型の値を抽出します。

構文

JSONExtractUInt(json [, indices_or_keys, ...])

引数

  • json — 解析するJSON文字列。String
  • indices_or_keys — 文字列または整数を指定できる0個以上の引数のリスト。Stringまたは(U)Int*

戻り値

値が存在する場合はUInt値を返し、存在しない場合は0を返します。UInt64

例

使用例

SELECT JSONExtractUInt('{"a": "hello", "b": [-100, 200.0, 300]}', 'b', -1) AS res;

┌─res─┐
│ 300 │
└─────┘

JSONExtractUIntCaseInsensitive​

導入バージョン: v25.8

JSONを解析し、大文字小文字を区別しないキーマッチングを使用してUInt型の値を抽出します。この関数はJSONExtractUIntと同様です。

構文

JSONExtractUIntCaseInsensitive(json [, indices_or_keys]...)

引数

  • json — 解析するJSON文字列 String
  • indices_or_keys — オプション。フィールドへナビゲートするためのインデックスまたはキー。キーは大文字小文字を区別しないマッチングを使用します String または (U)Int*

戻り値

抽出されたUInt値を返します。見つからない場合または変換できない場合は0を返します。UInt64

例

基本

SELECT JSONExtractUIntCaseInsensitive('{"COUNT": 789}', 'count')

789

JSONHas​

導入バージョン: v20.1

JSONドキュメント内に指定された値が存在するかどうかを確認します。

構文

JSONHas(json[ ,indices_or_keys, ...])

引数

  • json — パースするJSON文字列 String
  • [ ,indices_or_keys, ...] — 0個以上の引数のリスト String または (U)Int*

戻り値

json内に値が存在する場合は1を、存在しない場合は0を返します UInt8

例

使用例

SELECT JSONHas('{"a": "hello", "b": [-100, 200.0, 300]}', 'b') = 1;
SELECT JSONHas('{"a": "hello", "b": [-100, 200.0, 300]}', 'b', 4) = 0;

1
0

JSONLength​

導入バージョン: v20.1

JSON配列またはJSONオブジェクトの長さを返します。 値が存在しない場合、または型が正しくない場合は、0が返されます。

構文

JSONLength(json [, indices_or_keys, ...])

引数

  • json — パースするJSON文字列 String
  • [, indices_or_keys, ...] — オプション。0個以上の引数のリスト。String または (U)Int8/16/32/64

戻り値

JSON配列またはJSONオブジェクトの長さを返します。値が存在しない場合、または型が正しくない場合は0を返します。UInt64

例

使用例

SELECT JSONLength('{"a": "hello", "b": [-100, 200.0, 300]}', 'b') = 3;
SELECT JSONLength('{"a": "hello", "b": [-100, 200.0, 300]}') = 2;

1
1

JSONMergePatch​

導入バージョン: v23.10

複数のJSONオブジェクトをマージして生成されたマージ済みJSONオブジェクト文字列を返します。

構文

jsonMergePatch(json1[, json2, ...])

エイリアス: jsonMergePatch

引数

  • json1[, json2, ...] — 有効なJSONを含む1つ以上の文字列。String

戻り値

JSONオブジェクト文字列が有効な場合、マージ済みJSONオブジェクト文字列を返します。String

例

使用例

SELECT jsonMergePatch('{"a":1}', '{"name": "joey"}', '{"name": "tom"}', '{"name": "zoey"}') AS res;

┌─res───────────────────┐
│ {"a":1,"name":"zoey"} │
└───────────────────────┘

JSONSharedDataPaths​

導入バージョン: v24.8

JSON列の共有データ構造に格納されているパスのリストを返します。

構文

JSONSharedDataPaths(json)

引数

  • json — JSON列。JSON

戻り値

JSON列の共有データ構造に格納されているパスの配列を返します。Array(String)

例

使用例

CREATE TABLE test (json JSON(max_dynamic_paths=1)) ENGINE = Memory;
INSERT INTO test FORMAT JSONEachRow {"json" : {"a" : 42}}, {"json" : {"b" : "Hello"}}, {"json" : {"a" : [1, 2, 3], "c" : "2020-01-01"}}
SELECT json, JSONSharedDataPaths(json) FROM test;

┌─json─────────────────────────────────┬─JSONSharedDataPaths(json)─┐
│ {"a":"42"}                           │ []                        │
│ {"b":"Hello"}                        │ ['b']                     │
│ {"a":["1","2","3"],"c":"2020-01-01"} │ ['c']                     │
└──────────────────────────────────────┴───────────────────────────┘

JSONSharedDataPathsWithTypes​

導入バージョン: v24.8

JSON列の各行において、共有データ構造に格納されているパスとその型のリストを返します。

構文

JSONSharedDataPathsWithTypes(json)

引数

  • json — JSON列。JSON

戻り値

JSON列の共有データ構造に格納されているパスとそのデータ型のマップを返します。Map(String, String)

例

使用例

CREATE TABLE test (json JSON(max_dynamic_paths=1)) ENGINE = Memory;
INSERT INTO test FORMAT JSONEachRow {"json" : {"a" : 42}}, {"json" : {"b" : "Hello"}}, {"json" : {"a" : [1, 2, 3], "c" : "2020-01-01"}}
SELECT json, JSONSharedDataPathsWithTypes(json) FROM test;

┌─json─────────────────────────────────┬─JSONSharedDataPathsWithTypes(json)─┐
│ {"a":"42"}                           │ {}                                  │
│ {"b":"Hello"}                        │ {'b':'String'}                      │
│ {"a":["1","2","3"],"c":"2020-01-01"} │ {'c':'Date'}                        │
└──────────────────────────────────────┴─────────────────────────────────────┘

JSONType​

導入バージョン: v20.1

JSON値の型を返します。値が存在しない場合はNull=0が返されます。

構文

JSONType(json[, indices_or_keys, ...])

引数

  • json — パース対象のJSON文字列 String
  • json[, indices_or_keys, ...] — 0個以上の引数のリスト。各引数は文字列または整数を指定できます。String または (U)Int8/16/32/64

戻り値

JSON値の型を文字列として返します。値が存在しない場合はNull=0を返します。Enum

例

使用例

SELECT JSONType('{"a": "hello", "b": [-100, 200.0, 300]}') = 'Object';
SELECT JSONType('{"a": "hello", "b": [-100, 200.0, 300]}', 'a') = 'String';
SELECT JSONType('{"a": "hello", "b": [-100, 200.0, 300]}', 'b') = 'Array';

1
1
1

JSON_EXISTS​

導入バージョン: v21.8

JSON ドキュメント内に値が存在する場合、1 が返されます。 値が存在しない場合、0 が返されます。

構文

JSON_EXISTS(json, path)

引数

  • json — 有効な JSON を含む文字列。String
  • path — パスを表す文字列。String

戻り値

JSON ドキュメント内に値が存在する場合は 1 を、存在しない場合は 0 を返します。UInt8

例

使用例

SELECT JSON_EXISTS('{"hello":1}', '$.hello');
SELECT JSON_EXISTS('{"hello":{"world":1}}', '$.hello.world');
SELECT JSON_EXISTS('{"hello":["world"]}', '$.hello[*]');
SELECT JSON_EXISTS('{"hello":["world"]}', '$.hello[0]');

┌─JSON_EXISTS(⋯ '$.hello')─┐
│                        1 │
└──────────────────────────┘
┌─JSON_EXISTS(⋯llo.world')─┐
│                        1 │
└──────────────────────────┘
┌─JSON_EXISTS(⋯.hello[*]')─┐
│                        1 │
└──────────────────────────┘
┌─JSON_EXISTS(⋯.hello[0]')─┐
│                        1 │
└──────────────────────────┘

JSON_QUERY​

導入バージョン: v21.8

JSONを解析し、値をJSON配列またはJSONオブジェクトとして抽出します。 値が存在しない場合は、空文字列が返されます。

構文

JSON_QUERY(json, path)

引数

  • json — 有効なJSON文字列。String
  • path — パスを表す文字列。String

戻り値

抽出されたJSON配列またはJSONオブジェクトを文字列として返します。値が存在しない場合は空文字列を返します。String

例

使用例

SELECT JSON_QUERY('{"hello":"world"}', '$.hello');
SELECT JSON_QUERY('{"array":[[0, 1, 2, 3, 4, 5], [0, -1, -2, -3, -4, -5]]}', '$.array[*][0 to 2, 4]');
SELECT JSON_QUERY('{"hello":2}', '$.hello');
SELECT toTypeName(JSON_QUERY('{"hello":2}', '$.hello'));

["world"]
[0, 1, 4, 0, -1, -4]
[2]
String

JSON_VALUE​

導入バージョン: v21.11

JSONを解析し、値をJSONスカラーとして抽出します。値が存在しない場合、デフォルトでは空文字列が返されます。

この関数は以下の設定によって制御されます:

  • function_json_value_return_type_allow_nullable = true を設定すると、NULL が返されます。値が複合型(struct、array、mapなど)の場合、デフォルトでは空文字列が返されます。
  • function_json_value_return_type_allow_complex = true を設定すると、複合値が返されます。

構文

JSON_VALUE(json, path)

引数

  • json — 有効なJSONを含む文字列。String
  • path — パスを表す文字列。String

戻り値

抽出されたJSONスカラーを文字列として返します。値が存在しない場合は空文字列を返します。String

例

使用例

SELECT JSON_VALUE('{"hello":"world"}', '$.hello');
SELECT JSON_VALUE('{"array":[[0, 1, 2, 3, 4, 5], [0, -1, -2, -3, -4, -5]]}', '$.array[*][0 to 2, 4]');
SELECT JSON_VALUE('{"hello":2}', '$.hello');
SELECT JSON_VALUE('{"hello":"world"}', '$.b') settings function_json_value_return_type_allow_nullable=true;

world
0
2
ᴺᵁᴸᴸ

dynamicElement​

導入バージョン: v24.1

Dynamicカラムから指定された型のカラムを抽出します。

この関数を使用すると、Dynamicカラムから特定の型の値を抽出できます。行が要求された型の値を含む場合、その値を返します。行が異なる型またはNULLを含む場合、スカラー型に対してはNULLを、配列型に対しては空の配列を返します。

構文

dynamicElement(dynamic, type_name)

引数

  • dynamic — 抽出元のDynamicカラム。Dynamic
  • type_name — 抽出するバリアント型の名前(例: 'String'、'Int64'、'Array(Int64)')。

戻り値

Dynamicカラムから指定された型の値を返します。一致しない型に対してはNULLを返します(配列型の場合は空の配列)。Any

例

Dynamicカラムから異なる型を抽出する

CREATE TABLE test (d Dynamic) ENGINE = Memory;
INSERT INTO test VALUES (NULL), (42), ('Hello, World!'), ([1, 2, 3]);
SELECT d, dynamicType(d), dynamicElement(d, 'String'), dynamicElement(d, 'Int64'), dynamicElement(d, 'Array(Int64)'), dynamicElement(d, 'Date'), dynamicElement(d, 'Array(String)') FROM test

┌─d─────────────┬─dynamicType(d)─┬─dynamicElement(d, 'String')─┬─dynamicElement(d, 'Int64')─┬─dynamicElement(d, 'Array(Int64)')─┬─dynamicElement(d, 'Date')─┬─dynamicElement(d, 'Array(String)')─┐
│ ᴺᵁᴸᴸ          │ None           │ ᴺᵁᴸᴸ                        │                       ᴺᵁᴸᴸ │ []                                │                      ᴺᵁᴸᴸ │ []                                 │
│ 42            │ Int64          │ ᴺᵁᴸᴸ                        │                         42 │ []                                │                      ᴺᵁᴸᴸ │ []                                 │
│ Hello, World! │ String         │ Hello, World!               │                       ᴺᵁᴸᴸ │ []                                │                      ᴺᵁᴸᴸ │ []                                 │
│ [1,2,3]       │ Array(Int64)   │ ᴺᵁᴸᴸ                        │                       ᴺᵁᴸᴸ │ [1,2,3]                           │                      ᴺᵁᴸᴸ │ []                                 │
└───────────────┴────────────────┴─────────────────────────────┴────────────────────────────┴───────────────────────────────────┴───────────────────────────┴────────────────────────────────────┘

dynamicType​

導入バージョン: v24.1

Dynamicカラムの各行のバリアント型名を返します。

NULLを含む行の場合、この関数は'None'を返します。その他すべての行については、Dynamicカラムのその行に格納されている実際のデータ型を返します（例: 'Int64'、'String'、'Array(Int64)'）。

構文

dynamicType(dynamic)

引数

  • dynamic — 検査対象のDynamicカラム。Dynamic

戻り値

各行に格納されている値の型名を返します。NULL値の場合は'None'を返します。String

例

Dynamicカラムの型の検査

CREATE TABLE test (d Dynamic) ENGINE = Memory;
INSERT INTO test VALUES (NULL), (42), ('Hello, World!'), ([1, 2, 3]);
SELECT d, dynamicType(d) FROM test;

┌─d─────────────┬─dynamicType(d)─┐
│ ᴺᵁᴸᴸ          │ None           │
│ 42            │ Int64          │
│ Hello, World! │ String         │
│ [1,2,3]       │ Array(Int64)   │
└───────────────┴────────────────┘

isDynamicElementInSharedData​

導入バージョン: v24.1

Dynamic列において、個別のサブカラムではなく共有バリアント形式で格納されている行に対してtrueを返します。

Dynamic列にmax_types制限がある場合、この制限を超える値は個別の型付きサブカラムに分離されず、共有バイナリ形式で格納されます。この関数は、どの行がこの共有形式で格納されているかを識別します。

構文

isDynamicElementInSharedData(dynamic)

引数

  • dynamic — 検査対象のDynamic列。Dynamic

戻り値

値が共有バリアント形式で格納されている場合はtrueを返し、個別のサブカラムとして格納されている場合またはNULLの場合はfalseを返します。Bool

例

max_types制限を持つDynamic列における格納形式の確認

CREATE TABLE test (d Dynamic(max_types=2)) ENGINE = Memory;
INSERT INTO test VALUES (NULL), (42), ('Hello, World!'), ([1, 2, 3]);
SELECT d, isDynamicElementInSharedData(d) FROM test;

┌─d─────────────┬─isDynamicElementInSharedData(d)─┐
│ ᴺᵁᴸᴸ          │ false                           │
│ 42            │ false                           │
│ Hello, World! │ true                            │
│ [1,2,3]       │ true                            │
└───────────────┴─────────────────────────────────┘

isValidJSON​

導入バージョン: v20.1

渡された文字列が有効なJSONであるかを検証します。

構文

isValidJSON(json)

引数

  • json — 検証するJSON文字列 String

戻り値

文字列が有効なJSONの場合は1を、それ以外の場合は0を返します。UInt8

例

使用例

SELECT isValidJSON('{"a": "hello", "b": [-100, 200.0, 300]}') = 1;
SELECT isValidJSON('not JSON') = 0;

1
0

整数を使用したJSON配列とJSONオブジェクトへのアクセス

SELECT JSONHas('{"a": "hello", "b": [-100, 200.0, 300]}', 0);
SELECT JSONHas('{"a": "hello", "b": [-100, 200.0, 300]}', 1);
SELECT JSONHas('{"a": "hello", "b": [-100, 200.0, 300]}', 2);
SELECT JSONHas('{"a": "hello", "b": [-100, 200.0, 300]}', -1);
SELECT JSONHas('{"a": "hello", "b": [-100, 200.0, 300]}', -2);
SELECT JSONHas('{"a": "hello", "b": [-100, 200.0, 300]}', 3);

0
1
1
1
1
1
0

simpleJSONExtractBool​

導入バージョン: v21.4

field_nameという名前のフィールドの値から真偽値を解析します。 結果はUInt8型です。

構文

simpleJSONExtractBool(json, field_name)

エイリアス: visitParamExtractBool

引数

  • json — フィールドを検索するJSON。String
  • field_name — 検索するフィールドの名前。const String

戻り値

フィールドの値がtrueの場合は1を返し、それ以外の場合は0を返します。つまり、この関数は以下の場合を含む(ただしこれらに限定されない)ときに0を返します:

  • フィールドが存在しない場合
  • フィールドが文字列としてtrueを含む場合(例: {"field":"true"})
  • フィールドが数値として1を含む場合 UInt8

例

使用例

CREATE TABLE jsons
(
    `json` String
)
ENGINE = MergeTree
ORDER BY tuple();

INSERT INTO jsons VALUES ('{"foo":false,"bar":true}');
INSERT INTO jsons VALUES ('{"foo":"true","qux":1}');

SELECT simpleJSONExtractBool(json, 'bar') FROM jsons ORDER BY json;
SELECT simpleJSONExtractBool(json, 'foo') FROM jsons ORDER BY json;

0
1
0
0

simpleJSONExtractFloat​

導入バージョン: v21.4

field_name という名前のフィールドの値から Float64 を解析します。 field_name が文字列フィールドの場合、文字列の先頭から数値の解析を試みます。 フィールドが存在しない場合、または存在しても数値が含まれていない場合は 0 を返します。

構文

simpleJSONExtractFloat(json, field_name)

エイリアス: visitParamExtractFloat

引数

  • json — フィールドを検索する対象のJSON。String
  • field_name — 検索するフィールドの名前。const String

戻り値

フィールドが存在し数値が含まれている場合は、フィールドから解析された数値を返します。それ以外の場合は 0 を返します。Float64

例

使用例

CREATE TABLE jsons
(
    `json` String
)
ENGINE = MergeTree
ORDER BY tuple();

INSERT INTO jsons VALUES ('{"foo":"-4e3"}');
INSERT INTO jsons VALUES ('{"foo":-3.4}');
INSERT INTO jsons VALUES ('{"foo":5}');
INSERT INTO jsons VALUES ('{"foo":"not1number"}');
INSERT INTO jsons VALUES ('{"baz":2}');

SELECT simpleJSONExtractFloat(json, 'foo') FROM jsons ORDER BY json;

0
-4000
0
-3.4
5

simpleJSONExtractInt​

導入バージョン: v21.4

field_nameという名前のフィールドの値からInt64を解析します。 field_nameが文字列フィールドの場合、文字列の先頭から数値の解析を試みます。 フィールドが存在しない場合、または存在しても数値が含まれていない場合は、0を返します。

構文

simpleJSONExtractInt(json, field_name)

エイリアス: visitParamExtractInt

引数

  • json — フィールドを検索するJSON。String
  • field_name — 検索するフィールドの名前。const String

戻り値

フィールドが存在し数値が含まれている場合はフィールドから解析された数値を返し、それ以外の場合は0を返します。Int64

例

使用例

CREATE TABLE jsons
(
    `json` String
)
ENGINE = MergeTree
ORDER BY tuple();

INSERT INTO jsons VALUES ('{"foo":"-4e3"}');
INSERT INTO jsons VALUES ('{"foo":-3.4}');
INSERT INTO jsons VALUES ('{"foo":5}');
INSERT INTO jsons VALUES ('{"foo":"not1number"}');
INSERT INTO jsons VALUES ('{"baz":2}');

SELECT simpleJSONExtractInt(json, 'foo') FROM jsons ORDER BY json;

0
-4
0
-3
5

simpleJSONExtractRaw​

導入バージョン: v21.4

field_nameという名前のフィールドの値を、区切り文字を含めてStringとして返します。

構文

simpleJSONExtractRaw(json, field_name)

エイリアス: visitParamExtractRaw

引数

  • json — フィールドを検索するJSON。String
  • field_name — 検索するフィールドの名前。const String

戻り値

フィールドが存在する場合は区切り文字を含めてフィールドの値を文字列として返し、存在しない場合は空文字列を返します。String

例

使用例

CREATE TABLE jsons
(
    `json` String
)
ENGINE = MergeTree
ORDER BY tuple();

INSERT INTO jsons VALUES ('{"foo":"-4e3"}');
INSERT INTO jsons VALUES ('{"foo":-3.4}');
INSERT INTO jsons VALUES ('{"foo":5}');
INSERT INTO jsons VALUES ('{"foo":{"def":[1,2,3]}}');
INSERT INTO jsons VALUES ('{"baz":2}');

SELECT simpleJSONExtractRaw(json, 'foo') FROM jsons ORDER BY json;

"-4e3"
-3.4
5
{"def":[1,2,3]}

simpleJSONExtractString​

導入バージョン: v21.4

field_nameという名前のフィールドの値から、ダブルクォートで囲まれたStringを解析します。

実装の詳細

現在、基本多言語面に含まれない\uXXXX\uYYYY形式のコードポイントはサポートされていません(UTF-8ではなくCESU-8に変換されます)。

構文

simpleJSONExtractString(json, field_name)

エイリアス: visitParamExtractString

引数

  • json — フィールドを検索するJSON。String
  • field_name — 検索するフィールドの名前。const String

戻り値

区切り文字を含む、フィールドのエスケープ解除された値を文字列として返します。フィールドにダブルクォートで囲まれた文字列が含まれていない場合、エスケープ解除に失敗した場合、またはフィールドが存在しない場合は、空の文字列が返されます。String

例

使用例

CREATE TABLE jsons
(
    `json` String
)
ENGINE = MergeTree
ORDER BY tuple();

INSERT INTO jsons VALUES ('{"foo":"\\n\\u0000"}');
INSERT INTO jsons VALUES ('{"foo":"\\u263"}');
INSERT INTO jsons VALUES ('{"foo":"\\u263a"}');
INSERT INTO jsons VALUES ('{"foo":"hello}');

SELECT simpleJSONExtractString(json, 'foo') FROM jsons ORDER BY json;

\n\0

☺

simpleJSONExtractUInt​

導入バージョン: v21.4

field_nameという名前のフィールドの値からUInt64を解析します。 field_nameが文字列フィールドの場合、文字列の先頭から数値の解析を試みます。 フィールドが存在しない場合、または存在しても数値が含まれていない場合は、0を返します。

構文

simpleJSONExtractUInt(json, field_name)

エイリアス: visitParamExtractUInt

引数

  • json — フィールドを検索するJSON。String
  • field_name — 検索するフィールドの名前。const String

戻り値

フィールドが存在し数値が含まれている場合はフィールドから解析された数値を返し、それ以外の場合は0を返します。UInt64

例

使用例

CREATE TABLE jsons
(
    `json` String
)
ENGINE = MergeTree
ORDER BY tuple();

INSERT INTO jsons VALUES ('{"foo":"4e3"}');
INSERT INTO jsons VALUES ('{"foo":3.4}');
INSERT INTO jsons VALUES ('{"foo":5}');
INSERT INTO jsons VALUES ('{"foo":"not1number"}');
INSERT INTO jsons VALUES ('{"baz":2}');

SELECT simpleJSONExtractUInt(json, 'foo') FROM jsons ORDER BY json;

0
4
0
3
5

simpleJSONHas​

導入バージョン: v21.4

field_nameという名前のフィールドが存在するかどうかをチェックします。

構文

simpleJSONHas(json, field_name)

エイリアス: visitParamHas

引数

  • json — フィールドを検索するJSON。String
  • field_name — 検索するフィールドの名前。const String

返り値

フィールドが存在する場合は1を、存在しない場合は0を返します。UInt8

例

使用例

CREATE TABLE jsons
(
    `json` String
)
ENGINE = MergeTree
ORDER BY tuple();

INSERT INTO jsons VALUES ('{"foo":"true","qux":1}');

SELECT simpleJSONHas(json, 'foo') FROM jsons;
SELECT simpleJSONHas(json, 'bar') FROM jsons;

1
0

toJSONString​

導入バージョン: v21.7

値をJSON表現にシリアライズします。さまざまなデータ型とネストされた構造に対応しています。 64ビット整数以上(例: UInt64やInt128)は、デフォルトで引用符で囲まれます。この動作はoutput_format_json_quote_64bit_integersで制御できます。 特殊値NaNとinfはnullに置き換えられます。これらを表示するには、output_format_json_quote_denormals設定を有効にしてください。 Enum値をシリアライズする際、この関数はその名前を出力します。

関連項目:

構文

toJSONString(value)

引数

  • value — シリアライズする値。任意のデータ型を指定できます。Any

戻り値

値のJSON表現を返します。String

例

Mapのシリアライズ

SELECT toJSONString(map('key1', 1, 'key2', 2));

┌─toJSONString(map('key1', 1, 'key2', 2))─┐
│ {"key1":1,"key2":2}                     │
└─────────────────────────────────────────┘

特殊値

SELECT toJSONString(tuple(1.25, NULL, NaN, +inf, -inf, [])) SETTINGS output_format_json_quote_denormals = 1;

┌─toJSONString(tuple(1.25, NULL, NaN, plus(inf), minus(inf), []))─┐
│ [1.25,null,"nan","inf","-inf",[]]                               │
└─────────────────────────────────────────────────────────────────┘