- Docs Home
- About TiDB Cloud
- Get Started
- Develop Applications
- Overview
- Quick Start
- Build a TiDB Developer Cluster
- CRUD SQL in TiDB
- Build a Simple CRUD App with TiDB
- Example Applications
- Connect to TiDB
- Design Database Schema
- Write Data
- Read Data
- Transaction
- Optimize
- Troubleshoot
- Reference
- Cloud Native Development Environment
- Manage Cluster
- Plan Your Cluster
- Create a TiDB Cluster
- Connect to Your TiDB Cluster
- Set Up VPC Peering Connections
- Use an HTAP Cluster with TiFlash
- Scale a TiDB Cluster
- Upgrade a TiDB Cluster
- Delete a TiDB Cluster
- Use TiDB Cloud API (Beta)
- Migrate Data
- Import Sample Data
- Migrate Data into TiDB
- Configure Amazon S3 Access and GCS Access
- Migrate from MySQL-Compatible Databases
- Migrate Incremental Data from MySQL-Compatible Databases
- Migrate from Amazon Aurora MySQL in Bulk
- Import or Migrate from Amazon S3 or GCS to TiDB Cloud
- Import CSV Files from Amazon S3 or GCS into TiDB Cloud
- Import Apache Parquet Files from Amazon S3 or GCS into TiDB Cloud
- Troubleshoot Access Denied Errors during Data Import from Amazon S3
- Export Data from TiDB
- Back Up and Restore
- Monitor and Alert
- Overview
- Built-in Monitoring
- Built-in Alerting
- Third-Party Monitoring Integrations
- Tune Performance
- Overview
- Analyze Performance
- SQL Tuning
- Overview
- Understanding the Query Execution Plan
- SQL Optimization Process
- Overview
- Logic Optimization
- Physical Optimization
- Prepare Execution Plan Cache
- Control Execution Plans
- TiKV Follower Read
- Coprocessor Cache
- Garbage Collection (GC)
- Tune TiFlash performance
- Manage User Access
- Billing
- Reference
- TiDB Cluster Architecture
- TiDB Cloud Cluster Limits and Quotas
- TiDB Limitations
- SQL
- Explore SQL with TiDB
- SQL Language Structure and Syntax
- SQL Statements
ADD COLUMNADD INDEXADMINADMIN CANCEL DDLADMIN CHECKSUM TABLEADMIN CHECK [TABLE|INDEX]ADMIN SHOW DDL [JOBS|QUERIES]ALTER DATABASEALTER INDEXALTER TABLEALTER TABLE COMPACTALTER USERANALYZE TABLEBATCHBEGINCHANGE COLUMNCOMMITCHANGE DRAINERCHANGE PUMPCREATE [GLOBAL|SESSION] BINDINGCREATE DATABASECREATE INDEXCREATE ROLECREATE SEQUENCECREATE TABLE LIKECREATE TABLECREATE USERCREATE VIEWDEALLOCATEDELETEDESCDESCRIBEDODROP [GLOBAL|SESSION] BINDINGDROP COLUMNDROP DATABASEDROP INDEXDROP ROLEDROP SEQUENCEDROP STATSDROP TABLEDROP USERDROP VIEWEXECUTEEXPLAIN ANALYZEEXPLAINFLASHBACK TABLEFLUSH PRIVILEGESFLUSH STATUSFLUSH TABLESGRANT <privileges>GRANT <role>INSERTKILL [TIDB]MODIFY COLUMNPREPARERECOVER TABLERENAME INDEXRENAME TABLEREPLACEREVOKE <privileges>REVOKE <role>ROLLBACKSELECTSET DEFAULT ROLESET [NAMES|CHARACTER SET]SET PASSWORDSET ROLESET TRANSACTIONSET [GLOBAL|SESSION] <variable>SHOW ANALYZE STATUSSHOW [GLOBAL|SESSION] BINDINGSSHOW BUILTINSSHOW CHARACTER SETSHOW COLLATIONSHOW [FULL] COLUMNS FROMSHOW CREATE SEQUENCESHOW CREATE TABLESHOW CREATE USERSHOW DATABASESSHOW DRAINER STATUSSHOW ENGINESSHOW ERRORSSHOW [FULL] FIELDS FROMSHOW GRANTSSHOW INDEX [FROM|IN]SHOW INDEXES [FROM|IN]SHOW KEYS [FROM|IN]SHOW MASTER STATUSSHOW PLUGINSSHOW PRIVILEGESSHOW [FULL] PROCESSSLISTSHOW PROFILESSHOW PUMP STATUSSHOW SCHEMASSHOW STATS_HEALTHYSHOW STATS_HISTOGRAMSSHOW STATS_METASHOW STATUSSHOW TABLE NEXT_ROW_IDSHOW TABLE REGIONSSHOW TABLE STATUSSHOW [FULL] TABLESSHOW [GLOBAL|SESSION] VARIABLESSHOW WARNINGSSHUTDOWNSPLIT REGIONSTART TRANSACTIONTABLETRACETRUNCATEUPDATEUSEWITH
- Data Types
- Functions and Operators
- Overview
- Type Conversion in Expression Evaluation
- Operators
- Control Flow Functions
- String Functions
- Numeric Functions and Operators
- Date and Time Functions
- Bit Functions and Operators
- Cast Functions and Operators
- Encryption and Compression Functions
- Locking Functions
- Information Functions
- JSON Functions
- Aggregate (GROUP BY) Functions
- Window Functions
- Miscellaneous Functions
- Precision Math
- Set Operations
- List of Expressions for Pushdown
- TiDB Specific Functions
- Clustered Indexes
- Constraints
- Generated Columns
- SQL Mode
- Table Attributes
- Transactions
- Views
- Partitioning
- Temporary Tables
- Cached Tables
- Character Set and Collation
- Read Historical Data
- System Tables
mysql- INFORMATION_SCHEMA
- Overview
ANALYZE_STATUSCLIENT_ERRORS_SUMMARY_BY_HOSTCLIENT_ERRORS_SUMMARY_BY_USERCLIENT_ERRORS_SUMMARY_GLOBALCHARACTER_SETSCLUSTER_INFOCOLLATIONSCOLLATION_CHARACTER_SET_APPLICABILITYCOLUMNSDATA_LOCK_WAITSDDL_JOBSDEADLOCKSENGINESKEY_COLUMN_USAGEPARTITIONSPROCESSLISTREFERENTIAL_CONSTRAINTSSCHEMATASEQUENCESSESSION_VARIABLESSLOW_QUERYSTATISTICSTABLESTABLE_CONSTRAINTSTABLE_STORAGE_STATSTIDB_HOT_REGIONS_HISTORYTIDB_INDEXESTIDB_SERVERS_INFOTIDB_TRXTIFLASH_REPLICATIKV_REGION_PEERSTIKV_REGION_STATUSTIKV_STORE_STATUSUSER_PRIVILEGESVIEWS
- System Variables
- API Reference
- Storage Engines
- Dumpling
- Table Filter
- Troubleshoot Inconsistency Between Data and Indexes
- FAQs
- Release Notes
- Support
- Glossary
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.
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 |
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_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. |
See also
Was this page helpful?