Skip to content

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

Open
yahonda wants to merge 1 commit into
pingcap:release-8.5from
yahonda:fix-explain-joins-spill-wording
Open

explain-joins: reword "create ... on disk" as "spill ... to disk"#23346
yahonda wants to merge 1 commit 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.

In the hash join section, one sentence said TiDB "might create the `Build`
operator ... on disk", which is confusing. Align it with the wording used
later in the same page ("spill the `Build` operator ... to disk"), which more
accurately describes spilling the operator's data to temporary storage.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@ti-chi-bot

ti-chi-bot Bot commented Jul 23, 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 tangenta 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

@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

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 65040147-dd90-406d-8edd-ddbf966d1745

📥 Commits

Reviewing files that changed from the base of the PR and between 5e0ed95 and cfcb41c.

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

📝 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

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the doc wording change from "create ... on disk" to "spill ... to disk" in explain-joins.md.
Description check ✅ Passed The description covers the required change summary, affected version, and related link section in the repository template.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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

missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant