ConfigOptions

Struct ConfigOptions 

Source
#[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, }
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

§format: FormatOptions

Formatting options when printing batches

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, 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.

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 duplicate 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 ConfigField for ConfigOptions

Source§

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

Source§

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

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 T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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 T
where 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

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 T
where U: Into<T>,

Source§

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 T
where U: TryFrom<T>,

Source§

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> Ungil for T
where T: Send,