Struct LookupJoinNode 

pub struct LookupJoinNode { /* private fields */ }

Custom logical plan node for a lookup join.

Represents a join between a streaming input plan and a lookup table. The lookup table is not a DataFusion table; it is resolved at execution time via the lookup source connector.

Implementations

impl LookupJoinNode

pub fn new( input: LogicalPlan, lookup_table: String, lookup_schema: DFSchemaRef, join_keys: Vec<JoinKeyPair>, join_type: LookupJoinType, pushdown_predicates: Vec<Expr>, required_lookup_columns: HashSet<String>, output_schema: DFSchemaRef, metadata: LookupTableMetadata, ) -> Self

Creates a new lookup join node.

pub fn with_local_predicates(self, predicates: Vec<Expr>) -> Self

Sets predicates to be evaluated locally after the join.

pub fn with_aliases( self, lookup_alias: Option<String>, stream_alias: Option<String>, ) -> Self

Sets table aliases for qualified column resolution.

pub fn lookup_table_name(&self) -> &str

Returns the lookup table name.

pub fn join_keys(&self) -> &[JoinKeyPair]

Returns the join key pairs.

pub fn join_type(&self) -> LookupJoinType

Returns the join type.

pub fn pushdown_predicates(&self) -> &[Expr]

Returns the pushdown predicates.

pub fn required_lookup_columns(&self) -> &HashSet<String>

Returns the required lookup columns.

pub fn metadata(&self) -> &LookupTableMetadata

Returns the lookup table metadata.

pub fn lookup_schema(&self) -> &DFSchemaRef

Returns the lookup table schema.

pub fn local_predicates(&self) -> &[Expr]

Returns the local predicates (evaluated after the join).

pub fn lookup_alias(&self) -> Option<&str>

Returns the lookup table alias.

pub fn stream_alias(&self) -> Option<&str>

Returns the stream input alias.

Trait Implementations

impl Clone for LookupJoinNode

fn clone(&self) -> LookupJoinNode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LookupJoinNode

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

Formats the value using the given formatter.

impl Hash for LookupJoinNode

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 LookupJoinNode

fn eq(&self, other: &Self) -> 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 LookupJoinNode

fn partial_cmp(&self, other: &Self) -> 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 UserDefinedLogicalNodeCore for LookupJoinNode

fn name(&self) -> &'static str

Return the plan’s name.

fn inputs(&self) -> Vec<&LogicalPlan>

Return the logical plan’s inputs.

fn schema(&self) -> &DFSchemaRef

Return the output schema of this logical plan node.

fn expressions(&self) -> Vec<Expr>

Returns all expressions in the current logical plan node. This should not include expressions of any inputs (aka non-recursively). These expressions are used for optimizer passes and rewrites.

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

Write a single line, human readable string to f for use in explain plan.

fn with_exprs_and_inputs( &self, exprs: Vec<Expr>, inputs: Vec<LogicalPlan>, ) -> Result<Self>

Create a new UserDefinedLogicalNode with the specified children and expressions. This function is used during optimization when the plan is being rewritten and a new instance of the UserDefinedLogicalNode must be created.

fn check_invariants( &self, _check: InvariantLevel, ) -> Result<(), DataFusionError>

Perform check of invariants for the extension node.

fn prevent_predicate_push_down_columns(&self) -> HashSet<String>

A list of output columns (e.g. the names of columns in self.schema()) for which predicates can not be pushed below this node without changing the output.

fn necessary_children_exprs( &self, _output_columns: &[usize], ) -> Option<Vec<Vec<usize>>>

Returns the necessary input columns for this node required to compute the columns in the output schema

fn supports_limit_pushdown(&self) -> bool

Returns true if a limit can be safely pushed down through this UserDefinedLogicalNode node.

impl Eq for LookupJoinNode