Struct datafusion::physical_plan::filter::FilterExec
source · [−]pub struct FilterExec { /* private fields */ }
Expand description
FilterExec evaluates a boolean predicate against all input batches to determine which rows to include in its output batches.
Implementations
sourceimpl FilterExec
impl FilterExec
sourcepub fn try_new(
predicate: Arc<dyn PhysicalExpr>,
input: Arc<dyn ExecutionPlan>
) -> Result<Self>
pub fn try_new(
predicate: Arc<dyn PhysicalExpr>,
input: Arc<dyn ExecutionPlan>
) -> Result<Self>
Create a FilterExec on an input
sourcepub fn predicate(&self) -> &Arc<dyn PhysicalExpr>
pub fn predicate(&self) -> &Arc<dyn PhysicalExpr>
The expression to filter on. This expression must evaluate to a boolean value.
sourcepub fn input(&self) -> &Arc<dyn ExecutionPlan>
pub fn input(&self) -> &Arc<dyn ExecutionPlan>
The input plan
Trait Implementations
sourceimpl Debug for FilterExec
impl Debug for FilterExec
sourceimpl ExecutionPlan for FilterExec
impl ExecutionPlan for FilterExec
sourcefn output_partitioning(&self) -> Partitioning
fn output_partitioning(&self) -> Partitioning
Get the output partitioning of this plan
sourcefn statistics(&self) -> Statistics
fn statistics(&self) -> Statistics
The output statistics of a filtering operation are unknown
sourcefn children(&self) -> Vec<Arc<dyn ExecutionPlan>>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A>where
A: Allocator,
fn children(&self) -> Vec<Arc<dyn ExecutionPlan>>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A>where
A: Allocator,
A: Allocator,
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). Read more
sourcefn output_ordering(&self) -> Option<&[PhysicalSortExpr]>
fn output_ordering(&self) -> Option<&[PhysicalSortExpr]>
If the output of this operator is sorted, returns Some(keys)
with the description of how it was sorted. Read more
sourcefn maintains_input_order(&self) -> bool
fn maintains_input_order(&self) -> bool
Returns false
if this operator’s implementation may reorder
rows within or between partitions. Read more
sourcefn relies_on_input_order(&self) -> bool
fn relies_on_input_order(&self) -> bool
Returns true
if this operator relies on its inputs being
produced in a certain order (for example that they are sorted
a particular way) for correctness. Read more
sourcefn with_new_children(
self: Arc<Self>,
children: Vec<Arc<dyn ExecutionPlan>>
) -> Result<Arc<dyn ExecutionPlan>>
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.
sourcefn execute(
&self,
partition: usize,
context: Arc<TaskContext>
) -> Result<SendableRecordBatchStream>
fn execute(
&self,
partition: usize,
context: Arc<TaskContext>
) -> Result<SendableRecordBatchStream>
creates an iterator
sourcefn fmt_as(&self, t: DisplayFormatType, f: &mut Formatter<'_>) -> Result
fn fmt_as(&self, t: DisplayFormatType, f: &mut Formatter<'_>) -> Result
Format this ExecutionPlan
to f
in the specified type. Read more
sourcefn metrics(&self) -> Option<MetricsSet>
fn metrics(&self) -> Option<MetricsSet>
Return a snapshot of the set of Metric
s for this
ExecutionPlan
. Read more
sourcefn required_child_distribution(&self) -> Distribution
fn required_child_distribution(&self) -> Distribution
Specifies the data distribution requirements of all the children for this operator Read more
sourcefn benefits_from_input_partitioning(&self) -> bool
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 Read more
Auto Trait Implementations
impl !RefUnwindSafe for FilterExec
impl Send for FilterExec
impl Sync for FilterExec
impl Unpin for FilterExec
impl !UnwindSafe for FilterExec
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more