From 101b6ed1786e65d5793bac3d1d5db48acbca789d Mon Sep 17 00:00:00 2001
From: cbcwestwolf <1004626265@qq.com>
Date: Wed, 13 Nov 2024 21:23:31 +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 283626f21342..0b36d25c8456 100644
--- a/system-variables.md
+++ b/system-variables.md
@@ -1508,6 +1508,16 @@ mysql> SELECT job_info FROM mysql.analyze_jobs ORDER BY end_time DESC LIMIT 1;
- 可选值:`PRIORITY_LOW`、`PRIORITY_NORMAL`、`PRIORITY_HIGH`
- 这个变量用来设置 `ADD INDEX` 操作 `re-organize` 阶段的执行优先级,可设置为 `PRIORITY_LOW`/`PRIORITY_NORMAL`/`PRIORITY_HIGH`。
+### `tidb_ddl_reorg_max_write_speed` 从 v8.5.0 版本开始引入
+
+- 作用域:GLOBAL
+- 是否持久化到集群:是
+- 是否受 Hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value) 控制:否
+- 类型:整数型
+- 默认值:`0`
+- 范围:`[0, 1125899906842624]`(1 PiB)
+- 添加索引加速功能开启(由变量 `tidb_ddl_enable_fast_reorg` 控制)时,这个变量用于限制向每个 TiKV 节点写入的带宽大小,单位为字节。 默认值 `0` 表示不限制写入带宽。可以通过 `'1GiB'`、`256MiB` 等方式设置该变量。
+
### `tidb_ddl_reorg_worker_cnt`
- 作用域:GLOBAL
From 9f272b560ea26abb68ec4837722f43b960f50e6f Mon Sep 17 00:00:00 2001
From: CbcWestwolf <1004626265@qq.com>
Date: Thu, 14 Nov 2024 14:30:16 +0800
Subject: [PATCH 2/9] Update system-variables.md
Co-authored-by: tangenta
---
system-variables.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/system-variables.md b/system-variables.md
index 0b36d25c8456..dd74e15ff1f6 100644
--- a/system-variables.md
+++ b/system-variables.md
@@ -1516,7 +1516,7 @@ mysql> SELECT job_info FROM mysql.analyze_jobs ORDER BY end_time DESC LIMIT 1;
- 类型:整数型
- 默认值:`0`
- 范围:`[0, 1125899906842624]`(1 PiB)
-- 添加索引加速功能开启(由变量 `tidb_ddl_enable_fast_reorg` 控制)时,这个变量用于限制向每个 TiKV 节点写入的带宽大小,单位为字节。 默认值 `0` 表示不限制写入带宽。可以通过 `'1GiB'`、`256MiB` 等方式设置该变量。
+- 添加索引加速功能开启(由变量 `tidb_ddl_enable_fast_reorg` 控制)时,这个变量用于限制向每个 TiKV 节点写入的带宽大小,单位为字节每秒。 默认值 `0` 表示不限制写入带宽。可以通过 `'1GiB'`、`256MiB` 等方式设置该变量。
### `tidb_ddl_reorg_worker_cnt`
From 28079af979e7fcc35ef4cad2d04dc52a732e072d Mon Sep 17 00:00:00 2001
From: CbcWestwolf <1004626265@qq.com>
Date: Mon, 18 Nov 2024 10:31:08 +0800
Subject: [PATCH 3/9] Update system-variables.md
Co-authored-by: Grace Cai
---
system-variables.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/system-variables.md b/system-variables.md
index dd74e15ff1f6..7081ccd99f0f 100644
--- a/system-variables.md
+++ b/system-variables.md
@@ -1516,7 +1516,7 @@ mysql> SELECT job_info FROM mysql.analyze_jobs ORDER BY end_time DESC LIMIT 1;
- 类型:整数型
- 默认值:`0`
- 范围:`[0, 1125899906842624]`(1 PiB)
-- 添加索引加速功能开启(由变量 `tidb_ddl_enable_fast_reorg` 控制)时,这个变量用于限制向每个 TiKV 节点写入的带宽大小,单位为字节每秒。 默认值 `0` 表示不限制写入带宽。可以通过 `'1GiB'`、`256MiB` 等方式设置该变量。
+- 该变量仅在添加索引加速功能开启(由变量 [`tidb_ddl_enable_fast_reorg`](#tidb_ddl_enable_fast_reorg-从-v630-版本开始引入) 控制)时生效,用于限制每个 TiKV 节点写入的带宽。 默认值 `0` 表示不限制写入带宽。默认单位为字节每秒,也可以通过 `'1GiB'`、`256MiB` 等格式设置该变量。
### `tidb_ddl_reorg_worker_cnt`
From 631dfa439c98374b6e3e0d5b0d7352d1853d73d9 Mon Sep 17 00:00:00 2001
From: CbcWestwolf <1004626265@qq.com>
Date: Mon, 18 Nov 2024 10:31:17 +0800
Subject: [PATCH 4/9] Update system-variables.md
Co-authored-by: Grace Cai
---
system-variables.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/system-variables.md b/system-variables.md
index 7081ccd99f0f..4f23995da80f 100644
--- a/system-variables.md
+++ b/system-variables.md
@@ -1515,7 +1515,7 @@ mysql> SELECT job_info FROM mysql.analyze_jobs ORDER BY end_time DESC LIMIT 1;
- 是否受 Hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value) 控制:否
- 类型:整数型
- 默认值:`0`
-- 范围:`[0, 1125899906842624]`(1 PiB)
+- 范围:`[0, 1125899906842624]`(即最大可设置为 1 PiB)
- 该变量仅在添加索引加速功能开启(由变量 [`tidb_ddl_enable_fast_reorg`](#tidb_ddl_enable_fast_reorg-从-v630-版本开始引入) 控制)时生效,用于限制每个 TiKV 节点写入的带宽。 默认值 `0` 表示不限制写入带宽。默认单位为字节每秒,也可以通过 `'1GiB'`、`256MiB` 等格式设置该变量。
### `tidb_ddl_reorg_worker_cnt`
From 40b6eefb60a27ed3d3950aa1ce6ed9c4292cb30c Mon Sep 17 00:00:00 2001
From: CbcWestwolf <1004626265@qq.com>
Date: Tue, 19 Nov 2024 16:01:47 +0800
Subject: [PATCH 5/9] Update system-variables.md
Co-authored-by: xixirangrang
---
system-variables.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/system-variables.md b/system-variables.md
index 4f23995da80f..50945be5a9d8 100644
--- a/system-variables.md
+++ b/system-variables.md
@@ -1516,7 +1516,7 @@ mysql> SELECT job_info FROM mysql.analyze_jobs ORDER BY end_time DESC LIMIT 1;
- 类型:整数型
- 默认值:`0`
- 范围:`[0, 1125899906842624]`(即最大可设置为 1 PiB)
-- 该变量仅在添加索引加速功能开启(由变量 [`tidb_ddl_enable_fast_reorg`](#tidb_ddl_enable_fast_reorg-从-v630-版本开始引入) 控制)时生效,用于限制每个 TiKV 节点写入的带宽。 默认值 `0` 表示不限制写入带宽。默认单位为字节每秒,也可以通过 `'1GiB'`、`256MiB` 等格式设置该变量。
+- 该变量仅在添加索引加速功能开启(由变量 [`tidb_ddl_enable_fast_reorg`](#tidb_ddl_enable_fast_reorg-从-v630-版本开始引入) 控制)时生效,用于限制每个 TiKV 节点写入的带宽。默认值 `0` 表示不限制写入带宽。默认单位为字节每秒,也可以通过 `'1GiB'`、`256MiB` 等格式设置该变量。
### `tidb_ddl_reorg_worker_cnt`
From ab4217d3491358aa17722811aad962ee587dac6c Mon Sep 17 00:00:00 2001
From: cbcwestwolf <1004626265@qq.com>
Date: Tue, 19 Nov 2024 16:05:56 +0800
Subject: [PATCH 6/9] update
---
system-variables.md | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/system-variables.md b/system-variables.md
index 50945be5a9d8..dfc0c3aa0099 100644
--- a/system-variables.md
+++ b/system-variables.md
@@ -1516,7 +1516,8 @@ mysql> SELECT job_info FROM mysql.analyze_jobs ORDER BY end_time DESC LIMIT 1;
- 类型:整数型
- 默认值:`0`
- 范围:`[0, 1125899906842624]`(即最大可设置为 1 PiB)
-- 该变量仅在添加索引加速功能开启(由变量 [`tidb_ddl_enable_fast_reorg`](#tidb_ddl_enable_fast_reorg-从-v630-版本开始引入) 控制)时生效,用于限制每个 TiKV 节点写入的带宽。默认值 `0` 表示不限制写入带宽。默认单位为字节每秒,也可以通过 `'1GiB'`、`256MiB` 等格式设置该变量。
+- 这个变量用于限制每个 TiKV 节点写入的带宽,仅在开启添加索引加速功能时生效(由变量 [`tidb_ddl_enable_fast_reorg`](#tidb_ddl_enable_fast_reorg-从-v630-版本开始引入) 控制)。在数据量特别大的情况下,降低加索引时写入 TiKV 节点的带宽可以有效减少对前端负载的影响。
+- 默认值 `0` 表示不限制写入带宽。默认单位为字节每秒,也可以通过 `'1GiB'`、`256MiB` 等格式设置该变量。
### `tidb_ddl_reorg_worker_cnt`
From 5b27dd987214945c51ff51f2e37064ec635b5342 Mon Sep 17 00:00:00 2001
From: CbcWestwolf <1004626265@qq.com>
Date: Fri, 22 Nov 2024 16:24:58 +0800
Subject: [PATCH 7/9] Update system-variables.md
Co-authored-by: Grace Cai
---
system-variables.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/system-variables.md b/system-variables.md
index dfc0c3aa0099..61241d14957c 100644
--- a/system-variables.md
+++ b/system-variables.md
@@ -1516,7 +1516,7 @@ mysql> SELECT job_info FROM mysql.analyze_jobs ORDER BY end_time DESC LIMIT 1;
- 类型:整数型
- 默认值:`0`
- 范围:`[0, 1125899906842624]`(即最大可设置为 1 PiB)
-- 这个变量用于限制每个 TiKV 节点写入的带宽,仅在开启添加索引加速功能时生效(由变量 [`tidb_ddl_enable_fast_reorg`](#tidb_ddl_enable_fast_reorg-从-v630-版本开始引入) 控制)。在数据量特别大的情况下,降低加索引时写入 TiKV 节点的带宽可以有效减少对前端负载的影响。
+- 这个变量用于限制每个 TiKV 节点写入的带宽,仅在开启添加索引加速功能时生效(由变量 [`tidb_ddl_enable_fast_reorg`](#tidb_ddl_enable_fast_reorg-从-v630-版本开始引入) 控制)。在数据量特别大的情况下(如数十亿行数据),降低加索引时写入 TiKV 节点的带宽可以有效减少对业务负载的影响。
- 默认值 `0` 表示不限制写入带宽。默认单位为字节每秒,也可以通过 `'1GiB'`、`256MiB` 等格式设置该变量。
### `tidb_ddl_reorg_worker_cnt`
From b8bc0256d87b6b4f083948eff7502b7ee26a4411 Mon Sep 17 00:00:00 2001
From: CbcWestwolf <1004626265@qq.com>
Date: Tue, 26 Nov 2024 16:26:59 +0800
Subject: [PATCH 8/9] Update system-variables.md
Co-authored-by: Grace Cai
---
system-variables.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/system-variables.md b/system-variables.md
index 61241d14957c..a6001b580ab6 100644
--- a/system-variables.md
+++ b/system-variables.md
@@ -1517,7 +1517,7 @@ mysql> SELECT job_info FROM mysql.analyze_jobs ORDER BY end_time DESC LIMIT 1;
- 默认值:`0`
- 范围:`[0, 1125899906842624]`(即最大可设置为 1 PiB)
- 这个变量用于限制每个 TiKV 节点写入的带宽,仅在开启添加索引加速功能时生效(由变量 [`tidb_ddl_enable_fast_reorg`](#tidb_ddl_enable_fast_reorg-从-v630-版本开始引入) 控制)。在数据量特别大的情况下(如数十亿行数据),降低加索引时写入 TiKV 节点的带宽可以有效减少对业务负载的影响。
-- 默认值 `0` 表示不限制写入带宽。默认单位为字节每秒,也可以通过 `'1GiB'`、`256MiB` 等格式设置该变量。
+- 默认值 `0` 表示不限制写入带宽。默认单位为字节每秒,也可以通过 `'1GiB'`、`'256MiB'` 等格式设置该变量。
### `tidb_ddl_reorg_worker_cnt`
From 13758e8b28b743cb17a1e1046e0c493827106ec0 Mon Sep 17 00:00:00 2001
From: cbcwestwolf <1004626265@qq.com>
Date: Tue, 24 Jun 2025 09:46:02 +0800
Subject: [PATCH 9/9] update
---
system-variables.md | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/system-variables.md b/system-variables.md
index a6001b580ab6..4c3bdbc4f047 100644
--- a/system-variables.md
+++ b/system-variables.md
@@ -1508,16 +1508,19 @@ mysql> SELECT job_info FROM mysql.analyze_jobs ORDER BY end_time DESC LIMIT 1;
- 可选值:`PRIORITY_LOW`、`PRIORITY_NORMAL`、`PRIORITY_HIGH`
- 这个变量用来设置 `ADD INDEX` 操作 `re-organize` 阶段的执行优先级,可设置为 `PRIORITY_LOW`/`PRIORITY_NORMAL`/`PRIORITY_HIGH`。
-### `tidb_ddl_reorg_max_write_speed` 从 v8.5.0 版本开始引入
+### `tidb_ddl_reorg_max_write_speed` 从 v6.5.12 和 v7.5.5 版本开始引入
- 作用域:GLOBAL
- 是否持久化到集群:是
- 是否受 Hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value) 控制:否
-- 类型:整数型
+- 类型:字符串
- 默认值:`0`
-- 范围:`[0, 1125899906842624]`(即最大可设置为 1 PiB)
+- 范围:`[0, 1PiB]`
- 这个变量用于限制每个 TiKV 节点写入的带宽,仅在开启添加索引加速功能时生效(由变量 [`tidb_ddl_enable_fast_reorg`](#tidb_ddl_enable_fast_reorg-从-v630-版本开始引入) 控制)。在数据量特别大的情况下(如数十亿行数据),降低加索引时写入 TiKV 节点的带宽可以有效减少对业务负载的影响。
-- 默认值 `0` 表示不限制写入带宽。默认单位为字节每秒,也可以通过 `'1GiB'`、`'256MiB'` 等格式设置该变量。
+- 默认值 `0` 表示不限制写入带宽。
+- 该变量可设置为带单位的格式或不带单位的格式。
+ - 当该变量值不带单位时,默认单位为字节每秒。例如 `67108864` 表示 `64MiB` 每秒。
+ - 当该变量值带单位时,支持的单位包括 KiB、MiB、GiB、TiB。例如,`'1GiB'` 表示 1 GiB 每秒, `'256MiB'` 表示 256 MiB 每秒。
### `tidb_ddl_reorg_worker_cnt`