Struct datafusion::execution::context::SessionConfig

pub struct SessionConfig {
    pub target_partitions: usize,
    pub repartition_joins: bool,
    pub repartition_aggregations: bool,
    pub repartition_windows: bool,
    pub parquet_pruning: bool,
    pub config_options: ConfigOptions,
    /* private fields */
}

Configuration options for session context

Fields

target_partitions: usize

Number of partitions for query execution. Increasing partitions can increase concurrency.

repartition_joins: bool

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

repartition_aggregations: bool

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

repartition_windows: bool

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

parquet_pruning: bool

Should DataFusion parquet reader using the predicate to prune data

config_options: ConfigOptions

Configuration options

Implementations

impl SessionConfig

pub fn new() -> Self

Create an execution config with default setting

pub fn from_env() -> Self

Create an execution config with config options read from the environment

pub fn set(self, key: &str, value: ScalarValue) -> Self

Set a configuration option

pub fn set_bool(self, key: &str, value: bool) -> Self

Set a boolean configuration option

pub fn set_u64(self, key: &str, value: u64) -> Self

Set a generic u64 configuration option

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

Customize batch size

pub fn with_target_partitions(self, n: usize) -> Self

Customize target_partitions

pub fn with_default_catalog_and_schema(
    self,
    catalog: impl Into<String>,
    schema: impl Into<String>
) -> Self

Selects a name for the default catalog and schema

pub fn create_default_catalog_and_schema(self, create: bool) -> Self

Controls whether the default catalog and schema will be automatically created

pub fn with_information_schema(self, enabled: bool) -> Self

Enables or disables the inclusion of information_schema virtual tables

pub fn with_repartition_joins(self, enabled: bool) -> Self

Enables or disables the use of repartitioning for joins to improve parallelism

pub fn with_repartition_aggregations(self, enabled: bool) -> Self

Enables or disables the use of repartitioning for aggregations to improve parallelism

pub fn with_repartition_windows(self, enabled: bool) -> Self

Enables or disables the use of repartitioning for window functions to improve parallelism

pub fn with_parquet_pruning(self, enabled: bool) -> Self

Enables or disables the use of pruning predicate for parquet readers to skip row groups

pub fn batch_size(&self) -> usize

Get the currently configured batch size

pub fn config_options(&self) -> &ConfigOptions

Get the current configuration options

pub fn to_props(&self) -> HashMap<String, String>

Convert configuration options to name-value pairs with values converted to strings. Note that this method will eventually be deprecated and replaced by [config_options].

Trait Implementations

impl Clone for SessionConfig

fn clone(&self) -> SessionConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for SessionConfig

fn default() -> Self

Returns the “default value” for a type.