Skip to content

Conversation

mjonss
Copy link
Contributor

@mjonss mjonss commented Oct 13, 2025

close #21897

What is changed, added or deleted? (Required)

Added cost_trace as EXPLAIN FORMAT

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

@mjonss mjonss requested review from Copilot and dveeden October 13, 2025 09:50
Copy link

Summary of Changes

Hello @mjonss, 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 enhances the TiDB documentation by incorporating details for the newly supported EXPLAIN FORMAT="cost_trace" option. This addition provides users with a more comprehensive understanding of query execution plans, enabling them to analyze estimated costs and the formulas used for their calculation directly within the EXPLAIN output.

Highlights

  • New EXPLAIN Format Documentation: Documentation has been updated to include the cost_trace format for the EXPLAIN statement.
  • Detailed Cost Analysis: The cost_trace format provides estCost for estimated cost and costFormula for the cost formula, offering deeper insights into query execution plans.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

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.

@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 Oct 13, 2025
Copy link

@Copilot Copilot AI left a 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 adds documentation for a new EXPLAIN FORMAT option called cost_trace in TiDB, which provides extended cost information for query execution plans.

  • Added cost_trace format option to the EXPLAIN statement documentation
  • The new format provides additional cost-related columns (estCost and costFormula) for query plan analysis

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

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

This pull request adds documentation for the new cost_trace format option in the EXPLAIN statement. The change is accurate, but I've provided a suggestion to improve the wording and ensure consistency with the style guide by enclosing column names in backticks.

@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Oct 13, 2025
Copy link

ti-chi-bot bot commented Oct 13, 2025

[LGTM Timeline notifier]

Timeline:

  • 2025-10-13 10:57:22.0106002 +0000 UTC m=+91748.087852750: ☑️ agreed by dveeden.

@dveeden
Copy link
Contributor

dveeden commented Oct 13, 2025

From the check:

sql-statements/sql-statement-explain.md: 207: MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]

@hfxsd hfxsd self-assigned this Oct 13, 2025
@hfxsd hfxsd added translation/doing This PR's assignee is translating this PR. and removed missing-translation-status This PR does not have translation status info. labels Oct 13, 2025
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Daniël van Eeden <github@myname.nl>
Copy link

ti-chi-bot bot commented Oct 14, 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 hfxsd. 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

@hfxsd hfxsd requested a review from Oreoxmt October 14, 2025 08:04
@hfxsd hfxsd 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 Oct 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document cost_trace as EXPLAIN FORMAT

3 participants