Skip to content

Commit

Permalink
doc: minor fix to SortExec::with_fetch comment (#8011)
Browse files Browse the repository at this point in the history
  • Loading branch information
westonpace authored Nov 1, 2023
1 parent 3185783 commit aef95ed
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion datafusion/physical-plan/src/sorts/sort.rs
Original file line number Diff line number Diff line change
Expand Up @@ -735,7 +735,13 @@ impl SortExec {
self
}

/// Whether this `SortExec` preserves partitioning of the children
/// Modify how many rows to include in the result
///
/// If None, then all rows will be returned, in sorted order.
/// If Some, then only the top `fetch` rows will be returned.
/// This can reduce the memory pressure required by the sort
/// operation since rows that are not going to be included
/// can be dropped.
pub fn with_fetch(mut self, fetch: Option<usize>) -> Self {
self.fetch = fetch;
self
Expand Down

0 comments on commit aef95ed

Please sign in to comment.