-
Notifications
You must be signed in to change notification settings - Fork 704
WIP: tidb: update tidb_index_serial_scan_concurrency docs #21938
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.
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
base: master
Are you sure you want to change the base?
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates documentation to reflect the deprecation of the tidb_index_serial_scan_concurrency variable. The variable is no longer modifiable, and its functionality has been replaced by tidb_executor_concurrency for sequential index scans and tidb_analyze_distsql_scan_concurrency for ANALYZE operations.
Key Changes:
- Deprecates
tidb_index_serial_scan_concurrencywith a warning that directs users to the replacement variables - Removes references to the deprecated variable from troubleshooting and performance benchmarking guides
- Updates configuration examples to use
tidb_analyze_distsql_scan_concurrencyinstead of the deprecated variables
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| system-variables.md | Adds deprecation warning and updates description to indicate the variable is kept for backward compatibility only |
| statistics.md | Consolidates documentation by removing the separate section for tidb_index_serial_scan_concurrency and updating tidb_analyze_distsql_scan_concurrency to note its expanded role |
| troubleshoot-tidb-oom.md | Removes deprecated variable from the list of concurrency controls for reducing memory usage |
| tidb-cloud/v8.5-performance-benchmarking-with-tpcc.md | Replaces deprecated variables with tidb_analyze_distsql_scan_concurrency in TPC-C test setup |
| tidb-cloud/v8.1-performance-benchmarking-with-tpcc.md | Replaces deprecated variables with tidb_analyze_distsql_scan_concurrency in TPC-C test setup |
| best-practices/tidb-best-practices.md | Updates reference from deprecated variable to tidb_executor_concurrency for controlling index scan behavior |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
First-time contributors' checklist
What is changed, added or deleted? (Required)
See: 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.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?