Struct datafusion::physical_plan::filter::FilterExec

pub struct FilterExec { /* private fields */ }

FilterExec evaluates a boolean predicate against all input batches to determine which rows to include in its output batches.

Implementations

impl FilterExec

pub fn try_new(
    predicate: Arc<dyn PhysicalExpr>,
    input: Arc<dyn ExecutionPlan>
) -> Result<Self>

Create a FilterExec on an input

pub fn predicate(&self) -> &Arc<dyn PhysicalExpr>

The expression to filter on. This expression must evaluate to a boolean value.

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

The input plan

Trait Implementations

impl Debug for FilterExec

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

Formats the value using the given formatter.

impl ExecutionPlan for FilterExec

fn as_any(&self) -> &dyn Any

Return a reference to Any that can be used for downcasting

fn schema(&self) -> SchemaRef

Get the schema for this execution plan

fn output_partitioning(&self) -> Partitioning

Get the output partitioning of this plan

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 statistics(&self) -> Statistics

The output statistics of a filtering operation can be estimated if the predicate’s selectivity value can be determined for the incoming data.

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

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

fn equivalence_properties(&self) -> EquivalenceProperties

Get the EquivalenceProperties within the plan

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 fmt_as(&self, t: DisplayFormatType, f: &mut Formatter<'_>) -> Result

Format this ExecutionPlan to f in the specified type.

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

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

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