Struct ShuffleReadExec 

pub struct ShuffleReadExec { /* private fields */ }

Leaf node that streams an upstream ShuffleMap stage’s output partitions.

execute(p) merges partition p across all map tasks of the upstream stage. On the coordinator (encode side) the node carries no reader and cannot execute; the executor’s codec injects one at decode time.

Implementations

impl ShuffleReadExec

pub fn new( upstream_stage_index: usize, num_map_tasks: usize, partition_count: usize, schema: SchemaRef, reader: Option<Arc<dyn ShufflePartitionReader>>, ) -> Self

pub fn with_upstream_estimate( self, rows: Option<usize>, bytes: Option<usize>, ) -> Self

Attach the cut subtree’s estimated size. See Self::upstream_rows.

pub fn upstream_estimate(&self) -> (Option<usize>, Option<usize>)

The estimate as (rows, bytes), for encoding onto the wire.

pub fn estimate_of( plan: &Arc<dyn ExecutionPlan>, ) -> (Option<usize>, Option<usize>)

Capture a cut subtree’s estimate at the point the exchange is replaced.

pub fn upstream_stage_index(&self) -> usize

pub fn num_map_tasks(&self) -> usize

pub fn partition_count(&self) -> usize

Trait Implementations

impl Debug for ShuffleReadExec

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

Formats the value using the given formatter.

impl DisplayAs for ShuffleReadExec

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 ShuffleReadExec

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

D3(2): report the cut subtree’s estimate instead of “unknown”.

Inexact is the honest precision — this is a planning-time estimate of a stage that has not run. Absent stays absent: a rule that keys on known-size (as SpillableJoinSelection deliberately does) must still be able to tell “no idea” from “small”.

fn name(&self) -> &str

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

fn properties(&self) -> &Arc<PlanProperties>

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

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 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 downcast_delegate(&self) -> Option<&(dyn ExecutionPlan + 'static)>

Returns the plan that provides this plan’s public ExecutionPlan downcast identity.

fn schema(&self) -> Arc<Schema>

Get the schema for this execution plan

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

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

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

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

Reset any internal state within this ExecutionPlan.

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

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

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

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

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.

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 try_swapping_with_projection( &self, _projection: &ProjectionExec, ) -> Result<Option<Arc<dyn ExecutionPlan>>, DataFusionError>

Attempts to push down the given projection into the input of this ExecutionPlan.

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

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 handle_child_pushdown_result( &self, _phase: FilterPushdownPhase, child_pushdown_result: ChildPushdownResult, _config: &ConfigOptions, ) -> Result<FilterPushdownPropagation<Arc<dyn ExecutionPlan>>, DataFusionError>

Handle the result of a child pushdown.

fn with_new_state( &self, _state: Arc<dyn Any + Sync + Send>, ) -> 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.

fn try_pushdown_sort( &self, _order: &[PhysicalSortExpr], ) -> Result<SortOrderPushdownResult<Arc<dyn ExecutionPlan>>, DataFusionError>

Try to push down sort ordering requirements to this node.

fn with_preserve_order( &self, _preserve_order: bool, ) -> Option<Arc<dyn ExecutionPlan>>

Returns a variant of this ExecutionPlan that is aware of order-sensitivity.