docs/TOC-tidb-cloud.md at release-6.5 · pingcap/docs · GitHub

Docs Home
About TiDB Cloud
Get Started
Develop Applications
- Overview
- Quick Start
  - Build a TiDB Serverless Cluster in TiDB Cloud
  - CRUD SQL in TiDB
- Connect to TiDB Cloud
  - GUI Database Tools
  - Choose Driver or ORM
  - Java
  - Go
    - Go-MySQL-Driver
    - GORM
  - Python
  - Node.js
    - node-mysql2
    - mysql.js
    - Prisma
    - Sequelize
    - TypeORM
    - Next.js
    - AWS Lambda
  - Ruby
    - mysql2
    - Rails
- Third-Party Support
  - Third-Party Tools Supported by TiDB
  - Known Incompatibility Issues with Third-Party Tools
- Development Reference
  - Design Database Schema
  - Write Data
  - 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
    - FastScan
  - Transaction
  - 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
  - Development Guidelines
    - Object Naming Convention
    - SQL Development Specifications
  - Bookshop Example Application
Manage Cluster
- Plan Your Cluster
- Manage TiDB Serverless Clusters
  - Create a TiDB Serverless Cluster
  - Connect to Your TiDB Serverless Cluster
  - Branch (Beta)
  - Manage Spending Limit
  - Back Up and Restore TiDB Serverless Data
- Manage TiDB Dedicated Clusters
  - Create a TiDB Dedicated Cluster
  - Connect to Your TiDB Dedicated Cluster
  - Scale a TiDB Dedicated Cluster
  - Back Up and Restore TiDB Dedicated Data
  - Pause or Resume a TiDB Dedicated Cluster
  - Configure Maintenance Window
- Use an HTAP Cluster with TiFlash
- Monitor and Alert
- Tune Performance
  - Overview
  - Analyze Performance
  - 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
      - Physical Optimization
        
        Overview
        
        Index Selection
        
        Statistics
        
        Extended Statistics
        
        Wrong Index Solution
        
        Distinct Optimization
        
        Cost Model
      - Prepare Execution Plan Cache
    - Control Execution Plans
  - TiKV Follower Read
  - Coprocessor Cache
  - Garbage Collection (GC)
    - Overview
    - Configuration
  - Tune TiFlash Performance
- Upgrade a TiDB Cluster
- Delete a TiDB Cluster
Migrate or Import Data
Explore Data
- Chat2Query (Beta)
Data Service (Beta)
Stream Data
Security
- Identity Access Control
- Network Access Control
  - TiDB Serverless
    - Connect via Private Endpoint
    - TLS Connections to TiDB Serverless
  - TiDB Dedicated
- Data Access Control
  - Encryption at Rest Using Customer-Managed Encryption Keys
- Database Access Control
  - Configure Cluster Security Settings
- Audit Management
  - Database Audit Logging
  - Console Audit Logging
Billing
API
- API Overview
- API Reference
Integrations
- Airbyte
- Amazon AppFlow
- AWS Lambda
- Cloudflare
- Datadog
- dbt
- Gitpod
- n8n
- Netlify
- New Relic
- Prometheus and Grafana
- ProxySQL
- Terraform
- Vercel
- Zapier
Reference
- TiDB Cluster Architecture
  - Overview
  - Storage
  - Computing
  - Scheduling
  - TSO
- TiDB Dedicated Limitations and Quotas
- TiDB Serverless Limitations
- Limited SQL Features on TiDB Cloud
- TiDB Limitations
- Benchmarks
  - TPC-C Performance Test Report
  - Sysbench Performance Test Report
- SQL
  - Explore SQL with TiDB
  - SQL Language Structure and Syntax
    - Attributes
    - 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|JOB QUERIES]
    - ALTER DATABASE
    - ALTER INDEX
    - ALTER TABLE
    - ALTER TABLE COMPACT
    - ALTER USER
    - ANALYZE TABLE
    - BATCH
    - 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 CLUSTER
    - FLASHBACK DATABASE
    - FLASHBACK TABLE
    - FLUSH PRIVILEGES
    - FLUSH STATUS
    - FLUSH TABLES
    - GRANT <privileges>
    - GRANT <role>
    - INSERT
    - KILL [TIDB]
    - LOCK STATS
    - MODIFY COLUMN
    - PREPARE
    - RECOVER TABLE
    - RENAME INDEX
    - RENAME TABLE
    - RENAME USER
    - REPLACE
    - REVOKE <privileges>
    - REVOKE <role>
    - ROLLBACK
    - SAVEPOINT
    - SELECT
    - SET DEFAULT ROLE
    - SET [NAMES|CHARACTER SET]
    - SET PASSWORD
    - SET ROLE
    - SET TRANSACTION
    - SET [GLOBAL|SESSION] <variable>
    - SHOW ANALYZE STATUS
    - SHOW [GLOBAL|SESSION] BINDINGS
    - SHOW BUILTINS
    - SHOW CHARACTER SET
    - SHOW COLLATION
    - SHOW [FULL] COLUMNS FROM
    - SHOW CREATE DATABASE
    - 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 PROCESSLIST
    - SHOW PROFILES
    - SHOW PUMP STATUS
    - SHOW SCHEMAS
    - SHOW STATS_HEALTHY
    - SHOW STATS_HISTOGRAMS
    - SHOW STATS_LOCKED
    - 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
    - TABLE
    - TRACE
    - TRUNCATE
    - UNLOCK STATS
    - UPDATE
    - USE
    - WITH
  - 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
    - 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
    - Overview
    - Isolation Levels
    - Optimistic Transactions
    - Pessimistic Transactions
    - Non-Transactional DML Statements
  - Views
  - Partitioning
  - Temporary Tables
  - Cached Tables
  - Character Set and Collation
    - Overview
    - GBK
  - Read Historical Data
    - Use Stale Read (Recommended)
    - Use the tidb_snapshot System Variable
  - System Tables
    - mysql
    - INFORMATION_SCHEMA
  - Metadata Lock
  - Use UUIDs
- System Variables
- Storage Engines
  - TiKV
    - TiKV Overview
    - RocksDB Overview
  - TiFlash
    - TiFlash Overview
- CLI
  - Overview
  - cluster
    - create
    - delete
    - describe
    - list
    - connect-info
  - branch
    - create
    - delete
    - describe
    - list
    - connect-info
  - config
    - create
    - delete
    - describe
    - edit
    - list
    - set
    - use
  - connect
  - import
    - cancel
    - describe
    - list
    - start
      - local
      - s3
      - mysql
  - project
    - list
  - update
- Table Filter
- Troubleshoot Inconsistency Between Data and Indexes
- Support
- Glossary
FAQs
- TiDB Cloud FAQs
- TiDB Serverless FAQs
Release Notes
- 2023
- 2022
- 2021
- 2020