重要
你正在查看 TiDB 数据库的归档文档,归档文档不再提供任何更新。如无特殊需求,建议使用 TiDB 数据库的
最新 LTS 版本。
JSON 函数
TiDB 支持 MySQL 8.0 中提供的大部分 JSON 函数。
创建 JSON 值的函数
搜索 JSON 值的函数
函数 | 功能描述 |
---|
JSON_CONTAINS(target, candidate[, path]) | 通过返回 1 或 0 来表示目标 JSON 文档中是否包含给定的 candidate JSON 文档 |
JSON_CONTAINS_PATH(json_doc, one_or_all, path[, path] ...) | 通过返回 0 或 1 来表示一个 JSON 文档在给定路径是否包含数据 |
JSON_EXTRACT(json_doc, path[, path] ...) | 从 JSON 文档中解出某一路径对应的子文档 |
-> | 返回执行路径后面的 JSON 列的值;JSON_EXTRACT(doc, path_literal) 的别名 |
->> | 返回执行路径后面的 JSON 列的值和转义后的结果; JSON_UNQUOTE(JSON_EXTRACT(doc, path_literal)) 的别名 |
JSON_KEYS(json_doc[, path]) | 返回从 JSON 对象的顶级值作为 JSON array 的键,如果给定了路径参数,则从选定路径中获取顶级键 |
JSON_SEARCH(json_doc, one_or_all, search_str[, escape_char[, path] ...]) | 返回指定字符在 JSON 文档中的路径 |
value MEMBER OF(json_array) | 如果传入值是 JSON array 中的一个元素,返回 1,否则返回 0 |
JSON_OVERLAPS(json_doc1, json_doc2) | 表示两个 JSON 文档中是否包含公共部分。返回 1 表示两个 JSON 文档中包含公共部分,否则返回 0 |
修改 JSON 值的函数
函数 | 功能描述 |
---|
JSON_APPEND(json_doc, path, value) | JSON_ARRAY_APPEND 的别名 |
JSON_ARRAY_APPEND(json_doc, path, val[, path, val] ...) | 将值添加到 JSON 文档指定数组的末尾,并返回添加结果 |
JSON_ARRAY_INSERT(json_doc, path, val[, path, val] ...) | 将值插入到 JSON 文档中的指定位置并返回结果 |
JSON_INSERT(json_doc, path, val[, path, val] ...) | 在 JSON 文档中在某一路径下插入子文档 |
JSON_MERGE_PATCH(json_doc, json_doc[, json_doc] ...) | 合并 JSON 文档 |
JSON_MERGE_PRESERVE(json_doc, json_doc[, json_doc] ...) | 将两个或多个 JSON 文档合并成一个文档,并返回合并结果 |
JSON_MERGE(json_doc, json_doc[, json_doc] ...) | 已废弃,JSON_MERGE_PRESERVE 的别名 |
JSON_REMOVE(json_doc, path[, path] ...) | 移除 JSON 文档中某一路径下的子文档 |
JSON_REPLACE(json_doc, path, val[, path, val] ...) | 替换 JSON 文档中的某一路径下的子文档 |
JSON_SET(json_doc, path, val[, path, val] ...) | 在 JSON 文档中为某一路径设置子文档 |
JSON_UNQUOTE(json_val) | 去掉 JSON 值外面的引号,返回结果为字符串 |
返回 JSON 值属性的函数
效用函数
聚合函数
另请参阅
不支持的函数
JSON_SCHEMA_VALID()
JSON_SCHEMA_VALIDATION_REPORT()
JSON_TABLE()
JSON_VALUE()
更多信息,请参考 #14486。