Struct datafusion_common::config::OptimizerOptions

#[non_exhaustive]
pub struct OptimizerOptions {
    pub enable_round_robin_repartition: bool,
    pub filter_null_join_keys: bool,
    pub repartition_aggregations: bool,
    pub repartition_joins: bool,
    pub repartition_windows: bool,
    pub skip_failed_rules: bool,
    pub max_passes: usize,
    pub top_down_join_key_reordering: bool,
    pub prefer_hash_join: bool,
    pub hash_join_single_partition_threshold: usize,
}

Options related to query optimization

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

enable_round_robin_repartition: bool

When set to true, the physical plan optimizer will try to add round robin repartition to increase parallelism to leverage more CPU cores

filter_null_join_keys: bool

When set to true, the optimizer will insert filters before a join between a nullable and non-nullable column to filter out nulls on the nullable side. This filter can add additional overhead when the file format does not fully support predicate push down.

repartition_aggregations: bool

Should DataFusion repartition data using the aggregate keys to execute aggregates in parallel using the provided target_partitions level“

repartition_joins: bool

Should DataFusion repartition data using the join keys to execute joins in parallel using the provided target_partitions level“

repartition_windows: bool

Should DataFusion repartition data using the partitions keys to execute window functions in parallel using the provided target_partitions level“

skip_failed_rules: bool

When set to true, the logical plan optimizer will produce warning messages if any optimization rules produce errors and then proceed to the next rule. When set to false, any rules that produce errors will cause the query to fail

max_passes: usize

Number of times that the optimizer will attempt to optimize the plan

top_down_join_key_reordering: bool

When set to true, the physical plan optimizer will run a top down process to reorder the join keys

prefer_hash_join: bool

When set to true, the physical plan optimizer will prefer HashJoin over SortMergeJoin. HashJoin can work more efficiently than SortMergeJoin but consumes more memory

hash_join_single_partition_threshold: usize

The maximum estimated size in bytes for one input side of a HashJoin will be collected into a single partition

Trait Implementations

impl Clone for OptimizerOptions

fn clone(&self) -> OptimizerOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OptimizerOptions

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

Formats the value using the given formatter.

impl Default for OptimizerOptions

fn default() -> Self

Returns the “default value” for a type.