Struct datafusion::execution::TaskContext

pub struct TaskContext { /* private fields */ }

Task Execution Context

A TaskContext contains the state available during a single query’s execution. Please see SessionContext for a user level multi-query API.

Implementations

impl TaskContext

pub fn new( task_id: Option<String>, session_id: String, session_config: SessionConfig, scalar_functions: HashMap<String, Arc<ScalarUDF, Global>, RandomState>, aggregate_functions: HashMap<String, Arc<AggregateUDF, Global>, RandomState>, window_functions: HashMap<String, Arc<WindowUDF, Global>, RandomState>, runtime: Arc<RuntimeEnv, Global> ) -> TaskContext

Create a new TaskContext instance.

Most users will use SessionContext::task_ctx to create TaskContexts

pub fn try_new( task_id: String, session_id: String, task_props: HashMap<String, String, RandomState>, scalar_functions: HashMap<String, Arc<ScalarUDF, Global>, RandomState>, aggregate_functions: HashMap<String, Arc<AggregateUDF, Global>, RandomState>, runtime: Arc<RuntimeEnv, Global>, extensions: Extensions ) -> Result<TaskContext, DataFusionError>

👎Deprecated since 21.0.0: Construct SessionConfig and call TaskContext::new() instead

Create a new task context instance, by first copying all name/value pairs from task_props into a SessionConfig.

pub fn session_config(&self) -> &SessionConfig

Return the SessionConfig associated with this TaskContext

pub fn session_id(&self) -> String

Return the session_id of this TaskContext

pub fn task_id(&self) -> Option<String>

Return the task_id of this TaskContext

pub fn memory_pool(&self) -> &Arc<dyn MemoryPool, Global>

Return the MemoryPool associated with this TaskContext

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

Return the RuntimeEnv associated with this TaskContext

pub fn with_session_config(self, session_config: SessionConfig) -> TaskContext

Update the ConfigOptions

pub fn with_runtime(self, runtime: Arc<RuntimeEnv, Global>) -> TaskContext

Update the RuntimeEnv

Trait Implementations

impl Debug for TaskContext

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

Formats the value using the given formatter.

impl Default for TaskContext

fn default() -> TaskContext

Returns the “default value” for a type.

impl From<&SessionContext> for TaskContext

Create a new task context instance from SessionContext

fn from(session: &SessionContext) -> Self

Converts to this type from the input type.

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 TaskContext

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

Set of all available udfs.

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

Returns a reference to the udf named name.

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

Returns a reference to the udaf named name.

fn udwf(&self, name: &str) -> Result<Arc<WindowUDF, Global>, DataFusionError>

Returns a reference to the udwf named name.