Skip to content

tidb: correct some variables descriptions#21933

Closed
0xPoe wants to merge 2 commits into
pingcap:masterfrom
0xPoe:poe-patch-variables-update
Closed

tidb: correct some variables descriptions#21933
0xPoe wants to merge 2 commits into
pingcap:masterfrom
0xPoe:poe-patch-variables-update

Conversation

@0xPoe
Copy link
Copy Markdown
Member

@0xPoe 0xPoe commented Oct 19, 2025

First-time contributors' checklist

What is changed, added or deleted? (Required)

ref pingcap/tidb#64023

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.

  • 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

@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented Oct 19, 2025

[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 missing-translation-status This PR does not have translation status info. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 19, 2025
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @0xPoe, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request clarifies and corrects the documentation surrounding concurrency control variables in TiDB. It addresses the deprecation of tidb_index_serial_scan_concurrency by updating its description to reflect its read-only status and guiding users to the appropriate replacement variables, tidb_executor_concurrency for sequential index scans and tidb_analyze_distsql_scan_concurrency for index statistics collection. The changes ensure that users are directed to the correct variables for optimizing performance and troubleshooting.

Highlights

  • Variable Deprecation: The tidb_index_serial_scan_concurrency system variable has been deprecated and is now read-only, serving as an alias for tidb_executor_concurrency.
  • Concurrency Control Updates: Sequential index scans are now controlled by tidb_executor_concurrency, while index statistics collection (e.g., during ANALYZE TABLE) uses tidb_analyze_distsql_scan_concurrency.
  • Documentation Alignment: Various documentation files, including best practices, system variable descriptions, TPC-C benchmarking guides, TiDB Lightning configuration, and OOM troubleshooting, have been updated to reflect these changes and guide users to the correct variables.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@0xPoe 0xPoe closed this Oct 19, 2025
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request correctly updates the documentation to reflect the deprecation of tidb_index_serial_scan_concurrency and points to the new variables to use. The changes are consistent across multiple files. I've provided a couple of suggestions to improve clarity and conciseness by rephrasing some descriptions to be more direct and to avoid repetition, in line with the repository's style guide.

Comment thread statistics.md
#### `tidb_index_serial_scan_concurrency`

When you analyze index columns, you can use the [`tidb_index_serial_scan_concurrency`](/system-variables.md#tidb_index_serial_scan_concurrency) variable to control the number of Regions to be read at one time. The default value is `1`. Note that changing the value will affect query performance. Adjust the value carefully.
[`tidb_index_serial_scan_concurrency`](/system-variables.md#tidb_index_serial_scan_concurrency) is deprecated and read-only. Index statistics collection now follows [`tidb_analyze_distsql_scan_concurrency`](/system-variables.md#tidb_analyze_distsql_scan_concurrency), so adjust that variable to change the number of Regions read for index statistics.
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.

low

This sentence is a bit long and could be more direct. To improve clarity and follow the style guide's principle of using the second person, consider rephrasing.1

Suggested change
[`tidb_index_serial_scan_concurrency`](/system-variables.md#tidb_index_serial_scan_concurrency) is deprecated and read-only. Index statistics collection now follows [`tidb_analyze_distsql_scan_concurrency`](/system-variables.md#tidb_analyze_distsql_scan_concurrency), so adjust that variable to change the number of Regions read for index statistics.
[`tidb_index_serial_scan_concurrency`](/system-variables.md#tidb_index_serial_scan_concurrency) is deprecated and read-only. To control the number of Regions read for index statistics collection, you can adjust [`tidb_analyze_distsql_scan_concurrency`](/system-variables.md#tidb_analyze_distsql_scan_concurrency) instead.

Style Guide References

Footnotes

  1. The style guide recommends writing in the second person ('you') and avoiding unnecessary words for better clarity.

Comment thread system-variables.md
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/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant