Struct datafusion::physical_plan::test::exec::MockExec

pub struct MockExec { /* private fields */ }

A Mock ExecutionPlan that can be used for writing tests of other ExecutionPlans

Implementations

impl MockExec

pub fn new( data: Vec<Result<RecordBatch, DataFusionError>>, schema: Arc<Schema> ) -> MockExec

Create a new MockExec with a single partition that returns the specified Resultss.

By default, the batches are not produced immediately (the caller has to actually yield and another task must run) to ensure any poll loops are correct. This behavior can be changed with with_use_task

pub fn with_use_task(self, use_task: bool) -> MockExec

If use_task is true (the default) then the batches are sent back using a separate task to ensure the underlying stream is not immediately ready

Trait Implementations

impl Debug for MockExec

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

Formats the value using the given formatter.

impl DisplayAs for MockExec

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

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

impl ExecutionPlan for MockExec

fn execute( &self, partition: usize, _context: Arc<TaskContext> ) -> Result<Pin<Box<dyn RecordBatchStream<Item = Result<RecordBatch, DataFusionError>> + Send>>, DataFusionError>

Returns a stream which yields data

fn as_any(&self) -> &(dyn Any + 'static)

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

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

Get the schema for this execution plan

fn output_partitioning(&self) -> Partitioning

Specifies how the output of this ExecutionPlan is split into partitions.

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

If the output of this ExecutionPlan within each partition is sorted, returns Some(keys) with the description of how it was sorted.

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<MockExec>, _: Vec<Arc<dyn ExecutionPlan>> ) -> Result<Arc<dyn ExecutionPlan>, DataFusionError>

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

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

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

fn unbounded_output(&self, _children: &[bool]) -> Result<bool, DataFusionError>

Specifies whether this plan generates an infinite stream of records. If the plan does not support pipelining, but its input(s) are infinite, returns an error to indicate this.

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

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

fn equivalence_properties(&self) -> EquivalenceProperties

Get the EquivalenceProperties within the plan.

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.