Struct query::query_engine::state::QueryEngineState

pub struct QueryEngineState {
    df_context: SessionContext,
    catalog_manager: CatalogManagerRef,
    function_state: Arc<FunctionState>,
    udf_functions: Arc<RwLock<HashMap<String, FunctionRef>>>,
    aggregate_functions: Arc<RwLock<HashMap<String, AggregateFunctionMetaRef>>>,
    extension_rules: Vec<Arc<dyn ExtensionAnalyzerRule + Send + Sync>>,
    plugins: Plugins,
}

Query engine global state

Fields

df_context: SessionContext

catalog_manager: CatalogManagerRef

function_state: Arc<FunctionState>

udf_functions: Arc<RwLock<HashMap<String, FunctionRef>>>

aggregate_functions: Arc<RwLock<HashMap<String, AggregateFunctionMetaRef>>>

extension_rules: Vec<Arc<dyn ExtensionAnalyzerRule + Send + Sync>>

plugins: Plugins

Implementations

impl QueryEngineState

pub fn new( catalog_list: CatalogManagerRef, region_query_handler: Option<RegionQueryHandlerRef>, table_mutation_handler: Option<TableMutationHandlerRef>, procedure_service_handler: Option<ProcedureServiceHandlerRef>, flow_service_handler: Option<FlowServiceHandlerRef>, with_dist_planner: bool, plugins: Plugins, ) -> Self

fn remove_analyzer_rule( rules: &mut Vec<Arc<dyn AnalyzerRule + Send + Sync>>, name: &str, )

pub fn optimize_by_extension_rules( &self, plan: DfLogicalPlan, context: &QueryEngineContext, ) -> DfResult<DfLogicalPlan>

Optimize the logical plan by the extension anayzer rules.

pub fn optimize_logical_plan( &self, plan: DfLogicalPlan, ) -> DfResult<DfLogicalPlan>

Run the full logical plan optimize phase for the given plan.

pub fn register_function(&self, func: FunctionRef)

Register an udf function. Will override if the function with same name is already registered.

pub fn udf_function(&self, function_name: &str) -> Option<FunctionRef>

Retrieve the udf function by name

pub fn aggregate_function( &self, function_name: &str, ) -> Option<AggregateFunctionMetaRef>

Retrieve the aggregate function by name

pub fn register_udf(&self, udf: ScalarUdf)

Register a [ScalarUdf].

pub fn register_aggregate_function(&self, func: AggregateFunctionMetaRef)

Register an aggregate function.

Panics

Will panic if the function with same name is already registered.

Panicking consideration: currently the aggregated functions are all statically registered, user cannot define their own aggregate functions on the fly. So we can panic here. If that invariant is broken in the future, we should return an error instead of panicking.

pub fn catalog_manager(&self) -> &CatalogManagerRef

pub fn function_state(&self) -> Arc<FunctionState>

pub fn table_mutation_handler(&self) -> Option<&TableMutationHandlerRef>

Returns the [TableMutationHandlerRef] in state.

pub fn procedure_service_handler(&self) -> Option<&ProcedureServiceHandlerRef>

Returns the [ProcedureServiceHandlerRef] in state.

pub(crate) fn disallow_cross_catalog_query(&self) -> bool

pub(crate) fn session_state(&self) -> SessionState

pub fn read_table(&self, table: TableRef) -> DfResult<DataFrame>

Create a DataFrame for a table

Trait Implementations

impl Clone for QueryEngineState

fn clone(&self) -> QueryEngineState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QueryEngineState

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

Formats the value using the given formatter.