Merge remote-tracking branch 'upstream/master'

qiancai · Nov 13, 2024 · d2ced04 · d2ced04
2 parents b84551d + c3f8f39
commit d2ced04
Show file tree

Hide file tree

Showing 52 changed files with 889 additions and 322 deletions.
diff --git a/README.md b/README.md
@@ -28,6 +28,7 @@ Currently, we maintain the following versions of TiDB documentation in different
 | Branch name | TiDB docs version |
 | :---------|:----------|
 | [`master`](https://github.com/pingcap/docs/tree/master) | The latest development version |
+| [`release-8.4`](https://github.com/pingcap/docs/tree/release-8.4) | 8.4 Development Milestone Release |
 | [`release-8.3`](https://github.com/pingcap/docs/tree/release-8.3) | 8.3 Development Milestone Release |
 | [`release-8.2`](https://github.com/pingcap/docs/tree/release-8.2) | 8.2 Development Milestone Release |
 | [`release-8.1`](https://github.com/pingcap/docs/tree/release-8.1) | 8.1 LTS (Long-Term Support) |

diff --git a/TOC.md b/TOC.md
@@ -4,7 +4,7 @@
 - [Docs Home](https://docs.pingcap.com/)
 - About TiDB Self-Managed
   - [What is TiDB Self-Managed](/overview.md)
-  - [TiDB 8.3 Release Notes](/releases/release-8.3.0.md)
+  - [TiDB 8.4 Release Notes](/releases/release-8.4.0.md)
   - [Features](/basic-features.md)
   - [MySQL Compatibility](/mysql-compatibility.md)
   - [TiDB Limitations](/tidb-limitations.md)
@@ -1073,6 +1073,8 @@
   - [Release Timeline](/releases/release-timeline.md)
   - [TiDB Versioning](/releases/versioning.md)
   - [TiDB Installation Packages](/binary-package.md)
+  - v8.4
+    - [8.4.0-DMR](/releases/release-8.4.0.md)
   - v8.3
     - [8.3.0-DMR](/releases/release-8.3.0.md)
   - v8.2

diff --git a/basic-features.md b/basic-features.md
diff --git a/best-practices-on-public-cloud.md b/best-practices-on-public-cloud.md
@@ -193,14 +193,14 @@ set global tidb_tso_client_batch_max_wait_time = 2; # default: 0
 
 #### Adjust TiKV configuration
 
-To reduce the number of Regions and alleviate the heartbeat overhead on the system, it is recommended to increase the Region size in the TiKV configuration from `96MB` to `256MB`.
+To reduce the number of Regions and alleviate the heartbeat overhead on the system, you can refer to [Adjust Region size](/best-practices/massive-regions-best-practices.md#method-6-adjust-region-size) to moderately increase the size of the Region in TiKV configuration.
 
 ```
 [coprocessor]
-  region-split-size = "256MB"
+  region-split-size = "288MiB"
 ```
 
-## After tuning
+### After tuning
 
 After the tuning, the following effects can be observed:
 

diff --git a/br/backup-and-restore-use-cases.md b/br/backup-and-restore-use-cases.md
@@ -17,7 +17,7 @@ With PITR, you can satisfy the preceding requirements.
 
 ## Deploy the TiDB cluster and BR
 
-To use PITR, you need to deploy a TiDB cluster >= v6.2.0 and update BR to the same version as the TiDB cluster. This document uses v8.3.0 as an example.
+To use PITR, you need to deploy a TiDB cluster >= v6.2.0 and update BR to the same version as the TiDB cluster. This document uses v8.4.0 as an example.
 
 The following table shows the recommended hardware resources for using PITR in a TiDB cluster.
 
@@ -44,13 +44,13 @@ Install or upgrade BR using TiUP:
 - Install:
 
     ```shell
-    tiup install br:v8.3.0
+    tiup install br:v8.4.0
     ```
 
 - Upgrade:
 
     ```shell
-    tiup update br:v8.3.0
+    tiup update br:v8.4.0
     ```
 
 ## Configure backup storage (Amazon S3)

diff --git a/certificate-authentication.md b/certificate-authentication.md
@@ -361,7 +361,7 @@ The output:
 
 ```
 --------------
-mysql  Ver 8.3.0 for Linux on x86_64 (MySQL Community Server - GPL)
+mysql  Ver 8.4.0 for Linux on x86_64 (MySQL Community Server - GPL)
 
 Connection id:       1
 Current database:    test

diff --git a/develop/dev-guide-sample-application-nodejs-mysql2.md b/develop/dev-guide-sample-application-nodejs-mysql2.md
@@ -191,7 +191,7 @@ npm start
 If the connection is successful, the console will output the version of the TiDB cluster as follows:
 
 ```
-🔌 Connected to TiDB cluster! (TiDB version: 8.0.11-TiDB-v8.3.0)
+🔌 Connected to TiDB cluster! (TiDB version: 8.0.11-TiDB-v8.4.0)
 ⏳ Loading sample game data...
 ✅ Loaded sample game data.
 

diff --git a/develop/dev-guide-sample-application-nodejs-mysqljs.md b/develop/dev-guide-sample-application-nodejs-mysqljs.md
@@ -191,7 +191,7 @@ npm start
 If the connection is successful, the console will output the version of the TiDB cluster as follows:
 
 ```
-🔌 Connected to TiDB cluster! (TiDB version: 8.0.11-TiDB-v8.3.0)
+🔌 Connected to TiDB cluster! (TiDB version: 8.0.11-TiDB-v8.4.0)
 ⏳ Loading sample game data...
 ✅ Loaded sample game data.
 

diff --git a/develop/dev-guide-sample-application-nodejs-prisma.md b/develop/dev-guide-sample-application-nodejs-prisma.md
@@ -270,7 +270,7 @@ void main();
 If the connection is successful, the terminal will output the version of the TiDB cluster as follows:
 
 ```
-🔌 Connected to TiDB cluster! (TiDB version: 8.0.11-TiDB-v8.3.0)
+🔌 Connected to TiDB cluster! (TiDB version: 8.0.11-TiDB-v8.4.0)
 🆕 Created a new player with ID 1.
 ℹ️ Got Player 1: Player { id: 1, coins: 100, goods: 100 }
 🔢 Added 50 coins and 50 goods to player 1, now player 1 has 150 coins and 150 goods.

diff --git a/develop/dev-guide-sample-application-nodejs-typeorm.md b/develop/dev-guide-sample-application-nodejs-typeorm.md
@@ -233,7 +233,7 @@ npm start
 If the connection is successful, the terminal will output the version of the TiDB cluster as follows:
 
 ```
-🔌 Connected to TiDB cluster! (TiDB version: 8.0.11-TiDB-v8.3.0)
+🔌 Connected to TiDB cluster! (TiDB version: 8.0.11-TiDB-v8.4.0)
 🆕 Created a new player with ID 2.
 ℹ️ Got Player 2: Player { id: 2, coins: 100, goods: 100 }
 🔢 Added 50 coins and 50 goods to player 2, now player 2 has 100 coins and 150 goods.

diff --git a/develop/dev-guide-sample-application-ruby-mysql2.md b/develop/dev-guide-sample-application-ruby-mysql2.md
@@ -192,7 +192,7 @@ ruby app.rb
 If the connection is successful, the console will output the version of the TiDB cluster as follows:
 
 ```
-🔌 Connected to TiDB cluster! (TiDB version: 8.0.11-TiDB-v8.3.0)
+🔌 Connected to TiDB cluster! (TiDB version: 8.0.11-TiDB-v8.4.0)
 ⏳ Loading sample game data...
 ✅ Loaded sample game data.
 

diff --git a/develop/dev-guide-sample-application-ruby-rails.md b/develop/dev-guide-sample-application-ruby-rails.md
@@ -185,7 +185,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
 If the connection is successful, the console will output the version of the TiDB cluster as follows:
 
 ```
-🔌 Connected to TiDB cluster! (TiDB version: 8.0.11-TiDB-v8.3.0)
+🔌 Connected to TiDB cluster! (TiDB version: 8.0.11-TiDB-v8.4.0)
 ⏳ Loading sample game data...
 ✅ Loaded sample game data.
 

diff --git a/dm/dm-compatibility-catalog.md b/dm/dm-compatibility-catalog.md
@@ -32,7 +32,9 @@ DM supports migrating data from different sources to TiDB clusters. Based on the
 
 |Target database|Compatibility level|DM version|
 |-|-|-|
-|TiDB 6.0|GA|≥ 5.3.1|
+|TiDB 8.x|GA|≥ 5.3.1|
+|TiDB 7.x|GA|≥ 5.3.1|
+|TiDB 6.x|GA|≥ 5.3.1|
 |TiDB 5.4|GA|≥ 5.3.1|
 |TiDB 5.3|GA|≥ 5.3.1|
 |TiDB 5.2|GA|≥ 2.0.7, recommended: 5.4|
@@ -41,4 +43,4 @@ DM supports migrating data from different sources to TiDB clusters. Based on the
 |TiDB 4.x|GA|≥ 2.0.1, recommended: 2.0.7|
 |TiDB 3.x|GA|≥ 2.0.1, recommended: 2.0.7|
 |MySQL|Experimental||
-|MariaDB|Experimental||
+|MariaDB|Experimental||
diff --git a/dm/maintain-dm-using-tiup.md b/dm/maintain-dm-using-tiup.md
@@ -394,7 +394,7 @@ All operations above performed on the cluster machine use the SSH client embedde
 
 Then you can use the `--native-ssh` command-line flag to enable the system-native command-line tool:
 
-- Deploy a cluster: `tiup dm deploy <cluster-name> <version> <topo> --native-ssh`. Fill in the name of your cluster for `<cluster-name>`,  the DM version to be deployed (such as `v8.3.0`) for `<version>` , and the topology file name for `<topo>`.
+- Deploy a cluster: `tiup dm deploy <cluster-name> <version> <topo> --native-ssh`. Fill in the name of your cluster for `<cluster-name>`,  the DM version to be deployed (such as `v8.4.0`) for `<version>` , and the topology file name for `<topo>`.
 - Start a cluster: `tiup dm start <cluster-name> --native-ssh`.
 - Upgrade a cluster: `tiup dm upgrade ... --native-ssh`
 

diff --git a/dm/quick-start-create-task.md b/dm/quick-start-create-task.md
@@ -74,7 +74,7 @@ To run a TiDB server, use the following command:
 {{< copyable "shell-regular" >}}
 
 ```bash
-wget https://download.pingcap.org/tidb-community-server-v8.3.0-linux-amd64.tar.gz
+wget https://download.pingcap.org/tidb-community-server-v8.4.0-linux-amd64.tar.gz
 tar -xzvf tidb-latest-linux-amd64.tar.gz
 mv tidb-latest-linux-amd64/bin/tidb-server ./
 ./tidb-server

diff --git a/download-ecosystem-tools.md b/download-ecosystem-tools.md
@@ -28,7 +28,7 @@ You can download TiDB Toolkit from the following link:
 https://download.pingcap.org/tidb-community-toolkit-{version}-linux-{arch}.tar.gz
 ```
 
-`{version}` in the link indicates the version number of TiDB and `{arch}` indicates the architecture of the system, which can be `amd64` or `arm64`. For example, the download link for `v8.3.0` in the `amd64` architecture is `https://download.pingcap.org/tidb-community-toolkit-v8.3.0-linux-amd64.tar.gz`.
+`{version}` in the link indicates the version number of TiDB and `{arch}` indicates the architecture of the system, which can be `amd64` or `arm64`. For example, the download link for `v8.4.0` in the `amd64` architecture is `https://download.pingcap.org/tidb-community-toolkit-v8.4.0-linux-amd64.tar.gz`.
 
 > **Note:**
 >

diff --git a/functions-and-operators/tidb-functions.md b/functions-and-operators/tidb-functions.md
@@ -544,7 +544,7 @@ SELECT TIDB_VERSION()\G
 
 ```sql
 *************************** 1. row ***************************
-TIDB_VERSION(): Release Version: v8.3.0
+TIDB_VERSION(): Release Version: v8.4.0
 Edition: Community
 Git Commit Hash: 821e491a20fbab36604b36b647b5bae26a2c1418
 Git Branch: HEAD

diff --git a/information-schema/information-schema-tidb-servers-info.md b/information-schema/information-schema-tidb-servers-info.md
@@ -50,7 +50,7 @@ The output is as follows:
          PORT: 4000
   STATUS_PORT: 10080
         LEASE: 45s
-      VERSION: 8.0.11-TiDB-v8.3.0
+      VERSION: 8.0.11-TiDB-v8.4.0
      GIT_HASH: 827d8ff2d22ac4c93ae1b841b79d468211e1d393
 BINLOG_STATUS: Off
        LABELS:

diff --git a/pd-control.md b/pd-control.md
@@ -29,7 +29,7 @@ To obtain `pd-ctl` of the latest version, download the TiDB server installation
 
 > **Note:**
 >
-> `{version}` in the link indicates the version number of TiDB. For example, the download link for `v8.3.0` in the `amd64` architecture is `https://download.pingcap.org/tidb-community-server-v8.3.0-linux-amd64.tar.gz`.
+> `{version}` in the link indicates the version number of TiDB. For example, the download link for `v8.4.0` in the `amd64` architecture is `https://download.pingcap.org/tidb-community-server-v8.4.0-linux-amd64.tar.gz`.
 
 ### Compile from source code
 

diff --git a/performance-schema/performance-schema-session-connect-attrs.md b/performance-schema/performance-schema-session-connect-attrs.md
@@ -52,7 +52,7 @@ TABLE SESSION_CONNECT_ATTRS;
 | PROCESSLIST_ID | ATTR_NAME       | ATTR_VALUE | ORDINAL_POSITION |
 +----------------+-----------------+------------+------------------+
 |        2097154 | _client_name    | libmysql   |                0 |
-|        2097154 | _client_version | 8.3.0      |                1 |
+|        2097154 | _client_version | 8.4.0      |                1 |
 |        2097154 | _os             | Linux      |                2 |
 |        2097154 | _pid            | 1299203    |                3 |
 |        2097154 | _platform       | x86_64     |                4 |

diff --git a/post-installation-check.md b/post-installation-check.md
@@ -63,7 +63,7 @@ The following information indicates successful login:
 ```sql
 Welcome to the MySQL monitor.  Commands end with ; or \g.
 Your MySQL connection id is 3
-Server version: 8.0.11-TiDB-v8.3.0 TiDB Server (Apache License 2.0) Community Edition, MySQL 8.0 compatible
+Server version: 8.0.11-TiDB-v8.4.0 TiDB Server (Apache License 2.0) Community Edition, MySQL 8.0 compatible
 Copyright (c) 2000, 2023, Oracle and/or its affiliates. All rights reserved.
 Oracle is a registered trademark of Oracle Corporation and/or its
 affiliates. Other names may be trademarks of their respective

diff --git a/production-deployment-using-tiup.md b/production-deployment-using-tiup.md
@@ -95,7 +95,7 @@ https://download.pingcap.org/tidb-community-toolkit-{version}-linux-{arch}.tar.g
 
 > **Tip:**
 >
-> `{version}` in the link indicates the version number of TiDB and `{arch}` indicates the architecture of the system, which can be `amd64` or `arm64`. For example, the download link for `v8.3.0` in the `amd64` architecture is `https://download.pingcap.org/tidb-community-toolkit-v8.3.0-linux-amd64.tar.gz`.
+> `{version}` in the link indicates the version number of TiDB and `{arch}` indicates the architecture of the system, which can be `amd64` or `arm64`. For example, the download link for `v8.4.0` in the `amd64` architecture is `https://download.pingcap.org/tidb-community-toolkit-v8.4.0-linux-amd64.tar.gz`.
 
 **Method 2**: Manually pack an offline component package using `tiup mirror clone`. The detailed steps are as follows:
 
@@ -345,13 +345,13 @@ Before you run the `deploy` command, use the `check` and `check --apply` command
     {{< copyable "shell-regular" >}}
 
     ```shell
-    tiup cluster deploy tidb-test v8.3.0 ./topology.yaml --user root [-p] [-i /home/root/.ssh/gcp_rsa]
+    tiup cluster deploy tidb-test v8.4.0 ./topology.yaml --user root [-p] [-i /home/root/.ssh/gcp_rsa]
     ```
 
 In the `tiup cluster deploy` command above:
 
 - `tidb-test` is the name of the TiDB cluster to be deployed.
-- `v8.3.0` is the version of the TiDB cluster to be deployed. You can see the latest supported versions by running `tiup list tidb`.
+- `v8.4.0` is the version of the TiDB cluster to be deployed. You can see the latest supported versions by running `tiup list tidb`.
 - `topology.yaml` is the initialization configuration file.
 - `--user root` indicates logging into the target machine as the `root` user to complete the cluster deployment. The `root` user is expected to have `ssh` and `sudo` privileges to the target machine. Alternatively, you can use other users with `ssh` and `sudo` privileges to complete the deployment.
 - `[-i]` and `[-p]` are optional. If you have configured login to the target machine without password, these parameters are not required. If not, choose one of the two parameters. `[-i]` is the private key of the root user (or other users specified by `--user`) that has access to the target machine. `[-p]` is used to input the user password interactively.

diff --git a/quick-start-with-tidb.md b/quick-start-with-tidb.md
@@ -81,10 +81,10 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in
         {{< copyable "shell-regular" >}}
 
         ```shell
-        tiup playground v8.3.0 --db 2 --pd 3 --kv 3
+        tiup playground v8.4.0 --db 2 --pd 3 --kv 3
         ```
 
-        The command downloads a version cluster to the local machine and starts it, such as v8.3.0. To view the latest version, run `tiup list tidb`.
+        The command downloads a version cluster to the local machine and starts it, such as v8.4.0. To view the latest version, run `tiup list tidb`.
 
         This command returns the access methods of the cluster:
 
@@ -202,10 +202,10 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in
         {{< copyable "shell-regular" >}}
 
         ```shell
-        tiup playground v8.3.0 --db 2 --pd 3 --kv 3
+        tiup playground v8.4.0 --db 2 --pd 3 --kv 3
         ```
 
-        The command downloads a version cluster to the local machine and starts it, such as v8.3.0. To view the latest version, run `tiup list tidb`.
+        The command downloads a version cluster to the local machine and starts it, such as v8.4.0. To view the latest version, run `tiup list tidb`.
 
         This command returns the access methods of the cluster:
 
@@ -437,7 +437,7 @@ Other requirements for the target machine include:
     ```
 
     - `<cluster-name>`: Set the cluster name
-    - `<version>`: Set the TiDB cluster version, such as `v8.3.0`. You can see all the supported TiDB versions by running the `tiup list tidb` command
+    - `<version>`: Set the TiDB cluster version, such as `v8.4.0`. You can see all the supported TiDB versions by running the `tiup list tidb` command
     - `-p`: Specify the password used to connect to the target machine.
 
         > **Note:**