Skip to content

docs: Add more documentation about PartialSortExec operator - #24048

Open
alamb wants to merge 1 commit into
apache:mainfrom
alamb:alamb/partial-sort-exec-docs
Open

docs: Add more documentation about PartialSortExec operator#24048
alamb wants to merge 1 commit into
apache:mainfrom
alamb:alamb/partial-sort-exec-docs

Conversation

@alamb

@alamb alamb commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

Which issue does this PR close?

N/A

Rationale for this change

I was trying to explain to someone recently how PartialSortExec works, and I found the
datafusion docs weren't quite as explicit about the befits as I wanted

What changes are included in this PR?

  1. Update the PartialSortExec documentation to explain the streaming and memory implications better, and add a worked buffering example

Are these changes tested?

By CI

Are there any user-facing changes?

Better docs

@alamb alamb added the documentation Improvements or additions to documentation label Aug 1, 2026
@alamb

alamb commented Aug 1, 2026

Copy link
Copy Markdown
Contributor Author

FYI @NGA-TRAN per our disucssion

@github-actions github-actions Bot added physical-plan Changes to the physical-plan crate and removed documentation Improvements or additions to documentation labels Aug 1, 2026
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.85%. Comparing base (b4cde12) to head (8226ee8).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #24048      +/-   ##
==========================================
- Coverage   80.86%   80.85%   -0.01%     
==========================================
  Files        1101     1101              
  Lines      375444   375446       +2     
  Branches   375444   375446       +2     
==========================================
- Hits       303593   303578      -15     
- Misses      53764    53775      +11     
- Partials    18087    18093       +6     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@2010YOUY01 2010YOUY01 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM, this is a great doc improvement.

/// +---+---+---+
/// ```
///
/// Once known complete, the uffered rows are sorted by the full `(a, b, c)`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// Once known complete, the uffered rows are sorted by the full `(a, b, c)`
/// Once known complete, the buffered rows are sorted by the full `(a, b, c)`

@NGA-TRAN NGA-TRAN left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Make sense. Thanks Andrew

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

Labels

physical-plan Changes to the physical-plan crate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants