Skip to content

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

Open
ti-chi-bot wants to merge 5 commits into
pingcap:release-8.5from
ti-chi-bot:cherry-pick-23565-to-release-8.5
Open

system-variables: add tidb_paging_size_bytes (internal use) (#23565)#23681
ti-chi-bot wants to merge 5 commits into
pingcap:release-8.5from
ti-chi-bot:cherry-pick-23565-to-release-8.5

Conversation

@ti-chi-bot

@ti-chi-bot ti-chi-bot commented Aug 31, 2026

Copy link
Copy Markdown
Member

This is an automated cherry-pick of #23565

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)?

Summary by CodeRabbit

  • Documentation
    • Documented the tidb_paging_size_bytes system variable for limiting individual coprocessor response pages by byte size.
    • Added details on SESSION scope, cluster persistence, SET_VAR support, default value, valid range, and byte unit.
    • Documented that the setting is disabled by default and available on supported TiDB Cloud tiers running TiDB-X-CLOUD.202603 or later.
    • Noted that this is an internal variable and is not recommended for modification.

@ti-chi-bot ti-chi-bot added lgtm size/S Denotes a PR that changes 10-29 lines, ignoring generated files. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR. v9.0-beta.3 This PR/issue applies to TiDB v9.0-beta.3. labels Aug 31, 2026
@coderabbitai

coderabbitai Bot commented Aug 31, 2026

Copy link
Copy Markdown

Review Change Stack

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

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: fc224502-4a9d-471f-b795-0e4b71b0f478

📥 Commits

Reviewing files that changed from the base of the PR and between 2b3943c and 1f2d97d.

📒 Files selected for processing (1)
  • system-variables.md

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


📝 Walkthrough

Walkthrough

Adds reference documentation for tidb_paging_size_bytes, including its scope, availability, byte-based pagination behavior, default value, range, and SET_VAR support.

Changes

Paging variable documentation

Layer / File(s) Summary
System variable reference
system-variables.md
Documents tidb_paging_size_bytes, including its scope, availability, pagination behavior, default value, range, and SET_VAR support.

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

Merge Risk: 🔵 Low · up to 1f2d9

This change documents byte-based coprocessor paging, but users may be given an incompatible availability statement or omit a required Resource Group configuration, preventing the feature from working as described. Clarify these prerequisites before merge.

Suggested reviewers: qiancai

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description includes version and reference sections, but the required change summary is empty. It also selects master, while the objective states that this is a cherry-pick for the release-8.5 Add a concise explanation of the documentation change and its purpose. Select v8.5 instead of master, or clarify the intended target version and branch. Complete any other applicable template sections, including the AI involvement and c…
✅ Passed checks (4 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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 The title clearly identifies the documentation file and the primary change: adding the internal-use tidb_paging_size_bytes system variable.
Full details: Description check

Explanation

The description includes version and reference sections, but the required change summary is empty. It also selects master, while the objective states that this is a cherry-pick for the release-8.5 branch.

Resolution

Add a concise explanation of the documentation change and its purpose. Select v8.5 instead of master, or clarify the intended target version and branch. Complete any other applicable template sections, including the AI involvement and change-type checklists.

✨ 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 coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 3


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: a3c708e1-3e4c-4aaf-aa4b-38b6b587c48e

📥 Commits

Reviewing files that changed from the base of the PR and between ae3312e and a3645ed.

📒 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.

Comment thread system-variables.md Outdated
Comment thread system-variables.md Outdated

- Scope
- TiDB Self-Managed: SESSION | GLOBAL
- TiDB Cloud Essential and Premium: SESSION

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win

🔎 Supported by static analysis

🏁 Script executed:

printf '%s\n' '--- applicable conventions ---'
find /tmp/coderabbit-repo-knowledge/pingcap-docs-9c73f70c -path '*/\*.md' -print | sort
printf '%s\n' '--- target entry ---'
sed -n '5398,5424p' system-variables.md
printf '%s\n' '--- resource-control references ---'
rg -n -C 4 'Essential|non-burst|nonburstable|Resource Control|tidb_paging_size_bytes' \
  --glob '*.md' \
  /tmp/coderabbit-repo-knowledge/pingcap-docs-9c73f70c system-variables.md

Repository: pingcap/docs

Length of output: 5045


🏁 Script executed:

printf '%s\n' '--- applicable conventions ---'
find /tmp/coderabbit-repo-knowledge/pingcap-docs-9c73f70c -type f -name '*.md' -print | sort
printf '%s\n' '--- target entry ---'
sed -n '5398,5424p' system-variables.md
printf '%s\n' '--- resource-control references ---'
rg -n -C 4 'Essential|non-burst|nonburstable|Resource Control|tidb_paging_size_bytes' \
  --glob '*.md' \
  /tmp/coderabbit-repo-knowledge/pingcap-docs-9c73f70c system-variables.md

Repository: pingcap/docs

Length of output: 5310


🏁 Script executed:

printf '%s\n' '--- repository convention ---'
cat /tmp/coderabbit-repo-knowledge/pingcap-docs-9c73f70c/conventions/repo-wide.md
printf '%s\n' '--- resource-control document ---'
resource_doc=$(find . -name 'tidb-resource-control-ru-groups.md' -print -quit)
if [ -n "$resource_doc" ]; then
  rg -n -C 5 'Starter|Essential|Premium|fixed RU|non-burst|burstable|Resource Control' "$resource_doc"
else
  printf '%s\n' 'resource-control document not present in checkout'
fi

Repository: pingcap/docs

Length of output: 7668


Clarify TiDB Cloud Essential availability.

Resource Control is unavailable on TiDB Cloud Essential, but this variable requires Resource Control to take effect. Remove Essential from the scope, or document the internal exception that provides the required Resource Group.

Comment thread system-variables.md Outdated
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@ti-chi-bot

ti-chi-bot Bot commented Sep 3, 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

Comment thread system-variables.md Outdated
Comment thread system-variables.md Outdated
Comment thread system-variables.md Outdated
Comment thread system-variables.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lgtm size/S Denotes a PR that changes 10-29 lines, ignoring generated files. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source 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