Skip to main content

uqa_execution/statement/portal/
context.rs

1//
2// Unified Query Algebra
3//
4// Copyright (c) 2023-2026 Cognica, Inc.
5//
6
7//! Borrow live portal registries and defer native query and RETURNING inputs.
8
9use crate::{
10    catalog::services::CatalogSession,
11    mutation::{command_scope::CommandScopeSource, returning::ReturningExecutionContext},
12    statement::context::{
13        queries::StatementQueryContexts, session::StatementPortals, ExplainRenderer,
14    },
15};
16use uqa_sql::{
17    routines::{
18        declaration::RoutineTypeCatalog, resolution::RoutineOverloadCatalog, RoutineResolution,
19    },
20    semantics::returning::ReturningAnalysisContext,
21    SQLParam,
22};
23
24pub trait PortalReturningInputs<S: Clone + 'static> {
25    fn returning_execution_context(&self) -> ReturningExecutionContext<'_, S>;
26    fn returning_analysis_context(&self) -> ReturningAnalysisContext<'_>;
27}
28
29#[derive(Clone)]
30pub struct PortalExecutionContext<'a, S: Clone + 'static> {
31    pub state: &'a dyn StatementPortals,
32    pub queries: &'a dyn StatementQueryContexts<S>,
33    pub returning: &'a dyn PortalReturningInputs<S>,
34    pub command_scopes: &'a dyn CommandScopeSource<S>,
35    pub routines: &'a dyn RoutineResolution,
36    pub overloads: &'a dyn RoutineOverloadCatalog,
37    pub types: &'a dyn RoutineTypeCatalog,
38    pub session: &'a dyn CatalogSession,
39    pub explain: ExplainRenderer,
40    pub source_sql: Option<&'a str>,
41    pub created_at_micros: i64,
42}
43
44impl<'a, S: Clone + 'static> PortalExecutionContext<'a, S> {
45    pub fn with_source_sql(mut self, source_sql: Option<&'a str>) -> Self {
46        self.source_sql = source_sql;
47        self
48    }
49}
50
51pub struct SessionPortalDeclaration {
52    pub metadata: uqa_sql::catalog::session::CursorMetadata,
53    pub query: uqa_sql::plan::QueryPlan,
54    pub params: Vec<SQLParam>,
55    pub schema: uqa_sql::RowSchema,
56}
57
58pub struct SessionPortalCommandDeclaration {
59    pub metadata: uqa_sql::catalog::session::CursorMetadata,
60    pub command: Box<uqa_sql::plan::CommandPlan>,
61    pub params: Vec<SQLParam>,
62    pub schema: uqa_sql::RowSchema,
63    /// `PostgreSQL` 18 materializes one `NULL`-filled tuple for each row produced by a modifying command opened with explicit `SCROLL`.
64    pub null_returning_values: bool,
65}