docs/TOC-tidb-cloud.md at master · mayjiang0203/docs · GitHub

759 lines (758 loc) · 48.3 KB

Docs Home
About TiDB Cloud
- Why TiDB Cloud
- Architecture
- High Availability
- MySQL Compatibility
- Roadmap
Get Started
- Try Out TiDB Cloud
- Try Out TiDB + AI
- Try Out HTAP
- Try Out TiDB Cloud CLI
- Perform a PoC
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
  - 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
  - WordPress
  - Serverless Driver (Beta)
- 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
  - 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
  - Export Data from TiDB Serverless
- Manage TiDB Dedicated Clusters
- 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
        
        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
  - 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
- Overview
- Migrate Data into TiDB Cloud
- Import Data into TiDB Cloud
- Reference
Explore Data
- Chat2Query (Beta) in SQL Editor
Vector Search (Beta)
- Overview
- Get Started
  - Get Started with SQL
  - Get Started with Python
- Integrations
  - Overview
  - AI Frameworks
    - LlamaIndex
    - Langchain
  - Embedding Models/Services
    - Jina AI
  - ORM Libraries
- Reference
- Improve Performance
- Limitations
- Changelogs
Data Service (Beta)
- Overview
- Get Started
- Chat2Query API
- Manage Data App
- Manage Endpoint
- API Key
- Custom Domain
- Integrations
- Run in Postman
- Deploy Automatically with GitHub
- Use OpenAPI Specification with Next.js
- Data App Configuration Files
- Response and Status Code
Stream Data
- Changefeed Overview
- To MySQL Sink
- To Kafka Sink
- To TiDB Cloud Sink
- To Cloud Storage
Disaster Recovery
- Recovery Group Overview
- Get Started
- Failover and Reprotect Databases
- Delete a Recovery Group
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
- Invoices
- Billing Details
- Cost Explorer
- Billing Profile
- Credits
- Payment Method Setting
- Billing from AWS or GCP Marketplace
- Billing for Changefeed
- Billing for Data Migration
- Billing for Recovery Groups
- Manage Budgets
Managed Service Provider Program
- Managed Service Provider
- MSP Customer
API
- API Overview
- API Reference
  - v1beta1
    - Billing
    - Data Service
    - IAM
    - MSP
  - v1beta
Integrations
- Airbyte
- Amazon AppFlow
- 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
- TiDB Distributed eXecution Framework (DXF)
  - Introduction
  - TiDB Global Sort
- Benchmarks
  - 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
- 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
    - Overview
    - ADMIN
    - 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 INDEX
    - 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
    - Miscellaneous Functions
    - Precision Math
    - Set Operations
    - Sequence Functions
    - 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
  - FOREIGN KEY Constraints
  - Character Set and Collation
    - Overview
    - GBK
  - Read Historical Data
    - Use Stale Read (Recommended)
    - Use the tidb_snapshot System Variable
  - Placement Rules in SQL
  - System Tables
    - mysql Schema
      - Overview
      - user
    - INFORMATION_SCHEMA
    - PERFORMANCE_SCHEMA
      - Overview
      - SESSION_CONNECT_ATTRS
    - SYS
      - Overview
      - schema_unused_indexes
  - Metadata Lock
  - Use UUIDs
  - TiDB Accelerated Table Creation
- System Variables
- Server Status Variables
- Storage Engines
  - TiKV
    - TiKV Overview
    - RocksDB Overview
  - TiFlash
    - TiFlash Overview
    - Spill to Disk
- CLI
  - Overview
  - auth
    - login
    - logout
  - 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
  - ai
  - completion
  - config
    - create
    - delete
    - describe
    - edit
    - list
    - set
    - use
  - project
    - list
  - update
  - help
- Table Filter
- Resource Control
- URI Formats of External Storage Services
- DDL Execution Principles and Best Practices
- Troubleshoot Inconsistency Between Data and Indexes
- Support
- Glossary
FAQs
- TiDB Cloud FAQs
- TiDB Serverless FAQs
Release Notes
- 2024
- 2023
- 2022
- 2021
- 2020
Maintenance Notification
- [2024-09-15] TiDB Cloud Console Maintenance Notification
- [2024-04-18] TiDB Cloud Data Migration (DM) Feature Maintenance Notification
- [2024-04-16] TiDB Cloud Monitoring Features Maintenance Notification
- [2024-04-11] TiDB Cloud Data Migration (DM) Feature Maintenance Notification
- [2024-04-09] TiDB Cloud Monitoring Features Maintenance Notification
- [2023-11-14] TiDB Dedicated Scale Feature Maintenance Notification
- [2023-09-26] TiDB Cloud Console Maintenance Notification
- [2023-08-31] TiDB Cloud Console Maintenance Notification