Struct datafusion::config::ConfigOptions

pub struct ConfigOptions { /* private fields */ }

Configuration options struct. This can contain values for built-in and custom options

Implementations

impl ConfigOptions

pub fn new() -> Self

Create new ConfigOptions struct

pub fn from_env() -> Self

Create new ConfigOptions struct, taking values from environment variables where possible. For example, setting DATAFUSION_EXECUTION_BATCH_SIZE to control datafusion.execution.batch_size.

pub fn set(&mut self, key: &str, value: ScalarValue)

set a configuration option

pub fn set_bool(&mut self, key: &str, value: bool)

set a boolean configuration option

pub fn set_u64(&mut self, key: &str, value: u64)

set a u64 configuration option

pub fn get(&self, key: &str) -> Option<ScalarValue>

get a configuration option

pub fn get_bool(&self, key: &str) -> Option<bool>

get a boolean configuration option

pub fn get_u64(&self, key: &str) -> Option<u64>

get a u64 configuration option

pub fn get_string(&self, key: &str) -> Option<String>

get a string configuration option

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

Access the underlying hashmap

pub fn exists(&self, key: &str) -> bool

Tests if the key exists in the configuration

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 Debug for ConfigOptions

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

Formats the value using the given formatter.

impl Default for ConfigOptions

fn default() -> Self

Returns the “default value” for a type.