system-variables: add tidb_paging_size_bytes (internal use)#21752
system-variables: add tidb_paging_size_bytes (internal use)#21752JmPotato wants to merge 2 commits into
Conversation
Signed-off-by: JmPotato <github@ipotato.me>
| - 范围:`[0, 9223372036854775807]` | ||
| - 单位:字节 | ||
| - 这个变量用来设置 coprocessor 协议中单个 paging 响应的字节数上限,用于在按行数分页([`tidb_max_paging_size`](#tidb_max_paging_size-从-v630-版本开始引入))之外,额外提供按字节分页的能力。默认值为 `0`,表示关闭按字节分页。该功能仅在开启[资源管控](/tidb-resource-control-ru-groups.md)时生效,供 PD 资源管控做 RU 预扣费使用。 | ||
| - 该变量是 TiDB 内部使用的变量,**不推荐**修改该变量的值。 |
There was a problem hiding this comment.
| - 该变量是 TiDB 内部使用的变量,**不推荐**修改该变量的值。 | |
| - 该变量为 TiDB 内部变量,**不推荐**修改该变量的值。 |
| - 默认值:`0` | ||
| - 范围:`[0, 9223372036854775807]` | ||
| - 单位:字节 | ||
| - 这个变量用来设置 coprocessor 协议中单个 paging 响应的字节数上限,用于在按行数分页([`tidb_max_paging_size`](#tidb_max_paging_size-从-v630-版本开始引入))之外,额外提供按字节分页的能力。默认值为 `0`,表示关闭按字节分页。该功能仅在开启[资源管控](/tidb-resource-control-ru-groups.md)时生效,供 PD 资源管控做 RU 预扣费使用。 |
There was a problem hiding this comment.
| - 这个变量用来设置 coprocessor 协议中单个 paging 响应的字节数上限,用于在按行数分页([`tidb_max_paging_size`](#tidb_max_paging_size-从-v630-版本开始引入))之外,额外提供按字节分页的能力。默认值为 `0`,表示关闭按字节分页。该功能仅在开启[资源管控](/tidb-resource-control-ru-groups.md)时生效,供 PD 资源管控做 RU 预扣费使用。 | |
| - 控制 coprocessor 协议中单个分页响应的字节数上限,用于在 [`tidb_max_paging_size`](#tidb_max_paging_size-从-v630-版本开始引入) 所提供的按行数分页机制之外,额外提供按字节数分页的能力。默认值为 `0`,表示关闭按字节分页。该功能仅在开启[资源管控](/tidb-resource-control-ru-groups.md)时且当前语句所属资源组具有固定的 RU 配额时生效,供 PD 的资源管控模块在执行语句前根据扫描数据量预估并预扣 RU。 |
There was a problem hiding this comment.
reason: “预扣费”通常表示预先扣除费用,容易使人误以为 RU 是货币费用;此处实际是预扣 RU。
There was a problem hiding this comment.
已采纳该措辞,并同步了 pingcap/tidb#69868 的改动:默认值更新为 4194304(即 4 MiB),同时补充说明设为 0 表示关闭按字节数分页。
[LGTM Timeline notifier]Timeline:
|
|
@JmPotato I've added a few comments on this PR. PTAL. |
…rding - Sync the default value with pingcap/tidb#69868: 0 -> 4194304 (4 MiB) - Apply review suggestions: clarify the byte-budget paging description, note that 0 disables it, and reword the internal-variable notice Signed-off-by: JmPotato <github@ipotato.me>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
📝 WalkthroughWalkthrough新增 Changes分页字节数变量文档
Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
/hold |
What is changed, added or deleted? (Required)
新增系统变量
tidb_paging_size_bytes的文档说明。该变量由 pingcap/tidb#68091 引入,用于在 coprocessor 分页协议中,按字节数为单个 paging 响应设置上限(在按行数分页
tidb_max_paging_size之外,额外提供按字节分页的能力)。默认值经 pingcap/tidb#69868 调整为4194304(即 4 MiB),设为0表示关闭按字节数分页。该功能仅在开启资源管控且当前语句所属资源组具有固定的 RU 配额时生效,供 PD 的资源管控模块在执行语句前根据扫描数据量预估并预扣 RU。该变量为 TiDB 内部变量,因此文档中已明确标注 不推荐修改该变量的值。
字段(作用域、是否持久化、SET_VAR Hint、类型、默认值、范围、单位)均取自源码定义(
ScopeGlobal | ScopeSession、TypeUnsigned、默认4194304、范围[0, math.MaxInt64])。Which TiDB version(s) do your changes apply to? (Required)
What is the related PR or file link(s)?
Summary by CodeRabbit
tidb_paging_size_bytes的说明,包括作用域、默认值、取值范围及持久化设置方式。