Struct datafusion_expr::Filter

#[non_exhaustive]
pub struct Filter {
    pub predicate: Expr,
    pub input: Arc<LogicalPlan>,
}

Filters rows from its input that do not match an expression (essentially a WHERE clause with a predicate expression).

Semantically, <predicate> is evaluated for each row of the input; If the value of <predicate> is true, the input row is passed to the output. If the value of <predicate> is false, the row is discarded.

Filter should not be created directly but instead use try_new() and that these fields are only pub to support pattern matching

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

predicate: Expr

The predicate expression, which must have Boolean type.

input: Arc<LogicalPlan>

The incoming logical plan

Implementations

impl Filter

pub fn try_new(predicate: Expr, input: Arc<LogicalPlan>) -> Result<Self>

Create a new filter operator.

pub fn try_from_plan(plan: &LogicalPlan) -> Result<&Filter>

Trait Implementations

impl Clone for Filter

fn clone(&self) -> Filter

Returns a copy of the value.

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

Performs copy-assignment from source.