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<FilterExec, DataFusionError>

Create a FilterExec on an input

pub fn with_default_selectivity( self, default_selectivity: u8 ) -> Result<FilterExec, DataFusionError>

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

pub fn default_selectivity(&self) -> u8

The default selectivity

Trait Implementations

impl Debug for FilterExec

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

Formats the value using the given formatter.

impl DisplayAs for FilterExec

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 FilterExec

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

Return a reference to Any that can be used for downcasting

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

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

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

Returns false if this ExecutionPlan’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<FilterExec>, children: 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 execute( &self, partition: usize, context: Arc<TaskContext> ) -> Result<Pin<Box<dyn RecordBatchStream<Item = Result<RecordBatch, DataFusionError>> + Send>>, DataFusionError>

Begin execution of partition, returning a Stream of RecordBatches.

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

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

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

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

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.