887 lines (876 loc) · 56.1 KB

Table of Contents

GET STARTED

Why TiDB Cloud
- TiDB Cloud Introduction
- MySQL Compatibility
Get Started with TiDB Cloud
Key Concepts
- Overview
- Architecture
- Database Schema
- Transactions
- SQL
- AI Features
- Data Service
- Scalability
- High Availability
  - High Availability in TiDB Cloud Serverless
  - High Availability in TiDB Cloud Dedicated
- Monitoring
- Data Streaming
- Backup & Restore
- Security

DEVELOP

Development Quick Start
Connect to TiDB Cloud
- GUI Database Tools
- Choose Driver or ORM
- BI
  - Looker Studio
- Java
- Go
  - Go-MySQL-Driver
  - GORM
- Python
- Node.js
  - node-mysql2
  - mysql.js
  - Prisma
  - Sequelize
  - TypeORM
  - Next.js
  - AWS Lambda
- Ruby
  - mysql2
  - Rails
- C#
  - C#
- WordPress
- Serverless Driver
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
- 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
- Third-Party Support
  - Third-Party Tools Supported by TiDB
  - Known Incompatibility Issues with Third-Party Tools

GUIDES

Manage Cluster
- Plan Your Cluster
- Manage TiDB Cloud Serverless Clusters
  - Create a TiDB Cloud Serverless Cluster
  - Connect to Your TiDB Cloud Serverless Cluster
  - Branch
  - Manage Spending Limit
  - Back Up and Restore TiDB Cloud Serverless Data
  - Export Data from TiDB Cloud Serverless
- Manage TiDB Cloud Dedicated Clusters
- Use an HTAP Cluster with TiFlash
- Monitor and Alert
  - Overview
  - Built-in Metrics
  - Built-in Alerting
  - Subscribe to Alert Notifications
  - Cluster Events
  - Third-Party Metrics Integrations
  - TiDB Cloud Clinic
- Tune Performance
  - Overview
  - Analyze Performance
    - Use the Diagnosis Tab
    - Use Statement Summary Tables
  - 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
    - Index Advisor
  - TiKV Follower Read
  - Coprocessor Cache
  - Garbage Collection (GC)
    - Overview
    - Configuration
  - Tune TiFlash Performance
- Optimize Resource Allocation
  - Resource Manager
  - TiDB Node Group
    - Overview of TiDB Node Group
    - Manage TiDB Node Groups
- Upgrade a TiDB Cluster
- Delete a TiDB Cluster
Migrate or Import Data
- Overview
- Migrate Data into TiDB Cloud
- Import Data into TiDB Cloud Dedicated
- Import Data into TiDB Cloud Serverless
- Reference
Explore Data
- Chat2Query in SQL Editor
- SQL Proxy Account
Vector Search
- Overview
- Get Started
  - Get Started with SQL
  - Get Started with Python
- Integrations
  - Overview
  - AI Frameworks
    - LlamaIndex
    - Langchain
  - AI Services
    - Amazon Bedrock
  - Embedding Models/Services
    - Jina AI
  - ORM Libraries
- Text Search
- Reference
- Improve Performance
- Limitations
- Changelogs
Data Service
Stream Data
Disaster Recovery
Security
- Identity Access Control
- Network Access Control
  - TiDB Cloud Serverless
  - TiDB Cloud Dedicated
- Data Access Control
  - Encryption at Rest Using Customer-Managed Encryption Keys
  - User-Controlled Log Redaction
- Database Access Control
  - Configure Cluster Password Settings
- Audit Management
Billing
Integrations

REFERENCE

SQL Reference
- 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
  - Overview
  - ADMIN
  - ADMIN ALTER DDL JOBS
  - ADMIN CANCEL DDL
  - ADMIN CHECKSUM TABLE
  - ADMIN CHECK [TABLE|INDEX]
  - ADMIN CLEANUP INDEX
  - ADMIN PAUSE DDL
  - ADMIN RECOVER INDEX
  - ADMIN RESUME DDL
  - 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
  - CANCEL IMPORT JOB
  - COMMIT
  - CREATE [GLOBAL|SESSION] 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 [GLOBAL|SESSION] 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 [TIDB]
  - LOAD DATA
  - LOAD STATS
  - LOCK STATS
  - LOCK TABLES and UNLOCK TABLES
  - PREPARE
  - QUERY WATCH
  - RECOVER TABLE
  - RENAME TABLE
  - RENAME USER
  - 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 [GLOBAL|SESSION] <variable>
  - SHOW ANALYZE STATUS
  - SHOW [BACKUPS|RESTORES]
  - SHOW [GLOBAL|SESSION] BINDINGS
  - SHOW BUILTINS
  - SHOW CHARACTER SET
  - SHOW COLLATION
  - SHOW COLUMN_STATS_USAGE
  - SHOW COLUMNS FROM
  - 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 [FROM|IN]
  - 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 [GLOBAL|SESSION] VARIABLES
  - SHOW WARNINGS
  - 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
    - 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
  - Sequence Functions
  - Utility Functions
  - Miscellaneous Functions
  - TiDB Specific Functions
  - Utility Functions
  - Precision Math
  - Set Operations
  - List of Expressions for Pushdown
- Clustered Indexes
- Global Indexes
- Constraints
- Generated Columns
- SQL Mode
- Table Attributes
- Transactions
  - Overview
  - Isolation Levels
  - Optimistic Transactions
  - Pessimistic Transactions
  - Non-Transactional DML Statements
  - Pipelined DML
- Views
- Partitioning
- Temporary Tables
- Cached Tables
- FOREIGN KEY Constraints
- Character Set and Collation
  - Overview
  - GBK
  - GB18030
- Read Historical Data
  - Use Stale Read (Recommended)
  - Use the tidb_snapshot System Variable
- Placement Rules in SQL
- System Tables
  - mysql Schema
  - INFORMATION_SCHEMA
  - PERFORMANCE_SCHEMA
    - Overview
    - SESSION_CONNECT_ATTRS
  - SYS
    - Overview
    - schema_unused_indexes
- Metadata Lock
- Use UUIDs
- TiDB Accelerated Table Creation
- Schema Cache
API Reference
- Overview
- v1beta1
- v1beta
CLI Reference
- Overview
- auth
  - login
  - logout
  - whoami
- serverless
  - create
  - delete
  - describe
  - list
  - update
  - spending-limit
  - region
  - shell
  - branch
    - create
    - delete
    - describe
    - list
    - shell
  - import
    - cancel
    - describe
    - list
    - start
  - export
    - create
    - describe
    - list
    - cancel
    - download
  - sql-user
    - create
    - delete
    - list
    - update
  - audit-log
    - config
    - describe
    - download
    - filter-rule
      - create
      - delete
      - describe
      - list
      - template
      - update
  - authorized-network
    - create
    - delete
    - list
    - update
- ai
- completion
- config
  - create
  - delete
  - describe
  - edit
  - list
  - set
  - use
- project
  - list
- upgrade
- help
General Reference
- TiDB Cluster Architecture
  - Overview
  - Storage
  - Computing
  - Scheduling
  - TSO
- Storage Engines
  - TiKV
    - TiKV Overview
    - RocksDB Overview
  - TiFlash
    - TiFlash Overview
    - Spill to Disk
- TiDB Cloud Partner Web Console
- TiDB Distributed eXecution Framework (DXF)
  - Introduction
  - TiDB Global Sort
- TiDB Cloud Dedicated Limitations and Quotas
- TiDB Cloud Serverless Limitations
- Limited SQL Features on TiDB Cloud
- TiDB Limitations
- Benchmarks
  - TiDB v8.5
  - TiDB v8.1
    - TPC-C Performance Test Report
    - Sysbench Performance Test Report
  - TiDB v7.5
    - TPC-C Performance Test Report
    - Sysbench Performance Test Report
  - TiDB v7.1
    - TPC-C Performance Test Report
    - Sysbench Performance Test Report
  - TiDB v6.5
    - TPC-C Performance Test Report
    - Sysbench Performance Test Report
- System Variables
- Server Status Variables
- Table Filter
- URI Formats of External Storage Services
- DDL Execution Principles and Best Practices
- ANALYZE Embedded in DDL Statements
- Batch Processing
- Troubleshoot Inconsistency Between Data and Indexes
- Notifications
- Glossary
Support Plan
- Connected Care Overview
- Connected Care Details
- Connected Care Support Service Features
  - Connected: Clinic Service
  - Connected: AI Chat in IM
  - Connected: IM Subscription for TiDB Cloud Alerts
    - Subscribe via Slack
    - Subscribe via Zoom
  - Connected: IM Ticket Creation and Update Subscription
    - Create Tickets and Subscribe to Ticket Updates via Slack
    - Create Tickets and Subscribe to Ticket Updates via Lark
  - Connected: IM Interaction for Support Tickets
    - Interact with Support Tickets via Slack
    - Interact with Support Tickets via Lark
- Get Support
FAQs
- TiDB Cloud FAQs
- TiDB Cloud Serverless FAQs

RELEASES