Struct ConfigOptions

#[non_exhaustive]
pub struct ConfigOptions {
    pub catalog: CatalogOptions,
    pub execution: ExecutionOptions,
    pub optimizer: OptimizerOptions,
    pub sql_parser: SqlParserOptions,
    pub explain: ExplainOptions,
    pub extensions: Extensions,
}

Configuration options struct, able to store both built-in configuration and custom options

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.

catalog: CatalogOptions

Catalog options

execution: ExecutionOptions

Execution options

optimizer: OptimizerOptions

Optimizer options

sql_parser: SqlParserOptions

SQL parser options

explain: ExplainOptions

Explain options

extensions: Extensions

Optional extensions registered using Extensions::insert

Implementations

impl ConfigOptions

pub fn new() -> ConfigOptions

Creates a new ConfigOptions with default values

pub fn with_extensions(self, extensions: Extensions) -> ConfigOptions

Set extensions to provided value

pub fn set(&mut self, key: &str, value: &str) -> Result<(), DataFusionError>

Set a configuration option

pub fn from_env() -> Result<ConfigOptions, DataFusionError>

Create new ConfigOptions struct, taking values from environment variables where possible.

For example, setting DATAFUSION_EXECUTION_BATCH_SIZE will control datafusion.execution.batch_size.

pub fn from_string_hash_map( settings: &HashMap<String, String>, ) -> Result<ConfigOptions, DataFusionError>

Create new ConfigOptions struct, taking values from a string hash map.

Only the built-in configurations will be extracted from the hash map and other key value pairs will be ignored.

pub fn entries(&self) -> Vec<ConfigEntry>

Returns the ConfigEntry stored within this ConfigOptions

pub fn generate_config_markdown() -> String

Generate documentation that can be included in the user guide

Trait Implementations

impl Clone for ConfigOptions

fn clone(&self) -> ConfigOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConfigField for ConfigOptions

fn set(&mut self, key: &str, value: &str) -> Result<(), DataFusionError>

fn visit<V>(&self, v: &mut V, _key_prefix: &str, _description: &'static str)

where V: Visit,

impl Debug for ConfigOptions

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

Formats the value using the given formatter.

impl Default for ConfigOptions

fn default() -> ConfigOptions

Returns the “default value” for a type.