Struct SortExec 

pub struct SortExec {
    pub(crate) input: Arc<dyn ExecutionPlan>,
    expr: LexOrdering,
    metrics_set: ExecutionPlanMetricsSet,
    preserve_partitioning: bool,
    fetch: Option<usize>,
    common_sort_prefix: Vec<PhysicalSortExpr>,
    cache: PlanProperties,
    filter: Option<Arc<RwLock<TopKDynamicFilters>>>,
}

Sort execution plan.

Support sorting datasets that are larger than the memory allotted by the memory manager, by spilling to disk.

Fields

input: Arc<dyn ExecutionPlan>

Input schema

expr: LexOrdering

Sort expressions

metrics_set: ExecutionPlanMetricsSet

Containing all metrics set created during sort

preserve_partitioning: bool

Preserve partitions of input plan. If false, the input partitions will be sorted and merged into a single output partition.

fetch: Option<usize>

Fetch highest/lowest n results

common_sort_prefix: Vec<PhysicalSortExpr>

Normalized common sort prefix between the input and the sort expressions (only used with fetch)

cache: PlanProperties

Cache holding plan properties like equivalences, output partitioning etc.

filter: Option<Arc<RwLock<TopKDynamicFilters>>>

Filter matching the state of the sort for dynamic filter pushdown. If fetch is Some, this will also be set and a TopK operator may be used. If fetch is None, this will be None.

Implementations

impl SortExec

pub fn new(expr: LexOrdering, input: Arc<dyn ExecutionPlan>) -> Self

Create a new sort execution plan that produces a single, sorted output partition.

pub fn preserve_partitioning(&self) -> bool

Whether this SortExec preserves partitioning of the children

pub fn with_preserve_partitioning(self, preserve_partitioning: bool) -> Self

Specify the partitioning behavior of this sort exec

If preserve_partitioning is true, sorts each partition individually, producing one sorted stream for each input partition.

If preserve_partitioning is false, sorts and merges all input partitions producing a single, sorted partition.

fn create_filter(&self) -> Arc<RwLock<TopKDynamicFilters>>

Add or reset self.filter to a new TopKDynamicFilters.

fn cloned(&self) -> Self

pub fn with_fetch(&self, fetch: Option<usize>) -> Self

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 input(&self) -> &Arc<dyn ExecutionPlan>

Input schema

pub fn expr(&self) -> &LexOrdering

Sort expressions

pub fn fetch(&self) -> Option<usize>

If Some(fetch), limits output to only the first “fetch” items

fn output_partitioning_helper( input: &Arc<dyn ExecutionPlan>, preserve_partitioning: bool, ) -> Partitioning

fn compute_properties( input: &Arc<dyn ExecutionPlan>, sort_exprs: LexOrdering, preserve_partitioning: bool, ) -> Result<(PlanProperties, Vec<PhysicalSortExpr>)>

This function creates the cache object that stores the plan properties such as schema, equivalence properties, ordering, partitioning, etc. It also returns the common sort prefix between the input and the sort expressions.

Trait Implementations

impl Clone for SortExec

fn clone(&self) -> SortExec

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SortExec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DisplayAs for SortExec

fn fmt_as(&self, t: DisplayFormatType, f: &mut Formatter<'_>) -> Result

Format according to DisplayFormatType, used when verbose representation looks different from the default one

impl ExecutionPlan for SortExec

fn try_swapping_with_projection( &self, projection: &ProjectionExec, ) -> Result<Option<Arc<dyn ExecutionPlan>>>

Tries to swap the projection with its input SortExec. If it can be done, it returns the new swapped version having the SortExec as the top plan. Otherwise, it returns None.

fn name(&self) -> &'static str

Short name for the ExecutionPlan, such as ‘DataSourceExec’.

fn as_any(&self) -> &dyn Any

Returns the execution plan as Any so that it can be downcast to a specific implementation.

fn properties(&self) -> &PlanProperties

Return properties of the output of the ExecutionPlan, such as output ordering(s), partitioning information etc.

fn required_input_distribution(&self) -> Vec<Distribution>

Specifies the data distribution requirements for all the children for this ExecutionPlan, By default it’s [Distribution::UnspecifiedDistribution] for each child,

fn children(&self) -> Vec<&Arc<dyn ExecutionPlan>>

Get a list of children ExecutionPlans that act as inputs to this plan. The returned list will be empty for leaf nodes such as scans, will contain a single value for unary nodes, or two values for binary nodes (such as joins).

fn benefits_from_input_partitioning(&self) -> Vec<bool>

Specifies whether the ExecutionPlan benefits from increased parallelization at its input for each child.

fn with_new_children( self: Arc<Self>, children: Vec<Arc<dyn ExecutionPlan>>, ) -> Result<Arc<dyn ExecutionPlan>>

Returns a new ExecutionPlan where all existing children were replaced by the children, in order

fn reset_state(self: Arc<Self>) -> Result<Arc<dyn ExecutionPlan>>

Reset any internal state within this ExecutionPlan.

fn execute( &self, partition: usize, context: Arc<TaskContext>, ) -> Result<SendableRecordBatchStream>

Begin execution of partition, returning a Stream of [RecordBatch]es.

fn metrics(&self) -> Option<MetricsSet>

Return a snapshot of the set of Metrics for this ExecutionPlan. If no Metrics are available, return None.

fn statistics(&self) -> Result<Statistics>

👎Deprecated since 48.0.0: Use partition_statistics method instead

Returns statistics for this ExecutionPlan node. If statistics are not available, should return Statistics::new_unknown (the default), not an error.

fn partition_statistics(&self, partition: Option<usize>) -> Result<Statistics>

Returns statistics for a specific partition of this ExecutionPlan node. If statistics are not available, should return Statistics::new_unknown (the default), not an error. If partition is None, it returns statistics for the entire plan.

fn with_fetch(&self, limit: Option<usize>) -> Option<Arc<dyn ExecutionPlan>>

Returns a fetching variant of this ExecutionPlan node, if it supports fetch limits. Returns None otherwise.

fn fetch(&self) -> Option<usize>

Gets the fetch count for the operator, None means there is no fetch.

fn cardinality_effect(&self) -> CardinalityEffect

Gets the effect on cardinality, if known

fn gather_filters_for_pushdown( &self, phase: FilterPushdownPhase, parent_filters: Vec<Arc<dyn PhysicalExpr>>, config: &ConfigOptions, ) -> Result<FilterDescription>

Collect filters that this node can push down to its children. Filters that are being pushed down from parents are passed in, and the node may generate additional filters to push down. For example, given the plan FilterExec -> HashJoinExec -> DataSourceExec, what will happen is that we recurse down the plan calling ExecutionPlan::gather_filters_for_pushdown:

fn static_name() -> &'static str

where Self: Sized,

Short name for the ExecutionPlan, such as ‘DataSourceExec’. Like name but can be called without an instance.

fn schema(&self) -> SchemaRef

Get the schema for this execution plan

fn check_invariants(&self, check: InvariantLevel) -> Result<()>

Returns an error if this individual node does not conform to its invariants. These invariants are typically only checked in debug mode.

fn required_input_ordering(&self) -> Vec<Option<OrderingRequirements>>

Specifies the ordering required for all of the children of this ExecutionPlan.

fn maintains_input_order(&self) -> Vec<bool>

Returns false if this ExecutionPlan’s implementation may reorder rows within or between partitions.

fn repartitioned( &self, _target_partitions: usize, _config: &ConfigOptions, ) -> Result<Option<Arc<dyn ExecutionPlan>>>

If supported, attempt to increase the partitioning of this ExecutionPlan to produce target_partitions partitions.

fn supports_limit_pushdown(&self) -> bool

Returns true if a limit can be safely pushed down through this ExecutionPlan node.

fn handle_child_pushdown_result( &self, _phase: FilterPushdownPhase, child_pushdown_result: ChildPushdownResult, _config: &ConfigOptions, ) -> Result<FilterPushdownPropagation<Arc<dyn ExecutionPlan>>>

Handle the result of a child pushdown. This method is called as we recurse back up the plan tree after pushing filters down to child nodes via ExecutionPlan::gather_filters_for_pushdown. It allows the current node to process the results of filter pushdown from its children, deciding whether to absorb filters, modify the plan, or pass filters back up to its parent.

fn with_new_state( &self, _state: Arc<dyn Any + Send + Sync>, ) -> Option<Arc<dyn ExecutionPlan>>

Injects arbitrary run-time state into this execution plan, returning a new plan instance that incorporates that state if it is relevant to the concrete node implementation.