JSON - слабо схематизированный формат данных, представленный в YQL типом Json
. В отличии от реляционных таблиц, JSON может хранить данные, для которых схема не определена. Вот пример валидного JSON:
[
{
"name": "Jim Holden",
"age": 30
},
{
"name": "Naomi Nagata",
"age": "twenty years old"
}
]
Несмотря на то, что в первом объекте поле age
имеет тип Number
("age": 21
), а во втором String
("age": "twenty years old"
), это полностью валидный JSON.
Для работы с JSON, YQL реализует подмножество стандарта SQL support for JavaScript Object Notation (JSON), являющегося частью общепринятого стандарта ANSI SQL.
$json = CAST(@@{
"friends": [
{
"name": "James Holden",
"age": 35
},
{
"name": "Naomi Nagata",
"age": 30
}
]
}@@ AS Json);
SELECT
JSON_EXISTS($json, "$.friends[*].name"), -- True,
JSON_VALUE($json, "$.friends[0].age"), -- "35" (тип Utf8?)
JSON_QUERY($json, "$.friends[0]"); -- {"name": "James Holden", "age": 35}
В таблицах данные могут хранить в JSON или в строковом представлении. Функции JSON_*
для работы ожидают на вход JSON. Для преобразования String->JSON
нужно воспользоваться функцией CAST
, например CAST (my_string AS JSON)
.
Для обращения к значениям внутри JSON используется язык запросов JsonPath. Все функции для работы с JSON принимают JsonPath запрос в качестве аргумента.
Сразу разберем пример. Пусть у нас есть JSON:
{
"comments": [
{
"id": 123,
"text": "A whisper will do, if it's all that you can manage."
},
{
"id": 456,
"text": "My life has become a single, ongoing revelation that I haven’t been cynical enough."
}
]
}
Тогда чтобы получить текст второго комментария можно написать JsonPath запрос:
$.comments[1].text
В этом запросе:
$
- это способ обратиться ко всему JSON$.comments
- обращение к ключу comments
объекта JSON$.comments[1]
- обращение ко второму элементу массива JSON (нумерация с элементов начинается с 0)$.comments[1].text
- обращение к ключу text
объекта JSON"My life has become a single, ongoing revelation that I haven’t been cynical enough."
Операция | Пример |
---|---|
Извлечь ключ JSON объекта | $.key |
Извлечь все ключи JSON объекта | $.* |
Обращение к элементу массива | $[25] |
Извлечение подотрезка массива | $[2 to 5] |
Обращение к последнему элементу массива | $[last] |
Обращение ко всем элементам массива | $[*] |
Унарные операции | - 1 |
Бинарные операции | (12 * 3) % 4 + 8 |
Обращение к переменной | $variable |
Логические операции | `(1 > 2) || (3 <= 4) && ("string" == "another")| |
Соответствие регулярному выражению | $.name like_regex "^[A-Za-z]+$" |
Проверка префикса строки | $.name starts with "Bobbie" |
Проверка существования пути | exists ($.profile.name) |
Проверка булевского выражения на null | ($.age > 20) is unknown |
Фильтрация значений | $.friends ? (@.age >= 18 && @.gender == "male") |
Получение типа значения | $.name.type() |
Получение размера массива | $.friends.size() |
Преобразование строки в число | $.number.double() |
Округление числа вверх | $.number.ceiling() |
Округление числа вниз | $.number.floor() |
Абсолютное значение числа | $.number.abs() |
Получение пар ключ-значения из объекта | $.profile.keyvalue() |
Результат выполнения всех JsonPath выражений - это последовательность JSON значений. Например:
"Bobbie"
- это последовательность длины 1 с единственным элементом "Bobbie"
.$
(взятие всего JSON объекта) на JSON [1, 2, 3]
- это [1, 2, 3]
. Последовательность из 1 элемента, массива [1, 2, 3]
$[*]
(извлечение всех элементов массива) на JSON [1, 2, 3]
- это 1, 2, 3
. Последовательность из трех элементов 1
, 2
и 3
Если входная последовательность состоит из нескольких значений, некоторые операции исполнятся для каждого элемента (например, доступ к ключу JSON объекта). При этом другие операции требуют последовательности из одного элемента на вход (например, бинарные арифметические операции).
Поведение конкретной операции описано в соответствующей секции документации.
JsonPath поддерживает два режима выполнения - lax
и strict
. Указание режима не обязательно, по умолчанию используется lax
. Режим указывается в начале запроса, например: strict $.key
.
Поведение при каждом режиме описано в разделе соответствующих JsonPath операций.
При обращении к ключу JSON объекта в lax
режиме массивы автоматически распаковываются.
[
{
"key": 123
},
{
"key": 456
}
]
Запрос lax $.key
успешно выполнится с результатом 123, 456
. Поскольку $
является массивом, он автоматически распакуется, и обращение к ключу JSON объекта $.key
будет выполнено для каждого элемента массива.
При этом запрос strict $.key
завершится с ошибкой. В strict
режиме нет автоматической распаковки массивов. $
является массивом, а не объектом, поэтому обращение к ключу объекта $.key
не может быть выполнено. Это можно исправить, написав strict $[*].key
.
Распаковка происходит только на 1 уровень вглубь. В случае вложенных массивов распаковывается только самый внешний из них.
При обращении к элементу массива в lax
режиме JSON значения автоматически оборачиваются в массив.
{
"name": "Avasarala"
}
Запрос lax $[0].name
выполнится успешно с результатом "Avasarala"
. Поскольку $
не является массивом, он будет автоматически обернут в массив длины один. Обращение к первому элементу $[0]
вернет исходный JSON объект, в котором будет взят ключ name
.
При этом запрос strict $[0].name
завершится с ошибкой. В strict
режиме нет автоматической обертки в массив. $
является объектом, а не массивом, поэтому обращение к элементу $[0]
не может быть выполнено. Это можно исправить, написав strict $.name
.
Некоторые ошибки конвертируются в пустой результат при выполнении в lax
режиме.
Значения некоторых типов можно указать в JsonPath запросе используя литералы:
Тип | Пример |
---|---|
Числа | 42 , -1.23e-5 |
Булевские значения | false , true |
Null | null |
Строки | "Belt" |
JsonPath поддерживает обращение к ключам JSON объектов: $.session.user.name
.
{% note info %}
Обращение без кавычек можно использовать только для ключей, которые начинаются с буквы английского алфавита или подчеркивания, и содержат в себе только буквы английского алфавита, подчеркивания, цифры и знак доллара. Для всех остальных ключей необходимо использовать кавычки. Например: $.profile."this string has spaces"
, $.user."42 is the answer"
{% endnote %}
Для каждого значения из входной последовательности:
lax
режиме происходит автоматическая распаковка массиваstrict
режиме запрос завершается ошибкой. В lax
режиме для этого значения возвращается пустой результатРезультат выражения - конкатенация результатов для каждого значения из входной последовательности.
{
"name": "Amos",
"friends": [
{
"name": "Jim"
},
{
"name": "Alex"
}
]
}
lax |
strict |
|
---|---|---|
$.name |
"Amos" |
"Amos" |
$.surname |
Пустой результат | Ошибка |
$.friends.name |
"Jim", "Alex" |
Ошибка |
JsonPath поддерживает обращение ко всем ключам JSON объектов сразу: $.*
.
Для каждого значения из входной последовательности:
lax
режиме происходит автоматическая распаковка массиваstrict
режиме запрос завершается ошибкой. В lax
режиме для этого значения возвращается пустой результатРезультат выражения - конкатенация результатов для каждого значения из входной последовательности.
{
"profile": {
"id": 123,
"name": "Amos"
},
"friends": [
{
"name": "Jim"
},
{
"name": "Alex"
}
]
}
lax |
strict |
|
---|---|---|
$.profile.* |
123, "Amos" |
123, "Amos" |
$.friends.* |
"Jim", "Alex" |
Ошибка |
JsonPath поддерживает обращение к элементам массивов: $.friends[1, 3 to last - 1]
.
Для каждого значения из входной последовательности:
strict
режиме запрос завершается ошибкой. В lax
режиме происходит автоматическая обертка в массивlast
заменяется на последний индекс массива. Использование last
вне обращения к массиву - это ошибка в обоих режимахstrict
режиме запрос завершается ошибкой. В lax
режиме такой индекс игнорируется$[20 to 1]
), то в strict
режиме запрос завершается ошибкой. В lax
режиме такой отрезок игнорируется.[
{
"name": "Camina",
"surname": "Drummer"
},
{
"name": "Josephus",
"surname": "Miller"
},
{
"name": "Bobbie",
"surname": "Draper"
},
{
"name": "Julie",
"surname": "Mao"
}
]
lax |
strict |
|
---|---|---|
$[0].name |
"Camina" |
"Camina" |
$[1, 2 to 3].name |
"Josephus", "Bobbie", "Julie" |
"Josephus", "Bobbie", "Julie" |
$[last - 2].name |
"Josephus" |
"Josephus" |
$[2, last + 200 to 50].name |
"Bobbie" |
Ошибка |
$[50].name |
Пустой результат | Ошибка |
JsonPath поддерживает обращение ко всем элементам массива сразу: $[*]
.
Для каждого значения из входной последовательности:
strict
режиме запрос завершается ошибкой. В lax
режиме происходит автоматическая обертка в массив[
{
"class": "Station",
"title": "Medina"
},
{
"class": "Corvette",
"title": "Rocinante"
}
]
lax |
strict |
|
---|---|---|
$[*].title |
"Medina", "Rocinante" |
"Medina", "Rocinante" |
lax $[0][*].class |
"Station" |
Ошибка |
Разберем последний пример по шагам:
$[0]
возвращает первый элемент массива, то есть {"class": "Station", "title": "Medina"}
$[0][*]
ожидает массив на вход, но был дан объект. Происходит автоматическая обертка в массив, получается [ {"class": "Station", "title": "Medina"} ]
$[0][*]
может выполниться и возвращает все элементы массива, то есть {"class": "Station", "title": "Medina"}
$[0][*].class
возвращает поле class
, то есть "Station"
.{% note info %}
Все арифметические операции работают с числами как с Double. Возможна потеря точности при вычислениях.
{% endnote %}
JsonPath поддерживает унарный +
и -
.
Унарная операция применяется ко всем значениям из входной последовательности. Если унарной операции подать на вход не число, запрос завершится ошибкой в обоих режимах.
[1, 2, 3, 4]
Запрос strict -$[*]
завершится успешно с результатом -1, -2, -3, -4
.
Запрос lax -$
завершится с ошибкой, потому что $
является массивом, а не числом.
JsonPath поддерживает бинарные арифметические операции (в порядке убывания приоритета):
*
, деление чисел с плавающей точкой /
, взятие остатка %
(работает как функция MOD
в SQL
)+
, вычитание -
Порядок выполнения операций можно поменять используя скобочки.
В случае если каждый аргумент бинарной операции не является единственным числом или происходит деление на ноль, запрос завершается ошибкой в обоих режимах.
(1 + 2) * 3
даст 9
1 / 2
даст 0.5
5 % 2
даст 1
1 / 0
завершится ошибкой[-32.4, 5.2]
запрос $[0] % $[1]
даст -1.2
[1, 2, 3, 4]
запрос lax $[*] + $[*]
завершится ошибкой, так как результат выражения $[*]
- это 1, 2, 3, 4
, несколько чисел. Бинарная операция требует только одно число для каждого своего аргумента.В отличии от некоторых языков программирования, в JsonPath булевскими значениями считаются не только true
(истина) и false
(ложь), но и null
(неопределенность).
JsonPath считает все значения, полученные из JSON документа, не булевскими. Например, запрос ! $.is_valid_user
(логическое отрицание, примененное к полю is_valid_user
), является синтаксически неверным поскольку поле is_valid_user
не является булевским значением (даже если по факту в нем хранится true
или false
). Правильный способ написать такой запрос - это явно использовать сравнение с булевским значением, например $.is_valid_user == false
.
JsonPath поддерживает некоторые логические операции для работы с булевскими значениями.
Аргументы всех логических операций должны являться единственным булевским значением. Все логические операции возвращают булевское значение.
Таблица истинности:
x |
!x |
---|---|
true |
false |
false |
true |
null |
null |
Таблица истинности, первый столбец это левый аргумент, первая строка это правый аргумент, каждая клетка это результат применения логического И с левым и правым аргументами:
&& |
true |
false |
null |
---|---|---|---|
true |
true |
false |
null |
false |
false |
false |
false |
null |
null |
false |
null |
Таблица истинности, первый столбец это левый аргумент, первая строка это правый аргумент, каждая клетка это результат применения логического ИЛИ с левым и правым аргументами:
\|\| |
true |
false |
null |
---|---|---|---|
true |
true |
true |
true |
false |
true |
false |
null |
null |
true |
null |
null |
! (true == true)
, результат false
(true == true) && (true == false)
, результат false
(true == true) || (true == false)
, результат true
JsonPath реализует операторы сравнения для значений:
==
!=
и <>
<
и <=
>
и >=
Все операторы сравнения возвращают булевское значение. Оба аргумента оператора поддерживают наличие нескольких значений.
Если при вычислении аргументов оператора возникла ошибка, оператор возвращает null
. При этом выполнение JsonPath запроса продолжается.
Для каждого из аргументов производится автоматическая распаковка массивов. После этого для каждой пары, где первый элемент берется из последовательности левого аргумента, а второй элемент из последовательности правого аргумента:
ERROR
FOUND
ERROR
или FOUND
установлен и запрос исполняется в lax
режиме, больше никакие пары не рассматриваютсяЕсли после рассмотрения пар:
ERROR
, оператор возвращает null
FOUND
, оператор возвращает true
false
Можно сказать что данный алгоритм рассматривает все пары из декартового произведения левого и правого аргумента, пытаясь найти ту, сравнение которой вернет истину.
Сравнение элементов в паре производится по следующим правилам:
null == null
возвращает истинуnull
, возвращается ложьtrue
считается больше false
1e-20
Для примера рассмотрим JSON документ
{
"left": [1, 2],
"right": [4, "Inaros"]
}
и разберем по шагам выполнение запроса lax $.left < $.right
:
1, 2
, в качестве правого 4, "Iranos"
(1, 4)
. Сравнение проходит успешно, 1 < 4
это истина. Устанавливаем флаг FOUND
lax
режиме и установлен флаг FOUND
, больше никакие пары мы не рассматриваемFOUND
, оператор возвращает истинуРазберем тот же запрос, но в другом режиме выполнения: strict $.left < $.right
:
1, 2
, в качестве правого 4, "Iranos"
(1, 4)
. Сравнение проходит успешно, 1 < 4
это истина. Устанавливаем флаг FOUND
(2, 4)
. Сравнение проходит успешно, 2 < 4
это истина. Устанавливаем флаг FOUND
(1, "Iranos")
. Сравнение завершается ошибкой (число нельзя сравнить со строкой). Устанавливаем флаг ERROR
(2, "Iranos")
. Сравнение завершается ошибкой (число нельзя сравнить со строкой). Устанавливаем флаг ERROR
ERROR
, оператор возвращает null
JsonPath поддерживает предикаты - выражения, возвращающие булевское значение, и проверяющие некоторое условие. Их можно использовать, например, в фильтрах.
like_regex
Предикат like_regex
позволяет проверить строку на соответствие регулярному выражению. Синтаксис регулярных выражений такой же как в Hyperscan UDF и REGEXP.
<expression> like_regex <regexp string> [flag <flag string>]
Где:
<expression>
- это JsonPath выражение, содержащее строки, которые следует проверить на соответствие регулярному выражению<regexp string>
- это строка, содержащая регулярное выражениеflag <flag string>
- это опциональная секция, в которой <flag string>
является строкой с флагами для исполнения регулярного выраженияПоддерживаемые флаги:
i
- отключение чувствительности к региструПеред проверкой производится автоматическая распаковка массивов во входной последовательности.
После этого для каждого элемента входной последовательности:
ERROR
FOUND
ERROR
или FOUND
установлен и запрос исполняется в lax
режиме, больше никакие пары не рассматриваютсяЕсли после рассмотрения пар:
ERROR
, предикат возвращает null
FOUND
, предикат возвращает true
false
"123456" like_regex "^[0-9]+$"
возвращает true
"123abcd456" like_regex "^[0-9]+$"
возвращает false
"Naomi Nagata" like_regex "nag"
возвращает false
"Naomi Nagata" like_regex "nag" flag "i"
возвращает true
starts with
Предикат starts with
позволяет проверить является ли одна строка префиксом другой.
<string expression> starts with <prefix expression>
Где:
<string expression>
- это JsonPath выражение, содержащее строку, которую нужно проверить<prefix expression>
- это JsonPath выражение, содержащее строку-префиксТо есть предикат будет проверять что <string expression>
начинается со строки <prefix expression>
.
Первый аргумент предиката должен быть единственной строкой.
Второй аргумент предиката должен быть последовательностью (возможно, из нескольких) строк.
Для каждого элемента из последовательности строк-префиксов:
ERROR
FOUND
ERROR
или FOUND
установлен и запрос исполняется в lax
режиме, больше никакие пары не рассматриваютсяЕсли после рассмотрения пар:
ERROR
, предикат возвращает null
FOUND
, предикат возвращает true
false
"James Holden" starts with "James"
возвращает true
"James Holden" starts with "Amos"
возвращает false
exists
Предикат exists
позволяет проверить, возвращает ли JsonPath выражение хотя бы один элемент.
exists (<expression>)
Где <expression>
- это JsonPath выражение, которое нужно проверить. Скобки вокруг выражения обязательны.
null
false
true
Рассмотрим JSON документ:
{
"profile": {
"name": "Josephus",
"surname": "Miller"
}
}
exists ($.profile.name)
возвращает true
exists ($.friends.profile.name)
возвращает false
strict exists ($.friends.profile.name)
возвращает null
, потому что в strict
режиме обращение к несуществующим ключам объекта это ошибкаis unknown
Предикат is unknown
позволяет проверить, является ли булевское значение null
.
(<expression>) is unknown
Где <expression>
- это JsonPath выражение, которое нужно проверить. Допускаются только выражения, возвращающие булевское значение. Скобки вокруг выражения обязательны.
null
, предикат возвращает true
false
(1 == 2) is unknown
возвращает false
. Выражение 1 == 2
вернуло false
, что не является null
(1 == "string") is unknown
возвращает true
. Выражение 1 == "string"
вернуло null
, поскольку в JsonPath строки и числа не сравнимыJsonPath позволяет фильтровать значения, полученные в ходе выполнения запроса.
Выражение в фильтре должно возвращать булевское значение. Перед фильтрацией производится автоматическая распаковка массивов во входной последовательности.
Для каждого элемента входной последовательности:
@
становится равным текущему элементу входной последовательностиtrue
, текущий элемент добавляется в результат фильтраПусть у нас есть JSON документ, описывающий друзей пользователя
{
"friends": [
{
"name": "James Holden",
"age": 35,
"money": 500
},
{
"name": "Naomi Nagata",
"age": 30,
"money": 345
}
]
}
и мы хотим получить с помощью JsonPath запроса друзей которые старше 32 лет. Для этого можно написать следующий запрос:
$.friends ? (@.age > 32)
Разберем запрос по частям:
$.friends
- обращение к массиву friends
в JSON документе? ( ... )
- синтаксис фильтра. Выражение внутри скобок называется предикатом@
- обращение к текущему фильтруемому объекту. В нашем примере это объект, описывающий друга пользователя@.age
- обращение к полю age
текущего фильтруемого объекта@.age > 32
- сравнение поля age
со значением 32. В результате выполнения запроса останутся только те значения, для которых данный предикат вернул истинуВ результате выполнения этого запроса будет получен только первый друг из массива друзей пользователя.
Как и многие другие операторы языка JsonPath, фильтры можно выстраивать в цепочки. Разберем более сложный запрос, который отбирает имена друзей которые старше 20 лет и которые имеют меньше чем 400 единиц валюты:
$.friends ? (@.age > 20) ? (@.money < 400) . name
Разберем запрос по частям:
$.friends
- обращение к массиву friends
в JSON документе? (@.age > 20)
- первый фильтр. Поскольку все друзья старше 20, он просто вернет все элементы массива friends
? (@.money < 400)
- второй фильтр. Вернет только второй элемент массива friends
, поскольку только у него поле money
имеет значение меньше 400.name
- обращение к полю name
у отфильтрованных объектовВ результате выполнения этого запроса будет получена последовательность из одного элемента - "Naomi Nagata"
.
На практике рекомендуется объединять несколько фильтров в один если есть такая возможность. Рассмотренный запрос эквивалентен $.friends ? (@.age > 20 && @.money < 400) . name
.
JsonPath поддерживает методы - функции, которые преобразуют одни последовательности значений в другие. Синтаксис вызова метода похож на обращение к ключу объекта:
$.friends.size()
Также как и обращение к ключам объекта, вызовы методов можно выстраивать в цепочки:
$.numbers.double().floor()
type
Метод type
возвращает строчку с названием типа переданного значения.
Для каждого элемента входной последовательности метод добавляет строчку в выходную последовательность в соответствии с табличкой:
Тип значения | Строка с названием типа |
---|---|
Null | "null" |
Булевское значение | "boolean" |
Число | "number" |
Строка | "string" |
Массив | "array" |
Объект | "object" |
"Naomi".type()
возвращает "string"
false.type()
возвращает "boolean"
size
Метод size
возвращает размер массива.
Для каждого элемента входной последовательности метод добавляет в выходную последовательность:
1
Рассмотрим JSON документ:
{
"array": [1, 2, 3],
"object": {
"a": 1,
"b": 2
},
"scalar": "string"
}
И запросы к нему:
$.array.size()
возвращает 3
$.object.size()
возвращает 1
$.scalar.size()
возвращает 1
double
Метод double
конвертирует строки в числа.
Перед выполнением производится автоматическая распаковка массивов во входной последовательности.
Все элементы во входной последовательности должны быть строками, которые содержат числа в десятичной записи. Допускается указание дробной части и экспоненты.
"125".double()
возвращает 125
"125.456".double()
возвращает 125.456
"125.456e-3".double()
возвращает 0.125456
ceiling
Метод ceiling
округляет числа вверх.
Перед выполнением производится автоматическая распаковка массивов во входной последовательности.
Все элементы во входной последовательности должны быть числами.
(1.3).ceiling()
возвращает 2
(1.8).ceiling()
возвращает 2
(1.5).ceiling()
возвращает 2
(1.0).ceiling()
возвращает 1
floor
Метод floor
округляет числа вниз.
Перед выполнением производится автоматическая распаковка массивов во входной последовательности.
Все элементы во входной последовательности должны быть числами.
(1.3).floor()
возвращает 1
(1.8).floor()
возвращает 1
(1.5).floor()
возвращает 1
(1.0).floor()
возвращает 1
abs
Метод abs
вычисляет абсолютное значение числа (убирает знак).
Перед выполнением производится автоматическая распаковка массивов во входной последовательности.
Все элементы во входной последовательности должны быть числами.
(0.0).abs()
возвращает 0
(1.0).abs()
возвращает 1
(-1.0).abs()
возвращает 1
keyvalue
Метод keyvalue
конвертирует объект в последовательность пар ключ-значение.
Перед выполнением производится автоматическая распаковка массивов во входной последовательности.
Все элементы во входной последовательности должны быть объектами.
Для каждого элемента входной последовательности:
name
и value
name
хранит строку с названием ключа из парыvalue
хранит значение из парыРассмотрим JSON документ:
{
"name": "Chrisjen",
"surname": "Avasarala",
"age": 70
}
Для него запрос $.keyvalue()
вернет последовательность:
{
"name": "age",
"value": 70
},
{
"name": "name",
"value": "Chrisjen"
},
{
"name": "surname",
"value": "Avasarala"
}
Функции использующие JsonPath могут передавать значения внутрь запроса, они называются переменными. Чтобы обратиться к переменной, нужно написать символ $
и название переменной: $variable
.
Пусть переменная planet
равна
{
"name": "Mars",
"gravity": 0.376
}
Тогда запрос strict $planet.name
даст "Mars"
.
В отличии от многих языков программирования, JsonPath не поддерживает создание новых переменных или изменение существующих.
Все функции для работы с JSON принимают:
Json
или Json?
)PASSING
секцияПозволяет передавать значения в JsonPath запрос в качестве переменных.
PASSING
<expression 1> AS <variable name 1>,
<expression 2> AS <variable name 2>,
...
<expression>
может быть следующих типов:
Date
, DateTime
и Timestamp
(будет произведен CAST
в тип Double
перед передачей в JsonPath)Utf8
, Bool
и Json
Имя переменной <variable name>
можно указать несколькими способами:
variable
"variable"
JSON_VALUE(
$json,
"$.timestamp - $Now + $Hour"
PASSING
24 * 60 as Hour,
CurrentUtcTimestamp() as "Now"
)
Функция JSON_EXISTS
позволяет проверить, удовлетворяет ли JSON значение указанному JsonPath.
JSON_EXISTS(
<JSON expression>,
<JsonPath query>,
[<PASSING clause>]
[{TRUE | FALSE | UNKNOWN | ERROR} ON ERROR]
)
Возвращаемое значение: Bool?
Значения по умолчанию: если ON ERROR
секция не указана, используется FALSE ON ERROR
Поведение:
<JSON expression>
это NULL
или пустой Json?
, то возвращается пустой Bool?
Если при выполнении JsonPath возникла ошибка, то возвращаемое значение зависит от ON ERROR
секции:
TRUE
- вернуть True
FALSE
- вернуть False
UNKNOWN
- вернуть пустой Bool?
ERROR
- завершить весь запрос с ошибкойЕсли результат выполнения JsonPath - это одно или несколько значений, возвращается True
Иначе возвращается False
$json = CAST(@@{
"title": "Rocinante",
"crew": [
"James Holden",
"Naomi Nagata",
"Alex Kamai",
"Amos Burton"
]
}@@ as Json);
SELECT
JSON_EXISTS($json, "$.title"), -- True
JSON_EXISTS($json, "$.crew[*]"), -- True
JSON_EXISTS($json, "$.nonexistent"); -- False, так как JsonPath вернет пустой результат
SELECT
-- Ошибка JsonPath, вернет False, так как по умолчанию используется FALSE ON ERROR
JSON_EXISTS($json, "strict $.nonexistent");
SELECT
-- Ошибка JsonPath, весь YQL запрос завершится ошибкой
JSON_EXISTS($json, "strict $.nonexistent" ERROR ON ERROR);
Функция JSON_VALUE
позволяет извлечь из JSON скалярное значение (все что не массив и не объект).
JSON_VALUE(
<JSON expression>,
<JsonPath query>,
[<PASSING clause>]
[RETURNING <type>]
[{ERROR | NULL | DEFAULT <expr>} ON EMPTY]
[{ERROR | NULL | DEFAULT <expr>} ON ERROR]
)
Возвращаемое значение: <type>?
Значения по умолчанию:
ON EMPTY
секция не указана, используется NULL ON EMPTY
ON ERROR
секция не указана, используется NULL ON ERROR
RETURNING
секция не указана, в качестве <type>
используется Utf8
Поведение:
<JSON expression>
это NULL
или пустой Json?
, то возвращается пустой <type>?
Если возникла ошибка, то возвращаемое значение зависит от ON ERROR
секции:
NULL
- вернуть пустой <type>?
ERROR
- завершить весь запрос с ошибкойDEFAULT <expr>
- вернуть <expr>
, предварительно сделав CAST
в тип <type>?
. Если CAST
не удастся, весь запрос завершится с ошибкойЕсли в результате выполнения JsonPath получился пустой результат, то возвращаемое значение зависит от ON EMPTY
секции:
NULL
- вернуть пустой <type>?
ERROR
- завершить весь запрос с ошибкойDEFAULT <expr>
- вернуть <expr>
, предварительно сделав CAST
в тип <type>?
. Если CAST
не удастся, то поведение соответствует ON ERROR
секцииЕсли результат выполнения JsonPath - это одно значение, то:
RETURNING
секция не была указана, значение конвертируется в Utf8
CAST
значения в <type>
. Если CAST
не удастся, то поведение соответствует ON ERROR
секции. При этом значение из JSON должно "соответствовать" типу <type>
.Вернуть полученный результат
Определим соответствие JSON типов YQL типам:
Date
, DateTime
и Timestamp
Bool
Utf8
и String
Ошибками при выполнении JSON_VALUE
считаются:
RETURNING
секция поддерживает типы чисел, Date
, DateTime
, Timestamp
, Utf8
, String
и Bool
.
$json = CAST(@@{
"friends": [
{
"name": "James Holden",
"age": 35
},
{
"name": "Naomi Nagata",
"age": 30
}
]
}@@ as Json);
SELECT
JSON_VALUE($json, "$.friends[0].age"), -- "35" (тип Utf8?)
JSON_VALUE($json, "$.friends[0].age" RETURNING Uint64), -- 35 (тип Uint64?)
JSON_VALUE($json, "$.friends[0].age" RETURNING Utf8); -- пустой Utf8?, так как произошла ошибка. Тип JSON значения Number не соответствует строковому типу Utf8
SELECT
-- "empty" (тип String?)
JSON_VALUE(
$json,
"$.friends[50].name"
RETURNING String
DEFAULT "empty" ON EMPTY
);
SELECT
-- 20 (тип Uint64?). Результат выполнения JsonPath пустой, но значение
-- по умолчанию из секции ON EMPTY не может быть приведено к Uint64.
-- Поэтому используется значение из ON ERROR
JSON_VALUE(
$json,
"$.friends[50].age"
RETURNING Uint64
DEFAULT -1 ON EMPTY
DEFAULT 20 ON ERROR
);
Функция JSON_QUERY
позволяет извлекать из JSON массивы и объекты.
JSON_QUERY(
<JSON expression>,
<JsonPath query>,
[<PASSING clause>]
[WITHOUT [ARRAY] | WITH [CONDITIONAL | UNCONDITIONAL] [ARRAY] WRAPPER]
[{ERROR | NULL | EMPTY ARRAY | EMPTY OBJECT} ON EMPTY]
[{ERROR | NULL | EMPTY ARRAY | EMPTY OBJECT} ON ERROR]
)
Возвращаемое значение Json?
Значения по умолчанию
ON EMPTY
секция не указана, используется NULL ON EMPTY
ON ERROR
секция не указана, используется NULL ON ERROR
WRAPPER
секция не указана, используется WITHOUT WRAPPER
WITH WRAPPER
, но не указано CONDITIONAL
или UNCONDITIONAL
, используется UNCONDITIONAL
Поведение:
{% note info %}
Указывать секции WITH ... WRAPPER
и ON EMPTY
одновременно нельзя
{% endnote %}
<JSON expression>
это NULL
или пустой Json?
, то возвращается пустой Json?
Если указана WRAPPER
секция, то:
WITHOUT WRAPPER
или WITHOUT ARRAY WRAPPER
- никак не преобразовывать результат выполнения JsonPathWITH UNCONDITIONAL WRAPPER
или WITH UNCONDITIONAL ARRAY WRAPPER
- обернуть результат выполнения JsonPath в массивWITH CONDITIONAL WRAPPER
или WITH CONDITIONAL ARRAY WRAPPER
- обернуть результат выполнения JsonPath в массив если он не является единственным массивом или объектомЕсли в результате выполнения JsonPath получился пустой результат, то возвращаемое значение зависит от ON EMPTY
секции:
NULL
- вернуть пустой Json?
ERROR
- завершить весь запрос с ошибкойEMPTY ARRAY
- вернуть пустой JSON массив, []
EMPTY OBJECT
- вернуть пустой JSON объект, {}
Если возникла ошибка, то возвращаемое значение зависит от ON ERROR
секции:
NULL
- вернуть пустой Json?
ERROR
- завершить весь запрос с ошибкойEMPTY ARRAY
- вернуть пустой JSON массив, []
EMPTY OBJECT
- вернуть пустой JSON объект, {}
Вернуть полученный результат
Ошибками при выполнении JSON_QUERY
считаются:
WRAPPER
) или скалярное значение$json = CAST(@@{
"friends": [
{
"name": "James Holden",
"age": 35
},
{
"name": "Naomi Nagata",
"age": 30
}
]
}@@ as Json);
SELECT
JSON_QUERY($json, "$.friends[0]"); -- {"name": "James Holden", "age": 35}
SELECT
JSON_QUERY($json, "$.friends.name" WITH UNCONDITIONAL WRAPPER); -- ["James Holden", "Naomi Nagata"]
SELECT
JSON_QUERY($json, "$.friends[0]" WITH CONDITIONAL WRAPPER), -- {"name": "James Holden", "age": 35}
JSON_QUERY($json, "$.friends.name" WITH CONDITIONAL WRAPPER); -- ["James Holden", "Naomi Nagata"]