Struct datafusion::physical_plan::sorts::sort::SortExec

pub struct SortExec { /* private fields */ }

External Sort execution plan

Implementations

impl SortExec

pub fn try_new(
    expr: Vec<PhysicalSortExpr>,
    input: Arc<dyn ExecutionPlan>,
    fetch: Option<usize>
) -> Result<Self>

Create a new sort execution plan

pub fn preserve_partitioning(&self) -> bool

Whether this SortExec preserves partitioning of the children

pub fn new_with_partitioning(
    expr: Vec<PhysicalSortExpr>,
    input: Arc<dyn ExecutionPlan>,
    preserve_partitioning: bool,
    fetch: Option<usize>
) -> Self

Create a new sort execution plan with the option to preserve the partitioning of the input plan

pub fn input(&self) -> &Arc<dyn ExecutionPlan>

Input schema

pub fn expr(&self) -> &[PhysicalSortExpr]

Sort expressions

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

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

Trait Implementations

impl Debug for SortExec

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

Formats the value using the given formatter.

impl ExecutionPlan for SortExec

fn output_partitioning(&self) -> Partitioning

Get the output partitioning of this plan

fn as_any(&self) -> &dyn Any

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

fn schema(&self) -> SchemaRef

Get the schema for this execution plan

fn required_child_distribution(&self) -> Distribution

Specifies the data distribution requirements of all the children for this operator

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

Get a list of child execution plans that provide the input for this plan. The returned list will be empty for leaf nodes, will contain a single value for unary nodes, or two values for binary nodes (such as joins).

fn relies_on_input_order(&self) -> bool

Returns true if this operator relies on its inputs being produced in a certain order (for example that they are sorted a particular way) for correctness.

fn benefits_from_input_partitioning(&self) -> bool

Returns true if this operator would benefit from partitioning its input (and thus from more parallelism). For operators that do very little work the overhead of extra parallelism may outweigh any benefits

fn output_ordering(&self) -> Option<&[PhysicalSortExpr]>

If the output of this operator is sorted, returns Some(keys) with the description of how it was sorted.

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

Returns a new plan where all children were replaced by new plans.

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

creates an iterator

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

Return a snapshot of the set of Metrics for this ExecutionPlan.

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

Format this ExecutionPlan to f in the specified type.

fn statistics(&self) -> Statistics

Returns the global output statistics for this ExecutionPlan node.

fn maintains_input_order(&self) -> bool

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