Struct datafusion::execution::runtime_env::RuntimeEnv
source · pub struct RuntimeEnv {
pub memory_pool: Arc<dyn MemoryPool, Global>,
pub disk_manager: Arc<DiskManager, Global>,
pub object_store_registry: Arc<dyn ObjectStoreRegistry, Global>,
}
Expand description
Execution runtime environment that manages system resources such as memory, disk and storage.
A RuntimeEnv
is created from a RuntimeConfig
and has the
following resource management functionality:
MemoryPool
: Manage memoryDiskManager
: Manage temporary files on local diskObjectStoreRegistry
: Manage mapping URLs to object store instances
Fields§
§memory_pool: Arc<dyn MemoryPool, Global>
Runtime memory management
disk_manager: Arc<DiskManager, Global>
Manage temporary files during query execution
object_store_registry: Arc<dyn ObjectStoreRegistry, Global>
Object Store Registry
Implementations§
source§impl RuntimeEnv
impl RuntimeEnv
sourcepub fn new(config: RuntimeConfig) -> Result<RuntimeEnv, DataFusionError>
pub fn new(config: RuntimeConfig) -> Result<RuntimeEnv, DataFusionError>
Create env based on configuration
sourcepub fn register_object_store(
&self,
url: &Url,
object_store: Arc<dyn ObjectStore, Global>
) -> Option<Arc<dyn ObjectStore, Global>>
pub fn register_object_store( &self, url: &Url, object_store: Arc<dyn ObjectStore, Global> ) -> Option<Arc<dyn ObjectStore, Global>>
Registers a custom ObjectStore
to be used with a specific url.
This allows DataFusion to create external tables from urls that do not have
built in support such as hdfs://namenode:port/...
.
Returns the ObjectStore
previously registered for this
scheme, if any.
See ObjectStoreRegistry
for more details
sourcepub fn object_store(
&self,
url: impl AsRef<Url>
) -> Result<Arc<dyn ObjectStore, Global>, DataFusionError>
pub fn object_store( &self, url: impl AsRef<Url> ) -> Result<Arc<dyn ObjectStore, Global>, DataFusionError>
Retrieves a ObjectStore
instance for a url by consulting the
registry. See ObjectStoreRegistry::get_store
for more
details.
Trait Implementations§
source§impl Clone for RuntimeEnv
impl Clone for RuntimeEnv
source§fn clone(&self) -> RuntimeEnv
fn clone(&self) -> RuntimeEnv
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for RuntimeEnv
impl Debug for RuntimeEnv
source§impl Default for RuntimeEnv
impl Default for RuntimeEnv
source§fn default() -> RuntimeEnv
fn default() -> RuntimeEnv
Returns the “default value” for a type. Read more
Auto Trait Implementations§
impl !RefUnwindSafe for RuntimeEnv
impl Send for RuntimeEnv
impl Sync for RuntimeEnv
impl Unpin for RuntimeEnv
impl !UnwindSafe for RuntimeEnv
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more