explain-joins: reword "create ... on disk" as "spill ... to disk" - #23346
Conversation
|
Note Reviews pausedIt 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 Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Team Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 4 included reviews per hour; 0 remain after this review. 📝 WalkthroughWalkthroughThe Runtime Statistics documentation now states that TiDB may spill the hash join ChangesRuntime Statistics
Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: ⚪ Minimal · up to 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)
Full details: Description checkExplanation 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 CoverageExplanation 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)
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 |
cfcb41c to
fa4e61b
Compare
fa4e61b to
3b3e023
Compare
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
3b3e023 to
18622e7
Compare
[LGTM Timeline notifier]Timeline:
|
Co-authored-by: Grace Cai <qqzczy@126.com>
|
/approve |
|
[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 DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
In response to a cherrypick label: new pull request created to branch |
What is changed, added or deleted? (Required)
In the Hash Join section of
explain-joins.md, one sentence describes the on-disk behavior as:"create the
Buildoperator 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:This PR aligns the earlier sentence with that clearer, consistent wording ("spill ... to disk").
Which TiDB version(s) do your changes apply to? (Required)
What is the related PR or file link(s)?
N/A — documentation wording clarification.
🤖 Generated with Claude Code
Summary by CodeRabbit