Skip to content

system-variables: add doc for tidb_max_dist_task_nodes#20718

Merged
ti-chi-bot[bot] merged 7 commits intopingcap:masterfrom
hfxsd:tidb_max_dist_task_nodes
Apr 8, 2025
Merged

system-variables: add doc for tidb_max_dist_task_nodes#20718
ti-chi-bot[bot] merged 7 commits intopingcap:masterfrom
hfxsd:tidb_max_dist_task_nodes

Conversation

@hfxsd
Copy link
Collaborator

@hfxsd hfxsd commented Apr 8, 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.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 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)?

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

@hfxsd hfxsd self-assigned this Apr 8, 2025
@ti-chi-bot ti-chi-bot bot added the contribution This PR is from a community contributor. label Apr 8, 2025
Copy link
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.

Hello @hfxsd, 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!

Summary of Changes

This pull request adds documentation for the tidb_max_dist_task_nodes system variable. This variable, new in v9.0.0, controls the maximum number of TiDB nodes that the Distributed eXecution Framework (DXF) can use. The documentation includes the variable's scope, persistence, applicability to hints, type, default value, range, and a detailed explanation of its behavior, including its interaction with the tidb_service_scope variable. The PR also includes a note and an example to clarify how tidb_service_scope affects the number of TiDB nodes used by DXF.

Highlights

  • Documentation: Adds documentation for the tidb_max_dist_task_nodes system variable.
  • New System Variable: Documents the behavior of the new tidb_max_dist_task_nodes system variable introduced in v9.0.0.
  • DXF: Explains how tidb_max_dist_task_nodes affects the Distributed eXecution Framework (DXF).

Changelog

  • system-variables.md
    • Added documentation for the tidb_max_dist_task_nodes system variable.
    • Documented the scope, persistence, applicability to hints, type, default value, and range of tidb_max_dist_task_nodes.
    • Explained the interaction between tidb_max_dist_task_nodes and tidb_service_scope.
    • Provided an example to illustrate the effect of tidb_service_scope on the number of TiDB nodes used by DXF.
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.


A variable's doc,
Shows its scope and its range,
Knowledge shared wide.

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.

@ti-chi-bot ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Apr 8, 2025
Copy link
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

The pull request adds documentation for the tidb_max_dist_task_nodes system variable. The documentation is clear and concise, providing a good explanation of the variable's purpose, scope, range, and default value. The note about tidb_service_scope is also helpful for understanding the variable's behavior in different scenarios.

Merge Readiness

The pull request is well-written and the changes are straightforward. I did not find any critical or high severity issues. The pull request appears ready to be merged, but I am unable to approve it. Please have others review and approve this code before merging.

@hfxsd hfxsd added translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. for-release This PR relates to a TiDB release but does not have a tracked feature. v9.0-beta.1 This PR/issue applies to TiDB v9.0-beta.1. and removed missing-translation-status This PR does not have translation status info. labels Apr 8, 2025
@hfxsd hfxsd removed the contribution This PR is from a community contributor. label Apr 8, 2025
@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Apr 8, 2025
@ti-chi-bot
Copy link

ti-chi-bot bot commented Apr 8, 2025

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

Details

In response to this:

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.

Co-authored-by: Frank945946 <108602632+Frank945946@users.noreply.github.com>
@hfxsd hfxsd requested a review from lilin90 April 8, 2025 07:10
@hfxsd hfxsd added the type/compatibility-or-feature-change This PR involves compatibility changes or feature behavior changes. label Apr 8, 2025
Copy link
Member

@lilin90 lilin90 left a comment

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 added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Apr 8, 2025
@ti-chi-bot
Copy link

ti-chi-bot bot commented Apr 8, 2025

[LGTM Timeline notifier]

Timeline:

  • 2025-04-08 06:37:47.726271476 +0000 UTC m=+2151961.410507572: ☑️ agreed by tangenta.
  • 2025-04-08 08:33:45.960666629 +0000 UTC m=+2158919.644902722: ☑️ agreed by lilin90.

lilin90

This comment was marked as duplicate.

@hfxsd
Copy link
Collaborator Author

hfxsd commented Apr 8, 2025

/approve

@ti-chi-bot
Copy link

ti-chi-bot bot commented Apr 8, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hfxsd

The full list of commands accepted by this bot can be found here.

The pull request process is described 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 approved label Apr 8, 2025
@ti-chi-bot ti-chi-bot bot merged commit f61ca63 into pingcap:master Apr 8, 2025
9 checks passed
@hfxsd hfxsd added the needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. label Feb 26, 2026
@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created to branch release-8.5: #22498.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved for-release This PR relates to a TiDB release but does not have a tracked feature. lgtm needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. type/compatibility-or-feature-change This PR involves compatibility changes or feature behavior changes. v9.0-beta.1 This PR/issue applies to TiDB v9.0-beta.1.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants