JSON Functions
TiDB supports most of the JSON functions that shipped with the GA release of MySQL 5.7.
Functions that create JSON values
| Function Name | Description |
|---|---|
| JSON_ARRAY([val[, val] ...]) | Evaluates a (possibly empty) list of values and returns a JSON array containing those values |
| JSON_OBJECT(key, val[, key, val] ...) | Evaluates a (possibly empty) list of key-value pairs and returns a JSON object containing those pairs |
| JSON_QUOTE(string) | Returns a string as a JSON value with quotes |
Functions that search JSON values
| Function Name | Description |
|---|---|
| JSON_CONTAINS(target, candidate[, path]) | Indicates by returning 1 or 0 whether a given candidate JSON document is contained within a target JSON document |
| JSON_CONTAINS_PATH(json_doc, one_or_all, path[, path] ...) | Returns 0 or 1 to indicate whether a JSON document contains data at a given path or paths |
| JSON_EXTRACT(json_doc, path[, path] ...) | Returns data from a JSON document, selected from the parts of the document matched by the path arguments |
| -> | Returns the value from a JSON column after the evaluating path; an alias for JSON_EXTRACT(doc, path_literal) |
| ->> | Returns the value from a JSON column after the evaluating path and unquoting the result; an alias for JSON_UNQUOTE(JSON_EXTRACT(doc, path_literal)) |
| JSON_KEYS(json_doc[, path]) | Returns the keys from the top-level value of a JSON object as a JSON array, or, if a path argument is given, the top-level keys from the selected path |
| JSON_SEARCH(json_doc, one_or_all, search_string) | Search a JSON document for one or all matches of a string |
| value MEMBER OF(json_array) | If the passed value is an element of the JSON array, returns 1. Otherwise, returns 0. |
| JSON_OVERLAPS(json_doc1, json_doc2) | Indicates whether two JSON documents have overlapping part. If yes, returns 1. If not, returns 0. |
Functions that modify JSON values
| Function Name | Description |
|---|---|
| JSON_APPEND(json_doc, path, value) | An alias to JSON_ARRAY_APPEND |
| JSON_ARRAY_APPEND(json_doc, path, value) | Appends a value to the end of a JSON array at a specified path |
| JSON_ARRAY_INSERT(json_doc, path, val[, path, val] ...) | Inserts an array into the json document and returns the modified document |
| JSON_INSERT(json_doc, path, val[, path, val] ...) | Inserts data into a JSON document and returns the result |
| JSON_MERGE(json_doc, json_doc[, json_doc] ...) | A deprecated alias for JSON_MERGE_PRESERVE |
| JSON_MERGE_PATCH(json_doc, json_doc[, json_doc] ...) | Merge JSON documents |
| JSON_MERGE_PRESERVE(json_doc, json_doc[, json_doc] ...) | Merges two or more JSON documents and returns the merged result |
| JSON_REMOVE(json_doc, path[, path] ...) | Removes data from a JSON document and returns the result |
| JSON_REPLACE(json_doc, path, val[, path, val] ...) | Replaces existing values in a JSON document and returns the result |
| JSON_SET(json_doc, path, val[, path, val] ...) | Inserts or updates data in a JSON document and returns the result |
| JSON_UNQUOTE(json_val) | Unquotes a JSON value and returns the result as a string |
| JSON_ARRAY_APPEND(json_doc, path, val[, path, val] ...) | Appends values to the end of the indicated arrays within a JSON document and returns the result |
| JSON_ARRAY_INSERT(json_doc, path, val[, path, val] ...) | Insert values into the specified location of a JSON document and returns the result |
Functions that return JSON value attributes
| Function Name | Description |
|---|---|
| JSON_DEPTH(json_doc) | Returns the maximum depth of a JSON document |
| JSON_LENGTH(json_doc[, path]) | Returns the length of a JSON document, or, if a path argument is given, the length of the value within the path |
| JSON_TYPE(json_val) | Returns a string indicating the type of a JSON value |
| JSON_VALID(json_doc) | Checks if a json_doc is valid JSON. Useful for checking a column before converting it to the json type. |
Utility Functions
| Function Name | Description |
|---|---|
| JSON_PRETTY(json_doc) | Pretty formatting of a JSON document |
| JSON_STORAGE_FREE(json_doc) | Returns how much storage space was freed in the binary representation of the JSON value after it was updated in place. As TiDB has different storage architecture from MySQL, this function always returns 0 for a valid JSON value, and it is implemented for compatibility with MySQL 8.0. |
| JSON_STORAGE_SIZE(json_doc) | Returns an approximate size of bytes required to store the json value. As the size does not account for TiKV using compression, the output of this function is not strictly compatible with MySQL. |
Aggregate Functions
| Function Name | Description |
|---|---|
| JSON_ARRAYAGG(key) | Provides an aggregation of keys. |
| JSON_OBJECTAGG(key, value) | Provides an aggregation of values for a given key. |