Struct EqJoinPredicate

pub struct EqJoinPredicate {
    other_cond: Condition,
    eq_keys: Vec<(InputRef, InputRef, bool)>,
    left_cols_num: usize,
    right_cols_num: usize,
}

The join predicate used in optimizer

Fields

other_cond: Condition

Other conditions, linked with AND conjunction.

eq_keys: Vec<(InputRef, InputRef, bool)>

Vec of (left_col_index, right_col_index, null_safe), representing a conjunction of left_col_index = right_col_index

Note: right_col_index starts from left_cols_num

left_cols_num: usize

right_cols_num: usize

Implementations

impl EqJoinPredicate

pub fn new( other_cond: Condition, eq_keys: Vec<(InputRef, InputRef, bool)>, left_cols_num: usize, right_cols_num: usize, ) -> Self

The new method for JoinPredicate without any analysis, check or rewrite.

pub fn create( left_cols_num: usize, right_cols_num: usize, on_clause: Condition, ) -> Self

create will analyze the on clause condition and construct a JoinPredicate. e.g.

  select a.v1, a.v2, b.v1, b.v2 from a,b on a.v1 = a.v2 and a.v1 = b.v1 and a.v2 > b.v2

will call the create function with left_colsnum = 2 and on_clause is (supposed input_ref count start from 0)

input_ref(0) = input_ref(1) and input_ref(0) = input_ref(2) and input_ref(1) > input_ref(3)

And the create functions should return JoinPredicate

  other_conds = Vec[input_ref(0) = input_ref(1), input_ref(1) > input_ref(3)],
  keys= Vec[(0,2)]

pub fn eq_cond(&self) -> Condition

Get join predicate’s eq conds.

pub fn non_eq_cond(&self) -> Condition

pub fn all_cond(&self) -> Condition

pub fn has_eq(&self) -> bool

pub fn has_non_eq(&self) -> bool

pub fn other_cond(&self) -> &Condition

Get a reference to the join predicate’s other cond.

pub fn other_cond_mut(&mut self) -> &mut Condition

Get a mutable reference to the join predicate’s other cond.

pub fn eq_keys(&self) -> &[(InputRef, InputRef, bool)]

Get a reference to the join predicate’s eq keys.

Note: right_col_index starts from left_cols_num

pub fn eq_indexes(&self) -> Vec<(usize, usize)>

Vec of (left_col_index, right_col_index).

Note: right_col_index starts from 0

pub(crate) fn inequality_pairs( &self, ) -> (usize, Vec<(usize, InequalityInputPair)>)

pub fn eq_indexes_typed(&self) -> Vec<(InputRef, InputRef)>

Note: right_col_index starts from 0

pub fn eq_keys_are_type_aligned(&self) -> bool

pub fn left_eq_indexes(&self) -> Vec<usize>

pub fn right_eq_indexes(&self) -> Vec<usize>

Note: right_col_index starts from 0

pub fn null_safes(&self) -> Vec<bool>

pub fn r2l_eq_columns_mapping( &self, left_cols_num: usize, right_cols_num: usize, ) -> ColIndexMapping

return the eq columns index mapping from right inputs to left inputs

pub fn l2r_eq_columns_mapping( &self, left_cols_num: usize, right_cols_num: usize, ) -> ColIndexMapping

return the eq columns index mapping from left inputs to right inputs

pub fn reorder(self, reorder_idx: &[usize]) -> Self

Reorder the eq_keys according to the reorder_idx.

pub fn retain_prefix_eq_key(self, prefix_len: usize) -> Self

Retain the prefix of eq_keys based on the prefix_len. The other part is moved to the other condition.

pub fn rewrite_exprs(&self, rewriter: &mut (impl ExprRewriter + ?Sized)) -> Self

pub fn visit_exprs(&self, v: &mut (impl ExprVisitor + ?Sized))

Trait Implementations

impl Clone for EqJoinPredicate

fn clone(&self) -> EqJoinPredicate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EqJoinPredicate

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

Formats the value using the given formatter.

impl Display for EqJoinPredicate

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

Formats the value using the given formatter.

impl Hash for EqJoinPredicate

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 EqJoinPredicate

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

impl StructuralPartialEq for EqJoinPredicate