Struct LogicalFilter 

pub struct LogicalFilter {
    pub base: PlanBase<Logical>,
    core: Filter<LogicalPlanRef>,
}

LogicalFilter iterates over its input and returns elements for which predicate evaluates to true, filtering out the others.

If the condition allows nulls, then a null value is treated the same as false.

Fields

base: PlanBase<Logical>

core: Filter<LogicalPlanRef>

Implementations

impl LogicalFilter

pub fn new(input: PlanRef, predicate: Condition) -> Self

pub fn create(input: PlanRef, predicate: Condition) -> PlanRef

Create a LogicalFilter unless the predicate is always true

pub fn filter_out_all_null_keys(input: PlanRef, key: &[usize]) -> PlanRef

Create a LogicalFilter to filter out rows where all keys are null.

pub fn create_with_expr(input: PlanRef, predicate: ExprImpl) -> PlanRef

pub fn predicate(&self) -> &Condition

Get the predicate of the logical join.

Methods from Deref<Target = PlanBase<Logical>>

pub fn clone_with_new_plan_id(&self) -> Self

pub fn clone_with_new_distribution(&self, dist: Distribution) -> Self

Clone the plan node with a new distribution.

Panics if the plan node is not physical.

Trait Implementations

impl Clone for LogicalFilter

fn clone(&self) -> LogicalFilter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ColPrunable for LogicalFilter

fn prune_col( &self, required_cols: &[usize], ctx: &mut ColumnPruningContext, ) -> PlanRef

Transform the plan node to only output the required columns ordered by index number.

impl Debug for LogicalFilter

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

Formats the value using the given formatter.

impl Deref for LogicalFilter

type Target = PlanBase<Logical>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Distill for LogicalFilter

fn distill<'a>(&self) -> XmlNode<'a>

fn distill_to_string(&self) -> String

impl ExprRewritable<Logical> for LogicalFilter

fn has_rewritable_expr(&self) -> bool

fn rewrite_exprs(&self, r: &mut dyn ExprRewriter) -> PlanRef

impl ExprVisitable for LogicalFilter

fn visit_exprs(&self, v: &mut dyn ExprVisitor)

impl Hash for LogicalFilter

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

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 LogicalFilter

fn eq(&self, other: &LogicalFilter) -> 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 PlanNodeMeta for LogicalFilter

const NODE_TYPE: LogicalPlanNodeType = LogicalPlanNodeType::LogicalFilter

type Convention = Logical

fn plan_base(&self) -> &PlanBase<Logical>

Get the reference to the PlanBase with corresponding convention.

impl PlanTreeNode<Logical> for LogicalFilter

fn clone_with_inputs(&self, inputs: &[PlanRef<Logical>]) -> PlanRef<Logical>

Clone the node with a list of new inputs.

fn inputs(&self) -> SmallVec<[PlanRef<Logical>; 2]>

Get input nodes of the plan.

impl PlanTreeNodeUnary<Logical> for LogicalFilter

fn input(&self) -> PlanRef

fn clone_with_input(&self, input: PlanRef) -> Self

fn rewrite_with_input( &self, input: PlanRef, input_col_change: ColIndexMapping, ) -> (Self, ColIndexMapping)

Rewrites the plan node according to the schema change of its input node during rewriting.

impl PredicatePushdown for LogicalFilter

fn predicate_pushdown( &self, predicate: Condition, ctx: &mut PredicatePushdownContext, ) -> PlanRef

Push predicate down for every logical plan node.

impl ToBatch for LogicalFilter

fn to_batch(&self) -> Result<BatchPlanRef>

to_batch is equivalent to to_batch_with_order_required(&Order::any())

fn to_batch_with_order_required( &self, required_order: &Order, ) -> Result<BatchPlanRef>

convert the plan to batch physical plan and satisfy the required Order

impl ToStream for LogicalFilter

fn to_stream(&self, ctx: &mut ToStreamContext) -> Result<StreamPlanRef>

to_stream is equivalent to to_stream_with_dist_required(RequiredDist::Any)

fn logical_rewrite_for_stream( &self, ctx: &mut RewriteStreamContext, ) -> Result<(PlanRef, ColIndexMapping)>

logical_rewrite_for_stream will rewrite the logical node, and return (new_plan_node, col_mapping), the col_mapping is for original columns have been changed into some other position.

fn try_better_locality(&self, columns: &[usize]) -> Option<PlanRef>

fn to_stream_with_dist_required( &self, required_dist: &RequiredDist, ctx: &mut ToStreamContext, ) -> Result<StreamPlanRef>

convert the plan to streaming physical plan and satisfy the required distribution

impl Eq for LogicalFilter

impl LogicalPlanNode for LogicalFilter

impl StructuralPartialEq for LogicalFilter