Struct ExecutionState

pub struct ExecutionState {
    pub schema_cache: RwLock<Option<SchemaRef>>,
    pub group_tuples: GroupsProxyCache,
    pub join_tuples: JoinTuplesCache,
    pub branch_idx: usize,
    pub flags: AtomicU8,
    pub ext_contexts: Arc<Vec<DataFrame>>,
    /* private fields */
}

State/ cache that is maintained during the Execution of the physical plan.

Fields

schema_cache: RwLock<Option<SchemaRef>>

group_tuples: GroupsProxyCache

Used by Window Expression to prevent redundant grouping

join_tuples: JoinTuplesCache

Used by Window Expression to prevent redundant joins

branch_idx: usize

flags: AtomicU8

ext_contexts: Arc<Vec<DataFrame>>

Implementations

impl ExecutionState

pub fn new() -> Self

pub fn time_nodes(&mut self)

Toggle this to measure execution times.

pub fn has_node_timer(&self) -> bool

pub fn finish_timer(self) -> PolarsResult<DataFrame>

pub fn should_stop(&self) -> PolarsResult<()>

pub fn cancel_token(&self) -> Arc<AtomicBool>

pub fn record<T, F: FnOnce() -> T>(&self, func: F, name: Cow<'static, str>) -> T

pub fn split(&self) -> Self

Partially clones and partially clears state This should be used when splitting a node, like a join or union

pub fn set_schema(&self, schema: SchemaRef)

pub fn clear_schema_cache(&self)

Clear the schema. Typically at the end of a projection.

pub fn get_schema(&self) -> Option<SchemaRef>

Get the schema.

pub fn get_df_cache( &self, key: usize, cache_hits: u32, ) -> Arc<(AtomicI64, OnceCell<DataFrame>)>

pub fn remove_df_cache(&self, key: usize)

pub fn clear_window_expr_cache(&self)

Clear the cache used by the Window expressions

pub fn cache_window(&self) -> bool

Indicates that window expression’s [GroupTuples] may be cached.

pub fn has_window(&self) -> bool

Indicates that window expression’s [GroupTuples] may be cached.

pub fn verbose(&self) -> bool

More verbose logging

pub fn remove_cache_window_flag(&mut self)

pub fn insert_cache_window_flag(&mut self)

pub fn insert_has_window_function_flag(&mut self)

Trait Implementations

impl Clone for ExecutionState

fn clone(&self) -> Self

clones, but clears no state.

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

Performs copy-assignment from source.

impl Default for ExecutionState

fn default() -> Self

Returns the “default value” for a type.