diff --git a/TOC.md b/TOC.md index 30262d4c0ca2c..bd8b27377bf9f 100644 --- a/TOC.md +++ b/TOC.md @@ -2,187 +2,211 @@ ## Documentation List -+ About TiDB - - [TiDB Introduction](overview.md) - - [TiDB Architecture](architecture.md) -+ Quick Start - - [TiDB Quick Start Guide](QUICKSTART.md) - - [Basic SQL Statements](try-tidb.md) - - [Bikeshare Example Database](bikeshare-example-database.md) -+ TiDB User Guide - + TiDB Server Administration - - [The TiDB Server](sql/tidb-server.md) - - [The TiDB Command Options](sql/server-command-option.md) - - [The TiDB Data Directory](sql/tidb-server.md#tidb-data-directory) - - [The TiDB System Database](sql/system-database.md) - - [Information Schema](sql/information-schema.md) - - [The TiDB System Variables](sql/variable.md) - - [The TiDB Specific System Variables](sql/tidb-specific.md) - - [The TiDB Server Logs](sql/tidb-server.md#tidb-server-logs) - + Security - - [The TiDB Access Privilege System](sql/privilege.md) - - [TiDB User Account Management](sql/user-account-management.md) - - [Use Encrypted Connections](sql/encrypted-connections.md) - - [Security Compatibility with MySQL](sql/security-compatibility.md) - + SQL Optimization and Execution - - [SQL Optimization Process](sql/sql-optimizer-overview.md) - - [Understand the Query Execution Plan](sql/understanding-the-query-execution-plan.md) - - [Introduction to Statistics](sql/statistics.md) - - [Optimizer Hints](sql/optimizer-hints.md) - + Language Structure - - [Literal Values](sql/literal-values.md) - - [Schema Object Names](sql/schema-object-names.md) - - [Keywords and Reserved Words](sql/keywords-and-reserved-words.md) - - [User-Defined Variables](sql/user-defined-variables.md) - - [Expression Syntax](sql/expression-syntax.md) - - [Comment Syntax](sql/comment-syntax.md) - + Globalization - - [Character Set Support](sql/character-set-support.md) - - [Time Zone Support](sql/time-zone.md) - + Data Types - - [Numeric Types](sql/datatype.md#numeric-types) - - [Date and Time Types](sql/datatype.md#date-and-time-types) - - [String Types](sql/datatype.md#string-types) - - [JSON Types](sql/datatype.md#json-types) - - [The ENUM data type](sql/datatype.md#the-enum-data-type) - - [The SET Type](sql/datatype.md#the-set-type) - - [Data Type Default Values](sql/datatype.md#data-type-default-values) - + Functions and Operators - - [Function and Operator Reference](sql/functions-and-operators-reference.md) - - [Type Conversion in Expression Evaluation](sql/type-conversion-in-expression-evaluation.md) - - [Operators](sql/operators.md) - - [Control Flow Functions](sql/control-flow-functions.md) - - [String Functions](sql/string-functions.md) - - [Numeric Functions and Operators](sql/numeric-functions-and-operators.md) - - [Date and Time Functions](sql/date-and-time-functions.md) - - [Bit Functions and Operators](sql/bit-functions-and-operators.md) - - [Cast Functions and Operators](sql/cast-functions-and-operators.md) - - [Encryption and Compression Functions](sql/encryption-and-compression-functions.md) - - [Information Functions](sql/information-functions.md) - - [JSON Functions](sql/json-functions.md) - - [Aggregate (GROUP BY) Functions](sql/aggregate-group-by-functions.md) - - [Miscellaneous Functions](sql/miscellaneous-functions.md) - - [Precision Math](sql/precision-math.md) - + SQL Statement Syntax - - [Data Definition Statements](sql/ddl.md) - - [Data Manipulation Statements](sql/dml.md) - - [Transactions](sql/transaction.md) - - [Database Administration Statements](sql/admin.md) - - [Prepared SQL Statement Syntax](sql/prepare.md) - - [Utility Statements](sql/util.md) - - [TiDB SQL Syntax Diagram](https://pingcap.github.io/sqlgram/) - + Transactions - - [Transaction Model](sql/transaction-model.md) - - [Isolation Levels](sql/transaction-isolation.md) - - [Constraints](sql/constraints.md) - - [Generated Columns](sql/generated-columns.md) - - [Connectors and APIs](sql/connection-and-APIs.md) - - [Error Codes and Troubleshooting](sql/error.md) - - [Compatibility with MySQL](sql/mysql-compatibility.md) - - [TiDB Memory Control](sql/tidb-memory-control.md) - - [Slow Query Log](sql/slow-query.md) - + Advanced Usage - - [Read Data From History Versions](op-guide/history-read.md) - - [Garbage Collection (GC)](op-guide/gc.md) -+ TiDB Operations Guide - - [Hardware and Software Requirements](op-guide/recommendation.md) - + Deploy - - [Ansible Deployment (Recommended)](op-guide/ansible-deployment.md) - - [Offline Deployment Using Ansible](op-guide/offline-ansible-deployment.md) - + Binary Deployment - - [Local Install](op-guide/binary-local-deployment.md) - - [Testing Environment](op-guide/binary-testing-deployment.md) - - [Production Deployment](op-guide/binary-deployment.md) - - [Docker Deployment](op-guide/docker-deployment.md) - - [Docker Compose Deployment](op-guide/docker-compose.md) - - [Cross-DC Deployment Solutions](op-guide/cross-dc-deployment.md) - - [Kubernetes Deployment](op-guide/kubernetes.md) - + Configure - + By Component - - [tidb-server](op-guide/configuration.md) - - [pd-server](op-guide/pd-configuration.md) - - [tikv-server](op-guide/tikv-configuration.md) - - [Configuration File Description](op-guide/tidb-config-file.md) - - [Modify Component Configuration Using Ansible](op-guide/ansible-deployment-rolling-update.md#modify-component-configuration) - - [Enable TLS Authentication](op-guide/security.md) ++ [Introduction](QUICKSTART.md) ++ Concepts + - [Architecture](architecture.md) + + [Key Features](overview.md) + - [Horizontal Scalability](overview.md#horizontal-scalability) + - [MySQL Compatible Syntax](overview.md#mysql-compatible-syntax) + - [Replicate from and to MySQL](overview.md#replicate-from-and-to-mysql) + - [Distributed Transactions with Strong Consistency](overview.md#distributed-transactions-with-strong-consistency) + - [Cloud Native Architecture](overview.md#cloud-native-architecture) + - [Minimize ETL with HTAP](overview.md#minimize-etl-with-htap) + - [Fault Tolerance & Recovery with Raft](overview.md#fault-tolerance--recovery-with-raft) + - [Automatic Rebalancing](overview.md#automatic-rebalancing) + - [Deployment and Orchestration with Ansible, Kubernetes, Docker](overview.md#deployment-and-orchestration-with-ansible-kubernetes-docker) + - [JSON Support](overview.md#json-support) + - [Spark Integration](overview.md#spark-integration) + - [Read Historical Data without Restoring from Backup](overview.md#read-historical-data-without-restoring-from-backup) + - [Fast Import and Restore of Data](overview.md#fast-import-and-restore-of-data) + - [Hybrid of Column and Row Storage](overview.md#hybrid-of-column-and-row-storage) + - [SQL Plan Management](overview.md#sql-plan-management) + - [Open Source](overview.md#open-source) + - [Online Schema Changes](overview.md#online-schema-changes) ++ How-to + + Get Started + + Start a Local Cluster + - [From Binary](op-guide/binary-local-deployment.md) + - [In Kubernetes](op-guide/kubernetes-local.md) + - [In Docker Compose](op-guide/docker-compose.md) + - [Explore SQL with TiDB](try-tidb.md) + - [Import Sample Database](bikeshare-example-database.md) + - [Read Historical Data](op-guide/history-read.md) + - Deploy + - [Hardware Recommendations](op-guide/recommendation.md) + + From Binary Tarball + - [For testing environments](op-guide/binary-testing-deployment.md) + - [For production environments](op-guide/binary-deployment.md) + + Orchestrated Deployment + - [Ansible Deployment (Recommended)](op-guide/ansible-deployment.md) + - [Ansible Offline Deployment](op-guide/offline-ansible-deployment.md) + - [Docker Deployment](op-guide/docker-deployment.md) + - [Kubernetes Deployment](op-guide/kubernetes.md) + - [Overview of Ansible Operations](op-guide/ansible-operation.md) + + Geographic Redundancy + - [Overview](op-guide/cross-dc-deployment.md) + - [Configure Location Awareness](op-guide/location-awareness.md) + - [TiSpark](tispark/tispark-quick-start-guide.md) + - [Data Migration with Ansible](tools/dm/deployment.md) + + Secure + - [Security Compatibility with MySQL](sql/security-compatibility.md) + - [The TiDB Access Privilege System](sql/privilege.md) + - [TiDB User Account Management](sql/user-account-management.md) + + Transport Layer Security (TLS) + - [Enable TLS For MySQL Clients](sql/encrypted-connections.md) + - [Enable TLS Between TiDB Components](op-guide/security.md) - [Generate Self-signed Certificates](op-guide/generate-self-signed-certificates.md) - - [Cluster Topology Configuration](op-guide/location-awareness.md) + Monitor - - [Monitoring Framework Overview](op-guide/monitor-overview.md) + - [Overview](op-guide/monitor-overview.md) - [Monitor a TiDB Cluster](op-guide/monitor.md) + Key Monitoring Metrics - [Overview](op-guide/dashboard-overview-info.md) - [TiDB](op-guide/tidb-dashboard-info.md) - [PD](op-guide/dashboard-pd-info.md) - [TiKV](op-guide/dashboard-tikv-info.md) - + Scale - - [Scale a TiDB Cluster](op-guide/horizontal-scale.md) - - [Scale Using Ansible](op-guide/ansible-deployment-scale.md) - + Upgrade - - [Upgrade the Component Version](op-guide/ansible-deployment-rolling-update.md#upgrade-the-component-version) - - [TiDB 2.0 Upgrade Guide](op-guide/tidb-v2.0-upgrade-guide.md) - - [TiDB 2.1 Upgrade Guide](op-guide/tidb-v2.1-upgrade-guide.md) - - [FAQs After Upgrade](op-guide/upgrade-faq.md) - - [Tune Performance](op-guide/tune-tikv.md) - + Backup and Migrate + + Migrate + - [Overview](op-guide/migration-overview.md) + + Migrate from MySQL + - [Migrate the Full Data](op-guide/migration.md) + - [Migrate the Incremental Data](op-guide/migration-incremental.md) + - [Migrate from CSV](tools/lightning/csv.md) + + Maintain - [Backup and Restore](op-guide/backup-restore.md) - + Migrate - - [Migration Overview](op-guide/migration-overview.md) - - [Migrate all data](op-guide/migration.md) - - [Migrate data incrementally](op-guide/migration-incremental.md) - - [TiDB-Ansible Common Operations](op-guide/ansible-operation.md) - - [Troubleshoot](trouble-shooting.md) -+ TiDB Enterprise Tools - - [Syncer](tools/syncer.md) - - [mydumper](tools/mydumper.md) - - [Loader](tools/loader.md) - + Data Migration - - [Overview](tools/dm/overview.md) - - [Restrictions](tools/dm/overview.md#usage-restrictions) - + Features - - [Table Routing](tools/dm/data-synchronization-features.md#table-routing) - - [Black and White Lists](tools/dm/data-synchronization-features.md#black-and-white-table-lists) - - [Binlog Event Filtering](tools/dm/data-synchronization-features.md#binlog-event-filtering) - - [Column Mapping](tools/dm/data-synchronization-features.md#column-mapping) - - [Synchronization Delay Monitoring](tools/dm/data-synchronization-features.md#synchronization-delay-monitoring) - + Sharding Support - - [Introduction](tools/dm/shard-merge.md) - - [Restrictions](tools/dm/shard-merge.md#restrictions) - - [Handle Sharding DDL Locks Manually](tools/dm/manually-handling-sharding-ddl-locks.md) - + Usage Scenarios - - [Simple Scenario](tools/dm/simple-synchronization-scenario.md) - - [Shard Merge Scenario](tools/dm/shard-merge-scenario.md) - - [Deploy a DM Cluster](tools/dm/deployment.md) - - [Migrate Data Using DM](tools/dm/practice.md) - + Configure - - [Overview](tools/dm/dm-configuration-file-overview.md) - - [Task Configuration](tools/dm/task-configuration-file-intro.md) - - [Monitor](tools/dm/monitor.md) - - [Manage the Task](tools/dm/manage-task.md) - - [Cluster Operations](tools/dm/cluster-operations.md) - - [Upgrade](tools/dm/dm-upgrade.md) - - [Troubleshoot](tools/dm/troubleshooting.md) - + TiDB-Lightning - - [Overview](tools/lightning/overview-architecture.md) - - [Deployment](tools/lightning/deployment.md) - - [Checkpoints](tools/lightning/checkpoints.md) - - [Table Filter](tools/lightning/filter.md) - - [CSV Support](tools/lightning/csv.md) - - [Monitor](tools/lightning/monitor.md) - - [Troubleshooting](tools/lightning/errors.md) - - [FAQs](tools/lightning/faq.md) - - [TiDB-Binlog](tools/tidb-binlog-cluster.md) - - [PD Control](tools/pd-control.md) - - [PD Recover](tools/pd-recover.md) - - [TiKV Control](https://github.com/tikv/tikv/blob/master/docs/tools/tikv-control.md) - - [TiDB Controller](tools/tidb-controller.md) - - [Download](tools/download.md) -+ [TiKV Documentation](https://github.com/tikv/tikv/wiki) -+ TiSpark Documentation - - [Quick Start Guide](tispark/tispark-quick-start-guide.md) - - [User Guide](tispark/tispark-user-guide.md) -- [Frequently Asked Questions (FAQ)](FAQ.md) -- [TiDB Best Practices](https://pingcap.com/blog/2017-07-24-tidbbestpractice/) + + Scale + - [Scale a TiDB Cluster](op-guide/horizontal-scale.md) + - [Scale using Ansible](op-guide/ansible-deployment-scale.md) + - [Identify slow queries](sql/slow-query.md) + + Upgrade + - [Upgrade from TiDB 2.1](op-guide/tidb-v2.1-upgrade-guide.md) + - [Upgrade Data Migration](tools/dm/dm-upgrade.md) + - [Rolling updates with Ansible](op-guide/ansible-deployment-rolling-update.md) + - Troubleshoot + - [Common Errors](sql/error.md) + - [Troubleshoot Cluster Setup](trouble-shooting.md) + - [Troubleshoot Data Migrations](tools/dm/troubleshooting.md) + - [Troubleshoot TiDB-Lightning](tools/lightning/errors.md) + - [Support Resources](support.md) + - [Report an Issue](report-issue.md) + + [Contribute](contribute.md) + - [Contribute to TiDB](contribute.md#contribute-to-tidb) + - [Improve the Docs](contribute.md#improve-the-docs) ++ Reference + + SQL + - [Supported Client Drivers](sql/connection-and-APIs.md) + - [MySQL Compatibility](sql/mysql-compatibility.md) + + SQL Statements + - [Data Definition Statements](sql/ddl.md) + - [Data Manipulation Statements](sql/dml.md) + - [Transactions](sql/transaction.md) + - [Database Administration Statements](sql/admin.md) + - [Prepared SQL Statement Syntax](sql/prepare.md) + - [Utility Statements](sql/util.md) + - [TiDB SQL Syntax Diagram](https://pingcap.github.io/sqlgram/) + + Data Types + - [Numeric Types](sql/datatype.md#numeric-types) + - [Date and Time Types](sql/datatype.md#date-and-time-types) + - [String Types](sql/datatype.md#string-types) + - [JSON Types](sql/datatype.md#json-types) + - [The ENUM data type](sql/datatype.md#the-enum-data-type) + - [The SET Type](sql/datatype.md#the-set-type) + - [Data Type Default Values](sql/datatype.md#data-type-default-values) + - [Constraints](sql/constraints.md) + + Functions and Operators + - [Function and Operator Reference](sql/functions-and-operators-reference.md) + - [Type Conversion in Expression Evaluation](sql/type-conversion-in-expression-evaluation.md) + - [Operators](sql/operators.md) + - [Control Flow Functions](sql/control-flow-functions.md) + - [String Functions](sql/string-functions.md) + - [Numeric Functions and Operators](sql/numeric-functions-and-operators.md) + - [Date and Time Functions](sql/date-and-time-functions.md) + - [Bit Functions and Operators](sql/bit-functions-and-operators.md) + - [Cast Functions and Operators](sql/cast-functions-and-operators.md) + - [Encryption and Compression Functions](sql/encryption-and-compression-functions.md) + - [Information Functions](sql/information-functions.md) + - [JSON Functions](sql/json-functions.md) + - [Aggregate (GROUP BY) Functions](sql/aggregate-group-by-functions.md) + - [Miscellaneous Functions](sql/miscellaneous-functions.md) + - [Precision Math](sql/precision-math.md) + + SQL Language Structure + - [Literal Values](sql/literal-values.md) + - [Schema Object Names](sql/schema-object-names.md) + - [Keywords and Reserved Words](sql/keywords-and-reserved-words.md) + - [User-Defined Variables](sql/user-defined-variables.md) + - [Expression Syntax](sql/expression-syntax.md) + - [Comment Syntax](sql/comment-syntax.md) + - [Generated Columns](sql/generated-columns.md) + + Transactions + - [Transaction Model](sql/transaction-model.md) + - [Isolation Levels](sql/transaction-isolation.md) + + Performance + - [Overview](sql/sql-optimizer-overview.md) + - [Cost-based Optimizer](sql/understanding-the-query-execution-plan.md) + - [Introduction to Statistics](sql/statistics.md) + - [Optimizer Hints](sql/optimizer-hints.md) + - [Tune TiKV](op-guide/tune-tikv.md) + - [TiDB Best Practices](https://pingcap.com/blog/2017-07-24-tidbbestpractice/) + - [TiDB System Database](sql/system-database.md) + - [Information Schema](sql/information-schema.md) + - [TiSpark](tispark/tispark-user-guide.md) + + Configuration + + tidb-server + - [MySQL System Variables](sql/variable.md) + - [TiDB Specific System Variables](sql/tidb-specific.md) + - [Time Zone](sql/time-zone.md) + - [Character Set](sql/character-set-support.md) + - [Memory Control](sql/tidb-memory-control.md) + - [Garbage Collection (GC)](op-guide/gc.md) + - [Configuration Flags](op-guide/configuration.md) + + pd-server + - [Configuration Flags](op-guide/pd-configuration.md) + + tikv-server + - [Configuration Flags](op-guide/tikv-configuration.md) + + Tools + - [Syncer](tools/syncer.md) + - [mydumper](tools/mydumper.md) + - [Loader](tools/loader.md) + + Data Migration + - [Overview](tools/dm/overview.md) + - [Restrictions](tools/dm/overview.md#usage-restrictions) + - [Deploy](tools/dm/practice.md) + + Features + - [Table Routing](tools/dm/data-synchronization-features.md#table-routing) + - [Black and White Lists](tools/dm/data-synchronization-features.md#black-and-white-table-lists) + - [Binlog Event Filtering](tools/dm/data-synchronization-features.md#binlog-event-filtering) + - [Column Mapping](tools/dm/data-synchronization-features.md#column-mapping) + - [Synchronization Delay Monitoring](tools/dm/data-synchronization-features.md#synchronization-delay-monitoring) + + Sharding Support + - [Introduction](tools/dm/shard-merge.md) + - [Restrictions](tools/dm/shard-merge.md#restrictions) + - [Handle Sharding DDL Locks Manually](tools/dm/manually-handling-sharding-ddl-locks.md) + + Usage Scenarios + - [Simple Scenario](tools/dm/simple-synchronization-scenario.md) + - [Shard Merge Scenario](tools/dm/shard-merge-scenario.md) + + Configure + - [Overview](tools/dm/dm-configuration-file-overview.md) + - [Task Configuration](tools/dm/task-configuration-file-intro.md) + - [Monitor](tools/dm/monitor.md) + - [Manage the Task](tools/dm/manage-task.md) + - [Cluster Operations](tools/dm/cluster-operations.md) + + TiDB-Lightning + - [Overview](tools/lightning/overview-architecture.md) + - [Deployment](tools/lightning/deployment.md) + - [Checkpoints](tools/lightning/checkpoints.md) + - [Table Filter](tools/lightning/filter.md) + - [CSV Support](tools/lightning/csv.md) + - [Monitor](tools/lightning/monitor.md) + - [TiDB-Binlog](tools/tidb-binlog-cluster.md) (Enterprise) + - [PD Control](tools/pd-control.md) + - [PD Recover](tools/pd-recover.md) + - [TiKV Control](https://github.com/tikv/tikv/blob/master/docs/tools/tikv-control.md) + - [TiDB Controller](tools/tidb-controller.md) + - [Download](tools/download.md) + - [Roadmap](ROADMAP.md) + - [Adopters](adopters.md) ++ FAQs + - [TiDB FAQs](FAQ.md) + - [TiDB-Lightning FAQs](tools/lightning/faq.md) + - [Upgrade FAQs](op-guide/upgrade-faq.md) + [Releases](releases/rn.md) + v3.0 - [3.0.0 Beta.1](releases/3.0.0-beta.1.md) @@ -237,9 +261,3 @@ - [RC3](releases/rc3.md) - [RC2](releases/rc2.md) - [RC1](releases/rc1.md) -- [TiDB Adopters](adopters.md) -- [TiDB Roadmap](ROADMAP.md) -- [Connect with us](community.md) -+ More Resources - - [PingCAP Blog](https://pingcap.com/blog/) - - [Weekly Update](https://pingcap.com/weekly/)