TOC.md

• Docs Home
• About TiDB Self-Managed
  • What is TiDB Self-Managed
  • TiDB 8.4 Release Notes
  • Features
  • MySQL Compatibility
  • TiDB Limitations
  • Credits
  • Roadmap
• Get Started
  • Quick Start with TiDB
  • Quick Start with HTAP
  • Learn TiDB SQL
  • Learn HTAP
  • Import Example Database
• Develop
  • Overview
  • Quick Start
    • Build a TiDB Cloud Serverless Cluster
    • CRUD SQL in TiDB
  • Example Applications
    • Java
      • JDBC
      • MyBatis
      • Hibernate
      • Spring Boot
    • Go
      • Go-MySQL-Driver
      • GORM
    • Python
      • mysqlclient
      • MySQL Connector/Python
      • PyMySQL
      • SQLAlchemy
      • peewee
      • Django
    • Node.js
      • node-mysql2
      • mysql.js
      • Prisma
      • Sequelize
      • TypeORM
      • Next.js
      • AWS Lambda
    • Ruby
      • mysql2
      • Rails
  • Connect to TiDB
    • GUI Database Tools
      • JetBrains DataGrip
      • DBeaver
      • VS Code
      • MySQL Workbench
      • Navicat
    • Choose Driver or ORM
    • Connect to TiDB
    • Connection Pools and Connection Parameters
  • Design Database Schema
    • Overview
    • Create a Database
    • Create a Table
    • Create a Secondary Index
  • Write Data
    • Insert Data
    • Update Data
    • Delete Data
    • Periodically Delete Data Using Time to Live
    • Prepared Statements
  • Read Data
    • Query Data from a Single Table
    • Multi-table Join Queries
    • Subquery
    • Paginate Results
    • Views
    • Temporary Tables
    • Common Table Expression
    • Read Replica Data
      • Follower Read
      • Stale Read
    • HTAP Queries
  • Vector Search
    • Overview
    • Get Started
      • Get Started with SQL
      • Get Started with Python
    • Integrations
      • Overview
      • AI Frameworks
        • LlamaIndex
        • Langchain
      • Embedding Models/Services
        • Jina AI
      • ORM Libraries
        • SQLAlchemy
        • peewee
        • Django
    • Improve Performance
    • Limitations
  • Transaction
    • Overview
    • Optimistic and Pessimistic Transactions
    • Transaction Restraints
    • Handle Transaction Errors
  • Optimize
    • Overview
    • SQL Performance Tuning
    • Best Practices for Performance Tuning
    • Best Practices for Indexing
    • Other Optimization Methods
      • Avoid Implicit Type Conversions
      • Unique Serial Number Generation
  • Troubleshoot
    • SQL or Transaction Issues
    • Unstable Result Set
    • Timeouts
  • Reference
    • Bookshop Example Application
    • Guidelines
      • Object Naming Convention
      • SQL Development Specifications
  • Cloud Native Development Environment
    • Gitpod
  • Third-Party Support
    • Third-Party Tools Supported by TiDB
    • Known Incompatibility Issues with Third-Party Tools
    • ProxySQL Integration Guide
    • Amazon AppFlow Integration Guide
• Deploy
  • Software and Hardware Requirements
  • Environment Configuration Checklist
  • Plan Cluster Topology
    • Minimal Topology
    • TiFlash Topology
    • PD Microservices Topology
    • TiProxy Topology
    • TiCDC Topology
    • TiSpark Topology
    • Cross-DC Topology
    • Hybrid Topology
  • Deploy Using TiUP
  • Deploy on Kubernetes
  • Verify Cluster Status
  • Test Cluster Performance
    • Test TiDB Using Sysbench
    • Test TiDB Using TPC-C
    • Test TiDB Using CH-benCHmark
• Migrate
  • Overview
  • Migration Tools
  • Import Best Practices
  • Migration Scenarios
    • Migrate from Aurora
    • Migrate Small Datasets from MySQL
    • Migrate Large Datasets from MySQL
    • Migrate and Merge MySQL Shards of Small Datasets
    • Migrate and Merge MySQL Shards of Large Datasets
    • Migrate from Vitess
    • Migrate from MariaDB
    • Migrate from CSV Files
    • Migrate from SQL Files
    • Migrate from Parquet Files
    • Migrate from One TiDB Cluster to Another TiDB Cluster
    • Migrate from TiDB to MySQL-compatible Databases
  • Advanced Migration
    • Continuous Replication with gh-ost or pt-osc
    • Migrate to a Downstream Table with More Columns
    • Filter Binlog Events
    • Filter DML Events Using SQL Expressions
• Stream Data
  • TiCDC Overview
  • Deploy and Maintain
  • Changefeed
    • Overview
    • Create Changefeeds
      • Replicate Data to MySQL-compatible Databases
      • Replicate Data to Kafka
      • Replicate Data to Pulsar
      • Replicate Data to Storage Services
    • Manage Changefeeds
    • Log Filter
    • DDL Replication
    • Bidirectional Replication
  • Monitor and Alert
    • Monitoring Metrics Summary
    • Monitoring Metrics Details
    • Alert Rules
  • Integration Scenarios
    • Overview
    • Integrate with Confluent and Snowflake
    • Integrate with Apache Kafka and Apache Flink
  • Reference
    • TiCDC Architecture
    • TiCDC Server Configurations
    • TiCDC Changefeed Configurations
    • TiCDC Client Authentication
    • Data Integrity Validation for Single-Row Data
    • Data Consistency Validation for Upstream and Downstream TiDB Clusters
    • TiCDC Behavior in Splitting UPDATE Events
    • Output Protocols
      • TiCDC Avro Protocol
      • TiCDC Canal-JSON Protocol
      • TiCDC CSV Protocol
      • TiCDC Debezium Protocol
      • TiCDC Open Protocol
      • TiCDC Simple Protocol
    • TiCDC Open API v2
    • TiCDC Open API v1
    • TiCDC Data Consumption
      • TiCDC Row Data Checksum Verification Based on Avro
      • Guide for Developing a Storage Sink Consumer
    • TiCDC Compatibility
  • Troubleshoot
  • FAQs
  • Glossary
• Maintain
  • Security
    • Best Practices for TiDB Security Configuration
    • Enable TLS Between TiDB Clients and Servers
    • Enable TLS Between TiDB Components
    • Generate Self-signed Certificates
    • Encryption at Rest
    • Enable Encryption for Disk Spill
    • Log Redaction
  • Upgrade
    • Use TiUP
    • Use TiDB Operator
    • TiDB Smooth Upgrade
    • TiFlash Upgrade Guide
  • Scale
    • Use TiUP (Recommended)
    • Use TiDB Operator
  • Backup and Restore
    • Overview
    • Architecture
      • Architecture Overview
      • Snapshot Backup and Restore Architecture
      • Log Backup and PITR Architecture
    • Use BR
      • Use Overview
      • Snapshot Backup and Restore Guide
      • Log Backup and PITR Guide
      • Use Cases
      • Backup Storages
    • BR CLI Manuals
      • Overview
      • Snapshot Backup and Restore Command Manual
      • Log Backup and PITR Command Manual
    • References
      • BR Features
        • Backup Auto-Tune
        • Batch Create Table
        • Checkpoint Backup
        • Checkpoint Restore
      • Back up and Restore Data Using Dumpling and TiDB Lightning
      • Back Up and Restore RawKV
      • Incremental Backup and Restore
  • Cluster Disaster Recovery (DR)
    • DR Solutions Overview
    • Primary-Secondary DR
    • Multi-Replica Cluster DR
    • BR-based DR
  • Resource Control
  • Configure Time Zone
  • Daily Checklist
  • Maintain TiFlash
  • Maintain TiDB Using TiUP
  • Modify Configuration Dynamically
  • Online Unsafe Recovery
  • Replicate Data Between Primary and Secondary Clusters
• Monitor and Alert
  • Monitoring Framework Overview
  • Monitoring API
  • Deploy Monitoring Services
  • Upgrade Monitoring Services
  • Export Grafana Snapshots
  • TiDB Cluster Alert Rules
  • TiFlash Alert Rules
  • Customize Configurations of Monitoring Servers
  • BR Monitoring and Alert
• Troubleshoot
  • Issue Summary
    • TiDB Troubleshooting Map
    • Troubleshoot TiDB Cluster Setup
    • Troubleshoot TiFlash
  • Issue Scenarios
    • Slow Queries
      • Identify Slow Queries
      • Analyze Slow Queries
    • TiDB OOM
    • Hotspot
    • Increased Read and Write Latency
    • Write Conflicts in Optimistic Transactions
    • High Disk I/O Usage
    • Lock Conflicts
    • Inconsistency Between Data and Indexes
  • Diagnostic Methods
    • SQL Diagnostics
    • Statement Summary Tables
    • Identify Expensive Queries Using Top SQL
    • Identify Expensive Queries Using Logs
    • Save and Restore the On-Site Information of a Cluster
    • Understanding Stale Read and safe-ts in TiKV
  • Support Resources
• Performance Tuning
  • Tuning Guide
    • Performance Tuning Overview
    • Configure TiDB for Optimal Performance
    • Performance Analysis and Tuning
    • Performance Tuning Practices for OLTP Scenarios
    • TiFlash Performance Analysis Methods
    • TiCDC Performance Analysis Methods
    • Latency Breakdown
    • TiDB Best Practices on Public Cloud
  • Configuration Tuning
    • Tune Operating System Performance
    • Tune TiDB Memory
    • Tune TiKV Threads
    • Tune TiKV Memory
    • TiKV Follower Read
    • TiKV MVCC In-Memory Engine
    • Tune Region Performance
    • Tune TiFlash Performance
    • Coprocessor Cache
    • Garbage Collection (GC)
      • Overview
      • Configuration
  • SQL Tuning
    • Overview
    • Understanding the Query Execution Plan
      • Overview
      • EXPLAIN Walkthrough
      • Indexes
      • Joins
      • MPP Queries
      • Subqueries
      • Aggregation
      • Views
      • Partitions
      • Index Merge
    • SQL Optimization Process
      • Overview
      • Logic Optimization
        • Overview
        • Subquery Related Optimizations
        • Column Pruning
        • Decorrelation of Correlated Subquery
        • Eliminate Max/Min
        • Predicates Push Down
        • Partition Pruning
        • TopN and Limit Push Down
        • Join Reorder
        • Derive TopN or Limit from Window Functions
      • Physical Optimization
        • Overview
        • Index Selection
        • Statistics
        • Extended Statistics
        • Wrong Index Solution
        • Distinct Optimization
        • Cost Model
        • Runtime Filter
      • Prepared Execution Plan Cache
      • Non-Prepared Execution Plan Cache
    • Control Execution Plans
      • Overview
      • Optimizer Hints
      • SQL Plan Management
      • The Blocklist of Optimization Rules and Expression Pushdown
      • Optimizer Fix Controls
• Tutorials
  • Multiple Availability Zones in One Region Deployment
  • Three Availability Zones in Two Regions Deployment
  • Two Availability Zones in One Region Deployment
  • Read Historical Data
    • Use Stale Read (Recommended)
      • Usage Scenarios of Stale Read
      • Perform Stale Read Using As OF TIMESTAMP
      • Perform Stale Read Using tidb_read_staleness
      • Perform Stale Read Using tidb_external_ts
    • Use the tidb_snapshot System Variable
  • Best Practices
    • Use TiDB
    • Java Application Development
    • Use HAProxy
    • Highly Concurrent Write
    • Grafana Monitoring
    • PD Scheduling
    • TiKV Performance Tuning with Massive Regions
    • Three-node Hybrid Deployment
    • Local Read Under Three Data Centers Deployment
    • Use UUIDs
    • Read-Only Storage Nodes
  • Use Placement Rules
  • Use Load Base Split
  • Use Store Limit
  • DDL Execution Principles and Best Practices
  • Use PD Microservices
    • PD Microservices Overview
    • Scale PD Microservice Nodes Using TiUP
    • TSO Configuration File
    • TSO Configuration Flags
    • Scheduling Configuration File
    • Scheduling Configuration Flags
• TiDB Tools
  • Overview
  • Use Cases
  • Download
  • TiUP
    • Documentation Map
    • Overview
    • Terminology and Concepts
    • Manage TiUP Components
    • FAQ
    • Troubleshooting Guide
    • Command Reference
      • Overview
      • TiUP Commands
        • tiup clean
        • tiup completion
        • tiup env
        • tiup help
        • tiup install
        • tiup list
        • tiup mirror
          • Overview
          • tiup mirror clone
          • tiup mirror genkey
          • tiup mirror grant
          • tiup mirror init
          • tiup mirror merge
          • tiup mirror modify
          • tiup mirror publish
          • tiup mirror rotate
          • tiup mirror set
          • tiup mirror sign
        • tiup status
        • tiup telemetry
        • tiup uninstall
        • tiup update
      • TiUP Cluster Commands
        • Overview
        • tiup cluster audit
        • tiup cluster audit cleanup
        • tiup cluster check
        • tiup cluster clean
        • tiup cluster deploy
        • tiup cluster destroy
        • tiup cluster disable
        • tiup cluster display
        • tiup cluster edit-config
        • tiup cluster enable
        • tiup cluster help
        • tiup cluster import
        • tiup cluster list
        • tiup cluster meta backup
        • tiup cluster meta restore
        • tiup cluster patch
        • tiup cluster prune
        • tiup cluster reload
        • tiup cluster rename
        • tiup cluster replay
        • tiup cluster restart
        • tiup cluster scale-in
        • tiup cluster scale-out
        • tiup cluster start
        • tiup cluster stop
        • tiup cluster template
        • tiup cluster upgrade
      • TiUP DM Commands
        • Overview
        • tiup dm audit
        • tiup dm deploy
        • tiup dm destroy
        • tiup dm disable
        • tiup dm display
        • tiup dm edit-config
        • tiup dm enable
        • tiup dm help
        • tiup dm import
        • tiup dm list
        • tiup dm patch
        • tiup dm prune
        • tiup dm reload
        • tiup dm replay
        • tiup dm restart
        • tiup dm scale-in
        • tiup dm scale-out
        • tiup dm start
        • tiup dm stop
        • tiup dm template
        • tiup dm upgrade
    • TiDB Cluster Topology Reference
    • DM Cluster Topology Reference
    • Mirror Reference Guide
    • TiUP Components
      • tiup-playground
      • tiup-cluster
      • tiup-mirror
      • tiup-bench
  • TiDB Operator
  • TiDB Data Migration
    • About TiDB Data Migration
    • Architecture
    • Quick Start
    • Best Practices
    • Deploy a DM cluster
      • Hardware and Software Requirements
      • Use TiUP (Recommended)
      • Use TiUP Offline
      • Use Binary
      • Use Kubernetes
    • Tutorials
      • Create a Data Source
      • Manage Data Sources
      • Configure Tasks
      • Shard Merge
      • Table Routing
      • Block and Allow Lists
      • Binlog Event Filter
      • Filter DMLs Using SQL Expressions
      • Online DDL Tool Support
      • Customize a Secret Key for Encryption and Decryption
      • Manage a Data Migration Task
        • Precheck a Task
        • Create a Task
        • Query Status
        • Pause a Task
        • Resume a Task
        • Stop a Task
    • Advanced Tutorials
      • Merge and Migrate Data from Sharded Tables
        • Overview
        • Pessimistic Mode
        • Optimistic Mode
        • Manually Handle Sharding DDL Lock
      • Migrate from MySQL Databases that Use GH-ost/PT-osc
      • Migrate Data to a Downstream TiDB Table with More Columns
      • Continuous Data Validation
    • Maintain
      • Cluster Upgrade
        • Maintain DM Clusters Using TiUP (Recommended)
        • Manually Upgrade from v1.0.x to v2.0+
      • Tools
        • Manage Using WebUI
        • Manage Using dmctl
      • Performance Tuning
        • Benchmarks
        • Optimize Configurations
        • Test DM Performance
        • Handle Performance Issues
      • Manage Data Sources
        • Switch the MySQL Instance to Be Migrated
      • Manage Tasks
        • Handle Failed DDL Statements
        • Manage Schemas of Tables to be Migrated
      • Export and Import Data Sources and Task Configurations of Clusters
      • Handle Alerts
      • Daily Check
    • Reference
      • Architecture
        • DM-worker
        • Safe Mode
        • Relay Log
        • DDL Handling
      • Mechanism
        • DML Replication Mechanism
      • Command Line
        • DM-master & DM-worker
      • Configuration Files
        • Overview
        • Upstream Database Configurations
        • Task Configurations
        • DM-master Configuration
        • DM-worker Configuration
        • Table Selector
      • OpenAPI
      • Compatibility Catalog
      • Secure
        • Enable TLS for DM Connections
        • Generate Self-signed Certificates
      • Monitoring and Alerts
        • Monitoring Metrics
        • Alert Rules
      • Error Codes
      • Glossary
      • Example
        • Migrate Data Using DM
        • Create a Data Migration Task
        • Best Practices of Data Migration in the Shard Merge Scenario
      • Troubleshoot
        • FAQ
        • Handle Errors
      • Release Notes
  • TiDB Lightning
    • Overview
    • IMPORT INTO vs. TiDB Lightning
    • Compatibility of TiDB Lightning and IMPORT INTO with TiCDC and Log Backup
    • Get Started
    • Deploy TiDB Lightning
    • Target Database Requirements
    • Data Sources
      • Data Match Rules
      • Rename databases and tables
      • CSV
      • SQL
      • Parquet
      • Compressed files
      • Customized File
      • Import data from Amazon S3
    • Physical Import Mode
      • Requirements and Limitations
      • Use Physical Import Mode
    • Logical Import Mode
      • Requirements and Limitations
      • Use Logical Import Mode
    • Prechecks
    • Table Filter
    • Checkpoints
    • Import Data in Parallel
    • Error Resolution
    • Troubleshooting
    • Reference
      • Configuration File
      • Command Line Flags
      • Monitoring
      • Web Interface
      • FAQ
      • Glossary
  • Dumpling
  • PingCAP Clinic Diagnostic Service
    • Overview
    • Quick Start
    • Troubleshoot Clusters Using PingCAP Clinic
    • PingCAP Clinic Diagnostic Data
  • TiSpark
    • User Guide
  • sync-diff-inspector
    • Overview
    • Data Check for Tables with Different Schema/Table Names
    • Data Check in the Sharding Scenario
    • Data Check in the DM Replication Scenario
  • TiProxy
    • Overview
    • Load Balancing Policies
    • Traffic Replay
    • Configuration
    • Command Line Parameters
    • Monitoring Metrics
    • API
    • Troubleshooting
    • Performance Test
• Reference
  • Cluster Architecture
    • Overview
    • Storage
    • Computing
    • Scheduling
    • TSO
  • Storage Engine - TiKV
    • TiKV Overview
    • RocksDB Overview
    • Titan Overview
    • Titan Configuration
    • Partitioned Raft KV
  • Storage Engine - TiFlash
    • Overview
    • Create TiFlash Replicas
    • Use TiDB to Read TiFlash Replicas
    • Use TiSpark to Read TiFlash Replicas
    • Use MPP Mode
    • Use FastScan
    • Disaggregated Storage and Compute Architecture and S3 Support
    • Supported Push-down Calculations
    • TiFlash Query Result Materialization
    • TiFlash Late Materialization
    • Spill to Disk
    • Data Validation
    • MinTSO Scheduler
    • Compatibility
    • Pipeline Execution Model
  • TiDB Distributed eXecution Framework (DXF)
    • Introduction
    • TiDB Global Sort
  • System Variables
  • Server Status Variables
  • Configuration File Parameters
    • tidb-server
    • tikv-server
    • tiflash-server
    • pd-server
  • CLI
    • tikv-ctl
    • pd-ctl
    • tidb-ctl
    • pd-recover
  • Command Line Flags
    • tidb-server
    • tikv-server
    • tiflash-server
    • pd-server
  • Key Monitoring Metrics
    • Overview
    • Performance Overview
    • TiDB
    • PD
    • TiKV
    • TiFlash
    • TiCDC
    • Resource Control
  • Privileges
    • Security Compatibility with MySQL
    • Privilege Management
    • User Account Management
    • TiDB Password Management
    • Role-Based Access Control
    • Certificate-Based Authentication
  • SQL
    • SQL Language Structure and Syntax
      • Attributes
        • AUTO_INCREMENT
        • AUTO_RANDOM
        • SHARD_ROW_ID_BITS
      • Literal Values
      • Schema Object Names
      • Keywords and Reserved Words
      • User-Defined Variables
      • Expression Syntax
      • Comment Syntax
    • SQL Statements
      • Overview
      • ADMIN
      • ADMIN ALTER DDL JOBS
      • ADMIN CANCEL DDL
      • ADMIN CHECKSUM TABLE
      • ADMIN CHECK [TABLE|INDEX]
      • ADMIN CLEANUP
      • ADMIN PAUSE DDL
      • ADMIN RECOVER INDEX
      • ADMIN RESUME DDL
      • ADMIN [SET|SHOW|UNSET] BDR ROLE
      • ADMIN SHOW DDL [JOBS|JOB QUERIES]
      • ALTER DATABASE
      • ALTER INSTANCE
      • ALTER PLACEMENT POLICY
      • ALTER RANGE
      • ALTER RESOURCE GROUP
      • ALTER SEQUENCE
      • ALTER TABLE
        • Overview
        • ADD COLUMN
        • ADD INDEX
        • ALTER INDEX
        • CHANGE COLUMN
        • COMPACT
        • DROP COLUMN
        • DROP INDEX
        • MODIFY COLUMN
        • RENAME INDEX
      • ALTER USER
      • ANALYZE TABLE
      • BACKUP
      • BATCH
      • BEGIN
      • CALIBRATE RESOURCE
      • CANCEL IMPORT JOB
      • COMMIT
      • CREATE BINDING
      • CREATE DATABASE
      • CREATE INDEX
      • CREATE PLACEMENT POLICY
      • CREATE RESOURCE GROUP
      • CREATE ROLE
      • CREATE SEQUENCE
      • CREATE TABLE LIKE
      • CREATE TABLE
      • CREATE USER
      • CREATE VIEW
      • DEALLOCATE
      • DELETE
      • DESC
      • DESCRIBE
      • DO
      • DROP BINDING
      • DROP DATABASE
      • DROP PLACEMENT POLICY
      • DROP RESOURCE GROUP
      • DROP ROLE
      • DROP SEQUENCE
      • DROP STATS
      • DROP TABLE
      • DROP USER
      • DROP VIEW
      • EXECUTE
      • EXPLAIN ANALYZE
      • EXPLAIN
      • FLASHBACK CLUSTER
      • FLASHBACK DATABASE
      • FLASHBACK TABLE
      • FLUSH PRIVILEGES
      • FLUSH STATUS
      • FLUSH TABLES
      • GRANT <privileges>
      • GRANT <role>
      • IMPORT INTO
      • INSERT
      • KILL
      • LOAD DATA
      • LOAD STATS
      • LOCK STATS
      • [LOCK|UNLOCK] TABLES
      • PREPARE
      • QUERY WATCH
      • RECOVER TABLE
      • RENAME USER
      • RENAME TABLE
      • REPLACE
      • RESTORE
      • REVOKE <privileges>
      • REVOKE <role>
      • ROLLBACK
      • SAVEPOINT
      • SELECT
      • SET DEFAULT ROLE
      • SET [NAMES|CHARACTER SET]
      • SET PASSWORD
      • SET RESOURCE GROUP
      • SET ROLE
      • SET TRANSACTION
      • SET <variable>
      • SHOW ANALYZE STATUS
      • SHOW [BACKUPS|RESTORES]
      • SHOW BINDINGS
      • SHOW BUILTINS
      • SHOW CHARACTER SET
      • SHOW COLLATION
      • SHOW COLUMN_STATS_USAGE
      • SHOW COLUMNS FROM
      • SHOW CONFIG
      • SHOW CREATE DATABASE
      • SHOW CREATE PLACEMENT POLICY
      • SHOW CREATE RESOURCE GROUP
      • SHOW CREATE SEQUENCE
      • SHOW CREATE TABLE
      • SHOW CREATE USER
      • SHOW DATABASES
      • SHOW ENGINES
      • SHOW ERRORS
      • SHOW FIELDS FROM
      • SHOW GRANTS
      • SHOW IMPORT JOB
      • SHOW INDEXES
      • SHOW MASTER STATUS
      • SHOW PLACEMENT
      • SHOW PLACEMENT FOR
      • SHOW PLACEMENT LABELS
      • SHOW PLUGINS
      • SHOW PRIVILEGES
      • SHOW PROCESSLIST
      • SHOW PROFILES
      • SHOW SCHEMAS
      • SHOW STATS_BUCKETS
      • SHOW STATS_HEALTHY
      • SHOW STATS_HISTOGRAMS
      • SHOW STATS_LOCKED
      • SHOW STATS_META
      • SHOW STATS_TOPN
      • SHOW STATUS
      • SHOW TABLE NEXT_ROW_ID
      • SHOW TABLE REGIONS
      • SHOW TABLE STATUS
      • SHOW TABLES
      • SHOW VARIABLES
      • SHOW WARNINGS
      • SHUTDOWN
      • SPLIT REGION
      • START TRANSACTION
      • TABLE
      • TRACE
      • TRUNCATE
      • UNLOCK STATS
      • UPDATE
      • USE
      • WITH
    • Data Types
      • Overview
      • Default Values
      • Numeric Types
      • Date and Time Types
      • String Types
      • JSON Type
      • Vector 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
      • Vector Functions and Operators
      • JSON Functions
        • Overview
        • Functions That Create JSON
        • Functions That Search JSON
        • Functions That Modify JSON
        • Functions That Return JSON
        • JSON Utility Functions
        • Functions That Aggregate JSON
        • Functions That Validate JSON
      • Aggregate (GROUP BY) Functions
      • GROUP BY Modifiers
      • Window Functions
      • Miscellaneous Functions
      • Precision Math
      • Set Operations
      • Sequence Functions
      • List of Expressions for Pushdown
      • TiDB Specific Functions
      • Comparisons between Functions and Syntax of Oracle and TiDB
    • Clustered Indexes
    • Vector Index
    • Constraints
    • Generated Columns
    • SQL Mode
    • Table Attributes
    • Transactions
      • Overview
      • Isolation Levels
      • Optimistic Transactions
      • Pessimistic Transactions
      • Non-Transactional DML Statements
    • Views
    • Partitioning
    • Temporary Tables
    • Cached Tables
    • FOREIGN KEY Constraints
    • Character Set and Collation
      • Overview
      • GBK
    • Placement Rules in SQL
    • System Tables
      • mysql Schema
        • Overview
        • user
      • INFORMATION_SCHEMA
        • Overview
        • ANALYZE_STATUS
        • CHECK_CONSTRAINTS
        • CLIENT_ERRORS_SUMMARY_BY_HOST
        • CLIENT_ERRORS_SUMMARY_BY_USER
        • CLIENT_ERRORS_SUMMARY_GLOBAL
        • CHARACTER_SETS
        • CLUSTER_CONFIG
        • CLUSTER_HARDWARE
        • CLUSTER_INFO
        • CLUSTER_LOAD
        • CLUSTER_LOG
        • CLUSTER_SYSTEMINFO
        • COLLATIONS
        • COLLATION_CHARACTER_SET_APPLICABILITY
        • COLUMNS
        • DATA_LOCK_WAITS
        • DDL_JOBS
        • DEADLOCKS
        • ENGINES
        • INSPECTION_RESULT
        • INSPECTION_RULES
        • INSPECTION_SUMMARY
        • KEYWORDS
        • KEY_COLUMN_USAGE
        • MEMORY_USAGE
        • MEMORY_USAGE_OPS_HISTORY
        • METRICS_SUMMARY
        • METRICS_TABLES
        • PARTITIONS
        • PLACEMENT_POLICIES
        • PROCESSLIST
        • REFERENTIAL_CONSTRAINTS
        • RESOURCE_GROUPS
        • RUNAWAY_WATCHES
        • SCHEMATA
        • SEQUENCES
        • SESSION_VARIABLES
        • SLOW_QUERY
        • STATISTICS
        • TABLES
        • TABLE_CONSTRAINTS
        • TABLE_STORAGE_STATS
        • TIDB_CHECK_CONSTRAINTS
        • TIDB_HOT_REGIONS
        • TIDB_HOT_REGIONS_HISTORY
        • TIDB_INDEXES
        • TIDB_INDEX_USAGE
        • TIDB_SERVERS_INFO
        • TIDB_TRX
        • TIFLASH_REPLICA
        • TIFLASH_SEGMENTS
        • TIFLASH_TABLES
        • TIKV_REGION_PEERS
        • TIKV_REGION_STATUS
        • TIKV_STORE_STATUS
        • USER_ATTRIBUTES
        • USER_PRIVILEGES
        • VARIABLES_INFO
        • VIEWS
      • METRICS_SCHEMA
      • PERFORMANCE_SCHEMA
        • Overview
        • SESSION_CONNECT_ATTRS
      • SYS
        • Overview
        • schema_unused_indexes
    • Metadata Lock
    • TiDB Accelerated Table Creation
    • Schema Cache
  • UI
    • TiDB Dashboard
      • Overview
      • Maintain
        • Deploy
        • Reverse Proxy
        • User Management
        • Secure
      • Access
      • Overview Page
      • Cluster Info Page
      • Top SQL Page
      • Key Visualizer Page
      • Metrics Relation Graph
      • SQL Statements Analysis
        • SQL Statements Page
        • SQL Details Page
      • Slow Queries Page
      • Cluster Diagnostics
        • Access Cluster Diagnostics Page
        • View Diagnostics Report
        • Use Diagnostics
      • Monitoring Page
      • Search Logs Page
      • Resource Manager Page
      • Instance Profiling
        • Manual Profiling
        • Continuous Profiling
      • Session Management and Configuration
        • Share Session
        • Configure SSO
      • FAQ
  • Telemetry
  • Error Codes
  • Table Filter
  • Schedule Replicas by Topology Labels
  • URI Formats of External Storage Services
• FAQs
  • FAQ Summary
  • TiDB FAQs
  • SQL FAQs
  • Deployment FAQs
  • Migration FAQs
  • Upgrade FAQs
  • Monitoring FAQs
  • Cluster Management FAQs
  • High Availability FAQs
  • High Reliability FAQs
  • Backup and Restore FAQs
• Release Notes
  • All Releases
  • Release Timeline
  • TiDB Versioning
  • TiDB Installation Packages
  • v8.4
    • 8.4.0-DMR
  • v8.3
    • 8.3.0-DMR
  • v8.2
    • 8.2.0-DMR
  • v8.1
    • 8.1.1
    • 8.1.0
  • v8.0
    • 8.0.0-DMR
  • v7.6
    • 7.6.0-DMR
  • v7.5
    • 7.5.4
    • 7.5.3
    • 7.5.2
    • 7.5.1
    • 7.5.0
  • v7.4
    • 7.4.0-DMR
  • v7.3
    • 7.3.0-DMR
  • v7.2
    • 7.2.0-DMR
  • v7.1
    • 7.1.6
    • 7.1.5
    • 7.1.4
    • 7.1.3
    • 7.1.2
    • 7.1.1
    • 7.1.0
  • v7.0
    • 7.0.0-DMR
  • v6.6
    • 6.6.0-DMR
  • v6.5
    • 6.5.11
    • 6.5.10
    • 6.5.9
    • 6.5.8
    • 6.5.7
    • 6.5.6
    • 6.5.5
    • 6.5.4
    • 6.5.3
    • 6.5.2
    • 6.5.1
    • 6.5.0
  • v6.4
    • 6.4.0-DMR
  • v6.3
    • 6.3.0-DMR
  • v6.2
    • 6.2.0-DMR
  • v6.1
    • 6.1.7
    • 6.1.6
    • 6.1.5
    • 6.1.4
    • 6.1.3
    • 6.1.2
    • 6.1.1
    • 6.1.0
  • v6.0
    • 6.0.0-DMR
  • v5.4
    • 5.4.3
    • 5.4.2
    • 5.4.1
    • 5.4.0
  • v5.3
    • 5.3.4
    • 5.3.3
    • 5.3.2
    • 5.3.1
    • 5.3.0
  • v5.2
    • 5.2.4
    • 5.2.3
    • 5.2.2
    • 5.2.1
    • 5.2.0
  • v5.1
    • 5.1.5
    • 5.1.4
    • 5.1.3
    • 5.1.2
    • 5.1.1
    • 5.1.0
  • v5.0
    • 5.0.6
    • 5.0.5
    • 5.0.4
    • 5.0.3
    • 5.0.2
    • 5.0.1
    • 5.0 GA
    • 5.0.0-rc
  • v4.0
    • 4.0.16
    • 4.0.15
    • 4.0.14
    • 4.0.13
    • 4.0.12
    • 4.0.11
    • 4.0.10
    • 4.0.9
    • 4.0.8
    • 4.0.7
    • 4.0.6
    • 4.0.5
    • 4.0.4
    • 4.0.3
    • 4.0.2
    • 4.0.1
    • 4.0 GA
    • 4.0.0-rc.2
    • 4.0.0-rc.1
    • 4.0.0-rc
    • 4.0.0-beta.2
    • 4.0.0-beta.1
    • 4.0.0-beta
  • v3.1
    • 3.1.2
    • 3.1.1
    • 3.1.0 GA
    • 3.1.0-rc
    • 3.1.0-beta.2
    • 3.1.0-beta.1
    • 3.1.0-beta
  • v3.0
    • 3.0.20
    • 3.0.19
    • 3.0.18
    • 3.0.17
    • 3.0.16
    • 3.0.15
    • 3.0.14
    • 3.0.13
    • 3.0.12
    • 3.0.11
    • 3.0.10
    • 3.0.9
    • 3.0.8
    • 3.0.7
    • 3.0.6
    • 3.0.5
    • 3.0.4
    • 3.0.3
    • 3.0.2
    • 3.0.1
    • 3.0 GA
    • 3.0.0-rc.3
    • 3.0.0-rc.2
    • 3.0.0-rc.1
    • 3.0.0-beta.1
    • 3.0.0-beta
  • v2.1
    • 2.1.19
    • 2.1.18
    • 2.1.17
    • 2.1.16
    • 2.1.15
    • 2.1.14
    • 2.1.13
    • 2.1.12
    • 2.1.11
    • 2.1.10
    • 2.1.9
    • 2.1.8
    • 2.1.7
    • 2.1.6
    • 2.1.5
    • 2.1.4
    • 2.1.3
    • 2.1.2
    • 2.1.1
    • 2.1 GA
    • 2.1 RC5
    • 2.1 RC4
    • 2.1 RC3
    • 2.1 RC2
    • 2.1 RC1
    • 2.1 Beta
  • v2.0
    • 2.0.11
    • 2.0.10
    • 2.0.9
    • 2.0.8
    • 2.0.7
    • 2.0.6
    • 2.0.5
    • 2.0.4
    • 2.0.3
    • 2.0.2
    • 2.0.1
    • 2.0
    • 2.0 RC5
    • 2.0 RC4
    • 2.0 RC3
    • 2.0 RC1
    • 1.1 Beta
    • 1.1 Alpha
  • v1.0
    • 1.0.8
    • 1.0.7
    • 1.0.6
    • 1.0.5
    • 1.0.4
    • 1.0.3
    • 1.0.2
    • 1.0.1
    • 1.0
    • Pre-GA
    • RC4
    • RC3
    • RC2
    • RC1
• Glossary