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