Struct datafusion_physical_plan::sorts::partial_sort::PartialSortExec

pub struct PartialSortExec { /* private fields */ }

Partial Sort execution plan.

Implementations

impl PartialSortExec

pub fn new( expr: Vec<PhysicalSortExpr>, input: Arc<dyn ExecutionPlan>, common_prefix_length: usize, ) -> Self

Create a new partial sort execution plan

pub fn preserve_partitioning(&self) -> bool

Whether this PartialSortExec preserves partitioning of the children

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

Specify the partitioning behavior of this partial 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.

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) -> &[PhysicalSortExpr]

Sort expressions

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

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

Trait Implementations

impl Clone for PartialSortExec

fn clone(&self) -> PartialSortExec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PartialSortExec

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

Formats the value using the given formatter.

impl DisplayAs for PartialSortExec

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 PartialSortExec

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

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

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 benefits_from_input_partitioning(&self) -> Vec<bool>

Specifies whether the ExecutionPlan benefits from increased parallelization at its input 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 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 execute( &self, partition: usize, context: Arc<TaskContext>, ) -> Result<SendableRecordBatchStream>

Begin execution of partition, returning a Stream of RecordBatches.

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>

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

fn static_name() -> &'static str

where Self: Sized,

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

fn schema(&self) -> SchemaRef

Get the schema for this execution plan

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

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 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.