2020-04-03 13:23:32 +00:00
---
2022-08-28 14:53:34 +00:00
slug: /en/sql-reference/functions/json-functions
2023-04-19 17:05:55 +00:00
sidebar_position: 105
2022-04-09 13:29:05 +00:00
sidebar_label: JSON
2020-04-03 13:23:32 +00:00
---
2023-10-25 15:08:27 +00:00
There are two sets of functions to parse JSON.
2024-03-05 16:55:08 +00:00
- `simpleJSON*` (`visitParam*`) is made to parse a special very limited subset of a JSON, but these functions are extremely fast.
2023-02-14 14:35:25 +00:00
- `JSONExtract*` is made to parse normal JSON.
2024-03-05 16:55:08 +00:00
# simpleJSON/visitParam functions
2023-02-14 14:35:25 +00:00
ClickHouse has special functions for working with simplified JSON. All these JSON functions are based on strong assumptions about what the JSON can be, but they try to do as little as possible to get the job done.
2022-04-09 13:29:05 +00:00
The following assumptions are made:
2017-12-28 15:13:23 +00:00
2020-03-20 10:10:48 +00:00
1. The field name (function argument) must be a constant.
2024-03-05 16:55:08 +00:00
2. The field name is somehow canonically encoded in JSON. For example: `simpleJSONHas('{"abc":"def"}', 'abc') = 1` , but `simpleJSONHas('{"\\u0061\\u0062\\u0063":"def"}', 'abc') = 0`
2020-03-20 10:10:48 +00:00
3. Fields are searched for on any nesting level, indiscriminately. If there are multiple matching fields, the first occurrence is used.
2021-05-27 19:44:11 +00:00
4. The JSON does not have space characters outside of string literals.
2017-12-28 15:13:23 +00:00
2024-03-05 16:55:08 +00:00
## simpleJSONHas
2017-12-28 15:13:23 +00:00
2024-03-05 16:55:08 +00:00
Checks whether there is a field named `field_name` . The result is `UInt8` .
2021-04-17 17:04:32 +00:00
2024-03-05 16:55:08 +00:00
**Syntax**
2017-12-28 15:13:23 +00:00
2024-03-05 16:55:08 +00:00
```sql
simpleJSONHas(json, field_name)
```
**Parameters**
2017-12-28 15:13:23 +00:00
2024-05-24 03:54:16 +00:00
- `json` : The JSON in which the field is searched for. [String ](../data-types/string.md#string )
2024-03-05 16:55:08 +00:00
- `field_name` : The name of the field to search for. [String literal ](../syntax#string )
2021-04-17 17:04:32 +00:00
2024-03-05 16:55:08 +00:00
**Returned value**
2017-12-28 15:13:23 +00:00
2024-03-05 16:55:08 +00:00
It returns `1` if the field exists, `0` otherwise.
2017-12-28 15:13:23 +00:00
2024-03-05 16:55:08 +00:00
**Example**
2017-12-28 15:13:23 +00:00
2024-03-05 16:55:08 +00:00
Query:
2021-04-17 17:04:32 +00:00
2024-03-05 16:55:08 +00:00
```sql
CREATE TABLE jsons
(
`json` String
)
ENGINE = Memory;
2017-12-28 15:13:23 +00:00
2024-03-05 16:55:08 +00:00
INSERT INTO jsons VALUES ('{"foo":"true","qux":1}');
SELECT simpleJSONHas(json, 'foo') FROM jsons;
SELECT simpleJSONHas(json, 'bar') FROM jsons;
```
2017-12-28 15:13:23 +00:00
2024-03-05 16:55:08 +00:00
```response
1
0
```
## simpleJSONExtractUInt
2021-04-17 17:04:32 +00:00
2024-03-05 16:55:08 +00:00
Parses `UInt64` from the value of the field named `field_name` . If this is a string field, it tries to parse a number from the beginning of the string. If the field does not exist, or it exists but does not contain a number, it returns `0` .
2017-12-28 15:13:23 +00:00
2024-03-05 16:55:08 +00:00
**Syntax**
2017-12-28 15:13:23 +00:00
2024-03-05 16:55:08 +00:00
```sql
simpleJSONExtractUInt(json, field_name)
```
2021-04-17 17:04:32 +00:00
2024-03-05 16:55:08 +00:00
**Parameters**
2017-12-28 15:13:23 +00:00
2024-05-24 03:54:16 +00:00
- `json` : The JSON in which the field is searched for. [String ](../data-types/string.md#string )
2024-03-05 16:55:08 +00:00
- `field_name` : The name of the field to search for. [String literal ](../syntax#string )
2017-12-28 15:13:23 +00:00
2024-03-05 16:55:08 +00:00
**Returned value**
2021-04-17 17:04:32 +00:00
2024-03-05 16:55:08 +00:00
It returns the number parsed from the field if the field exists and contains a number, `0` otherwise.
2017-12-28 15:13:23 +00:00
2024-03-05 16:55:08 +00:00
**Example**
Query:
```sql
CREATE TABLE jsons
(
`json` String
)
ENGINE = Memory;
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;
2017-12-28 15:13:23 +00:00
```
2024-03-05 16:55:08 +00:00
```response
0
4
0
3
5
```
2017-12-28 15:13:23 +00:00
2024-03-05 16:55:08 +00:00
## simpleJSONExtractInt
2017-12-28 15:13:23 +00:00
2024-03-05 16:55:08 +00:00
Parses `Int64` from the value of the field named `field_name` . If this is a string field, it tries to parse a number from the beginning of the string. If the field does not exist, or it exists but does not contain a number, it returns `0` .
2021-04-17 17:04:32 +00:00
2024-03-05 16:55:08 +00:00
**Syntax**
2017-12-28 15:13:23 +00:00
2024-03-05 16:55:08 +00:00
```sql
simpleJSONExtractInt(json, field_name)
2017-12-28 15:13:23 +00:00
```
2024-03-05 16:55:08 +00:00
**Parameters**
2024-05-24 03:54:16 +00:00
- `json` : The JSON in which the field is searched for. [String ](../data-types/string.md#string )
2024-03-05 16:55:08 +00:00
- `field_name` : The name of the field to search for. [String literal ](../syntax#string )
**Returned value**
It returns the number parsed from the field if the field exists and contains a number, `0` otherwise.
**Example**
Query:
```sql
CREATE TABLE jsons
(
`json` String
)
ENGINE = Memory;
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;
```
```response
0
-4
0
-3
5
```
## simpleJSONExtractFloat
Parses `Float64` from the value of the field named `field_name` . If this is a string field, it tries to parse a number from the beginning of the string. If the field does not exist, or it exists but does not contain a number, it returns `0` .
**Syntax**
```sql
simpleJSONExtractFloat(json, field_name)
```
**Parameters**
2024-05-24 03:54:16 +00:00
- `json` : The JSON in which the field is searched for. [String ](../data-types/string.md#string )
2024-03-05 16:55:08 +00:00
- `field_name` : The name of the field to search for. [String literal ](../syntax#string )
**Returned value**
It returns the number parsed from the field if the field exists and contains a number, `0` otherwise.
**Example**
Query:
```sql
CREATE TABLE jsons
(
`json` String
)
ENGINE = Memory;
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;
```
```response
0
-4000
0
-3.4
5
```
## simpleJSONExtractBool
Parses a true/false value from the value of the field named `field_name` . The result is `UInt8` .
**Syntax**
```sql
simpleJSONExtractBool(json, field_name)
```
**Parameters**
2024-05-24 03:54:16 +00:00
- `json` : The JSON in which the field is searched for. [String ](../data-types/string.md#string )
2024-03-05 16:55:08 +00:00
- `field_name` : The name of the field to search for. [String literal ](../syntax#string )
**Returned value**
It returns `1` if the value of the field is `true` , `0` otherwise. This means this function will return `0` including (and not only) in the following cases:
- If the field doesn't exists.
- If the field contains `true` as a string, e.g.: `{"field":"true"}` .
- If the field contains `1` as a numerical value.
**Example**
Query:
```sql
CREATE TABLE jsons
(
`json` String
)
ENGINE = Memory;
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;
```
```response
0
1
0
0
```
## simpleJSONExtractRaw
Returns the value of the field named `field_name` as a `String` , including separators.
**Syntax**
```sql
simpleJSONExtractRaw(json, field_name)
```
**Parameters**
2024-05-24 03:54:16 +00:00
- `json` : The JSON in which the field is searched for. [String ](../data-types/string.md#string )
2024-03-05 16:55:08 +00:00
- `field_name` : The name of the field to search for. [String literal ](../syntax#string )
**Returned value**
2024-05-24 03:54:16 +00:00
It returns the value of the field as a [`String` ](../data-types/string.md#string ), including separators if the field exists, or an empty `String` otherwise.
2024-03-05 16:55:08 +00:00
**Example**
Query:
```sql
CREATE TABLE jsons
(
`json` String
)
ENGINE = Memory;
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;
```
```response
"-4e3"
-3.4
5
{"def":[1,2,3]}
```
## simpleJSONExtractString
Parses `String` in double quotes from the value of the field named `field_name` .
**Syntax**
```sql
simpleJSONExtractString(json, field_name)
```
**Parameters**
2024-05-24 03:54:16 +00:00
- `json` : The JSON in which the field is searched for. [String ](../data-types/string.md#string )
2024-03-05 16:55:08 +00:00
- `field_name` : The name of the field to search for. [String literal ](../syntax#string )
**Returned value**
2024-05-24 03:54:16 +00:00
It returns the value of a field as a [`String` ](../data-types/string.md#string ), including separators. The value is unescaped. It returns an empty `String` : if the field doesn't contain a double quoted string, if unescaping fails or if the field doesn't exist.
2024-03-05 16:55:08 +00:00
**Implementation details**
2017-12-28 15:13:23 +00:00
There is currently no support for code points in the format `\uXXXX\uYYYY` that are not from the basic multilingual plane (they are converted to CESU-8 instead of UTF-8).
2024-03-05 16:55:08 +00:00
**Example**
Query:
```sql
CREATE TABLE jsons
(
`json` String
)
ENGINE = Memory;
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;
```
```response
\n\0
☺
```
## visitParamHas
This function is [an alias of `simpleJSONHas` ](./json-functions#simplejsonhas ).
## visitParamExtractUInt
This function is [an alias of `simpleJSONExtractUInt` ](./json-functions#simplejsonextractuint ).
## visitParamExtractInt
This function is [an alias of `simpleJSONExtractInt` ](./json-functions#simplejsonextractint ).
## visitParamExtractFloat
This function is [an alias of `simpleJSONExtractFloat` ](./json-functions#simplejsonextractfloat ).
## visitParamExtractBool
This function is [an alias of `simpleJSONExtractBool` ](./json-functions#simplejsonextractbool ).
## visitParamExtractRaw
This function is [an alias of `simpleJSONExtractRaw` ](./json-functions#simplejsonextractraw ).
## visitParamExtractString
This function is [an alias of `simpleJSONExtractString` ](./json-functions#simplejsonextractstring ).
2023-02-14 14:35:25 +00:00
# JSONExtract functions
2023-02-14 14:50:03 +00:00
The following functions are based on [simdjson ](https://github.com/lemire/simdjson ) designed for more complex JSON parsing requirements.
2023-02-14 14:45:45 +00:00
2022-06-02 10:55:18 +00:00
## isValidJSON(json)
2019-10-12 12:00:46 +00:00
Checks that passed string is a valid json.
Examples:
2020-03-20 10:10:48 +00:00
``` sql
2019-10-12 12:00:46 +00:00
SELECT isValidJSON('{"a": "hello", "b": [-100, 200.0, 300]}') = 1
SELECT isValidJSON('not a json') = 0
```
2024-05-23 11:54:45 +00:00
## JSONHas(json\[, indices_or_keys\]...)
2019-04-24 04:23:14 +00:00
If the value exists in the JSON document, `1` will be returned.
2019-05-16 13:35:31 +00:00
If the value does not exist, `0` will be returned.
2019-04-24 04:23:14 +00:00
Examples:
2020-03-20 10:10:48 +00:00
``` sql
2019-09-23 15:31:46 +00:00
SELECT JSONHas('{"a": "hello", "b": [-100, 200.0, 300]}', 'b') = 1
SELECT JSONHas('{"a": "hello", "b": [-100, 200.0, 300]}', 'b', 4) = 0
2019-04-24 04:23:14 +00:00
```
2019-05-16 13:35:31 +00:00
`indices_or_keys` is a list of zero or more arguments each of them can be either string or integer.
2019-04-24 04:23:14 +00:00
2023-04-19 15:55:29 +00:00
- String = access object member by key.
- Positive integer = access the n-th member/key from the beginning.
- Negative integer = access the n-th member/key from the end.
2019-04-24 04:23:14 +00:00
2021-05-27 19:44:11 +00:00
Minimum index of the element is 1. Thus the element 0 does not exist.
2019-06-14 12:44:33 +00:00
2019-05-10 08:49:03 +00:00
You may use integers to access both JSON arrays and JSON objects.
2019-04-24 04:23:14 +00:00
So, for example:
2020-03-20 10:10:48 +00:00
``` sql
2019-09-23 15:31:46 +00:00
SELECT JSONExtractKey('{"a": "hello", "b": [-100, 200.0, 300]}', 1) = 'a'
SELECT JSONExtractKey('{"a": "hello", "b": [-100, 200.0, 300]}', 2) = 'b'
SELECT JSONExtractKey('{"a": "hello", "b": [-100, 200.0, 300]}', -1) = 'b'
SELECT JSONExtractKey('{"a": "hello", "b": [-100, 200.0, 300]}', -2) = 'a'
SELECT JSONExtractString('{"a": "hello", "b": [-100, 200.0, 300]}', 1) = 'hello'
2019-04-24 04:23:14 +00:00
```
2024-05-23 11:54:45 +00:00
## JSONLength(json\[, indices_or_keys\]...)
2019-04-24 04:23:14 +00:00
2019-05-10 08:49:03 +00:00
Return the length of a JSON array or a JSON object.
2019-04-24 04:23:14 +00:00
2019-05-16 13:35:31 +00:00
If the value does not exist or has a wrong type, `0` will be returned.
2019-04-24 04:23:14 +00:00
Examples:
2020-03-20 10:10:48 +00:00
``` sql
2019-09-23 15:31:46 +00:00
SELECT JSONLength('{"a": "hello", "b": [-100, 200.0, 300]}', 'b') = 3
SELECT JSONLength('{"a": "hello", "b": [-100, 200.0, 300]}') = 2
2019-04-24 04:23:14 +00:00
```
2024-05-23 11:54:45 +00:00
## JSONType(json\[, indices_or_keys\]...)
2019-04-24 04:23:14 +00:00
Return the type of a JSON value.
2019-05-16 13:35:31 +00:00
If the value does not exist, `Null` will be returned.
2019-04-24 04:23:14 +00:00
Examples:
2020-03-20 10:10:48 +00:00
``` sql
2019-09-23 15:31:46 +00:00
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'
2019-04-24 04:23:14 +00:00
```
2024-05-23 11:54:45 +00:00
## JSONExtractUInt(json\[, indices_or_keys\]...)
2020-03-20 10:10:48 +00:00
2024-05-23 11:54:45 +00:00
## JSONExtractInt(json\[, indices_or_keys\]...)
2020-03-20 10:10:48 +00:00
2024-05-23 11:54:45 +00:00
## JSONExtractFloat(json\[, indices_or_keys\]...)
2020-03-20 10:10:48 +00:00
2024-05-23 11:54:45 +00:00
## JSONExtractBool(json\[, indices_or_keys\]...)
2019-04-24 04:23:14 +00:00
2019-05-16 13:35:31 +00:00
Parses a JSON and extract a value. These functions are similar to `visitParam` functions.
2019-04-24 04:23:14 +00:00
2019-05-16 13:35:31 +00:00
If the value does not exist or has a wrong type, `0` will be returned.
2019-04-24 04:23:14 +00:00
Examples:
2020-03-20 10:10:48 +00:00
``` sql
2019-09-23 15:31:46 +00:00
SELECT JSONExtractInt('{"a": "hello", "b": [-100, 200.0, 300]}', 'b', 1) = -100
SELECT JSONExtractFloat('{"a": "hello", "b": [-100, 200.0, 300]}', 'b', 2) = 200.0
SELECT JSONExtractUInt('{"a": "hello", "b": [-100, 200.0, 300]}', 'b', -1) = 300
2019-04-24 04:23:14 +00:00
```
2024-05-23 11:54:45 +00:00
## JSONExtractString(json\[, indices_or_keys\]...)
2019-04-24 04:23:14 +00:00
2019-05-16 13:35:31 +00:00
Parses a JSON and extract a string. This function is similar to `visitParamExtractString` functions.
2019-04-24 04:23:14 +00:00
2019-05-16 13:35:31 +00:00
If the value does not exist or has a wrong type, an empty string will be returned.
2019-04-24 04:23:14 +00:00
2019-05-16 13:35:31 +00:00
The value is unescaped. If unescaping failed, it returns an empty string.
2019-04-24 04:23:14 +00:00
Examples:
2020-03-20 10:10:48 +00:00
``` sql
2019-09-23 15:31:46 +00:00
SELECT JSONExtractString('{"a": "hello", "b": [-100, 200.0, 300]}', 'a') = 'hello'
SELECT JSONExtractString('{"abc":"\\n\\u0000"}', 'abc') = '\n\0'
SELECT JSONExtractString('{"abc":"\\u263a"}', 'abc') = '☺'
SELECT JSONExtractString('{"abc":"\\u263"}', 'abc') = ''
SELECT JSONExtractString('{"abc":"hello}', 'abc') = ''
2019-04-24 04:23:14 +00:00
```
2024-05-23 11:54:45 +00:00
## JSONExtract(json\[, indices_or_keys...\], Return_type)
2019-05-13 13:46:19 +00:00
2019-05-16 13:35:31 +00:00
Parses a JSON and extract a value of the given ClickHouse data type.
2019-05-13 13:46:19 +00:00
2019-05-16 13:35:31 +00:00
This is a generalization of the previous `JSONExtract<type>` functions.
This means
`JSONExtract(..., 'String')` returns exactly the same as `JSONExtractString()` ,
`JSONExtract(..., 'Float64')` returns exactly the same as `JSONExtractFloat()` .
2019-05-13 13:46:19 +00:00
Examples:
2020-03-20 10:10:48 +00:00
``` sql
2019-05-16 13:35:31 +00:00
SELECT JSONExtract('{"a": "hello", "b": [-100, 200.0, 300]}', 'Tuple(String, Array(Float64))') = ('hello',[-100,200,300])
SELECT JSONExtract('{"a": "hello", "b": [-100, 200.0, 300]}', 'Tuple(b Array(Float64), a String)') = ([-100,200,300],'hello')
2023-04-12 02:18:07 +00:00
SELECT JSONExtract('{"a": "hello", "b": "world"}', 'Map(String, String)') = map('a', 'hello', 'b', 'world');
2019-05-16 13:35:31 +00:00
SELECT JSONExtract('{"a": "hello", "b": [-100, 200.0, 300]}', 'b', 'Array(Nullable(Int8))') = [-100, NULL, NULL]
SELECT JSONExtract('{"a": "hello", "b": [-100, 200.0, 300]}', 'b', 4, 'Nullable(Int64)') = NULL
SELECT JSONExtract('{"passed": true}', 'passed', 'UInt8') = 1
SELECT JSONExtract('{"day": "Thursday"}', 'day', 'Enum8(\'Sunday\' = 0, \'Monday\' = 1, \'Tuesday\' = 2, \'Wednesday\' = 3, \'Thursday\' = 4, \'Friday\' = 5, \'Saturday\' = 6)') = 'Thursday'
SELECT JSONExtract('{"day": 5}', 'day', 'Enum8(\'Sunday\' = 0, \'Monday\' = 1, \'Tuesday\' = 2, \'Wednesday\' = 3, \'Thursday\' = 4, \'Friday\' = 5, \'Saturday\' = 6)') = 'Friday'
```
2024-05-23 11:54:45 +00:00
## JSONExtractKeysAndValues(json\[, indices_or_keys...\], Value_type)
2019-05-16 13:35:31 +00:00
2020-04-20 10:08:39 +00:00
Parses key-value pairs from a JSON where the values are of the given ClickHouse data type.
2019-05-16 13:35:31 +00:00
Example:
2020-03-20 10:10:48 +00:00
``` sql
2021-03-13 18:18:45 +00:00
SELECT JSONExtractKeysAndValues('{"x": {"a": 5, "b": 7, "c": 11}}', 'x', 'Int8') = [('a',5),('b',7),('c',11)];
2019-05-13 13:46:19 +00:00
```
2022-06-02 10:55:18 +00:00
## JSONExtractKeys
2021-11-02 17:01:49 +00:00
2021-11-06 20:58:06 +00:00
Parses a JSON string and extracts the keys.
2021-11-02 17:01:49 +00:00
**Syntax**
``` sql
2021-11-06 20:58:15 +00:00
JSONExtractKeys(json[, a, b, c...])
2021-11-02 17:01:49 +00:00
```
**Arguments**
2024-05-24 03:54:16 +00:00
- `json` — [String ](../data-types/string.md ) with valid JSON.
- `a, b, c...` — Comma-separated indices or keys that specify the path to the inner field in a nested JSON object. Each argument can be either a [String ](../data-types/string.md ) to get the field by the key or an [Integer ](../data-types/int-uint.md ) to get the N-th field (indexed from 1, negative integers count from the end). If not set, the whole JSON is parsed as the top-level object. Optional parameter.
2021-11-02 17:01:49 +00:00
**Returned value**
2024-05-24 03:54:16 +00:00
Array with the keys of the JSON. [Array ](../data-types/array.md )([String](../data-types/string.md)).
2021-11-02 17:01:49 +00:00
**Example**
Query:
```sql
SELECT JSONExtractKeys('{"a": "hello", "b": [-100, 200.0, 300]}');
```
Result:
```
text
┌─JSONExtractKeys('{"a": "hello", "b": [-100, 200.0, 300]}')─┐
│ ['a','b'] │
└────────────────────────────────────────────────────────────┘
```
2024-05-23 11:54:45 +00:00
## JSONExtractRaw(json\[, indices_or_keys\]...)
2019-05-16 13:35:31 +00:00
2020-04-20 10:08:39 +00:00
Returns a part of JSON as unparsed string.
2019-05-16 13:35:31 +00:00
If the part does not exist or has a wrong type, an empty string will be returned.
Example:
2020-03-20 10:10:48 +00:00
``` sql
2021-03-13 18:18:45 +00:00
SELECT JSONExtractRaw('{"a": "hello", "b": [-100, 200.0, 300]}', 'b') = '[-100, 200.0, 300]';
2019-05-16 13:35:31 +00:00
```
2019-06-05 10:04:00 +00:00
2024-05-23 11:54:45 +00:00
## JSONExtractArrayRaw(json\[, indices_or_keys...\])
2019-12-08 14:49:26 +00:00
2019-12-08 20:50:00 +00:00
Returns an array with elements of JSON array, each represented as unparsed string.
2019-12-08 14:49:26 +00:00
2020-03-20 10:10:48 +00:00
If the part does not exist or isn’ t array, an empty array will be returned.
2019-12-08 14:49:26 +00:00
Example:
2020-03-20 10:10:48 +00:00
``` sql
2021-11-25 21:20:37 +00:00
SELECT JSONExtractArrayRaw('{"a": "hello", "b": [-100, 200.0, "hello"]}', 'b') = ['-100', '200.0', '"hello"'];
2019-12-08 14:49:26 +00:00
```
2022-06-02 10:55:18 +00:00
## JSONExtractKeysAndValuesRaw
2020-04-20 10:08:39 +00:00
2020-05-07 18:38:27 +00:00
Extracts raw data from a JSON object.
2020-04-20 10:08:39 +00:00
2020-05-07 18:38:27 +00:00
**Syntax**
2020-04-20 10:08:39 +00:00
2020-05-07 18:38:27 +00:00
``` sql
JSONExtractKeysAndValuesRaw(json[, p, a, t, h])
```
2021-02-15 21:22:10 +00:00
**Arguments**
2020-05-07 18:38:27 +00:00
2024-05-24 03:54:16 +00:00
- `json` — [String ](../data-types/string.md ) with valid JSON.
- `p, a, t, h` — Comma-separated indices or keys that specify the path to the inner field in a nested JSON object. Each argument can be either a [string ](../data-types/string.md ) to get the field by the key or an [integer ](../data-types/int-uint.md ) to get the N-th field (indexed from 1, negative integers count from the end). If not set, the whole JSON is parsed as the top-level object. Optional parameter.
2020-05-07 18:38:27 +00:00
**Returned values**
2024-05-24 03:54:16 +00:00
- Array with `('key', 'value')` tuples. Both tuple members are strings. [Array ](../data-types/array.md )([Tuple](../data-types/tuple.md)([String](../data-types/string.md), [String ](../data-types/string.md )).
- Empty array if the requested object does not exist, or input JSON is invalid. [Array ](../data-types/array.md )([Tuple](../data-types/tuple.md)([String](../data-types/string.md), [String ](../data-types/string.md )).
2020-05-07 18:38:27 +00:00
**Examples**
Query:
2020-04-20 10:08:39 +00:00
``` sql
2021-03-13 18:18:45 +00:00
SELECT JSONExtractKeysAndValuesRaw('{"a": [-100, 200.0], "b":{"c": {"d": "hello", "f": "world"}}}');
2020-05-07 18:38:27 +00:00
```
Result:
``` text
┌─JSONExtractKeysAndValuesRaw('{"a": [-100, 200.0], "b":{"c": {"d": "hello", "f": "world"}}}')─┐
│ [('a','[-100,200]'),('b','{"c":{"d":"hello","f":"world"}}')] │
└──────────────────────────────────────────────────────────────────────────────────────────────┘
2020-04-20 10:08:39 +00:00
```
2020-05-07 18:38:27 +00:00
Query:
``` sql
2021-03-13 18:18:45 +00:00
SELECT JSONExtractKeysAndValuesRaw('{"a": [-100, 200.0], "b":{"c": {"d": "hello", "f": "world"}}}', 'b');
2020-05-07 18:38:27 +00:00
```
Result:
``` text
┌─JSONExtractKeysAndValuesRaw('{"a": [-100, 200.0], "b":{"c": {"d": "hello", "f": "world"}}}', 'b')─┐
│ [('c','{"d":"hello","f":"world"}')] │
└───────────────────────────────────────────────────────────────────────────────────────────────────┘
```
Query:
``` sql
2021-03-13 18:18:45 +00:00
SELECT JSONExtractKeysAndValuesRaw('{"a": [-100, 200.0], "b":{"c": {"d": "hello", "f": "world"}}}', -1, 'c');
2020-05-07 18:38:27 +00:00
```
Result:
``` text
┌─JSONExtractKeysAndValuesRaw('{"a": [-100, 200.0], "b":{"c": {"d": "hello", "f": "world"}}}', -1, 'c')─┐
│ [('d','"hello"'),('f','"world"')] │
└───────────────────────────────────────────────────────────────────────────────────────────────────────┘
```
2022-06-02 10:55:18 +00:00
## JSON_EXISTS(json, path)
2021-10-21 13:39:10 +00:00
If the value exists in the JSON document, `1` will be returned.
If the value does not exist, `0` will be returned.
Examples:
``` sql
2021-10-23 16:04:29 +00:00
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]');
2021-10-21 13:39:10 +00:00
```
2023-10-25 15:08:27 +00:00
:::note
2022-04-09 13:29:05 +00:00
Before version 21.11 the order of arguments was wrong, i.e. JSON_EXISTS(path, json)
:::
2021-10-21 13:39:10 +00:00
2022-06-02 10:55:18 +00:00
## JSON_QUERY(json, path)
2021-10-21 13:39:10 +00:00
2021-10-23 16:04:29 +00:00
Parses a JSON and extract a value as JSON array or JSON object.
2021-10-21 13:39:10 +00:00
If the value does not exist, an empty string will be returned.
Example:
``` sql
2021-10-23 16:04:29 +00:00
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'));
2021-10-21 13:39:10 +00:00
```
Result:
``` text
["world"]
[0, 1, 4, 0, -1, -4]
[2]
String
```
2023-10-25 15:08:27 +00:00
:::note
2022-04-09 13:29:05 +00:00
Before version 21.11 the order of arguments was wrong, i.e. JSON_QUERY(path, json)
:::
2021-10-21 13:39:10 +00:00
2022-06-02 10:55:18 +00:00
## JSON_VALUE(json, path)
2021-10-21 13:39:10 +00:00
2021-10-23 16:04:29 +00:00
Parses a JSON and extract a value as JSON scalar.
2021-10-21 13:39:10 +00:00
2023-10-26 17:26:18 +00:00
If the value does not exist, an empty string will be returned by default, and by SET `function_json_value_return_type_allow_nullable` = `true` , `NULL` will be returned. If the value is complex type (such as: struct, array, map), an empty string will be returned by default, and by SET `function_json_value_return_type_allow_complex` = `true` , the complex value will be returned.
2021-10-21 13:39:10 +00:00
Example:
``` sql
2021-10-23 16:04:29 +00:00
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 toTypeName(JSON_VALUE('{"hello":2}', '$.hello'));
2023-10-26 17:26:18 +00:00
select JSON_VALUE('{"hello":"world"}', '$.b') settings function_json_value_return_type_allow_nullable=true;
2023-03-25 13:54:45 +00:00
select JSON_VALUE('{"hello":{"world":"!"}}', '$.hello') settings function_json_value_return_type_allow_complex=true;
2021-10-21 13:39:10 +00:00
```
Result:
``` text
2022-04-15 11:03:59 +00:00
world
2021-10-21 13:39:10 +00:00
0
2
String
```
2023-10-25 15:08:27 +00:00
:::note
2022-04-09 13:29:05 +00:00
Before version 21.11 the order of arguments was wrong, i.e. JSON_VALUE(path, json)
:::
2021-10-21 13:39:10 +00:00
2022-06-02 10:55:18 +00:00
## toJSONString
2021-07-01 20:57:01 +00:00
2021-07-06 21:01:45 +00:00
Serializes a value to its JSON representation. Various data types and nested structures are supported.
2024-05-24 03:54:16 +00:00
64-bit [integers ](../data-types/int-uint.md ) or bigger (like `UInt64` or `Int128` ) are enclosed in quotes by default. [output_format_json_quote_64bit_integers ](../../operations/settings/settings.md#session_settings-output_format_json_quote_64bit_integers ) controls this behavior.
2021-07-10 07:01:34 +00:00
Special values `NaN` and `inf` are replaced with `null` . Enable [output_format_json_quote_denormals ](../../operations/settings/settings.md#settings-output_format_json_quote_denormals ) setting to show them.
2024-05-24 03:54:16 +00:00
When serializing an [Enum ](../data-types/enum.md ) value, the function outputs its name.
2021-07-01 20:57:01 +00:00
**Syntax**
``` sql
toJSONString(value)
```
**Arguments**
2023-04-19 15:55:29 +00:00
- `value` — Value to serialize. Value may be of any data type.
2021-07-01 20:57:01 +00:00
**Returned value**
2024-05-24 03:54:16 +00:00
- JSON representation of the value. [String ](../data-types/string.md ).
2021-07-01 20:57:01 +00:00
**Example**
2024-05-24 03:54:16 +00:00
The first example shows serialization of a [Map ](../data-types/map.md ).
The second example shows some special values wrapped into a [Tuple ](../data-types/tuple.md ).
2021-07-06 20:49:14 +00:00
2021-07-01 20:57:01 +00:00
Query:
``` sql
2021-07-06 20:49:14 +00:00
SELECT toJSONString(map('key1', 1, 'key2', 2));
2021-07-10 07:01:34 +00:00
SELECT toJSONString(tuple(1.25, NULL, NaN, +inf, -inf, [])) SETTINGS output_format_json_quote_denormals = 1;
2021-07-01 20:57:01 +00:00
```
Result:
``` text
2021-07-06 20:49:14 +00:00
{"key1":1,"key2":2}
2021-07-10 07:01:34 +00:00
[1.25,null,"nan","inf","-inf",[]]
2021-07-01 20:57:01 +00:00
```
2021-07-08 20:18:56 +00:00
**See Also**
2023-04-19 15:55:29 +00:00
- [output_format_json_quote_64bit_integers ](../../operations/settings/settings.md#session_settings-output_format_json_quote_64bit_integers )
- [output_format_json_quote_denormals ](../../operations/settings/settings.md#settings-output_format_json_quote_denormals )
2023-02-21 03:17:44 +00:00
## JSONArrayLength
Returns the number of elements in the outermost JSON array. The function returns NULL if input JSON string is invalid.
**Syntax**
``` sql
JSONArrayLength(json)
```
Alias: `JSON_ARRAY_LENGTH(json)` .
**Arguments**
2024-05-24 03:54:16 +00:00
- `json` — [String ](../data-types/string.md ) with valid JSON.
2023-02-21 03:17:44 +00:00
**Returned value**
2024-05-24 03:54:16 +00:00
- If `json` is a valid JSON array string, returns the number of array elements, otherwise returns NULL. [Nullable(UInt64) ](../data-types/int-uint.md ).
2023-02-21 03:17:44 +00:00
**Example**
``` sql
SELECT
JSONArrayLength(''),
JSONArrayLength('[1,2,3]')
┌─JSONArrayLength('')─┬─JSONArrayLength('[1,2,3]')─┐
│ ᴺᵁᴸᴸ │ 3 │
└─────────────────────┴────────────────────────────┘
```
2023-09-07 02:10:33 +00:00
2023-10-10 06:51:51 +00:00
## jsonMergePatch
2023-09-07 02:10:33 +00:00
2023-10-25 15:08:27 +00:00
Returns the merged JSON object string which is formed by merging multiple JSON objects.
2023-09-07 02:10:33 +00:00
**Syntax**
``` sql
2023-10-10 06:51:51 +00:00
jsonMergePatch(json1, json2, ...)
2023-09-07 02:10:33 +00:00
```
**Arguments**
2024-05-24 03:54:16 +00:00
- `json` — [String ](../data-types/string.md ) with valid JSON.
2023-09-07 02:10:33 +00:00
**Returned value**
2024-05-24 03:54:16 +00:00
- If JSON object strings are valid, return the merged JSON object string. [String ](../data-types/string.md ).
2023-09-07 02:10:33 +00:00
**Example**
``` sql
2023-10-10 06:51:51 +00:00
SELECT jsonMergePatch('{"a":1}', '{"name": "joey"}', '{"name": "tom"}', '{"name": "zoey"}') AS res
2023-09-07 02:10:33 +00:00
┌─res───────────────────┐
│ {"a":1,"name":"zoey"} │
└───────────────────────┘
```