Skip to main content

uqa_execution/statement/context/
session.rs

1//
2// Unified Query Algebra
3//
4// Copyright (c) 2023-2026 Cognica, Inc.
5//
6
7//! Session settings, notifications, portals, transactions and prepared-plan state.
8
9use uqa_sql::{
10    ast::{ColumnType, DiscardTarget, FetchCursorStmt, SetConstraintName, TransactionStmt},
11    plan::UnifiedPlan,
12    SQLError, SQLResult,
13};
14
15pub trait StatementSettings {
16    fn set_runtime_parameter(
17        &self,
18        name: &str,
19        value: Option<&str>,
20        local: bool,
21    ) -> Result<(), SQLError>;
22    fn reset_all_variables(&self);
23    fn discard(&self, target: DiscardTarget) -> Result<(), SQLError>;
24    fn load_library(&self, library: &str) -> Result<(), SQLError>;
25}
26pub trait StatementNotifications {
27    fn notification_subscriptions_required(&self) -> bool {
28        false
29    }
30    fn notify(&self, channel: &str, payload: &str) -> Result<(), SQLError>;
31    fn listen(&self, channel: &str) -> Result<(), SQLError>;
32    fn unlisten(&self, channel: Option<&str>) -> Result<(), SQLError>;
33}
34pub trait StatementControl {
35    fn transaction_failed(&self) -> bool;
36    fn run_transaction_statement(&self, statement: TransactionStmt) -> Result<(), SQLError>;
37    fn set_constraints(
38        &self,
39        requested: &[SetConstraintName],
40        deferred: bool,
41        nested_statement: bool,
42    ) -> Result<(), SQLError>;
43}
44pub trait StatementPortals {
45    fn in_transaction_block(&self) -> bool;
46    fn ensure_session_portal_available(&self, name: &str) -> Result<(), SQLError>;
47    fn open_pending_session_portal(
48        &self,
49        declaration: crate::statement::portal::SessionPortalDeclaration,
50    ) -> Result<(), SQLError>;
51    fn open_pending_command_session_portal(
52        &self,
53        declaration: crate::statement::portal::SessionPortalCommandDeclaration,
54    ) -> Result<(), SQLError>;
55    fn fetch_session_portal(&self, fetch: &FetchCursorStmt) -> Result<SQLResult, SQLError>;
56    fn close_session_portal(&self, name: &str) -> Result<(), SQLError>;
57    fn close_all_session_portals(&self);
58}
59pub trait PreparedPlanState {
60    fn lookup_prepared(&self, name: &str) -> Option<UnifiedPlan>;
61    fn prepared_parameter_types(&self, name: &str) -> Option<Vec<Option<ColumnType>>>;
62    fn deallocate_prepared(&self, name: Option<&str>);
63}
64#[derive(Clone, Copy)]
65pub struct PreparedStatements<'a> {
66    pub state: &'a dyn PreparedPlanState,
67    pub arguments: &'a dyn crate::query::prepared::PreparedArgumentScopes,
68    pub definitions: crate::statement::prepared::PreparedRegistrationContext<'a>,
69    pub plans: &'a dyn uqa_sql::prepared::planning::PreparedPlanProvider,
70}