Struct HashJoinRel 

pub struct HashJoinRel {
    pub common: Option<RelCommon>,
    pub left: Option<Box<Rel>>,
    pub right: Option<Box<Rel>>,
    pub keys: Vec<ComparisonJoinKey>,
    pub post_join_filter: Option<Box<Expression>>,
    pub type: i32,
    pub build_input: i32,
    pub residual_expression: Option<Box<Expression>>,
    pub advanced_extension: Option<AdvancedExtension>,
}

The hash join operator will build a hash table out of one input (default right) based on a set of join keys. It will then probe that hash table for the other input (default left), finding matches.

Two rows are a match if every key comparison returns true and, when specified, residual_expression also evaluates to true.

Fields

common: Option<RelCommon>

left: Option<Box<Rel>>

right: Option<Box<Rel>>

keys: Vec<ComparisonJoinKey>

One or more keys to join on. The relation is invalid if this is empty.

If a custom comparison function is used then it must be consistent with the hash function used for the keys.

In other words, the hash function must return the same hash code when the comparison returns true. For example, if the comparison function is “equals ignoring case” then the hash function must return the same hash code for strings that differ only by case. Note: the hash function is not specified here. It is the responsibility of the consumer to find an appropriate hash function for a given comparsion function or to reject the plan if it cannot do so.

post_join_filter: Option<Box<Expression>>

An optional boolean filter applied to each output record after join-type-specific output formation is complete. Semantically equivalent to placing a FilterRel directly above this join.

type: i32

build_input: i32

Specifies which side of input to build the hash table for this hash join. Defaults to BUILD_INPUT_RIGHT.

residual_expression: Option<Box<Expression>>

An optional boolean expression evaluated on each candidate key-match to determine whether it is a true match. A candidate is only considered a match when all keys comparisons AND this expression evaluate to true. This expression interacts with join-type semantics: for example, in a left outer join, a left row that has key matches but no candidate satisfying this expression will be emitted with nulls for the right side.

advanced_extension: Option<AdvancedExtension>

Implementations

impl HashJoinRel

pub fn type(&self) -> JoinType

Returns the enum value of type, or the default if the field is set to an invalid enum value.

pub fn set_type(&mut self, value: JoinType)

Sets type to the provided enum value.

pub fn build_input(&self) -> BuildInput

Returns the enum value of build_input, or the default if the field is set to an invalid enum value.

pub fn set_build_input(&mut self, value: BuildInput)

Sets build_input to the provided enum value.

Trait Implementations

impl Clone for HashJoinRel

fn clone(&self) -> HashJoinRel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HashJoinRel

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

Formats the value using the given formatter.

impl Default for HashJoinRel

fn default() -> Self

Returns the “default value” for a type.

impl Message for HashJoinRel

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Name for HashJoinRel

const NAME: &'static str = "HashJoinRel"

Simple name for this Message. This name is the same as it appears in the source .proto file, e.g. FooBar.

const PACKAGE: &'static str = "substrait"

Package name this message type is contained in. They are domain-like and delimited by ., e.g. google.protobuf.

fn full_name() -> String

Fully-qualified unique name for this Message. It’s prefixed with the package name and names of any parent messages, e.g. google.rpc.BadRequest.FieldViolation. By default, this is the package name followed by the message name. Fully-qualified names must be unique within a domain of Type URLs.

fn type_url() -> String

Type URL for this Message, which by default is the full name with a leading slash, but may also include a leading domain name, e.g. type.googleapis.com/google.profile.Person. This can be used when serializing into the google.protobuf.Any type.

impl PartialEq for HashJoinRel

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HashJoinRel