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,
    pub format: FormatOptions,
}

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

format: FormatOptions

Formatting options when printing batches

Implementations

impl ConfigOptions

pub fn new() -> Self

Creates a new ConfigOptions with default values

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

Set extensions to provided value

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

Set a configuration option

pub fn from_env() -> Result<Self>

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

For example, to configure datafusion.execution.batch_size (ExecutionOptions::batch_size) you would set the DATAFUSION_EXECUTION_BATCH_SIZE environment variable.

The name of the environment variable is the option’s key, transformed to uppercase and with periods replaced with underscores.

Values are parsed according to the same rules used in casts from Utf8.

If the value in the environment variable cannot be cast to the type of the configuration option, the default value will be used instead and a warning emitted. Environment variables are read when this method is called, and are not re-read later.

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

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 duplicate 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<()>

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

impl Debug for ConfigOptions

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

Formats the value using the given formatter.

impl Default for ConfigOptions

fn default() -> ConfigOptions

Returns the “default value” for a type.