system-variables: add tidb_paging_size_bytes (internal use) by qiancai · Pull Request #23565 · pingcap/docs

qiancai · 2026-08-19T06:35:40Z

What is changed, added or deleted? (Required)

This PR is translated from: pingcap/docs-cn#21752

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

master (the latest development version)

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

Other reference link(s):
- pingcap/tidb PR: *: add tidb_paging_size_bytes and forward it to coprocessor RPC tidb#68091
- pingcap/tidb PR（恢复默认值为 0）: sessionctx: restore tidb_paging_size_bytes default to 0 tidb#70052
- kvproto PR: proto: add paging_size_bytes to coprocessor.Request kvproto#1448

Summary by CodeRabbit

Documentation
- Documented the new tidb_paging_size_bytes system variable for v9.0.0.
- Described its persisted SESSION/GLOBAL scope, integer type, default value of 0, supported range, byte unit, and SET_VAR support.
- Explained that it limits paged coprocessor responses by bytes when resource control and fixed RU quotas are enabled.
- Noted that it is intended for internal use and is generally not recommended for manual modification.

Synced from: pingcap/docs-cn#21752 Target PR: pingcap#23565 Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

github-actions · 2026-08-19T06:37:19Z

Auto-sync completed successfully

Source PR: pingcap/docs-cn#21752
Target PR: #23565

English documentation has been updated based on Chinese documentation changes.

ti-chi-bot · 2026-08-19T06:37:25Z

[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 assign breezewish for approval. 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:

OWNERS

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

coderabbitai · 2026-08-19T06:38:03Z

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

▶️ Resume reviews
🔍 Trigger review

📝 Walkthrough

Walkthrough

The system variable reference documents tidb_paging_size_bytes in v9.0.0. It defines byte-based coprocessor pagination, scope, type, default, range, prerequisites, and internal-use guidance.

Changes

Paging variable documentation

Layer / File(s)	Summary
Add `tidb_paging_size_bytes` reference `system-variables.md`	Documents the variable’s SESSION/GLOBAL scopes, integer range, byte unit, default value, `SET_VAR` support, pagination behavior, prerequisites, and internal-use warning.

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

Merge Risk: 🟡 Moderate · up to 3b9f8

The new variable’s documentation currently misstates the byte-based pagination behavior, which could lead to incorrect configuration and RU estimation; merge should wait for this wording and the unsigned type metadata to be corrected.

Suggested reviewers: jmpotato, hfxsd, 0xpoe

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description check	✅ Passed	The description identifies the change as a translated documentation update, selects master, and provides related reference links.
Title check	✅ Passed	The title clearly identifies the system variable documentation change and notes its internal-use status.
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.

✨ 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.}

coderabbitai

Actionable comments posted: 1

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 3ca8963c-4b06-4514-8a0d-f14d178822a7

📥 Commits

Reviewing files that changed from the base of the PR and between 763bb1f and dad2709.

📒 Files selected for processing (1)

system-variables.md

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.

coderabbitai

Actionable comments posted: 1

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 930a3f5f-bfc6-4321-8bf8-d5d24d3bbfe5

📥 Commits

Reviewing files that changed from the base of the PR and between dad2709 and a7a3bf5.

📒 Files selected for processing (1)

system-variables.md

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.

qiancai · 2026-08-19T07:48:40Z

/cc @JmPotato

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

coderabbitai

Actionable comments posted: 1

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 2607efea-6510-400b-9b48-8b0f823da67d

📥 Commits

Reviewing files that changed from the base of the PR and between a7a3bf5 and 3b9f878.

📒 Files selected for processing (1)

system-variables.md

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.

ti-chi-bot · 2026-08-21T08:02:41Z

@JmPotato: adding LGTM is restricted to approvers and reviewers in OWNERS files.

Details

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Create empty translation PR

2c5b075

qiancai added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. v9.0-beta.3 This PR/issue applies to TiDB v9.0-beta.3. labels Aug 19, 2026

ti-chi-bot Bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Aug 19, 2026

Auto-sync: Update English docs from Chinese PR

dad2709

Synced from: pingcap/docs-cn#21752 Target PR: pingcap#23565 Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

ti-chi-bot Bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Aug 19, 2026

coderabbitai Bot reviewed Aug 19, 2026

View reviewed changes

Comment thread system-variables.md

qiancai commented Aug 19, 2026

View reviewed changes

Comment thread system-variables.md Outdated

Update system-variables.md

a7a3bf5

coderabbitai Bot reviewed Aug 19, 2026

View reviewed changes

Comment thread system-variables.md Outdated

ti-chi-bot Bot requested a review from JmPotato August 19, 2026 07:48

Update system-variables.md

3b9f878

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

coderabbitai Bot reviewed Aug 20, 2026

View reviewed changes

Comment thread system-variables.md

JmPotato approved these changes Aug 21, 2026

View reviewed changes

Navigation Menu

Uh oh!

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

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

qiancai commented Aug 19, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

github-actions Bot commented Aug 19, 2026

Uh oh!

ti-chi-bot Bot commented Aug 19, 2026

Uh oh!

coderabbitai Bot commented Aug 19, 2026 •

edited

Loading

Reviews paused

Walkthrough

Changes

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

qiancai commented Aug 19, 2026

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

ti-chi-bot Bot commented Aug 21, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

qiancai commented Aug 19, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What is changed, added or deleted? (Required)

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

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

Summary by CodeRabbit

Summary by CodeRabbit

Uh oh!

github-actions Bot commented Aug 19, 2026

Uh oh!

ti-chi-bot Bot commented Aug 19, 2026

Uh oh!

coderabbitai Bot commented Aug 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Walkthrough

Changes

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

qiancai commented Aug 19, 2026

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ti-chi-bot Bot commented Aug 21, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

qiancai commented Aug 19, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Aug 19, 2026 •

edited

Loading