From eeb2c932206977b3c0b63d5e4ec6ca460e70e9a0 Mon Sep 17 00:00:00 2001 From: Ran Date: Thu, 16 Jul 2020 20:34:01 +0800 Subject: [PATCH 1/2] cherry pick #3300 to release-4.0 Signed-off-by: ti-srebot --- TOC.md | 2 +- _index.md | 2 +- faq/tidb-faq.md | 8 ++++---- get-started-with-tidb-binlog.md | 2 +- production-deployment-from-binary-tarball.md | 2 +- quick-start-with-tidb.md | 2 ++ test-deployment-from-binary-tarball.md | 2 +- test-deployment-using-docker.md | 2 +- architecture.md => tidb-architecture.md | 4 ++++ 9 files changed, 16 insertions(+), 10 deletions(-) rename architecture.md => tidb-architecture.md (95%) diff --git a/TOC.md b/TOC.md index 48d15bb86c602..8fc4fc1023337 100644 --- a/TOC.md +++ b/TOC.md @@ -188,7 +188,7 @@ + [User Guide](/tispark-overview.md) + Reference + Cluster Architecture - + [Overview](/architecture.md) + + [Overview](/tidb-architecture.md) + Key Monitoring Metrics + [Overview](/grafana-overview-dashboard.md) + [TiDB](/grafana-tidb-dashboard.md) diff --git a/_index.md b/_index.md index a6d8f30fac15f..4e9d781e6273f 100644 --- a/_index.md +++ b/_index.md @@ -90,7 +90,7 @@ Designed for the cloud, TiDB provides flexible scalability, reliability and secu Reference -- [TiDB Architecture](/architecture.md) +- [TiDB Architecture](/tidb-architecture.md) - [Key Monitoring Metrics](/grafana-overview-dashboard.md) - [Enable TLS](/enable-tls-between-clients-and-servers.md) - [Privilege Management](/privilege-management.md) diff --git a/faq/tidb-faq.md b/faq/tidb-faq.md index 235cc076557b5..f1af8272c029e 100644 --- a/faq/tidb-faq.md +++ b/faq/tidb-faq.md @@ -21,7 +21,7 @@ TiDB is a distributed SQL database that features in horizontal scalability, high #### What is TiDB's architecture? -The TiDB cluster has three components: the TiDB server, the PD (Placement Driver) server, and the TiKV server. For more details, see [TiDB architecture](/architecture.md). +The TiDB cluster has three components: the TiDB server, the PD (Placement Driver) server, and the TiKV server. For more details, see [TiDB architecture](/tidb-architecture.md). #### Is TiDB based on MySQL? @@ -53,7 +53,7 @@ This problem occurs because MySQL 8.0 changes the [authentication plugin](/secur #### How is TiDB highly available? -TiDB is self-healing. All of the three components, TiDB, TiKV and PD, can tolerate failures of some of their instances. With its strong consistency guarantee, whether it’s data machine failures or even downtime of an entire data center, your data can be recovered automatically. For more information, see [TiDB architecture](/architecture.md). +TiDB is self-healing. All of the three components, TiDB, TiKV and PD, can tolerate failures of some of their instances. With its strong consistency guarantee, whether it’s data machine failures or even downtime of an entire data center, your data can be recovered automatically. For more information, see [TiDB architecture](/tidb-architecture.md). #### How is TiDB strongly consistent? @@ -65,7 +65,7 @@ At the bottom layer, TiKV uses a model of replication log + State Machine to rep Yes. TiDB distributes transactions across your cluster, whether it is a few nodes in a single location or many [nodes across multiple data centers](/multi-data-centers-in-one-city-deployment.md). -Inspired by Google's Percolator, the transaction model in TiDB is mainly a two-phase commit protocol with some practical optimizations. This model relies on a timestamp allocator to assign the monotone increasing timestamp for each transaction, so conflicts can be detected. [PD](/architecture.md#placement-driver-pd-server) works as the timestamp allocator in a TiDB cluster. +Inspired by Google's Percolator, the transaction model in TiDB is mainly a two-phase commit protocol with some practical optimizations. This model relies on a timestamp allocator to assign the monotone increasing timestamp for each transaction, so conflicts can be detected. [PD](/tidb-architecture.md#placement-driver-pd-server) works as the timestamp allocator in a TiDB cluster. #### What programming language can I use to work with TiDB? @@ -111,7 +111,7 @@ As a standalone database, MySQL can only implement across-database transactions The display content of TiDB `show processlist` is almost the same as that of MySQL `show processlist`. TiDB `show processlist` does not display the system process ID. The ID that it displays is the current session ID. The differences between TiDB `show processlist` and MySQL `show processlist` are as follows: -- As TiDB is a distributed database, the `tidb-server` instance is a stateless engine for parsing and executing the SQL statements (for details, see [TiDB architecture](/architecture.md)). `show processlist` displays the session list executed in the `tidb-server` instance that the user logs in to from the MySQL client, not the list of all the sessions running in the cluster. But MySQL is a standalone database and its `show processlist` displays all the SQL statements executed in MySQL. +- As TiDB is a distributed database, the `tidb-server` instance is a stateless engine for parsing and executing the SQL statements (for details, see [TiDB architecture](/tidb-architecture.md)). `show processlist` displays the session list executed in the `tidb-server` instance that the user logs in to from the MySQL client, not the list of all the sessions running in the cluster. But MySQL is a standalone database and its `show processlist` displays all the SQL statements executed in MySQL. - The `State` column in TiDB is not continually updated during query execution. As TiDB supports parallel query, each statement may be in multiple _states_ at once, and thus it is difficult to simplify to a single value. #### How to modify the user password and privilege? diff --git a/get-started-with-tidb-binlog.md b/get-started-with-tidb-binlog.md index 36ecfb956155c..c5f902e3bea42 100644 --- a/get-started-with-tidb-binlog.md +++ b/get-started-with-tidb-binlog.md @@ -9,7 +9,7 @@ aliases: ['/docs/stable/get-started-with-tidb-binlog/','/docs/v4.0/get-started-w This tutorial starts with a simple TiDB Binlog deployment with a single node of each component (Placement Driver, TiKV Server, TiDB Server, Pump, and Drainer), set up to push data into a MariaDB Server instance. -This tutorial is targeted toward users who have some familiarity with the [TiDB Architecture](/architecture.md), who may have already set up a TiDB cluster (not mandatory), and who wants to gain hands-on experience with TiDB Binlog. This tutorial is a good way to "kick the tires" of TiDB Binlog and to familiarize yourself with the concepts of its architecture. +This tutorial is targeted toward users who have some familiarity with the [TiDB Architecture](/tidb-architecture.md), who may have already set up a TiDB cluster (not mandatory), and who wants to gain hands-on experience with TiDB Binlog. This tutorial is a good way to "kick the tires" of TiDB Binlog and to familiarize yourself with the concepts of its architecture. > **Warning:** > diff --git a/production-deployment-from-binary-tarball.md b/production-deployment-from-binary-tarball.md index 4c9f2d3454074..b48268c3de2ec 100644 --- a/production-deployment-from-binary-tarball.md +++ b/production-deployment-from-binary-tarball.md @@ -13,7 +13,7 @@ See also [local deployment](/deploy-tidb-from-binary.md) and [testing environmen ## Prepare -Before you start, see [TiDB architecture](/architecture.md) and [Software and Hardware Recommendations](/hardware-and-software-requirements.md). Make sure the following requirements are satisfied: +Before you start, see [TiDB architecture](/tidb-architecture.md) and [Software and Hardware Recommendations](/hardware-and-software-requirements.md). Make sure the following requirements are satisfied: ### Operating system diff --git a/quick-start-with-tidb.md b/quick-start-with-tidb.md index abb6c9389620d..7d3b1befc2bfe 100644 --- a/quick-start-with-tidb.md +++ b/quick-start-with-tidb.md @@ -308,7 +308,9 @@ Click to try TiDB-Wasm playground: . It takes about 10 sec - If you have just deployed a TiDB cluster for the local test environment: - Learn [Basic SQL operations in TiDB](/basic-sql-operations.md) + - [Migrate data to TiDB](/migration-overview.md) - Learn [TiDB key features and scenarios](/overview.md) + - Learn [TiDB's architecture](/tidb-architecture.md) - Learn [TiDB's compatibility with MySQL](/mysql-compatibility.md) - If you are ready to deploy a TiDB cluster for the production environment: diff --git a/test-deployment-from-binary-tarball.md b/test-deployment-from-binary-tarball.md index 858a808c1dc37..b2e8740e41365 100644 --- a/test-deployment-from-binary-tarball.md +++ b/test-deployment-from-binary-tarball.md @@ -13,7 +13,7 @@ See also [local deployment](/deploy-tidb-from-binary.md) and [production environ ## Prepare -Before you start, see [TiDB architecture](/architecture.md) and [Software and Hardware Recommendations](/hardware-and-software-requirements.md). Make sure the following requirements are satisfied: +Before you start, see [TiDB architecture](/tidb-architecture.md) and [Software and Hardware Recommendations](/hardware-and-software-requirements.md). Make sure the following requirements are satisfied: ### Operating system diff --git a/test-deployment-using-docker.md b/test-deployment-using-docker.md index 73616e2aa750e..1933539515e2a 100644 --- a/test-deployment-using-docker.md +++ b/test-deployment-using-docker.md @@ -13,7 +13,7 @@ aliases: ['/docs/stable/test-deployment-using-docker/','/docs/v4.0/test-deployme This document shows you how to manually deploy a multi-node TiDB cluster on multiple machines using Docker. -To learn more, see [TiDB architecture](/architecture.md) and [Software and Hardware Recommendations](/hardware-and-software-requirements.md). +To learn more, see [TiDB architecture](/tidb-architecture.md) and [Software and Hardware Recommendations](/hardware-and-software-requirements.md). ## Preparation diff --git a/architecture.md b/tidb-architecture.md similarity index 95% rename from architecture.md rename to tidb-architecture.md index 19c0198ce0c0f..37b194edbfecd 100644 --- a/architecture.md +++ b/tidb-architecture.md @@ -1,8 +1,12 @@ --- title: TiDB Architecture summary: The key architecture components of the TiDB platform +<<<<<<< HEAD:architecture.md category: introduction aliases: ['/docs/stable/architecture/','/docs/v4.0/architecture/'] +======= +aliases: ['/docs/dev/architecture/','/tidb/dev/architecture'] +>>>>>>> 19bf4a3... add what's next links in quick start (#3300):tidb-architecture.md --- # TiDB Architecture From ea39eb576c4f6768c88951b3195fc16ed6bf2e86 Mon Sep 17 00:00:00 2001 From: Ran Date: Thu, 16 Jul 2020 20:36:40 +0800 Subject: [PATCH 2/2] Update tidb-architecture.md --- tidb-architecture.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/tidb-architecture.md b/tidb-architecture.md index 37b194edbfecd..72f2cd9d735dc 100644 --- a/tidb-architecture.md +++ b/tidb-architecture.md @@ -1,12 +1,7 @@ --- title: TiDB Architecture summary: The key architecture components of the TiDB platform -<<<<<<< HEAD:architecture.md -category: introduction -aliases: ['/docs/stable/architecture/','/docs/v4.0/architecture/'] -======= -aliases: ['/docs/dev/architecture/','/tidb/dev/architecture'] ->>>>>>> 19bf4a3... add what's next links in quick start (#3300):tidb-architecture.md +aliases: ['/docs/stable/architecture/','/docs/v4.0/architecture/','/tidb/stable/architecture'] --- # TiDB Architecture