Enum datafusion::execution::memory_manager::MemoryManagerConfig

pub enum MemoryManagerConfig {
    Existing(Arc<MemoryManager>),
    New {
        max_memory: usize,
        memory_fraction: f64,
    },
}

Configuration information for memory management

Variants

Existing(Arc<MemoryManager>)

Use the existing MemoryManager

New

Fields

max_memory: usize

Max execution memory allowed for DataFusion. Defaults to usize::MAX, which will not attempt to limit the memory used during plan execution.

memory_fraction: f64

The fraction of max_memory that the memory manager will use for execution.

The purpose of this config is to set aside memory for untracked data structures, and imprecise size estimation during memory acquisition. Defaults to 0.7

Create a new MemoryManager that will use up to some fraction of total system memory.

Implementations

impl MemoryManagerConfig

pub fn new() -> Self

Create a new memory MemoryManager with no limit on the memory used

pub fn new_existing(existing: Arc<MemoryManager>) -> Self

Create a configuration based on an existing MemoryManager

pub fn try_new_limit(max_memory: usize, memory_fraction: f64) -> Result<Self>

Create a new MemoryManager with a max_memory and fraction

Trait Implementations

impl Clone for MemoryManagerConfig

fn clone(&self) -> MemoryManagerConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MemoryManagerConfig

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

Formats the value using the given formatter.

impl Default for MemoryManagerConfig

fn default() -> Self

Returns the “default value” for a type.