Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
qiancai wants to merge 4 commits into
base: master
Choose a base branch
from
+12 −0
Open

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

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2c5b075
Create empty translation PR
qiancai Aug 19, 2026
dad2709
Auto-sync: Update English docs from Chinese PR
github-actions[bot] Aug 19, 2026
a7a3bf5
Update system-variables.md
qiancai Aug 19, 2026
3b9f878
Update system-variables.md
qiancai Aug 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions system-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5499,6 +5499,18 @@ SHOW WARNINGS;
- Range: `[0, 2147483647]`
- This variable controls the iteration of the optimizer's estimation logic. After changing the value of this variable, the estimation logic of the optimizer will change greatly. Currently, `0` is the only valid value. It is not recommended to set it to other values.

### `tidb_paging_size_bytes` <span class="version-mark">New in v9.0.0</span>

@qiancai qiancai Aug 28, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Suggested change
### `tidb_paging_size_bytes` <span class="version-mark">New in v9.0.0</span>
### `tidb_paging_size_bytes` <span class="version-mark">New in v9.0.0 and TiDB-X-CLOUD.202603</span>
>**Note:**
>
> This variable is not supported on TiDB Cloud Starter.


- Scope: SESSION | GLOBAL

@qiancai qiancai Aug 28, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Suggested change
- Scope: SESSION | GLOBAL
- Scope: SESSION | GLOBAL for TiDB Self-Managed; SESSION for TiDB Cloud Essential and Premium

- Persists to cluster: Yes
- Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): Yes
- Type: Integer
Comment thread
qiancai marked this conversation as resolved.
- Default value: `0`
- Range: `[0, 9223372036854775807]`
- Unit: bytes
- Controls the maximum size, in bytes, of a single paged response in the coprocessor protocol, providing an additional response-size-based pagination mechanism alongside the row-based pagination controlled by [`tidb_max_paging_size`](#tidb_max_paging_size-new-in-v630). The default value of this variable is `0`, which disables byte-based pagination. This feature takes effect only when [resource control](/tidb-resource-control-ru-groups.md) is enabled, and the resource group of the current statement has a fixed RU quota. It allows the PD resource control module to estimate RU consumption based on the amount of data to be scanned and deduct the estimated RUs in advance before the statement is executed. To enable this feature, consider setting the variable to `4194304` (4 MiB).
Comment thread
qiancai marked this conversation as resolved.
- This variable is an internal TiDB variable. It is **not recommended** to modify its value.

### tidb_partition_prune_mode <span class="version-mark">New in v5.1</span>

> **Warning:**
Expand Down