Struct Join

pub struct Join<F: Field> {
    pub join_type: JoinType,
    pub alias: Option<String>,
    pub dock_table_alias: String,
    pub dock_field: F,
    pub connector_field: F,
}

Represents a join statement for SQL.

All used fields must be safe to use in an SQL Query!

Will Serialize like this:

{join_type} join "{source_table}"
on "{dock_table}.{dock_field}" = "{alias||source_table}.{connector_field||dock_field}"
[as "{alias}"]

Fields

join_type: JoinType

Which kind of join to perform

alias: Option<String>

What name the joined table has after the join defaults to the table of the connector field.

dock_table_alias: String

The alias name of the table docked against

dock_field: F

The field that gets compared against.

connector_field: F

The field in the soutce tablethat has to equal dock_field This also determines which table gets joined in.

Implementations

impl<F: Field> Join<F>

pub fn to_sql(&self) -> String

Serializes the Join struct to SQL

Note: to_string() was intentionally not used here as relying on that might have uninteded footgun-like consquences in the future.

pub fn table_alias(&self) -> &str

Returns the name the table can be accessd under in an SQL statement.

This is either the alias if set or the source_table name.

Trait Implementations

impl<F: Clone + Field> Clone for Join<F>

fn clone(&self) -> Join<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug + Field> Debug for Join<F>

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

Formats the value using the given formatter.

impl<F: PartialEq + Field> PartialEq for Join<F>

fn eq(&self, other: &Join<F>) -> 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<F: Eq + Field> Eq for Join<F>

impl<F: Field> StructuralPartialEq for Join<F>