Skip to main content

uqa_execution/routines/invocation/
context.rs

1//
2// Unified Query Algebra
3//
4// Copyright (c) 2023-2026 Cognica, Inc.
5//
6
7//! Invocation inputs retain the caller's live state without exposing an engine.
8use crate::routines::RoutineContext;
9use uqa_sql::{
10    plpgsql::VariableConflict,
11    routines::{
12        compilation::RoutineParserCatalog, declaration::RoutineTypeCatalog,
13        resolution::RoutineOverloadContext, security::RoutineExecutionAuthority, RoutineResolution,
14    },
15    SQLError,
16};
17pub trait RoutineInvocationState {
18    fn finish(&mut self);
19}
20pub trait RoutineInvocationSession {
21    fn plpgsql_body(
22        &self,
23        function: &uqa_sql::routines::SQLUserFunction,
24        definition: &uqa_sql::ast::CreateFunction,
25        relation: Option<i64>,
26    ) -> Result<std::sync::Arc<uqa_sql::routines::CompiledFunctionBody>, SQLError>;
27    fn depth_limit(&self) -> usize;
28    fn state_guard(
29        &self,
30        configured: bool,
31        security_definer: bool,
32    ) -> Box<dyn RoutineInvocationState + '_>;
33    fn set_current_user(&self, user: uqa_core::catalog_role::RoleIdentity) -> Result<(), SQLError>;
34    fn set_configured_parameter(&self, name: &str, value: &str) -> Result<(), SQLError>;
35    /// The `plpgsql.variable_conflict` setting a `PL/pgSQL` body compiled now takes, with the language's library loaded as its call handler loads it.
36    fn plpgsql_variable_conflict(&self) -> VariableConflict;
37}
38pub struct RoutineInvocationContext<'a> {
39    pub runtime: RoutineContext<'a>,
40    pub session: &'a dyn RoutineInvocationSession,
41    pub lookup: &'a dyn RoutineResolution,
42    pub overloads: RoutineOverloadContext<'a>,
43    pub types: &'a dyn RoutineTypeCatalog,
44    pub authority: &'a dyn RoutineExecutionAuthority,
45}
46
47#[derive(Clone, Copy)]
48pub struct RoutineCallRetention<'a> {
49    pub descriptions: &'a uqa_sql::routines::invocation::descriptions::RoutineCallDescriptions,
50    pub scope: &'a dyn Fn() -> Option<
51        uqa_sql::routines::invocation::descriptions::RoutineDescriptionScope,
52    >,
53    pub control: uqa_core::memory::ProductionControl<'a>,
54}
55pub struct AnonymousBlockContext<'a> {
56    pub runtime: RoutineContext<'a>,
57    pub session: &'a dyn RoutineInvocationSession,
58    pub types: &'a dyn RoutineTypeCatalog,
59    pub parsers: &'a dyn RoutineParserCatalog,
60}