Skip to content

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

Open
ti-chi-bot wants to merge 2 commits into
pingcap:masterfrom
ti-chi-bot:cherry-pick-23346-to-master
Open

explain-joins: reword "create ... on disk" as "spill ... to disk" (#23346)#23755
ti-chi-bot wants to merge 2 commits into
pingcap:masterfrom
ti-chi-bot:cherry-pick-23346-to-master

Conversation

@ti-chi-bot

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

Copy link
Copy Markdown
Member

This is an automated cherry-pick of #23346

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 the hash join runtime statistics documentation to explain that data from the Build side might be spilled to disk when the query memory limit is exceeded.

yahonda and others added 2 commits September 7, 2026 02:24
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
@ti-chi-bot ti-chi-bot added lgtm size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. type/cherry-pick-for-master This PR is cherry-picked to master from a source PR. labels Sep 7, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 7, 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 7, 2026

Copy link
Copy Markdown

Review 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: Team

Run ID: 1145263b-4360-4341-8745-7714aa6113b0

📥 Commits

Reviewing files that changed from the base of the PR and between f83b80b and 66787fe.

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

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


📝 Walkthrough

Walkthrough

The hash join documentation now describes spilling data from the Build side to disk when tidb_mem_quota_query is exceeded.

Changes

Hash Join Documentation

Layer / File(s) Summary
Runtime statistics wording
explain-joins.md
The documentation replaces the description of creating the Build operator on disk with a description of spilling Build-side data to disk.

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

Merge Risk: ⚪ Minimal · up to 66787

This documentation-only update clarifies hash join disk spilling behavior without changing runtime behavior or configuration. It is ready to merge.

🚥 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 data to disk.
Description check ✅ Passed The description explains the change and reason, identifies the affected TiDB version, and provides related-change information. Some optional template checkboxes are omitted, but the required content i…
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.
✨ 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.

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

Labels

lgtm size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. type/cherry-pick-for-master This PR is cherry-picked to master from a source PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants