JSON 函数

本节提供 Databend 中 JSON 函数的参考信息。JSON 函数支持解析、验证、查询和操作 JSON 数据结构。

JSON 解析与验证

函数	描述	示例
PARSE_JSON	将 JSON 字符串解析为 VARIANT 值	PARSE_JSON('{"name":"John","age":30}') → {"name":"John","age":30}
CHECK_JSON	验证字符串是否为有效 JSON	CHECK_JSON('{"valid": true}') → true

JSON 类型信息

函数	描述	示例
JSON_TYPEOF	返回 JSON 值的类型	JSON_TYPEOF('{"key": "value"}') → 'OBJECT'

JSON 转换

函数	描述	示例
JSON_TO_STRING	将 JSON 值转换为字符串	JSON_TO_STRING({"name":"John"}) → '{"name":"John"}'

JSON 路径操作

函数	描述	示例
JSON_PATH_EXISTS	检查 JSON 路径是否存在	JSON_PATH_EXISTS('{"a":1}', '$.a') → true
JSON_PATH_MATCH	按路径模式匹配 JSON 值	JSON_PATH_MATCH('{"items":[1,2,3]}', '$.items[*]') → [1,2,3]
JSON_PATH_QUERY	使用 JSONPath 查询 JSON 数据	JSON_PATH_QUERY('{"a":1,"b":2}', '$.a') → 1
JSON_PATH_QUERY_ARRAY	查询 JSON 数据并以数组形式返回结果	JSON_PATH_QUERY_ARRAY('[1,2,3]', '$[*]') → [1,2,3]
JSON_PATH_QUERY_FIRST	返回 JSON 路径查询的第一个结果	JSON_PATH_QUERY_FIRST('[1,2,3]', '$[*]') → 1

JSON 数据提取

函数	描述	示例
GET	按索引或字段名从 JSON 提取值	GET('{"name":"John"}', 'name') → "John"
GET_IGNORE_CASE	以不区分大小写的方式按字段名提取值	GET_IGNORE_CASE('{"Name":"John"}', 'name') → "John"
GET_BY_KEYPATH	使用 {segment} 键路径提取嵌套值	GET_BY_KEYPATH('{"user":{"name":"Ada"}}', '{user,name}') → "Ada"
GET_PATH	使用路径表示法提取值	GET_PATH('{"user":{"name":"John"}}', 'user.name') → "John"
JSON_EXTRACT_PATH_TEXT	使用路径从 JSON 提取文本值	JSON_EXTRACT_PATH_TEXT('{"name":"John"}', 'name') → 'John'
JSON_EACH	将 JSON 对象展开为键值对	JSON_EACH('{"a":1,"b":2}') → [("a",1),("b",2)]
JSON_ARRAY_ELEMENTS	将 JSON 数组展开为单个元素	JSON_ARRAY_ELEMENTS('[1,2,3]') → 1, 2, 3
JQ	使用 jq 风格查询处理 JSON	JQ('{"name":"John"}', '.name') → "John"

JSON 格式化与处理

函数	描述	示例
JSON_PRETTY	以适当缩进格式化 JSON	JSON_PRETTY('{"a":1}') → 格式化后的 JSON 字符串
STRIP_NULL_VALUE	将 JSON 的 null 值转换为 SQL 的 NULL 值	STRIP_NULL_VALUE(parse_json('null')) → NULL
JSON_STRIP_NULLS	从 JSON 对象中移除 null 值	JSON_STRIP_NULLS(PARSE_JSON('{"a":1,"b":null}')) → {"a":1}

JSON 包含与键检测

函数	描述	示例
JSON_CONTAINS_IN_LEFT	判断左侧 JSON 是否包含右侧 JSON	JSON_CONTAINS_IN_LEFT('{"a":1,"b":2}', '{"b":2}') → true
JSON_EXISTS_KEY	检查单个键是否存在	JSON_EXISTS_KEY('{"a":1}', 'a') → true
JSON_EXISTS_ANY_KEYS	只要键列表中任意一个存在即返回 true	JSON_EXISTS_ANY_KEYS('{"a":1}', ['x','a']) → true
JSON_EXISTS_ALL_KEYS	仅当所有键都存在时返回 true	JSON_EXISTS_ALL_KEYS('{"a":1,"b":2}', ['a','b']) → true