Skip to content

tidb-x: add statement summary system variables (#23001) - #23897

Open
ti-chi-bot wants to merge 16 commits into
pingcap:release-8.5from
ti-chi-bot:cherry-pick-23001-to-release-8.5
Open

ti-chi-bot wants to merge 16 commits into
pingcap:release-8.5from
ti-chi-bot:cherry-pick-23001-to-release-8.5

Conversation

@ti-chi-bot

@ti-chi-bot ti-chi-bot commented Sep 16, 2026

Copy link
Copy Markdown
Member

This is an automated cherry-pick of #23001

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:

  • tidb_stmt_summary_group_by_user
  • tidb_stmt_summary_persist_evicted

Updated files:

  • statement-summary-tables.md
  • system-variables.md
  • system-variable-reference.md

Check List

Tests:

  • ./scripts/markdownlint statement-summary-tables.md system-variable-reference.md system-variables.md
  • git diff --check -- statement-summary-tables.md system-variable-reference.md system-variables.md

Summary by CodeRabbit

  • Documentation
    • Added TiDB Cloud documentation for two global Boolean system variables.
    • Documented statement summary grouping by executing user, including availability, defaults, and summary reset behavior.
    • Documented persistence of evicted statement summaries, including availability, defaults, and history-query behavior.

@ti-chi-bot ti-chi-bot added lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR. type/compatibility-or-feature-change This PR involves compatibility changes or feature behavior changes. labels Sep 16, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 16, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign oreoxmt for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@coderabbitai

coderabbitai Bot commented Sep 16, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 58ef6274-d816-402b-81d6-03cb277450fe

📥 Commits

Reviewing files that changed from the base of the PR and between 06a8e1a and ddd649d.

📒 Files selected for processing (1)
  • system-variables.md

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.


📝 Walkthrough

Walkthrough

The documentation adds TiDB Cloud behavior details for two GLOBAL Boolean statement-summary variables, including support restrictions, defaults, aggregation behavior, persistence behavior, and history-query effects.

Changes

Statement Summary Variables

Layer / File(s) Summary
Variable behavior documentation
system-variables.md
Documents tidb_stmt_summary_group_by_user and tidb_stmt_summary_persist_evicted, including TiDB Cloud support restrictions, defaults, aggregation behavior, eviction persistence, and query effects.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Suggested reviewers: qiancai

Merge Risk: ⚪ Minimal · up to ddd64

This change adds documentation for statement-summary variables and is ready to merge.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the documentation changes, lists the affected variables and files, identifies the source PR, and records validation checks. It does not include the required TiDB version selec… Add the required TiDB version section and select the applicable version, most likely v8.5. Include the relevant template headings where applicable.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the addition of statement summary system variables and includes the related PR number.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Description check

Explanation

The description explains the documentation changes, lists the affected variables and files, identifies the source PR, and records validation checks. It does not include the required TiDB version selection section, although the change targets the release-8.5 branch.

  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 73e03aeb-e5de-4e00-9a6e-1cf91692b5dc

📥 Commits

Reviewing files that changed from the base of the PR and between 6acba5d and 06a8e1a.

📒 Files selected for processing (3)
  • statement-summary-tables.md
  • system-variable-reference.md
  • system-variables.md

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.

Comment thread statement-summary-tables.md Outdated
@qiancai qiancai changed the title docs: add statement summary system variables (#23001) tidb-x: add statement summary system variables (#23001) Sep 16, 2026
@qiancai
qiancai force-pushed the cherry-pick-23001-to-release-8.5 branch from 24cfb7c to ddd649d Compare September 16, 2026 10:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR. type/compatibility-or-feature-change This PR involves compatibility changes or feature behavior changes.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants