| title | category |
|---|---|
JSON 函数及语法糖 |
user guide |
TiDB 支持 MySQL 5.7 GA 版本发布的大多数 JSON 函数。MySQL 5.7 发布后，又增加了更多 JSON 函数，TiDB 并未支持所有这些函数（参见未支持的函数）。
| 函数及语法糖 | 功能描述 |
|---|---|
| JSON_ARRAY([val[, val] ...]) | 根据一系列元素创建一个 JSON 文档 |
| JSON_OBJECT(key, val[, key, val] ...) | 根据一系列 K/V 对创建一个 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_INSERT(json_doc, path, val[, path, val] ...) | 在 JSON 文档中在某一路径下插入子文档 |
| JSON_MERGE(json_doc, json_doc[, json_doc] ...) | 将多个 JSON 文档合并成一个文档，其类型为数组 |
| 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_DEPTH(json_doc) | 返回 JSON 文档的最大深度 |
| JSON_LENGTH(json_doc[, path]) | 返回 JSON 文档的长度；如果路径参数已定，则返回该路径下值的长度 |
| JSON_TYPE(json_val) | 检查某 JSON 文档内部内容的类型 |
TiDB 暂未支持以下 JSON 函数。相关进展参见 TiDB #7546:
JSON_APPEND及其别名JSON_ARRAY_APPENDJSON_ARRAY_INSERTJSON_DEPTHJSON_MERGE_PATCHJSON_MERGE_PRESERVE，使用别名JSON_MERGE替代JSON_PRETTYJSON_QUOTEJSON_SEARCHJSON_STORAGE_SIZEJSON_VALIDJSON_ARRAYAGGJSON_OBJECTAGG