v6.5.12: tidb: add description for var tidb_ddl_reorg_max_write_speed (#19071) (#19256)

Co-authored-by: tangenta <[email protected]>
Co-authored-by: Grace Cai <[email protected]>
Co-authored-by: xixirangrang <[email protected]>
Co-authored-by: cbcwestwolf <[email protected]>

Author: 5 people

system-variables.md

@@ -1007,6 +1007,16 @@ MPP 是 TiFlash 引擎提供的分布式计算框架，允许节点之间的数
 - 可选值：`PRIORITY_LOW`、`PRIORITY_NORMAL`、`PRIORITY_HIGH`
 - 这个变量用来设置 `ADD INDEX` 操作 `re-organize` 阶段的执行优先级，可设置为 `PRIORITY_LOW`/`PRIORITY_NORMAL`/`PRIORITY_HIGH`。
 
+### `tidb_ddl_reorg_max_write_speed` <span class="version-mark">从 v6.5.12 版本开始引入</span>
+
+- 作用域：GLOBAL
+- 是否持久化到集群：是
+- 类型：整数型
+- 默认值：`0`
+- 范围：`[0, 1125899906842624]`（即最大可设置为 1 PiB）
+- 这个变量用于限制每个 TiKV 节点写入的带宽，仅在开启添加索引加速功能时生效（由变量 [`tidb_ddl_enable_fast_reorg`](#tidb_ddl_enable_fast_reorg-从-v630-版本开始引入) 控制）。在数据量特别大的情况下（如数十亿行数据），降低加索引时写入 TiKV 节点的带宽可以有效减少对业务负载的影响。
+- 默认值 `0` 表示不限制写入带宽。默认单位为字节每秒，也可以通过 `'1GiB'`、`'256MiB'` 等格式设置该变量。
+
 ### `tidb_ddl_reorg_worker_cnt`
 
 - 作用域：GLOBAL