Struct datafusion::execution::runtime_env::RuntimeEnv

pub struct RuntimeEnv {
    pub memory_manager: Arc<MemoryManager>,
    pub disk_manager: Arc<DiskManager>,
    pub object_store_registry: Arc<ObjectStoreRegistry>,
    pub table_factories: HashMap<String, Arc<dyn TableProviderFactory>>,
}

Execution runtime environment.

Fields

memory_manager: Arc<MemoryManager>

Runtime memory management

disk_manager: Arc<DiskManager>

Manage temporary files during query execution

object_store_registry: Arc<ObjectStoreRegistry>

Object Store Registry

table_factories: HashMap<String, Arc<dyn TableProviderFactory>>

TableProviderFactories

Implementations

impl RuntimeEnv

pub fn new(config: RuntimeConfig) -> Result<Self>

Create env based on configuration

pub fn register_requester(&self, id: &MemoryConsumerId)

Register the consumer to get it tracked

pub fn drop_consumer(&self, id: &MemoryConsumerId, mem_used: usize)

Drop the consumer from get tracked, reclaim memory

pub fn grow_tracker_usage(&self, delta: usize)

Grow tracker memory of delta

pub fn shrink_tracker_usage(&self, delta: usize)

Shrink tracker memory of delta

pub fn register_object_store(
    &self,
    scheme: impl AsRef<str>,
    host: impl AsRef<str>,
    object_store: Arc<dyn ObjectStore>
) -> Option<Arc<dyn ObjectStore>>

Registers a custom ObjectStore to be used when accessing a specific scheme and host. This allows DataFusion to create external tables from urls that do not have built in support such as hdfs://....

Returns the ObjectStore previously registered for this scheme, if any.

See ObjectStoreRegistry for more details

pub fn register_table_factories(
    &mut self,
    table_factories: HashMap<String, Arc<dyn TableProviderFactory>>
)

Registers TableFactories

pub fn object_store(&self, url: impl AsRef<Url>) -> Result<Arc<dyn ObjectStore>>

Retrieves a ObjectStore instance for a url by consulting the registery. See ObjectStoreRegistry::get_by_url for more details.

Trait Implementations

impl Clone for RuntimeEnv

fn clone(&self) -> RuntimeEnv

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RuntimeEnv

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

Formats the value using the given formatter.

impl Default for RuntimeEnv

fn default() -> Self

Returns the “default value” for a type.