Struct Filter

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

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

having: bool

The flag to indicate if the filter is a having clause

Implementations

impl Filter

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

Create a new filter operator.

Notes: as Aliases have no effect on the output of a filter operator, they are removed from the predicate expression.

pub fn try_new_with_having( predicate: Expr, input: Arc<LogicalPlan>, ) -> Result<Filter, DataFusionError>

Create a new filter operator for a having clause. This is similar to a filter, but its having flag is set to true.

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.

impl Debug for Filter

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

Formats the value using the given formatter.

impl From<Filter> for PyFilter

fn from(filter: Filter) -> PyFilter

Converts to this type from the input type.

impl From<PyFilter> for Filter

fn from(filter: PyFilter) -> Self

Converts to this type from the input type.

impl Hash for Filter

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Filter

fn eq(&self, other: &Filter) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Filter

fn partial_cmp(&self, other: &Filter) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Filter

impl StructuralPartialEq for Filter