docs/TOC.md at master · en-jin19/docs · GitHub

918 lines (917 loc) · 51.3 KB

About TiDB
Quick Start
Deploy
- Software and Hardware Requirements
- Environment Configuration Checklist
- Plan Cluster Topology
- Install and Start
  - Use TiUP (Recommended)
  - Deploy in Kubernetes
- Verify Cluster Status
- Test Cluster Performance
  - Test TiDB Using Sysbench
  - Test TiDB Using TPC-C
Migrate
Maintain
- Upgrade
  - Use TiUP (Recommended)
  - Use TiDB Operator
- Scale
  - Use TiUP (Recommended)
  - Use TiDB Operator
- Backup and Restore
  - Use BR Tool (Recommended)
    - BR Tool Overview
    - Use BR Command-line for Backup and Restoration
    - BR Use Cases
    - External Storages
      - External Storages Overview
      - Back up and Restore Data on Azure Blob Storage
    - BR Features
      - Auto Tune
      - Batch Create Table
    - BR FAQ
- Configure Time Zone
- Daily Checklist
- Maintain TiFlash
- Maintain TiDB Using TiUP
- Modify Configuration Online
- Online Unsafe Recovery
- Replicate Data Between Primary and Secondary Clusters
Monitor and Alert
Troubleshoot
Performance Tuning
- System Tuning
  - Operating System Tuning
- Software Tuning
  - Configuration
  - Coprocessor Cache
- SQL Tuning
  - Overview
  - Understanding the Query Execution Plan
    - Overview
    - EXPLAIN Walkthrough
    - Indexes
    - Joins
    - MPP Queries
    - Subqueries
    - Aggregation
    - Views
    - Partitions
  - SQL Optimization Process
    - Overview
    - Logic Optimization
    - Physical Optimization
    - Prepare Execution Plan Cache
  - Control Execution Plans
Tutorials
- Multiple Data Centers in One City Deployment
- Three Data Centers in Two Cities Deployment
- Two Data Centers in One City Deployment
- Read Historical Data
  - Use Stale Read (Recommended)
  - Use the tidb_snapshot System Variable
- Best Practices
- Use Placement Rules
- Use Load Base Split
- Use Store Limit
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
    - TiUP DM Commands
  - TiDB Cluster Topology Reference
  - DM Cluster Topology Reference
  - Mirror Reference Guide
  - TiUP Components
- PingCAP Clinic Diagnostic Service (Technical Preview)
- TiDB Operator
- Dumpling
- TiDB Lightning
  - Overview
  - Prechecks and requirements
  - Key Features
  - Tutorial
  - Deploy
  - Configure
  - Monitor
  - FAQ
  - Glossary
- TiDB Data Migration
  - About TiDB Data Migration
  - Quick Start
  - Deploy a DM cluster
  - Tutorials
    - Create a Data Source
    - Manage Data Sources
    - Configure Tasks
    - Table Routing
    - Block and Allow Lists
    - Binlog Event Filter
    - Filter DMLs Using SQL Expressions
    - Manage a Data Migration Task
  - Advanced Tutorials
    - Merge and Migrate Data from Sharded Tables
    - Migrate from MySQL Databases that Use GH-ost/PT-osc
    - Migrate Data to a Downstream TiDB Table with More Columns
  - 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
    - 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
    - Command Line
      - DM-master & DM-worker
    - Configuration Files
    - OpenAPI
    - Compatibility Catalog
    - Secure
      - Enable TLS for DM Connections
      - Generate Self-signed Certificates
    - Monitoring and Alerts
      - Monitoring Metrics
      - Alert Rules
    - Error Codes
    - Glossary
  - Example
  - Troubleshoot
    - FAQ
    - Handle Errors
  - Release Notes
- Backup & Restore (BR)
  - BR Tool Overview
  - Use BR Command-line for Backup and Restoration
  - BR Use Cases
  - External Storages
  - BR Features
    - Auto Tune
  - 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
- TiCDC
- Dumpling
- sync-diff-inspector
- TiSpark
  - User Guide
Reference
- Cluster Architecture
  - Overview
  - Storage
  - Computing
  - Scheduling
- Key Monitoring Metrics
  - Overview
  - TiDB
  - PD
  - TiKV
  - TiFlash
  - TiCDC
- Secure
- Privileges
- SQL
- UI
  - TiDB Dashboard
    - Overview
    - Maintain
    - 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
    - Search Logs Page
    - Instance Profiling
      - Manual Profiling
      - Continuous Profiling
    - Session Management and Configuration
      - Share Session
      - Configure SSO
    - FAQ
- CLI
  - tikv-ctl
  - pd-ctl
  - tidb-ctl
  - pd-recover
- Command Line Flags
- Configuration File Parameters
- System Variables
- Storage Engines
  - TiKV
  - TiFlash
    - Overview
    - Use TiFlash
- Telemetry
- Errors Codes
- Table Filter
- Schedule Replicas by Topology Labels
FAQs
Glossary
Release Notes
- All Releases
- Release Timeline
- v6.0
  - 6.0.0-DMR
- v5.4
  - 5.4.0
- v5.3
  - 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.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