Skip to content

Conversation

@qiancai
Copy link
Owner

@qiancai qiancai commented Sep 29, 2025

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)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)

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

  • This PR is translated from:
  • Other reference link(s):

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

  • New Features

    • Added tidb_opt_selectivity_factor system variable (SESSION/GLOBAL, persistent) to control default optimizer selectivity when statistics are unavailable.
    • Introduced per-operator executor concurrency controls (index lookup, index lookup join, hash join, hash aggregation partial/final, projection, window) alongside tidb_executor_concurrency for finer tuning.
  • Documentation

    • Updated system variables reference with details and guidance for the new optimizer selectivity and executor concurrency settings.

@coderabbitai
Copy link

coderabbitai bot commented Sep 29, 2025

Walkthrough

Documentation updates in system-variables.md introduce a new optimizer selectivity variable and expand executor concurrency settings with per-operator variables. The selectivity variable appears twice in the document. No code changes are included.

Changes

Cohort / File(s) Summary of Changes
Optimizer selectivity variable
system-variables.md
Added tidb_opt_selectivity_factor (SESSION
Executor per-operator concurrency
system-variables.md
Documented per-operator concurrency variables alongside tidb_executor_concurrency: tidb_index_lookup_concurrency, tidb_index_lookup_join_concurrency, tidb_hash_join_concurrency, tidb_hashagg_partial_concurrency, tidb_hashagg_final_concurrency, tidb_projection_concurrency, tidb_window_concurrency.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

A rabbit taps docs with careful flair,
New knobs for speed, selections fair.
Concurrency carrots in tidy rows,
While twin selectivity twice now shows.
I thump my foot—change merged with cheer,
Hops per second feel snappier here! 🥕✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 1 inconclusive)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The pull request description remains as the unfilled template and does not include any of the required information, such as a summary of changes, the TiDB versions affected, related PR or file links, or confirmation of signing the Contributor License Agreement. Because all mandatory sections are left blank, the description does not meet the repository’s template requirements for documentation contributions. Please complete the description template by providing a clear “What is changed, added or deleted?” section explaining the updates, selecting the appropriate TiDB version checkboxes, adding any related PR or file links, and confirming that you have signed the Contributor License Agreement.
Title Check ❓ Inconclusive The title “Update system-variables.md” identifies the file that was changed but fails to communicate the substantive updates in this pull request, such as introducing the tidb_opt_selectivity_factor variable and adding per-operator concurrency settings. Its generic phrasing does not highlight the key features or intent of the changes, making it difficult for readers to quickly grasp the purpose of the PR. Because it merely states that the file was updated without specifying what was added or why, the title is too vague to serve as an effective summary. Please choose a more descriptive title that succinctly reflects the main changes, for example “Add tidb_opt_selectivity_factor and per-operator concurrency variables to system-variables.md,” so that reviewers and future readers can immediately understand the PR’s purpose and content.
✅ Passed checks (1 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch test-add-a-variable

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


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 and usage tips.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link

@coderabbitai coderabbitai bot left a comment

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 details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1566e06 and ba2a185.

📒 Files selected for processing (1)
  • system-variables.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: pull

github-actions bot added a commit to qiancai/docs that referenced this pull request Sep 29, 2025
  Synced from: qiancai/docs-cn#15
  Target PR: #45
  AI Provider: gemini

  Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
github-actions bot added a commit to qiancai/docs that referenced this pull request Sep 29, 2025
  Synced from: qiancai/docs-cn#15
  Target PR: #47
  AI Provider: gemini

  Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
github-actions bot added a commit to qiancai/docs that referenced this pull request Sep 29, 2025
  Synced from: qiancai/docs-cn#15
  Target PR: #49
  AI Provider: gemini

  Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
github-actions bot added a commit to qiancai/docs that referenced this pull request Oct 21, 2025
  Synced from: qiancai/docs-cn#15
  Target PR: #50
  AI Provider: gemini

  Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants