Revert "Revert "v8.5.6 dashboard: Add note about prepared statements …#22672
Revert "Revert "v8.5.6 dashboard: Add note about prepared statements …#22672hfxsd wants to merge 1 commit intofeature/preview-v8.5.6from
Conversation
…in Slow …" This reverts commit 793505d.
|
[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
contribution
hfxsd
added
translation/from-docs-cn
![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 TiDB Dashboard slow query documentation to clarify how prepared statement arguments are displayed, noting their position at the end of the query and the use of hexadecimal literals for non-printable characters. A review comment suggests improving the sentence structure by replacing a repetitive instance of "for example" with "such as" to enhance readability and adhere to style guidelines.
| > | ||
| > The maximum length of the query recorded in the `Query` column is limited by the [`tidb_stmt_summary_max_sql_length`](/system-variables.md#tidb_stmt_summary_max_sql_length-new-in-v40) system variable. | ||
| > - The maximum length of the query recorded in the `Query` column is limited by the [`tidb_stmt_summary_max_sql_length`](/system-variables.md#tidb_stmt_summary_max_sql_length-new-in-v40) system variable. | ||
| > - For prepared statements, arguments are listed at the end of the query, for example: `[arguments: "foo", 123]`. Non-printable arguments are displayed as hexadecimal literals, for example, `0x01`. |
There was a problem hiding this comment.
The phrase "for example" is used twice in the same sentence, which is repetitive. Replacing the second instance with "such as" improves the flow and adheres to the style guide principle of avoiding repetition.
| > - For prepared statements, arguments are listed at the end of the query, for example: `[arguments: "foo", 123]`. Non-printable arguments are displayed as hexadecimal literals, for example, `0x01`. | |
| > - For prepared statements, arguments are listed at the end of the query, for example: `[arguments: "foo", 123]`. Non-printable arguments are displayed as hexadecimal literals, such as `0x01`. |
References
- Avoid unnecessary words and repetition. (link)
1 participant
…in Slow …"
This reverts commit 793505d.
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?