From 7dc67b0a59ac600737ca18e1bb48e09620fce61d Mon Sep 17 00:00:00 2001
From: cbcwestwolf <1004626265@qq.com>
Date: Mon, 18 Nov 2024 14:19:40 +0800
Subject: [PATCH 1/9] tidb: add description for var
tidb_ddl_reorg_max_write_speed
---
system-variables.md | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/system-variables.md b/system-variables.md
index 26dda7f009f23..0318c21b0f592 100644
--- a/system-variables.md
+++ b/system-variables.md
@@ -1194,6 +1194,16 @@ MPP is a distributed computing framework provided by the TiFlash engine, which a
- This variable is used to set the priority of executing the `ADD INDEX` operation in the `re-organize` phase.
- You can set the value of this variable to `PRIORITY_LOW`, `PRIORITY_NORMAL` or `PRIORITY_HIGH`.
+### `tidb_ddl_reorg_max_write_speed` New in v8.5.0
+
+- Scope: GLOBAL
+- Persists to cluster: Yes
+- Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No
+- Type: Integer
+- Default value: `0`
+- Range: `[0, 1125899906842624]` (i.e. the maximum value that can be set is 1 PiB)
+- This variable only takes effect when index creation acceleration is enabled (by [`tidb_ddl_enable_fast_reorg`](#tidb_ddl_enable_fast_reorg-new-in-v630)). It limits the bandwidth in which writing data into each TiKV. The default value `0` means no writing limitation. The default unit is bytes per second. You can also set this variable to values like `'1GiB'`, `'256MiB`.
+
### tidb_ddl_reorg_worker_cnt
- Scope: GLOBAL
From 5a5b9012819c8df68426e3e8dae2de9594c23af0 Mon Sep 17 00:00:00 2001
From: CbcWestwolf <1004626265@qq.com>
Date: Mon, 18 Nov 2024 15:25:21 +0800
Subject: [PATCH 2/9] Apply suggestions from code review
Co-authored-by: Grace Cai
---
system-variables.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/system-variables.md b/system-variables.md
index 0318c21b0f592..c577a11a18030 100644
--- a/system-variables.md
+++ b/system-variables.md
@@ -1194,15 +1194,15 @@ MPP is a distributed computing framework provided by the TiFlash engine, which a
- This variable is used to set the priority of executing the `ADD INDEX` operation in the `re-organize` phase.
- You can set the value of this variable to `PRIORITY_LOW`, `PRIORITY_NORMAL` or `PRIORITY_HIGH`.
-### `tidb_ddl_reorg_max_write_speed` New in v8.5.0
+### tidb_ddl_reorg_max_write_speed New in v8.5.0
- Scope: GLOBAL
- Persists to cluster: Yes
- Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No
- Type: Integer
- Default value: `0`
-- Range: `[0, 1125899906842624]` (i.e. the maximum value that can be set is 1 PiB)
-- This variable only takes effect when index creation acceleration is enabled (by [`tidb_ddl_enable_fast_reorg`](#tidb_ddl_enable_fast_reorg-new-in-v630)). It limits the bandwidth in which writing data into each TiKV. The default value `0` means no writing limitation. The default unit is bytes per second. You can also set this variable to values like `'1GiB'`, `'256MiB`.
+- Range: `[0, 1125899906842624]` (the maximum value that can be set is 1 PiB)
+- This variable only takes effect when index creation acceleration is enabled (controlled by the [`tidb_ddl_enable_fast_reorg`](#tidb_ddl_enable_fast_reorg-new-in-v630) variable). It limits the write bandwidth for each TiKV node. The default value `0` means no write bandwidth limit. The default unit is bytes per second. You can also set the value in formats such as `'1GiB'` or `'256MiB`.
### tidb_ddl_reorg_worker_cnt
From cb82c68322177d3053677482971244148987febc Mon Sep 17 00:00:00 2001
From: CbcWestwolf <1004626265@qq.com>
Date: Tue, 19 Nov 2024 16:18:54 +0800
Subject: [PATCH 3/9] Update system-variables.md
Co-authored-by: Aolin
---
system-variables.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/system-variables.md b/system-variables.md
index c577a11a18030..0ab1c1ebeb961 100644
--- a/system-variables.md
+++ b/system-variables.md
@@ -1202,7 +1202,7 @@ MPP is a distributed computing framework provided by the TiFlash engine, which a
- Type: Integer
- Default value: `0`
- Range: `[0, 1125899906842624]` (the maximum value that can be set is 1 PiB)
-- This variable only takes effect when index creation acceleration is enabled (controlled by the [`tidb_ddl_enable_fast_reorg`](#tidb_ddl_enable_fast_reorg-new-in-v630) variable). It limits the write bandwidth for each TiKV node. The default value `0` means no write bandwidth limit. The default unit is bytes per second. You can also set the value in formats such as `'1GiB'` or `'256MiB`.
+- This variable limits the write bandwidth for each TiKV node and only takes effect when index creation acceleration is enabled (controlled by the [`tidb_ddl_enable_fast_reorg`](#tidb_ddl_enable_fast_reorg-new-in-v630) variable). The default value `0` means no write bandwidth limit. The default unit is bytes per second. You can also set the value in formats such as `'1GiB'` or `'256MiB`.
### tidb_ddl_reorg_worker_cnt
From 411db8b8fdae57ad13f8f45cd58d0bc1f7a774e3 Mon Sep 17 00:00:00 2001
From: cbcwestwolf <1004626265@qq.com>
Date: Tue, 19 Nov 2024 16:38:03 +0800
Subject: [PATCH 4/9] update
---
system-variables.md | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/system-variables.md b/system-variables.md
index 0ab1c1ebeb961..e75ab543075c5 100644
--- a/system-variables.md
+++ b/system-variables.md
@@ -1202,7 +1202,8 @@ MPP is a distributed computing framework provided by the TiFlash engine, which a
- Type: Integer
- Default value: `0`
- Range: `[0, 1125899906842624]` (the maximum value that can be set is 1 PiB)
-- This variable limits the write bandwidth for each TiKV node and only takes effect when index creation acceleration is enabled (controlled by the [`tidb_ddl_enable_fast_reorg`](#tidb_ddl_enable_fast_reorg-new-in-v630) variable). The default value `0` means no write bandwidth limit. The default unit is bytes per second. You can also set the value in formats such as `'1GiB'` or `'256MiB`.
+- This variable limits the write bandwidth for each TiKV node and only takes effect when index creation acceleration is enabled (controlled by the [`tidb_ddl_enable_fast_reorg`](#tidb_ddl_enable_fast_reorg-new-in-v630) variable). When the data size in the cluster is quite large, limiting the write bandwidth for index creation can reduce the impact of the frontend workload.
+- The default value `0` means no write bandwidth limit. The default unit is bytes per second. You can also set the value in formats such as `'1GiB'` or `'256MiB`.
### tidb_ddl_reorg_worker_cnt
From 3319d90e67995aff97a8482916bbefd7ee110062 Mon Sep 17 00:00:00 2001
From: cbcwestwolf <1004626265@qq.com>
Date: Tue, 19 Nov 2024 16:51:45 +0800
Subject: [PATCH 5/9] update
---
system-variables.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/system-variables.md b/system-variables.md
index e75ab543075c5..a623ff60fbb26 100644
--- a/system-variables.md
+++ b/system-variables.md
@@ -1202,7 +1202,7 @@ MPP is a distributed computing framework provided by the TiFlash engine, which a
- Type: Integer
- Default value: `0`
- Range: `[0, 1125899906842624]` (the maximum value that can be set is 1 PiB)
-- This variable limits the write bandwidth for each TiKV node and only takes effect when index creation acceleration is enabled (controlled by the [`tidb_ddl_enable_fast_reorg`](#tidb_ddl_enable_fast_reorg-new-in-v630) variable). When the data size in the cluster is quite large, limiting the write bandwidth for index creation can reduce the impact of the frontend workload.
+- This variable limits the write bandwidth for each TiKV node and only takes effect when index creation acceleration is enabled (controlled by the [`tidb_ddl_enable_fast_reorg`](#tidb_ddl_enable_fast_reorg-new-in-v630) variable). When the data size in the cluster is quite large, limiting the write bandwidth for index creation can reduce the impact on the frontend workload.
- The default value `0` means no write bandwidth limit. The default unit is bytes per second. You can also set the value in formats such as `'1GiB'` or `'256MiB`.
### tidb_ddl_reorg_worker_cnt
From 467ee7eba74b0ab2ff33ade41d054388389b2d1a Mon Sep 17 00:00:00 2001
From: Grace Cai
Date: Tue, 26 Nov 2024 14:21:02 +0800
Subject: [PATCH 6/9] Update system-variables.md
---
system-variables.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/system-variables.md b/system-variables.md
index a623ff60fbb26..ec1cbfe3cb912 100644
--- a/system-variables.md
+++ b/system-variables.md
@@ -1202,7 +1202,7 @@ MPP is a distributed computing framework provided by the TiFlash engine, which a
- Type: Integer
- Default value: `0`
- Range: `[0, 1125899906842624]` (the maximum value that can be set is 1 PiB)
-- This variable limits the write bandwidth for each TiKV node and only takes effect when index creation acceleration is enabled (controlled by the [`tidb_ddl_enable_fast_reorg`](#tidb_ddl_enable_fast_reorg-new-in-v630) variable). When the data size in the cluster is quite large, limiting the write bandwidth for index creation can reduce the impact on the frontend workload.
+- This variable limits the write bandwidth for each TiKV node and only takes effect when index creation acceleration is enabled (controlled by the [`tidb_ddl_enable_fast_reorg`](#tidb_ddl_enable_fast_reorg-new-in-v630) variable). When the data size in your cluster is quite large (such as billions of rows), limiting the write bandwidth for index creation can effectively reduce the impact on application workloads.
- The default value `0` means no write bandwidth limit. The default unit is bytes per second. You can also set the value in formats such as `'1GiB'` or `'256MiB`.
### tidb_ddl_reorg_worker_cnt
From 31a511fde9dbe636f38248483c40f4188ad44770 Mon Sep 17 00:00:00 2001
From: Grace Cai
Date: Tue, 26 Nov 2024 16:17:14 +0800
Subject: [PATCH 7/9] minor format updates
---
system-variables.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/system-variables.md b/system-variables.md
index ec1cbfe3cb912..1129da6c27fad 100644
--- a/system-variables.md
+++ b/system-variables.md
@@ -1203,7 +1203,7 @@ MPP is a distributed computing framework provided by the TiFlash engine, which a
- Default value: `0`
- Range: `[0, 1125899906842624]` (the maximum value that can be set is 1 PiB)
- This variable limits the write bandwidth for each TiKV node and only takes effect when index creation acceleration is enabled (controlled by the [`tidb_ddl_enable_fast_reorg`](#tidb_ddl_enable_fast_reorg-new-in-v630) variable). When the data size in your cluster is quite large (such as billions of rows), limiting the write bandwidth for index creation can effectively reduce the impact on application workloads.
-- The default value `0` means no write bandwidth limit. The default unit is bytes per second. You can also set the value in formats such as `'1GiB'` or `'256MiB`.
+- The default value `0` means no write bandwidth limit. The default unit is bytes per second. You can also set the value in formats such as `'1GiB'` or `'256MiB'`.
### tidb_ddl_reorg_worker_cnt
From d5572eaf28a1740330dc3ce02471e83a83e13d78 Mon Sep 17 00:00:00 2001
From: Grace Cai
Date: Wed, 19 Feb 2025 10:43:17 +0800
Subject: [PATCH 8/9] Update system-variables.md
---
system-variables.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/system-variables.md b/system-variables.md
index 1129da6c27fad..4168f9d49edf1 100644
--- a/system-variables.md
+++ b/system-variables.md
@@ -1194,7 +1194,7 @@ MPP is a distributed computing framework provided by the TiFlash engine, which a
- This variable is used to set the priority of executing the `ADD INDEX` operation in the `re-organize` phase.
- You can set the value of this variable to `PRIORITY_LOW`, `PRIORITY_NORMAL` or `PRIORITY_HIGH`.
-### tidb_ddl_reorg_max_write_speed New in v8.5.0
+### tidb_ddl_reorg_max_write_speed New in v6.5.12
- Scope: GLOBAL
- Persists to cluster: Yes
From de77abc382323b15aef727bbca30965bfefe3507 Mon Sep 17 00:00:00 2001
From: Grace Cai
Date: Thu, 27 Feb 2025 20:31:02 +0800
Subject: [PATCH 9/9] Update system-variables.md
---
system-variables.md | 1 -
1 file changed, 1 deletion(-)
diff --git a/system-variables.md b/system-variables.md
index 4168f9d49edf1..b2154a43d0ed8 100644
--- a/system-variables.md
+++ b/system-variables.md
@@ -1198,7 +1198,6 @@ MPP is a distributed computing framework provided by the TiFlash engine, which a
- Scope: GLOBAL
- Persists to cluster: Yes
-- Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No
- Type: Integer
- Default value: `0`
- Range: `[0, 1125899906842624]` (the maximum value that can be set is 1 PiB)