Struct JoinBuilder

pub struct JoinBuilder { /* private fields */ }

Implementations

impl JoinBuilder

pub fn new(lf: LazyFrame) -> Self

Create the JoinBuilder with the provided LazyFrame as the left table.

pub fn with(self, other: LazyFrame) -> Self

The right table in the join.

pub fn how(self, how: JoinType) -> Self

Select the join type.

pub fn validate(self, validation: JoinValidation) -> Self

pub fn on<E: AsRef<[Expr]>>(self, on: E) -> Self

The expressions you want to join both tables on.

The passed expressions must be valid in both LazyFrames in the join.

pub fn left_on<E: AsRef<[Expr]>>(self, on: E) -> Self

The expressions you want to join the left table on.

The passed expressions must be valid in the left table.

pub fn right_on<E: AsRef<[Expr]>>(self, on: E) -> Self

The expressions you want to join the right table on.

The passed expressions must be valid in the right table.

pub fn allow_parallel(self, allow: bool) -> Self

Allow parallel table evaluation.

pub fn force_parallel(self, force: bool) -> Self

Force parallel table evaluation.

pub fn join_nulls(self, join_nulls: bool) -> Self

Join on null values. By default null values will never produce matches.

pub fn suffix<S>(self, suffix: S) -> Self

where S: Into<PlSmallStr>,

Suffix to add duplicate column names in join. Defaults to "_right" if this method is never called.

pub fn coalesce(self, coalesce: JoinCoalesce) -> Self

Whether to coalesce join columns.

pub fn maintain_order(self, maintain_order: MaintainOrderJoin) -> Self

Whether to preserve the row order.

pub fn finish(self) -> LazyFrame

Finish builder

pub fn join_where(self, predicates: Vec<Expr>) -> LazyFrame