planner: Plan Replayer supports dumping multiple statement at once #22429
Conversation
|
[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. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
ti-chi-bot
bot
added
the
missing-translation-status
Summary of ChangesHello @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 updates the documentation for the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe 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
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 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
|
ti-chi-bot
bot
added
the
size/S
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the documentation for PLAN REPLAYER to include the new syntax for dumping multiple SQL statements at once. The changes are accurate and add a helpful example. I have provided a couple of suggestions to improve clarity and conciseness, in line with the repository's style guide.
| Depending on whether you dump a single SQL statement or multiple SQL statements, the structure of the exported ZIP file is as follows: | ||
|
|
||
| - For a single SQL statement, the ZIP file includes `sql/sql0.sql` and `explain.txt`. | ||
| - For multiple SQL statements, the ZIP file includes `sql/sql0.sql`, `sql/sql1.sql`, ... and the corresponding `explain/explain0.txt`, `explain/explain1.txt`, ..., together with schema and statistics files for the referenced tables. |
There was a problem hiding this comment.
To improve clarity, this section can be rephrased to be more direct and avoid using '...'.
| Depending on whether you dump a single SQL statement or multiple SQL statements, the structure of the exported ZIP file is as follows: | |
| - For a single SQL statement, the ZIP file includes `sql/sql0.sql` and `explain.txt`. | |
| - For multiple SQL statements, the ZIP file includes `sql/sql0.sql`, `sql/sql1.sql`, ... and the corresponding `explain/explain0.txt`, `explain/explain1.txt`, ..., together with schema and statistics files for the referenced tables. | |
| The structure of the exported ZIP file depends on whether you dump a single SQL statement or multiple SQL statements: | |
| - For a single SQL statement, the ZIP file includes `sql/sql0.sql` and `explain.txt`. | |
| - For multiple SQL statements, the ZIP file includes SQL files such as `sql/sql0.sql` and `sql/sql1.sql`, their corresponding explain files such as `explain/explain0.txt` and `explain/explain1.txt`, and the schema and statistics files for the referenced tables. |
References
- The style guide emphasizes clarity, simplicity, and readability (line 14). The suggested change improves readability by making the sentence structure simpler and avoiding the informal '...'. (link)
| ); | ||
| ``` | ||
|
|
||
| Alternatively, when there are multiple SQL statements, you can obtain the result of the `PLAN REPLAYER DUMP` execution using a file. The results of multiple SQL statements are separated by `;` in this file. |
There was a problem hiding this comment.
This sentence can be simplified for better readability and to be more direct for the user, in line with the style guide's preference for using the second person ('you').
| Alternatively, when there are multiple SQL statements, you can obtain the result of the `PLAN REPLAYER DUMP` execution using a file. The results of multiple SQL statements are separated by `;` in this file. | |
| Alternatively, you can dump multiple SQL statements from a file. In this file, separate SQL statements with a semicolon (`;`). |
References
- The style guide recommends writing in the second person ('you') (line 22) and preferring clarity and simplicity (line 14). The suggested change makes the instruction more direct and easier for the user to follow. (link)
1 participant
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)?
PLAN REPLAYER DUMP EXPLAINcommand tidb#66162Do your changes match any of the following descriptions?