Skip to content

system variables: document tidb_enable_adaptive_limit_scan - #21952

Open
solotzg wants to merge 2 commits into
pingcap:masterfrom
solotzg:codex/add-adaptive-limit-sysvar-doc
Open

solotzg wants to merge 2 commits into
pingcap:masterfrom
solotzg:codex/add-adaptive-limit-sysvar-doc

Conversation

@solotzg

@solotzg solotzg commented Sep 22, 2026

Copy link
Copy Markdown
Contributor

What is changed, added, or deleted? (Required)

Document the new tidb_enable_adaptive_limit_scan system variable introduced by pingcap/tidb#70252, including its scope, persistence, experimental status, default values for fresh and upgraded clusters, and supported query plans.

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

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions (in Chinese).

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)

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

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

@ti-chi-bot

ti-chi-bot Bot commented Sep 22, 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 assign csuzhangxc 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:

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

@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 Sep 22, 2026
@coderabbitai

coderabbitai Bot commented Sep 22, 2026

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: pingcap/docs-cn/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 95856bf5-e74d-40ce-bb72-9023df4aa969

📥 Commits

Reviewing files that changed from the base of the PR and between 0f9f2f8 and c7fb1f7.

📒 Files selected for processing (2)
  • system-variable-reference.md
  • system-variables.md

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


📝 Walkthrough

Walkthrough

Changes

自适应 LIMIT 扫描系统变量

Layer / File(s) Summary
系统变量定义与索引
system-variables.md, system-variable-reference.md
新增 tidb_enable_adaptive_limit_scan。文档记录其作用域、持久化属性、类型、默认值、适用计划和版本信息。系统变量索引新增对应链接。

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: qiancai

Merge Risk: ⚪ Minimal · up to 9c0d7

This change documents and indexes the adaptive LIMIT scan variable; no merge-blocking production risk is identified in the supplied current-head evidence.

🚥 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. 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 标题准确概括了本次变更:为系统变量 tidb_enable_adaptive_limit_scan 添加文档。标题简洁且与主要改动一致。
Description check ✅ Passed 描述包含变更内容、适用版本、关联代码 PR、AI agent involvement 和变更类型检查项。必填信息基本完整,且与 PR 改动一致。
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

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.

@qiancai qiancai added the v9.0-beta.3 This PR/issue applies to TiDB v9.0-beta.3. label Sep 22, 2026
@solotzg solotzg changed the title system variables: document tidb_enable_adaptive_limit_scan system variables: document tidb_enable_adaptive_limit_scan Sep 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

missing-translation-status This PR does not have translation status info. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. 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