Struct JoinOptions 

pub struct JoinOptions {
    pub join_type: JoinType,
    pub algorithm: JoinAlgorithm,
    pub batch_size: usize,
    pub memory_limit_bytes: Option<usize>,
    pub concurrency: usize,
}

Options controlling join execution.

Fields

join_type: JoinType

Type of join to perform.

algorithm: JoinAlgorithm

Algorithm to use. Planner may override this based on table sizes.

batch_size: usize

Target number of probe rows per output RecordBatch. Larger batches reduce per-batch overhead (fewer Arrow gathers) at the cost of increased peak memory; smaller batches improve latency.

memory_limit_bytes: Option<usize>

Memory limit in bytes for hash table (hash join only). When exceeded, algorithm will partition and spill to disk.

concurrency: usize

Concurrency hint: number of threads for parallel partitions.

Implementations

impl JoinOptions

pub fn inner() -> Self

Create options for an inner join with default settings.

pub fn left() -> Self

Create options for a left outer join with default settings.

pub fn right() -> Self

Create options for a right outer join with default settings.

pub fn full() -> Self

Create options for a full outer join with default settings.

pub fn semi() -> Self

Create options for a semi join with default settings.

pub fn anti() -> Self

Create options for an anti join with default settings.

pub fn with_algorithm(self, algorithm: JoinAlgorithm) -> Self

Set the join algorithm.

pub fn with_batch_size(self, batch_size: usize) -> Self

Set the output batch size.

pub fn with_memory_limit(self, limit_bytes: usize) -> Self

Set the memory limit for hash joins.

pub fn with_concurrency(self, concurrency: usize) -> Self

Set the concurrency level.

Trait Implementations

impl Clone for JoinOptions

fn clone(&self) -> JoinOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JoinOptions

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

Formats the value using the given formatter.

impl Default for JoinOptions

fn default() -> Self

Returns the “default value” for a type.