Skip to content

explain-joins: reword "create ... on disk" as "spill ... to disk" - #23346

Merged
ti-chi-bot[bot] merged 2 commits into
pingcap:release-8.5from
yahonda:fix-explain-joins-spill-wording
Sep 7, 2026
Merged

explain-joins: reword "create ... on disk" as "spill ... to disk"#23346
ti-chi-bot[bot] merged 2 commits into
pingcap:release-8.5from
yahonda:fix-explain-joins-spill-wording

Conversation

@yahonda

@yahonda yahonda commented Jul 23, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

In the Hash Join section of explain-joins.md, one sentence describes the on-disk behavior as:

TiDB will attempt to use temporary storage, and might create the Build operator (used as part of the hash join) on disk.

"create the Build operator on disk" is confusing — the operator is not created on disk; its data is spilled to temporary storage. Later on the same page, the system-variables section already describes the same behavior with clearer wording:

TiDB will attempt to spill the Build operator of a hash join to disk to save memory.

This PR aligns the earlier sentence with that clearer, consistent wording ("spill ... to disk").

Which TiDB version(s) do your changes apply to? (Required)

  • master (the latest development version)
  • v8.5 (TiDB 8.5 versions)

What is the related PR or file link(s)?

N/A — documentation wording clarification.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Clarified that when the query memory quota is exceeded and temporary storage on out-of-memory is enabled, the hash join Build operator may spill to disk.

@ti-chi-bot ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 23, 2026
@coderabbitai

coderabbitai Bot commented Jul 23, 2026

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Team

Run ID: 7aa23ef8-54bf-4602-9612-0f5498f82a05

📥 Commits

Reviewing files that changed from the base of the PR and between fa4e61b and c132810.

📒 Files selected for processing (1)
  • explain-joins.md

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


📝 Walkthrough

Walkthrough

The Runtime Statistics documentation now states that TiDB may spill the hash join Build operator to disk when tidb_mem_quota_query is exceeded and temporary storage on OOM is enabled.

Changes

Runtime Statistics

Layer / File(s) Summary
Hash join spill wording
explain-joins.md
Clarifies that TiDB spills the hash join Build operator to disk instead of creating it on disk.

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

Merge Risk: ⚪ Minimal · up to c1328

The documentation now clearly describes hash join Build-side disk spilling when query memory is exceeded and temporary storage is enabled. No merge-readiness risk remains.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the documentation wording change from creating the Build operator on disk to spilling it to disk.
Description check ✅ Passed The description explains the change and rationale, identifies the affected TiDB version, and provides the related-file context. Optional checklist sections are omitted, but the required content is com…
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 change and rationale, identifies the affected TiDB version, and provides the related-file context. Optional checklist sections are omitted, but the required content is complete.

Full details: Docstring Coverage

Explanation

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 files. (1 skipped: 1 unsupported.)

✨ 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.

@yahonda
yahonda force-pushed the fix-explain-joins-spill-wording branch from cfcb41c to fa4e61b Compare August 3, 2026 00:16
@yahonda
yahonda force-pushed the fix-explain-joins-spill-wording branch from fa4e61b to 3b3e023 Compare August 10, 2026 00:56
@CLAassistant

CLAassistant commented Aug 14, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@yahonda
yahonda force-pushed the fix-explain-joins-spill-wording branch from 3b3e023 to 18622e7 Compare September 2, 2026 02:42
Comment thread explain-joins.md Outdated

@qiancai qiancai left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Rest LGTM

@qiancai qiancai self-assigned this Sep 3, 2026
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Sep 3, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 3, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-09-03 04:36:18.136971941 +0000 UTC m=+1340413.308066149: ☑️ agreed by qiancai.

@qiancai qiancai added translation/doing This PR's assignee is translating this PR. needs-cherry-pick-master Should cherry pick this PR to master branch. and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Sep 3, 2026
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Sep 3, 2026
Co-authored-by: Grace Cai <qqzczy@126.com>
@qiancai

qiancai commented Sep 7, 2026

Copy link
Copy Markdown
Collaborator

/approve

@qiancai qiancai added the lgtm label Sep 7, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 7, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

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

The pull request process is described 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

@ti-chi-bot ti-chi-bot Bot added the approved label Sep 7, 2026
@ti-chi-bot
ti-chi-bot Bot merged commit 6282c8b into pingcap:release-8.5 Sep 7, 2026
12 checks passed
@ti-chi-bot

Copy link
Copy Markdown
Member

In response to a cherrypick label: new pull request created to branch master: #23755.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved lgtm needs-cherry-pick-master Should cherry pick this PR to master branch. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. translation/doing This PR's assignee is translating this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants