Skip to content

tidb: mark tidb_mpp_store_fail_ttl as deprecated #21410

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

gengliqi
Copy link
Contributor

@gengliqi gengliqi commented Jul 16, 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.

  • 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

Copy link

ti-chi-bot bot commented Jul 16, 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 qiancai 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.

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/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 16, 2025
Copy link

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

Summary of Changes

Hello @gengliqi, 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 updates the documentation for the tidb_mpp_store_fail_ttl system variable, reflecting its deprecation and a change in its default behavior. This change signifies an improvement in how TiDB handles newly started TiFlash nodes, removing the necessity for a waiting period to prevent query failures.

Highlights

  • Documentation Update: The tidb_mpp_store_fail_ttl system variable is now officially marked as deprecated in the documentation.
  • Variable Behavior Change: Starting from TiDB v9.0.0, the default value of tidb_mpp_store_fail_ttl will be fixed to 0s, meaning no delay is imposed for newly started TiFlash nodes.
  • Rationale for Change: The deprecation and change in default value are due to improvements that eliminate the need for an additional delay to prevent query failures when new TiFlash nodes come online.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

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 issue 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 is currently in preview and 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 to provide feedback.

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.

Copy link

@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

The documentation update to deprecate tidb_mpp_store_fail_ttl is clear and follows the established format. I've added a few suggestions to enhance clarity and conciseness, aligning with the repository's style guide.

- Default value: `60s`
- The newly started TiFlash node does not provide services. To prevent queries from failing, TiDB limits the tidb-server sending queries to the newly started TiFlash node. This variable indicates the time range in which the newly started TiFlash node is not sent requests.
- Default value: Before v9.0.0, the default value is `60s`. Starting from v9.0.0, the default value is `0s`.
- The newly started TiFlash node does not provide services. To prevent queries from failing, TiDB limits the tidb-server from sending queries to the newly started TiFlash nodes. This variable indicates the time range during which the newly started TiFlash node does not send requests.

Choose a reason for hiding this comment

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

medium

The current description is a bit confusing and contains a factual error. The phrase the newly started TiFlash node does not send requests is incorrect; the node receives requests. The original passive voice is not sent requests was more accurate, but we can improve clarity with active voice.12

Here's a clearer and more concise version that explains the variable's purpose.

Style Guide References

Suggested change
- The newly started TiFlash node does not provide services. To prevent queries from failing, TiDB limits the tidb-server from sending queries to the newly started TiFlash nodes. This variable indicates the time range during which the newly started TiFlash node does not send requests.
- To prevent query failures when a TiFlash node starts, TiDB avoids sending queries to it for a period of time. This variable controls that time period.

Footnotes

  1. Documentation should be clear, simple, complete, readable, and technically accurate. (link)

  2. Avoid passive voice where possible to improve clarity. (link)

- Scope: SESSION | GLOBAL
- Persists to cluster: Yes
- Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No
- Type: Duration
- Default value: `60s`
- The newly started TiFlash node does not provide services. To prevent queries from failing, TiDB limits the tidb-server sending queries to the newly started TiFlash node. This variable indicates the time range in which the newly started TiFlash node is not sent requests.
- Default value: Before v9.0.0, the default value is `60s`. Starting from v9.0.0, the default value is `0s`.

Choose a reason for hiding this comment

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

low

To improve readability and avoid repetition, you can make this description more concise.1

Style Guide References

Suggested change
- Default value: Before v9.0.0, the default value is `60s`. Starting from v9.0.0, the default value is `0s`.
- Default value: `60s` before v9.0.0; `0s` from v9.0.0.

Footnotes

  1. Avoid unnecessary words and repetition. (link)

gengliqi and others added 2 commits July 16, 2025 22:23
u
Signed-off-by: gengliqi <[email protected]>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
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/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant