Struct datafusion::execution::context::SessionState

pub struct SessionState { /* private fields */ }

Execution context for registering data sources and executing queries

Implementations

impl SessionState

pub fn with_config_rt(config: SessionConfig, runtime: Arc<RuntimeEnv>) -> Self

Returns new SessionState using the provided configuration and runtime

pub fn with_query_planner(
    self,
    query_planner: Arc<dyn QueryPlanner + Send + Sync>
) -> Self

Replace the default query planner

pub fn with_optimizer_rules(
    self,
    rules: Vec<Arc<dyn OptimizerRule + Send + Sync>>
) -> Self

Replace the optimizer rules

pub fn with_physical_optimizer_rules(
    self,
    physical_optimizers: Vec<Arc<dyn PhysicalOptimizerRule + Send + Sync>>
) -> Self

Replace the physical optimizer rules

pub fn add_optimizer_rule(
    self,
    optimizer_rule: Arc<dyn OptimizerRule + Send + Sync>
) -> Self

Adds a new OptimizerRule

pub fn add_physical_optimizer_rule(
    self,
    optimizer_rule: Arc<dyn PhysicalOptimizerRule + Send + Sync>
) -> Self

Adds a new PhysicalOptimizerRule

pub async fn create_logical_plan(&self, sql: &str) -> Result<LogicalPlan>

Creates a LogicalPlan from the provided SQL string

See SessionContext::sql for a higher-level interface that also handles DDL

pub fn optimize(&self, plan: &LogicalPlan) -> Result<LogicalPlan>

Optimizes the logical plan by applying optimizer rules.

pub async fn create_physical_plan(
    &self,
    logical_plan: &LogicalPlan
) -> Result<Arc<dyn ExecutionPlan>>

Creates a physical plan from a logical plan.

Note: this first calls Self::optimize on the provided plan

pub fn session_id(&self) -> &str

Return the session ID

pub fn runtime_env(&self) -> &Arc<RuntimeEnv>

Return the runtime env

pub fn execution_props(&self) -> &ExecutionProps

Return the execution properties

pub fn config(&self) -> &SessionConfig

Return the SessionConfig

pub fn physical_optimizers(
    &self
) -> &[Arc<dyn PhysicalOptimizerRule + Send + Sync>]

Return the physical optimizers

pub fn config_options(&self) -> &ConfigOptions

return the configuration options

pub fn task_ctx(&self) -> Arc<TaskContext>

Get a new TaskContext to run in this session

pub fn catalog_list(&self) -> Arc<dyn CatalogList>

Return catalog list

Trait Implementations

impl Clone for SessionState

fn clone(&self) -> SessionState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SessionState

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

Formats the value using the given formatter.

impl From<&SessionState> for TaskContext

Create a new task context instance from SessionState

fn from(state: &SessionState) -> Self

Converts to this type from the input type.

impl FunctionRegistry for SessionState

fn udfs(&self) -> HashSet<String>

Set of all available udfs.

fn udf(&self, name: &str) -> Result<Arc<ScalarUDF>>

Returns a reference to the udf named name.

fn udaf(&self, name: &str) -> Result<Arc<AggregateUDF>>

Returns a reference to the udaf named name.

impl OptimizerConfig for SessionState

fn query_execution_start_time(&self) -> DateTime<Utc>

Return the time at which the query execution started. This time is used as the value for now()

fn options(&self) -> &ConfigOptions