Skip to content

Document tidb_query_cop_store_limit variable - #21909

Open
solotzg wants to merge 3 commits into
masterfrom
solotzg-patch-2
Open

Document tidb_query_cop_store_limit variable#21909
solotzg wants to merge 3 commits into
masterfrom
solotzg-patch-2

Conversation

@solotzg

@solotzg solotzg commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Added documentation for the tidb_query_cop_store_limit system variable, including its scope, persistence, type, default value, range, and behavior.

First-time contributors' checklist

What is changed, added or deleted? (Required)

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

Summary by CodeRabbit

  • 文档
    • 新增系统变量 tidb_query_cop_store_limit 的说明。
    • 补充其 SESSION/GLOBAL 作用域、默认值 15、取值范围 [0, 256]、集群持久化及 SET_VAR Hint 支持。
    • 说明该变量对 TiKV Coprocessor 请求并发尝试数的限制,以及设置为 0 时禁用限制。
    • 明确其与扫描并发度设置的区别,以及不影响 TiFlash 请求。

Added documentation for the `tidb_query_cop_store_limit` system variable, including its scope, persistence, type, default value, range, and behavior.
@ti-chi-bot ti-chi-bot Bot added the missing-translation-status This PR does not have translation status info. label Sep 1, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 1, 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 icemap 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 the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Sep 1, 2026
@coderabbitai

coderabbitai Bot commented Sep 1, 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
📝 Walkthrough

Walkthrough

文档新增系统变量 tidb_query_cop_store_limit。条目说明其作用域、默认值、取值范围、持久化方式,以及对 TiKV Coprocessor 请求的并发限制行为。

Changes

查询 Coprocessor 并发限制

Layer / File(s) Summary
新增系统变量文档条目
system-variables.md
新增 tidb_query_cop_store_limit 的配置属性和行为说明,包括 SESSIONGLOBAL 作用域,默认值 15,取值范围 [0, 256]SET_VAR Hint 支持和集群持久化。文档说明该变量仅限制 TiKV Coprocessor 请求,并区分 tidb_distsql_scan_concurrency 的作用。

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

Merge Risk: 🔵 Low · up to 0edfc

The documentation adds the variable but currently omits the special behavior of setting it to 0, and the first supported release marker still needs confirmation. The PR is mergeable with explicit owner follow-up to correct the boundary-value description and verify the version marker.

Suggested reviewers: windtalker, oreoxmt, qiancai

🚥 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_query_cop_store_limit 系统变量文档,内容简洁明确。
Description check ✅ Passed 描述包含变更内容、适用版本、相关 PR、CLA 状态、AI agent 参与情况和其他变更选项。开头说明覆盖了必填的变更内容,因此整体信息完整。
Full details: Docstring Coverage

Explanation

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 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch solotzg-patch-2

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: 1


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Team

Run ID: f3771ee1-390b-4738-b4db-8a2744b38f48

📥 Commits

Reviewing files that changed from the base of the PR and between abe71f2 and d6212f9.

📒 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
@solotzg
solotzg requested a review from windtalker September 1, 2026 05:11

@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: 1


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Team

Run ID: 780b3b0f-0663-4b2b-a057-8cde49f4aad1

📥 Commits

Reviewing files that changed from the base of the PR and between d6212f9 and 7f3d98f.

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

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

Comment thread system-variables.md

@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: 1


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Team

Run ID: 4afbd550-da61-47f4-803a-9152f8b8d655

📥 Commits

Reviewing files that changed from the base of the PR and between 7f3d98f and 0edfc76.

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

Comment thread system-variables.md

@windtalker windtalker left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lgtm

@ti-chi-bot

ti-chi-bot Bot commented Sep 1, 2026

Copy link
Copy Markdown

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

Details

In response to this:

lgtm

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.

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.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants