functions-and-operators, releases: clarify TIDB_DECODE_SQL_DIGESTS wording (#23686) - #23754
functions-and-operators, releases: clarify TIDB_DECODE_SQL_DIGESTS wording (#23686)#23754ti-chi-bot wants to merge 5 commits into
Conversation
…rding Reword "a form without formats and arguments" to "without value formats or arguments" to remove the redundant use of "form"/"formats" -- when translated, both words map to the identical term in some languages, making the parenthetical read as self-contradictory (a "form" without "format").
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
ti-chi-bot
added
lgtm
size/XS
|
[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 |
📝 WalkthroughWalkthroughThe documentation now describes normalized SQL statements as replacing literal values with placeholders such as ChangesTIDB_DECODE_SQL_DIGESTS documentation
Estimated code review effort: 1 (Trivial) | ~3 minutes Merge Risk: 🔵 Low · up to The function documentation is clearer, but linked documentation may still describe normalized SQL differently, which can confuse users. Align the wording or confirm the difference is intentional before merging. Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Team
Run ID: 34e2a4dd-b33c-4e34-885d-900b0b779461
📒 Files selected for processing (2)
functions-and-operators/tidb-functions.mdreleases/release-5.2.0.md
Included review availability: Your plan provides up to 4 included reviews per hour; 0 remain after this review.
| ## TIDB_DECODE_SQL_DIGESTS | ||
|
|
||
| The `TIDB_DECODE_SQL_DIGESTS()` function is used to query the normalized SQL statements (a form without formats and arguments) corresponding to the set of SQL digests in the cluster. This function accepts 1 or 2 arguments: | ||
| The `TIDB_DECODE_SQL_DIGESTS()` function is used to query the normalized SQL statements (in which literal values are replaced with placeholders such as `?` or `...`) corresponding to the set of SQL digests in the cluster. This function accepts 1 or 2 arguments: |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Align the linked TIDB_TRX description.
information-schema/information-schema-tidb-trx.md still says that normalized SQL is “without arguments and format”. This page now defines the same output as literal values replaced with placeholders. Update the linked sentence in this backport, or confirm that the older wording is intentional.
2 participants
This is an automated cherry-pick of #23686
What is changed, added or deleted? (Required)
Rewords the parenthetical describing
TIDB_DECODE_SQL_DIGESTS()'s output from"a form without formats and arguments" to "without value formats or arguments",
in 4 places (3 in
functions-and-operators/tidb-functions.md, 1 inreleases/release-5.2.0.md).The original phrasing uses "form" and "formats" as two separate words with the
same root meaning right next to each other ("a form without formats"), which
reads as slightly self-contradictory even in English, and becomes worse once
translated: in Japanese, both "form" and "format" map to the same word (形式),
so the translated sentence ends up reading as "a 形式 without 形式" — literally
"a form without form" — with no way to distinguish the two senses. Simplifying
to a single clear phrase avoids this.
Found while reviewing the Japanese translation for this exact confusion.
Which TiDB version(s) do your changes apply to? (Required)
What is the related PR or file link(s)?
AI agent involvement
Do your changes match any of the following descriptions?
Summary by CodeRabbit
TIDB_DECODE_SQL_DIGESTS()to explain that normalized SQL statements replace literal values with placeholders such as?or....