TOC.md

TiDB Documentation

Documentation List

• About TiDB
  • TiDB Introduction
  • What's New in TiDB 5.0
  • Basic Features
  • Benchmarks
    • Interaction Test on Online Workloads and ADD INDEX
  • MySQL Compatibility
  • TiDB Limitations
  • TiDB Adopters
  • Credits
• Quick Start
  • Try Out TiDB
  • Learn TiDB SQL
  • Import Example Database
• Deploy
  • Software and Hardware Requirements
  • Environment Configuration Checklist
  • Topology Patterns
    • Minimal Topology
    • TiFlash Topology
    • TiCDC Topology
    • TiDB Binlog Topology
    • TiSpark Topology
    • Cross-DC Topology
    • Hybrid Topology
  • Install and Start
    • Linux OS
      • Use TiUP (Recommended)
      • Use TiUP Offline (Recommended)
      • Deploy in Kubernetes
  • Verify Cluster Status
• Migrate
  • Overview
  • Migrate from MySQL
    • Migrate Using Dumpling and TiDB Lightning
    • Migrate from Amazon Aurora MySQL Using DM
  • Migrate from CSV Files
    • Use TiDB Lightning
    • Use LOAD DATA Statement
  • Migrate from SQL Files
• Maintain
  • Upgrade
    • Use TiUP (Recommended)
    • Use TiUP Offline (Recommended)
    • Use TiDB Operator
  • Scale
    • Use TiUP (Recommended)
    • Use TiDB Operator
  • Backup and Restore
    • Use BR Tool (Recommended)
      • Use BR Tool
      • BR Use Cases
      • BR Storages
    • Use Dumpling and TiDB Lightning (Recommended)
  • Read Historical Data
  • Configure Time Zone
  • Daily Checklist
  • Maintain TiFlash
  • Maintain TiDB Using TiUP
  • Modify Configuration Online
• Monitor and Alert
  • Monitoring Framework Overview
  • Monitoring API
  • Deploy Monitoring Services
  • Export Grafana Snapshots
  • TiDB Cluster Alert Rules
  • TiFlash Alert Rules
• Troubleshoot
  • TiDB Troubleshooting Map
  • Identify Slow Queries
  • Analyze Slow Queries
  • SQL Diagnostics
  • Identify Expensive Queries
  • Statement Summary Tables
  • Troubleshoot Hotspot Issues
  • Troubleshoot Increased Read and Write Latency
  • Troubleshoot Cluster Setup
  • Troubleshoot High Disk I/O Usage
  • Troubleshoot Lock Conflicts
  • Troubleshoot TiFlash
  • Troubleshoot Write Conflicts in Optimistic Transactions
• Performance Tuning
  • System Tuning
    • Operating System Tuning
  • Software Tuning
    • Configuration
      • Tune TiDB Memory
      • Tune TiKV Threads
      • Tune TiKV Memory
      • TiKV Follower Read
      • TiFlash Tuning
    • Coprocessor Cache
  • SQL Tuning
    • Overview
    • Understanding the Query Execution Plan
      • Overview
      • EXPLAIN Walkthrough
      • Indexes
      • Joins
      • Subqueries
      • Aggregation
      • Views
      • Partitions
    • 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
      • Physical Optimization
        • Overview
        • Index Selection
        • Statistics
        • Wrong Index Solution
        • Distinct Optimization
      • Prepare Execution Plan Cache
    • Control Execution Plans
      • Overview
      • Optimizer Hints
      • SQL Plan Management
      • The Blocklist of Optimization Rules and Expression Pushdown
• Tutorials
  • Multiple Data Centers in One City Deployment
  • Three Data Centers in Two Cities Deployment
  • 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
  • Use Placement Rules
  • Use Load Base Split
  • Use Store Limit
• TiDB Ecosystem Tools
  • Overview
  • Use Cases
  • Download
  • Backup & Restore (BR)
    • Use BR Tool
    • BR Use Cases
    • BR FAQ
  • TiDB Binlog
    • Overview
    • Quick Start
    • Deploy
    • Maintain
    • Configure
      • Pump
      • Drainer
    • Upgrade
    • Monitor
    • Reparo
    • binlogctl
    • Binlog Consumer Client
    • TiDB Binlog Relay Log
    • Bidirectional Replication Between TiDB Clusters
    • Glossary
    • Troubleshoot
      • Troubleshoot
      • Handle Errors
    • FAQ
  • TiDB Lightning
    • Overview
    • Tutorial
    • Deploy
    • Configure
    • Key Features
      • Checkpoints
      • Table Filter
      • CSV Support
      • Backends
      • Web Interface
    • Monitor
    • FAQ
    • Glossary
  • TiCDC
    • Overview
    • Deploy
    • Maintain
    • Troubleshoot
    • TiCDC Open Protocol
    • Integrate TiDB with Confluent Platform
  • Dumpling
  • sync-diff-inspector
    • Overview
    • Data Check for Tables with Different Schema/Table Names
    • Data Check in Sharding Scenarios
    • Data Check for TiDB Upstream/Downstream Clusters
  • TiSpark
    • Quick Start
    • User Guide
• Reference
  • Cluster Architecture
    • Overview
    • Storage
    • Computing
    • Scheduling
  • Key Monitoring Metrics
    • Overview
    • TiDB
    • PD
    • TiKV
    • TiFlash
  • Secure
    • 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
  • Privileges
    • Security Compatibility with MySQL
    • Privilege Management
    • User Account 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
      • ADD COLUMN
      • ADD INDEX
      • ADMIN
      • ADMIN CANCEL DDL
      • ADMIN CHECKSUM TABLE
      • ADMIN CHECK [TABLE|INDEX]
      • ADMIN SHOW DDL [JOBS|QUERIES]
      • ALTER DATABASE
      • ALTER INDEX
      • ALTER INSTANCE
      • ALTER TABLE
      • ALTER USER
      • ANALYZE TABLE
      • BACKUP
      • BEGIN
      • CHANGE COLUMN
      • COMMIT
      • CHANGE DRAINER
      • CHANGE PUMP
      • CREATE [GLOBAL|SESSION] BINDING
      • CREATE DATABASE
      • CREATE INDEX
      • CREATE ROLE
      • CREATE SEQUENCE
      • CREATE TABLE LIKE
      • CREATE TABLE
      • CREATE USER
      • CREATE VIEW
      • DEALLOCATE
      • DELETE
      • DESC
      • DESCRIBE
      • DO
      • DROP [GLOBAL|SESSION] BINDING
      • DROP COLUMN
      • DROP DATABASE
      • DROP INDEX
      • DROP ROLE
      • DROP SEQUENCE
      • DROP STATS
      • DROP TABLE
      • DROP USER
      • DROP VIEW
      • EXECUTE
      • EXPLAIN ANALYZE
      • EXPLAIN
      • FLASHBACK TABLE
      • FLUSH PRIVILEGES
      • FLUSH STATUS
      • FLUSH TABLES
      • GRANT <privileges>
      • GRANT <role>
      • INSERT
      • KILL [TIDB]
      • LOAD DATA
      • LOAD STATS
      • MODIFY COLUMN
      • PREPARE
      • RECOVER TABLE
      • RENAME INDEX
      • RENAME TABLE
      • REPLACE
      • RESTORE
      • REVOKE <privileges>
      • REVOKE <role>
      • ROLLBACK
      • SELECT
      • SET DEFAULT ROLE
      • SET [NAMES|CHARACTER SET]
      • SET PASSWORD
      • SET ROLE
      • SET TRANSACTION
      • SET [GLOBAL|SESSION] <variable>
      • SHOW ANALYZE STATUS
      • SHOW [BACKUPS|RESTORES]
      • SHOW [GLOBAL|SESSION] BINDINGS
      • SHOW BUILTINS
      • SHOW CHARACTER SET
      • SHOW COLLATION
      • SHOW [FULL] COLUMNS FROM
      • SHOW CONFIG
      • SHOW CREATE SEQUENCE
      • SHOW CREATE TABLE
      • SHOW CREATE USER
      • SHOW DATABASES
      • SHOW DRAINER STATUS
      • SHOW ENGINES
      • SHOW ERRORS
      • SHOW [FULL] FIELDS FROM
      • SHOW GRANTS
      • SHOW INDEX [FROM|IN]
      • SHOW INDEXES [FROM|IN]
      • SHOW KEYS [FROM|IN]
      • SHOW MASTER STATUS
      • SHOW PLUGINS
      • SHOW PRIVILEGES
      • SHOW [FULL] PROCESSSLIST
      • SHOW PROFILES
      • SHOW PUMP STATUS
      • SHOW SCHEMAS
      • SHOW STATS_HEALTHY
      • SHOW STATS_HISTOGRAMS
      • SHOW STATS_META
      • SHOW STATUS
      • SHOW TABLE NEXT_ROW_ID
      • SHOW TABLE REGIONS
      • SHOW TABLE STATUS
      • SHOW [FULL] TABLES
      • SHOW [GLOBAL|SESSION] VARIABLES
      • SHOW WARNINGS
      • SHUTDOWN
      • SPLIT REGION
      • START TRANSACTION
      • TRACE
      • TRUNCATE
      • UPDATE
      • USE
    • Data Types
      • Overview
      • Default Values
      • Numeric Types
      • Date and Time Types
      • String Types
      • JSON Type
    • 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
      • Information Functions
      • JSON Functions
      • Aggregate (GROUP BY) Functions
      • Window Functions
      • Miscellaneous Functions
      • Precision Math
      • Set Operations
      • List of Expressions for Pushdown
    • Clustered Indexes
    • Constraints
    • Generated Columns
    • SQL Mode
    • Transactions
      • Overview
      • Isolation Levels
      • Optimistic Transactions
      • Pessimistic Transactions
    • Garbage Collection (GC)
      • Overview
      • Configuration
    • Views
    • Partitioning
    • Character Set and Collation
    • System Tables
      • mysql
      • INFORMATION_SCHEMA
        • Overview
        • ANALYZE_STATUS
        • CHARACTER_SETS
        • CLUSTER_CONFIG
        • CLUSTER_HARDWARE
        • CLUSTER_INFO
        • CLUSTER_LOAD
        • CLUSTER_LOG
        • CLUSTER_SYSTEMINFO
        • COLLATIONS
        • COLLATION_CHARACTER_SET_APPLICABILITY
        • COLUMNS
        • DDL_JOBS
        • ENGINES
        • INSPECTION_RESULT
        • INSPECTION_RULES
        • INSPECTION_SUMMARY
        • KEY_COLUMN_USAGE
        • METRICS_SUMMARY
        • METRICS_TABLES
        • PARTITIONS
        • PROCESSLIST
        • SCHEMATA
        • SEQUENCES
        • SESSION_VARIABLES
        • SLOW_QUERY
        • STATISTICS
        • TABLES
        • TABLE_CONSTRAINTS
        • TABLE_STORAGE_STATS
        • TIDB_HOT_REGIONS
        • TIDB_INDEXES
        • TIDB_SERVERS_INFO
        • TIFLASH_REPLICA
        • TIKV_REGION_PEERS
        • TIKV_REGION_STATUS
        • TIKV_STORE_STATUS
        • USER_PRIVILEGES
        • VIEWS
      • METRICS_SCHEMA
  • UI
    • TiDB Dashboard
      • Overview
      • Maintain
        • Deploy
        • Reverse Proxy
        • Secure
      • Access
      • Overview Page
      • Cluster Info 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
      • Search Logs Page
      • Profile Instances Page
      • FAQ
  • CLI
    • tikv-ctl
    • pd-ctl
    • tidb-ctl
    • pd-recover
  • Command Line Flags
    • tidb-server
    • tikv-server
    • tiflash-server
    • pd-server
  • Configuration File Parameters
    • tidb-server
    • tikv-server
    • tiflash-server
    • pd-server
  • System Variables
  • Storage Engines
    • TiKV
      • TiKV Overview
      • RocksDB Overview
      • Titan Overview
      • Titan Configuration
    • TiFlash
      • Overview
      • Use TiFlash
  • TiUP
    • Documentation Guide
    • Overview
    • Terminology and Concepts
    • Manage TiUP Components
    • FAQ
    • Troubleshooting Guide
    • TiUP Components
      • tiup-playground
      • tiup-cluster
      • tiup-mirror
      • tiup-bench
  • Telemetry
  • Errors Codes
  • Table Filter
  • Schedule Replicas by Topology Labels
• FAQs
  • TiDB FAQs
  • SQL FAQs
  • Deploy and Maintain FAQs
  • Upgrade FAQs
  • High Availability FAQs
  • High Reliability FAQs
  • Migration FAQs
• Glossary
• Release Notes
  • All Releases
  • TiDB Roadmap
  • v5.0
    • 5.0.0-rc
  • v4.0
    • 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