Struct Join

pub struct Join {
    pub left: Option<Box<Relation>>,
    pub right: Option<Box<Relation>>,
    pub join_condition: Option<Expression>,
    pub join_type: i32,
    pub using_columns: Vec<String>,
    pub join_data_type: Option<JoinDataType>,
}

Relation of type [Join].

left and right must be present.

Fields

left: Option<Box<Relation>>

(Required) Left input relation for a Join.

right: Option<Box<Relation>>

(Required) Right input relation for a Join.

join_condition: Option<Expression>

(Optional) The join condition. Could be unset when using_columns is utilized.

This field does not co-exist with using_columns.

join_type: i32

(Required) The join type.

using_columns: Vec<String>

Optional. using_columns provides a list of columns that should present on both sides of the join inputs that this Join will join on. For example A JOIN B USING col_name is equivalent to A JOIN B on A.col_name = B.col_name.

This field does not co-exist with join_condition.

join_data_type: Option<JoinDataType>

(Optional) Only used by joinWith. Set the left and right join data types.

Implementations

impl Join

pub fn join_type(&self) -> JoinType

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

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

Sets join_type to the provided enum value.

Trait Implementations

impl Clone for Join

fn clone(&self) -> Join

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Join

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

Formats the value using the given formatter.

impl Default for Join

fn default() -> Self

Returns the “default value” for a type.

impl Message for Join

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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

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

where B: Buf, Self: Default,

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

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

where B: Buf, Self: Sized,

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

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

where B: Buf, Self: Sized,

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

impl PartialEq for Join

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