planner: add doc for explain explore statement
#21353
Conversation
ti-chi-bot
bot
added
missing-translation-status
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @qw4990, 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 introduces new documentation for the EXPLAIN EXPLORE statement, a feature available from TiDB v9.0.0. The added content aims to guide users on how to leverage this powerful SQL statement to discover and evaluate alternative execution plans for their queries, ultimately enabling them to optimize query performance by binding preferred plans.
Highlights
- New Documentation Section: A comprehensive new section titled 'Explain Explore' has been added to the
sql-plan-management.mdfile, detailing the usage and functionality of theEXPLAIN EXPLOREstatement in TiDB. - EXPLAIN EXPLORE Statement Explained: The documentation clarifies the syntax
EXPLAIN EXPLORE [ANALYZE] Stmt;and explains its purpose: to allow users to explore various potential execution plans for a given SQL query. - Practical Examples and Plan Binding: Detailed examples are provided, demonstrating how
EXPLAIN EXPLORE ANALYZEreturns multiple execution plans along with their performance metrics (e.g.,avg_latency,avg_scan_rows). It also illustrates how users can then select an optimal plan and bind it usingCREATE GLOBAL BINDING FROM HISTORY USING PLAN DIGEST. - Behavior Without ANALYZE: The documentation explicitly states that omitting the
ANALYZEkeyword will prevent the actual execution of the explored plans, resulting in zero execution data for the returned 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 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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request adds documentation for the EXPLAIN EXPLORE statement. The new section provides a good overview and examples. My review includes several suggestions to improve clarity, conciseness, and consistency with the documentation style guide. I've also pointed out a minor formatting issue in one of the examples.
Oreoxmt
added
v9.0-beta.2
ti-chi-bot
bot
removed
the
missing-translation-status
Signed-off-by: Aolin <[email protected]>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: 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 |
| explain explore analyze select sum(b) from t where a=1\G | ||
| Query OK, 50000 rows affected (0.738 sec) | ||
|
|
There was a problem hiding this comment.
| explain explore analyze select sum(b) from t where a=1\G | |
| Query OK, 50000 rows affected (0.738 sec) |
| @@ -18,6 +20,8 @@ TiDB supports the `EXPLAIN [options] FOR CONNECTION connection_id` statement. Ho | |||
|
|
|||
| ## Synopsis | |||
|
|
|||
| <!-- TODO: update the synopsis to include `EXPLAIN EXPLORE` --> | |||
There was a problem hiding this comment.
@qw4990 Please update the synopsis
|
@qw4990: The following test failed, say
Full PR test history. Your PR dashboard. 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. I understand the commands that are listed here. |
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.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?