Important
You are viewing the archived documentation of TiDB, which no longer receives updates. It is recommended that you use
the latest LTS version of the TiDB database.
JSON Functions Warning
This is still an experimental feature. It is NOT recommended that you use it in the production environment.
TiDB supports most of the JSON functions that shipped with the GA release of MySQL 5.7. Additional JSON functions were added to MySQL 5.7 after its release, and not all are available in TiDB (see unsupported functions ).
Functions that create JSON values 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
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_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 Utility Functions Function Name Description JSON_PRETTY(json_doc) Pretty formatting of a JSON document 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 Unsupported functions The following JSON functions are unsupported in TiDB. You can track the progress in adding them in TiDB #7546 :
JSON_MERGE_PATCHJSON_ARRAYAGGSee also