Struct datafusion_expr::execution_props::ExecutionProps

pub struct ExecutionProps {
    pub query_execution_start_time: DateTime<Utc>,
    pub alias_generator: Arc<AliasGenerator>,
    pub var_providers: Option<HashMap<VarType, Arc<dyn VarProvider + Send + Sync>>>,
}

Holds per-query execution properties and data (such as statement starting timestamps).

An ExecutionProps is created each time a LogicalPlan is prepared for execution (optimized). If the same plan is optimized multiple times, a new ExecutionProps is created each time.

It is important that this structure be cheap to create as it is done so during predicate pruning and expression simplification

Fields

query_execution_start_time: DateTime<Utc>

alias_generator: Arc<AliasGenerator>

Alias generator used by subquery optimizer rules

var_providers: Option<HashMap<VarType, Arc<dyn VarProvider + Send + Sync>>>

Providers for scalar variables

Implementations

impl ExecutionProps

pub fn new() -> Self

Creates a new execution props

pub fn with_query_execution_start_time( self, query_execution_start_time: DateTime<Utc>, ) -> Self

Set the query execution start time to use

pub fn start_execution(&mut self) -> &Self

Marks the execution of query started timestamp. This also instantiates a new alias generator.

pub fn add_var_provider( &mut self, var_type: VarType, provider: Arc<dyn VarProvider + Send + Sync>, ) -> Option<Arc<dyn VarProvider + Send + Sync>>

Registers a variable provider, returning the existing provider, if any

pub fn get_var_provider( &self, var_type: VarType, ) -> Option<Arc<dyn VarProvider + Send + Sync>>

Returns the provider for the var_type, if any

Trait Implementations

impl Clone for ExecutionProps

fn clone(&self) -> ExecutionProps

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExecutionProps

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

Formats the value using the given formatter.

impl Default for ExecutionProps

fn default() -> Self

Returns the “default value” for a type.