planner: add optimizer cost factors

[terry1purcell]

First-time contributors' checklist

• I've signed Contributor License Agreement that's required for repo owners to accept my contribution.

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

[gemini-code-assist]

Hello @terry1purcell, I'm Gemini Code Assist¹! 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]

[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 breezewish for approval. For more information see the Code Review Process.

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

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[gemini-code-assist]

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.

[ti-chi-bot]

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

[ti-chi-bot]

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

/cc @breezewish