Struct datafusion::physical_plan::filter::FilterExec

pub struct FilterExec { /* fields omitted */ }

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 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 with_new_children(
    &self,
    children: Vec<Arc<dyn ExecutionPlan>>
) -> Result<Arc<dyn ExecutionPlan>>

Returns a new plan where all children were replaced by new plans. The size of children must be equal to the size of ExecutionPlan::children().

fn execute<'life0, 'async_trait>(
    &'life0 self,
    partition: usize
) -> Pin<Box<dyn Future<Output = Result<SendableRecordBatchStream>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

creates an iterator

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

Format this ExecutionPlan to f in the specified type.

fn required_child_distribution(&self) -> Distribution

Specifies the data distribution requirements of all the children for this operator

fn metrics(&self) -> HashMap<String, SQLMetric>

Return a snapshot of the metrics collected during execution