12.17.1 JSON Function Reference
Table 12.21 JSON Functions
| Name | Description |
|---|---|
-> |
Return value from JSON column after evaluating path; equivalent to JSON_EXTRACT(). |
->> (introduced 5.7.13) |
Return value from JSON column after evaluating path and unquoting the result; equivalent to JSON_UNQUOTE(JSON_EXTRACT()). |
JSON_APPEND() (deprecated) |
Append data to JSON document |
JSON_ARRAY() |
Create JSON array |
JSON_ARRAY_APPEND() |
Append data to JSON document |
JSON_ARRAY_INSERT() |
Insert into JSON array |
JSON_CONTAINS() |
Whether JSON document contains specific object at path |
JSON_CONTAINS_PATH() |
Whether JSON document contains any data at path |
JSON_DEPTH() |
Maximum depth of JSON document |
JSON_EXTRACT() |
Return data from JSON document |
JSON_INSERT() |
Insert data into JSON document |
JSON_KEYS() |
Array of keys from JSON document |
JSON_LENGTH() |
Number of elements in JSON document |
JSON_MERGE() (deprecated 5.7.22) |
Merge JSON documents, preserving duplicate keys. Deprecated synonym for JSON_MERGE_PRESERVE() |
JSON_MERGE_PATCH() (introduced 5.7.22) |
Merge JSON documents, replacing values of duplicate keys |
JSON_MERGE_PRESERVE() (introduced 5.7.22) |
Merge JSON documents, preserving duplicate keys |
JSON_OBJECT() |
Create JSON object |
JSON_PRETTY() (introduced 5.7.22) |
Print a JSON document in human-readable format |
JSON_QUOTE() |
Quote JSON document |
JSON_REMOVE() |
Remove data from JSON document |
JSON_REPLACE() |
Replace values in JSON document |
JSON_SEARCH() |
Path to value within JSON document |
JSON_SET() |
Insert data into JSON document |
JSON_STORAGE_SIZE() (introduced 5.7.22) |
Space used for storage of binary representation of a JSON document |
JSON_TYPE() |
Type of JSON value |
JSON_UNQUOTE() |
Unquote JSON value |
JSON_VALID() |
Whether JSON value is valid |
MySQL 5.7.22 and later supports two aggregate JSON functions JSON_ARRAYAGG() and JSON_OBJECTAGG(). See Section 12.20, “Aggregate Functions”, for descriptions of these.
Also beginning with MySQL 5.7.22:
“pretty-printing” of JSON values in an easy-to-read format can be obtained using the
JSON_PRETTY()function.You can see how much storage space a given JSON value takes up using
JSON_STORAGE_SIZE().
For complete descriptions of these two functions, see Section 12.17.6, “JSON Utility Functions”.