Struct datafusion::physical_plan::explain::ExplainExec

pub struct ExplainExec { /* private fields */ }

Explain execution plan operator. This operator contains the string values of the various plans it has when it is created, and passes them to its output.

Implementations

impl ExplainExec

pub fn new( schema: SchemaRef, stringified_plans: Vec<StringifiedPlan>, verbose: bool ) -> Self

Create a new ExplainExec

pub fn stringified_plans(&self) -> &[StringifiedPlan]

The strings to be printed

pub fn verbose(&self) -> bool

access to verbose

Trait Implementations

impl Clone for ExplainExec

fn clone(&self) -> ExplainExec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExplainExec

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

Formats the value using the given formatter.

impl ExecutionPlan for ExplainExec

fn as_any(&self) -> &dyn Any

Return a reference to Any that can be used for downcasting

fn output_partitioning(&self) -> Partitioning

Get the output partitioning of this plan

fn schema(&self) -> SchemaRef

Get the schema for this execution plan

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 output_ordering(&self) -> Option<&[PhysicalSortExpr]>

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

fn with_new_children( self: Arc<Self>, _: 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 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 unbounded_output(&self, _children: &[bool]) -> Result<bool>

Specifies whether this plan generates an infinite stream of records. If the plan does not support pipelining, but it 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 operator, By default it’s [Distribution::UnspecifiedDistribution] for each child,

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

Specifies the ordering requirements for all of the children For each child, it’s the local ordering requirement within each partition rather than the global ordering

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

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

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 equivalence_properties(&self) -> EquivalenceProperties

Get the EquivalenceProperties within the plan

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

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