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

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

Fields (Non-exhaustive)§

This struct is marked as 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§

source§

impl ConfigOptions

source

pub fn new() -> Self

Creates a new ConfigOptions with default values

source

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

Set extensions to provided value

source

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

Set a configuration option

source

pub fn from_env() -> Result<Self>

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

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

source

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.

source

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

Returns the ConfigEntry stored within this ConfigOptions

source

pub fn generate_config_markdown() -> String

Generate documentation that can be included in the user guide

Trait Implementations§

source§

impl Clone for ConfigOptions

source§

fn clone(&self) -> ConfigOptions

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for ConfigOptions

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for ConfigOptions

source§

fn default() -> ConfigOptions

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.