Skip to content

system-variables: add tidb_paging_size_bytes (internal use)#21752

Open
JmPotato wants to merge 2 commits into
pingcap:masterfrom
JmPotato:add-tidb-paging-size-bytes
Open

system-variables: add tidb_paging_size_bytes (internal use)#21752
JmPotato wants to merge 2 commits into
pingcap:masterfrom
JmPotato:add-tidb-paging-size-bytes

Conversation

@JmPotato

@JmPotato JmPotato commented Jul 1, 2026

Copy link
Copy Markdown
Member

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 | ScopeSessionTypeUnsigned、默认 4194304、范围 [0, math.MaxInt64])。

Which TiDB version(s) do your changes apply to? (Required)

  • master (the latest development version)

What is the related PR or file link(s)?

Summary by CodeRabbit

  • 文档
    • 新增系统变量 tidb_paging_size_bytes 的说明,包括作用域、默认值、取值范围及持久化设置方式。
    • 补充按字节分页的生效条件、资源管控要求和使用限制。
    • 标注该变量为 TiDB 内部变量,不建议修改。

Signed-off-by: JmPotato <github@ipotato.me>
@ti-chi-bot ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jul 1, 2026
@qiancai qiancai self-assigned this Jul 10, 2026
@qiancai qiancai added the translation/doing This PR’s assignee is translating this PR. label Jul 10, 2026
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Jul 10, 2026
Comment thread system-variables.md Outdated
- 范围:`[0, 9223372036854775807]`
- 单位:字节
- 这个变量用来设置 coprocessor 协议中单个 paging 响应的字节数上限,用于在按行数分页([`tidb_max_paging_size`](#tidb_max_paging_size-从-v630-版本开始引入))之外,额外提供按字节分页的能力。默认值为 `0`,表示关闭按字节分页。该功能仅在开启[资源管控](/tidb-resource-control-ru-groups.md)时生效,供 PD 资源管控做 RU 预扣费使用。
- 该变量是 TiDB 内部使用的变量,**不推荐**修改该变量的值。

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- 该变量是 TiDB 内部使用的变量**不推荐**修改该变量的值。
- 该变量为 TiDB 内部变量**不推荐**修改该变量的值。

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

已采纳,感谢 review!

@qiancai qiancai left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rest LGTM

Comment thread system-variables.md Outdated
- 默认值:`0`
- 范围:`[0, 9223372036854775807]`
- 单位:字节
- 这个变量用来设置 coprocessor 协议中单个 paging 响应的字节数上限,用于在按行数分页([`tidb_max_paging_size`](#tidb_max_paging_size-从-v630-版本开始引入))之外,额外提供按字节分页的能力。默认值为 `0`,表示关闭按字节分页。该功能仅在开启[资源管控](/tidb-resource-control-ru-groups.md)时生效,供 PD 资源管控做 RU 预扣费使用。

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- 这个变量用来设置 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。

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reason: “预扣费”通常表示预先扣除费用,容易使人误以为 RU 是货币费用;此处实际是预扣 RU。

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

已采纳该措辞,并同步了 pingcap/tidb#69868 的改动:默认值更新为 4194304(即 4 MiB),同时补充说明设为 0 表示关闭按字节数分页。

@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jul 14, 2026
@ti-chi-bot

ti-chi-bot Bot commented Jul 14, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-07-14 07:23:37.163120982 +0000 UTC m=+698403.199216038: ☑️ agreed by qiancai.

@qiancai

qiancai commented Jul 14, 2026

Copy link
Copy Markdown
Collaborator

@JmPotato I've added a few comments on this PR. PTAL.

@qiancai qiancai added the v9.0-beta.3 This PR/issue applies to TiDB v9.0-beta.3. label Jul 14, 2026
…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>
@ti-chi-bot

ti-chi-bot Bot commented Jul 17, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from qiancai. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

新增 tidb_paging_size_bytes 系统变量文档,说明其配置属性、默认值、取值范围、按字节数分页的生效条件,以及内部变量属性。

Changes

分页字节数变量文档

Layer / File(s) Summary
分页字节数变量说明
system-variables.md
新增 tidb_paging_size_bytes 的版本、作用域、持久化与 Hint 设置属性、类型、默认值、范围及生效条件说明。

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: qiancai, lilin90

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed 标题准确概括了新增 tidb_paging_size_bytes 文档且强调内部使用,符合该变更。
Description check ✅ Passed 描述包含变更内容、适用版本和相关链接,且补充了默认值、作用域与内部变量说明,整体完整。
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@JmPotato

Copy link
Copy Markdown
Member Author

/hold

@ti-chi-bot ti-chi-bot Bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. translation/doing This PR’s assignee is translating this PR. v9.0-beta.3 This PR/issue applies to TiDB v9.0-beta.3.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants