Skip to content

system-variables: add optimizer cost factors #20748

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 5 commits into
base: master
Choose a base branch
from

Conversation

terry1purcell
Copy link
Contributor

@terry1purcell terry1purcell commented Apr 13, 2025

First-time contributors' checklist

What is changed, added or deleted? (Required)

Documented all of the new optimizer cost factors.

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)?

  • 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

@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 @terry1purcell, 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 new optimizer cost factors in TiDB v9.0.0. These factors are used internally in the Cost Model and are generally not recommended for modification unless directed by TiDB Optimizer Engineering. The changes involve adding descriptions, scope, applicability to hints, data type, range, and default values for each new cost factor.

Highlights

  • Documentation: Adds documentation for new optimizer cost factors in system-variables.md.
  • New Cost Factors: Introduces documentation for tidb_opt_hash_agg_cost_factor, tidb_opt_hash_join_cost_factor, tidb_opt_index_join_cost_factor, tidb_opt_index_lookup_cost_factor, tidb_opt_index_merge_cost_factor, tidb_opt_index_reader_cost_factor, tidb_opt_index_scan_cost_factor, tidb_opt_limit_cost_factor, tidb_opt_merge_join_cost_factor, tidb_opt_sort_cost_factor, tidb_opt_stream_agg_cost_factor, tidb_opt_table_fulL_scan_cost_factor, tidb_opt_table_range_scan_cost_factor, tidb_opt_table_reader_cost_factor, tidb_opt_table_rowid_cost_factor, tidb_opt_table_tiflash_scan_cost_factor, and tidb_opt_topn_cost_factor.
  • Version: Specifies that these cost factors are new in TiDB v9.0.0.

Changelog

Click here to see the changelog
  • system-variables.md
    • Added documentation for tidb_opt_hash_agg_cost_factor.
    • Added documentation for tidb_opt_hash_join_cost_factor.
    • Added documentation for tidb_opt_index_join_cost_factor.
    • Added documentation for tidb_opt_index_lookup_cost_factor.
    • Added documentation for tidb_opt_index_merge_cost_factor.
    • Added documentation for tidb_opt_index_reader_cost_factor.
    • Added documentation for tidb_opt_index_scan_cost_factor.
    • Added documentation for tidb_opt_limit_cost_factor.
    • Added documentation for tidb_opt_merge_join_cost_factor.
    • Added documentation for tidb_opt_sort_cost_factor.
    • Added documentation for tidb_opt_stream_agg_cost_factor.
    • Added documentation for tidb_opt_table_fulL_scan_cost_factor.
    • Added documentation for tidb_opt_table_range_scan_cost_factor.
    • Added documentation for tidb_opt_table_reader_cost_factor.
    • Added documentation for tidb_opt_table_rowid_cost_factor.
    • Added documentation for tidb_opt_table_tiflash_scan_cost_factor.
    • Added documentation for tidb_opt_topn_cost_factor.
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.


Cost factors defined,
Optimizer's choices refined,
Queries now take flight.

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/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Apr 13, 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.

Code Review

The pull request adds documentation for new optimizer cost factors in TiDB v9.0.0. The changes seem straightforward and well-organized.

Summary of Findings

  • Typographical error: There's a typographical error in one of the variable names: tidb_opt_table_fulL_scan_cost_factor. It should be tidb_opt_table_full_scan_cost_factor.
  • Inconsistent capitalization: The capitalization of 'fulL' in tidb_opt_table_fulL_scan_cost_factor is inconsistent with other variable names. It should be full.
  • Missing period at the end of the sentence: The description for each variable lacks a period at the end of the sentence.

Merge Readiness

The pull request is almost ready for merging. However, the typographical error in the variable name tidb_opt_table_fulL_scan_cost_factor needs to be corrected. Additionally, adding a period at the end of each variable description would improve the documentation's clarity. I am unable to approve this pull request, and recommend that another reviewer approves this code before merging.

Copy link

ti-chi-bot bot commented Apr 13, 2025

@gemini-code-assist[bot]: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In response to this:

Code Review

The pull request adds documentation for new optimizer cost factors in TiDB v9.0.0. The changes seem straightforward and well-organized.

Summary of Findings

  • Typographical error: There's a typographical error in one of the variable names: tidb_opt_table_fulL_scan_cost_factor. It should be tidb_opt_table_full_scan_cost_factor.
  • Inconsistent capitalization: The capitalization of 'fulL' in tidb_opt_table_fulL_scan_cost_factor is inconsistent with other variable names. It should be full.
  • Missing period at the end of the sentence: The description for each variable lacks a period at the end of the sentence.

Merge Readiness

The pull request is almost ready for merging. However, the typographical error in the variable name tidb_opt_table_fulL_scan_cost_factor needs to be corrected. Additionally, adding a period at the end of each variable description would improve the documentation's clarity. I am unable to approve this pull request, and recommend that another reviewer approves this code before merging.

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: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Copy link

ti-chi-bot bot commented Apr 14, 2025

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

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.

@terry1purcell
Copy link
Contributor Author

/cc @breezewish

@ti-chi-bot ti-chi-bot bot requested a review from breezewish April 25, 2025 22:03
@Oreoxmt Oreoxmt added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. type/compatibility-or-feature-change This PR involves compatibility changes or feature behavior changes. translation/doing This PR's assignee is translating this PR. labels Jul 8, 2025
@ti-chi-bot ti-chi-bot bot removed the missing-translation-status This PR does not have translation status info. label Jul 8, 2025
@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jul 8, 2025
@Oreoxmt Oreoxmt self-assigned this Jul 9, 2025
@Oreoxmt Oreoxmt added the v9.0-beta.2 This PR/issue applies to TiDB v9.0-beta.2. label Jul 9, 2025
@Oreoxmt Oreoxmt self-requested a review July 9, 2025 08:27
@Oreoxmt Oreoxmt added the needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. label Jul 9, 2025
@Oreoxmt
Copy link
Collaborator

Oreoxmt commented Jul 10, 2025

@terry1purcell PTAL terry1purcell#1 and help confirm whether these system variables apply to TiDB Cloud. If they don't, we should to add the following note to each of them:

docs/system-variables.md

Lines 4691 to 4693 in 689ea88

> **Note:**
>
> This TiDB variable is not applicable to TiDB Cloud.

@terry1purcell
Copy link
Contributor Author

@terry1purcell PTAL terry1purcell#1 and help confirm whether these system variables apply to TiDB Cloud. If they don't, we should to add the following note to each of them:

docs/system-variables.md

Lines 4691 to 4693 in 689ea88

> **Note:**
>
> This TiDB variable is not applicable to TiDB Cloud.

@Oreoxmt - there is nothing specific about these that would prohibit them from being utilized by TiDB cloud - unless we somehow place restrictions on what variables we expose to users. Do you know how I can validate this?

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 ask for approval from oreoxmt. 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 lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Jul 16, 2025
Copy link

ti-chi-bot bot commented Jul 16, 2025

[LGTM Timeline notifier]

Timeline:

  • 2025-07-08 09:42:28.782448131 +0000 UTC m=+1992801.505627110: ☑️ agreed by dveeden.
  • 2025-07-16 03:33:15.076401506 +0000 UTC m=+2661847.799580487: ☑️ agreed by Oreoxmt.

@Oreoxmt Oreoxmt added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR's assignee is translating this PR. labels Jul 16, 2025
@Oreoxmt
Copy link
Collaborator

Oreoxmt commented Jul 16, 2025

/cc @lilin90

@ti-chi-bot ti-chi-bot bot requested a review from lilin90 July 16, 2025 03:49
@lilin90 lilin90 changed the title planner: add optimizer cost factors system-variables: add optimizer cost factors Jul 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. lgtm needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. type/compatibility-or-feature-change This PR involves compatibility changes or feature behavior changes. v9.0-beta.2 This PR/issue applies to TiDB v9.0-beta.2.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants