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::ReturningInputs},
12    statement::context::{queries::StatementQueryContexts, session::StatementPortals},
13};
14use uqa_sql::{
15    routines::{
16        declaration::RoutineTypeCatalog, resolution::RoutineOverloadCatalog, RoutineResolution,
17    },
18    SQLParam,
19};
20
21#[derive(Clone)]
22pub struct PortalExecutionContext<'a, S: Clone + 'static> {
23    pub state: &'a dyn StatementPortals,
24    pub queries: &'a dyn StatementQueryContexts<S>,
25    pub returning: &'a dyn ReturningInputs<S>,
26    pub command_scopes: &'a dyn CommandScopeSource<S>,
27    pub routines: &'a dyn RoutineResolution,
28    pub overloads: &'a dyn RoutineOverloadCatalog,
29    pub types: &'a dyn RoutineTypeCatalog,
30    pub session: &'a dyn CatalogSession,
31    pub source_sql: Option<&'a str>,
32    pub created_at_micros: i64,
33}
34
35impl<'a, S: Clone + 'static> PortalExecutionContext<'a, S> {
36    pub fn with_source_sql(mut self, source_sql: Option<&'a str>) -> Self {
37        self.source_sql = source_sql;
38        self
39    }
40}
41
42pub struct SessionPortalDeclaration {
43    pub metadata: uqa_sql::catalog::session::CursorMetadata,
44    pub query: uqa_sql::plan::QueryPlan,
45    pub params: Vec<SQLParam>,
46    pub schema: uqa_sql::RowSchema,
47}
48
49pub struct SessionPortalCommandDeclaration {
50    pub metadata: uqa_sql::catalog::session::CursorMetadata,
51    pub command: Box<uqa_sql::plan::CommandPlan>,
52    pub params: Vec<SQLParam>,
53    pub schema: uqa_sql::RowSchema,
54    /// `PostgreSQL` 18 materializes one `NULL`-filled tuple for each row produced by a modifying command opened with explicit `SCROLL`.
55    pub null_returning_values: bool,
56}