Struct RuntimeEnvBuilder

pub struct RuntimeEnvBuilder {
    pub disk_manager: DiskManagerConfig,
    pub memory_pool: Option<Arc<dyn MemoryPool>>,
    pub cache_manager: CacheManagerConfig,
    pub object_store_registry: Arc<dyn ObjectStoreRegistry>,
}

Execution runtime configuration builder.

See example on RuntimeEnv

Fields

disk_manager: DiskManagerConfig

DiskManager to manage temporary disk file usage

memory_pool: Option<Arc<dyn MemoryPool>>

MemoryPool from which to allocate memory

Defaults to using an UnboundedMemoryPool if None

cache_manager: CacheManagerConfig

CacheManager to manage cache data

object_store_registry: Arc<dyn ObjectStoreRegistry>

ObjectStoreRegistry to get object store based on url

Implementations

impl RuntimeEnvBuilder

pub fn new() -> RuntimeEnvBuilder

New with default values

pub fn with_disk_manager( self, disk_manager: DiskManagerConfig, ) -> RuntimeEnvBuilder

Customize disk manager

pub fn with_memory_pool( self, memory_pool: Arc<dyn MemoryPool>, ) -> RuntimeEnvBuilder

Customize memory policy

pub fn with_cache_manager( self, cache_manager: CacheManagerConfig, ) -> RuntimeEnvBuilder

Customize cache policy

pub fn with_object_store_registry( self, object_store_registry: Arc<dyn ObjectStoreRegistry>, ) -> RuntimeEnvBuilder

Customize object store registry

pub fn with_memory_limit( self, max_memory: usize, memory_fraction: f64, ) -> RuntimeEnvBuilder

Specify the total memory to use while running the DataFusion plan to max_memory * memory_fraction in bytes.

This defaults to using GreedyMemoryPool

Note DataFusion does not yet respect this limit in all cases.

pub fn with_temp_file_path(self, path: impl Into<PathBuf>) -> RuntimeEnvBuilder

Use the specified path to create any needed temporary files

pub fn build(self) -> Result<RuntimeEnv, DataFusionError>

Build a RuntimeEnv

pub fn build_arc(self) -> Result<Arc<RuntimeEnv>, DataFusionError>

Convenience method to create a new Arc<RuntimeEnv>

Trait Implementations

impl Clone for RuntimeEnvBuilder

fn clone(&self) -> RuntimeEnvBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for RuntimeEnvBuilder

fn default() -> RuntimeEnvBuilder

Returns the “default value” for a type.