JoinOptions class final

Typed ordinary join options.

A null coalesce preserves Polars' join-specific default. This differs from the legacy LazyFrame.join default, which deliberately remains false.

Constructors

JoinOptions({JoinMode mode = JoinMode.inner, String suffix = '_right', bool? coalesce, bool nullsEqual = false, JoinValidation validation = JoinValidation.manyToMany, JoinMaintainOrder maintainOrder = JoinMaintainOrder.none, bool allowParallel = true, bool forceParallel = false})
const

Properties

allowParallel → bool
final
coalesce → bool?
final
forceParallel → bool
final
hashCode → int
The hash code for this object.
no setterinherited
maintainOrder → JoinMaintainOrder
final
mode → JoinMode
final
nullsEqual → bool
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
suffix → String
final
validation → JoinValidation
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited