docs: add statement summary system variables - #23001
Conversation
There was a problem hiding this comment.
Code Review
This pull request adds documentation for two new system variables introduced in TiDB v8.5.7: tidb_stmt_summary_group_by_user and tidb_stmt_summary_persist_evicted. The changes span across statement-summary-tables.md, system-variable-reference.md, and system-variables.md. The review comments suggest rewriting several sentences to use the active voice, reducing wordiness, and using "who" instead of "that" when referring to users, in alignment with the repository's documentation style guide.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
|
[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 |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review. 📝 WalkthroughWalkthroughThe documentation adds two GLOBAL statement summary variables. It describes user-based aggregation, LRU-evicted record persistence, defaults, memory effects, log output, and history query behavior. ChangesStatement summary configuration
Estimated code review effort: 1 (Trivial) | ~5 minutes Merge Risk: ⚪ Minimal · up to The PR only adds documentation for two system variables. No actionable merge-blocking risk remains; the normal link-anchor check should confirm that the new references resolve correctly. 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
🧪 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 |
| </CustomContent> | ||
|
|
||
| ### tidb_stmt_summary_persist_evicted <span class="version-mark">New in TiDB-X-CLOUD.202603.1</span> | ||
|
|
There was a problem hiding this comment.
| > **Note:** | |
| > | |
| > This variable is supported only for TiDB Cloud Essential and Premium instances whose kernel version is TiDB-X-CLOUD.202603.1 or later. | |
What is changed
This PR is translated from: pingcap/docs-cn#21694
Add English documentation for two statement summary system variables, corresponding to pingcap/docs-cn#21694:
Updated files:
Check List
Tests:
Summary by CodeRabbit
New Features
tidb_stmt_summary_group_by_userto optionally separate statement summaries by executing user.tidb_stmt_summary_persist_evictedto optionally preserve LRU-evicted statement records with anevictedmarker.Documentation