icydb_core/db/session/
mod.rs

1//! Module: session
2//! Responsibility: user-facing query/write execution facade over db executors.
3//! Does not own: planning semantics, cursor validation rules, or storage mutation protocol.
4//! Boundary: converts fluent/query intent calls into executor operations and response DTOs.
5
6mod accepted_schema;
7mod bounded_cache;
8mod catalog;
9mod integrity;
10mod query;
11mod read_set;
12mod request;
13mod response;
14mod resumable_job;
15#[cfg(feature = "sql")]
16mod sql;
17mod write;
18
19#[cfg(all(test, feature = "sql", feature = "diagnostics"))]
20mod tests;
21
22use crate::metrics::sink::with_metrics_sink;
23use crate::{
24    db::{Db, StoreRegistry},
25    metrics::sink::MetricsSink,
26    traits::CanisterKind,
27};
28use std::thread::LocalKey;
29
30pub(in crate::db) use accepted_schema::AcceptedSchemaCatalogContext;
31#[cfg(all(test, feature = "sql", feature = "diagnostics"))]
32pub(in crate::db) use accepted_schema::{
33    AcceptedSchemaRuntimeBuildCounts, accepted_schema_runtime_build_counts_for_tests,
34    reset_accepted_schema_runtime_build_counts_for_tests,
35};
36#[cfg(all(feature = "sql", feature = "diagnostics"))]
37pub use query::{
38    DirectDataRowAttribution, GroupedCountAttribution, GroupedExecutionAttribution,
39    KernelRowAttribution, ScalarAggregateAttribution,
40};
41#[doc(hidden)]
42pub use query::{
43    MAX_TYPED_EXACT_KEY_BATCH_INPUT_BYTES, MAX_TYPED_EXACT_KEY_BATCH_ITEMS,
44    MAX_TYPED_EXACT_KEY_BATCH_RESULT_BYTES, MAX_TYPED_EXACT_KEY_BATCH_STORED_BYTES,
45};
46pub use request::RequestExecutionRoot;
47pub(in crate::db) use request::RequestExecutionScope;
48pub(in crate::db) use response::finalize_structural_grouped_projection_result;
49pub(in crate::db) use response::grouped_cursor_from_bytes;
50#[cfg(all(feature = "sql", feature = "diagnostics"))]
51pub use sql::{
52    SqlCompileAttribution, SqlDistinctProjectionAttribution, SqlExecutionAttribution,
53    SqlHybridCoveringAttribution, SqlOutputBlobAttribution, SqlPureCoveringAttribution,
54    SqlQueryCacheAttribution, SqlQueryExecutionAttribution,
55};
56#[cfg(feature = "sql")]
57pub use sql::{
58    SqlConstraintValidationPage, SqlConstraintValidationRevisionStatus,
59    SqlConstraintValidationState, SqlDdlExecutionStatus, SqlDdlMutationKind,
60    SqlDdlPreparationReport, SqlIntegrityError, SqlStatementDispatch, SqlStatementResult,
61    SqlStatementShellSurface, SqlStatementSurface, TrustedResumableUpdateContinuation,
62    TrustedResumableUpdatePhase, TrustedResumableUpdateReceipt,
63    TrustedResumableUpdateRestartReason, sql_statement_dispatch, sql_statement_entity_name,
64    sql_statement_shell_surface, sql_statement_surface,
65};
66#[cfg(feature = "sql")]
67pub(in crate::db::session) use write::{
68    AcceptedStructuralMutation, AcceptedStructuralMutationTarget,
69    structural_data_key_from_runtime_values,
70};
71
72///
73/// DbSession
74///
75/// Session-scoped database handle with policy (debug, metrics) and execution routing.
76///
77
78pub struct DbSession<C: CanisterKind> {
79    db: Db<C>,
80    debug: bool,
81    metrics: Option<&'static dyn MetricsSink>,
82}
83
84impl<C: CanisterKind> DbSession<C> {
85    /// Construct one session facade over a sealed runtime store registry.
86    #[must_use]
87    pub fn new(
88        store: &'static LocalKey<StoreRegistry>,
89        request_root: &RequestExecutionRoot,
90    ) -> Self {
91        Self {
92            db: Db::new(store, request_root.scope()),
93            debug: false,
94            metrics: None,
95        }
96    }
97
98    /// Advance generated startup recovery without admitting ordinary database work.
99    #[doc(hidden)]
100    pub fn __continue_startup_recovery(&self) -> Result<bool, crate::error::InternalError> {
101        self.db.continue_startup_recovery()
102    }
103
104    /// Construct a session from the active synchronous request scope.
105    ///
106    /// Generated zero-argument `db!()` wiring uses this entry. `None` means
107    /// that the caller did not establish a request execution boundary.
108    #[doc(hidden)]
109    #[must_use]
110    pub fn __new_from_current_request(store: &'static LocalKey<StoreRegistry>) -> Option<Self> {
111        request::current_request_scope().map(|scope| Self {
112            db: Db::new(store, scope),
113            debug: false,
114            metrics: None,
115        })
116    }
117
118    /// Enable bounded request-wide query diagnostics without resetting prior counters.
119    ///
120    /// Returns `true` only when this call enabled collection. Every session
121    /// derived from the same request root observes the same diagnostic state.
122    #[cfg(feature = "diagnostics")]
123    #[must_use]
124    pub fn enable_request_diagnostics(&self) -> bool {
125        self.db.request_execution_scope().enable_diagnostics()
126    }
127
128    /// Snapshot bounded request-wide query diagnostics when collection is enabled.
129    #[cfg(feature = "diagnostics")]
130    #[must_use]
131    pub fn request_diagnostics(&self) -> Option<crate::db::RequestDiagnostics> {
132        self.db.request_execution_scope().diagnostics_snapshot()
133    }
134
135    /// Enable debug execution behavior where supported by executors.
136    #[must_use]
137    pub const fn debug(mut self) -> Self {
138        self.debug = true;
139        self
140    }
141
142    /// Attach one metrics sink for all session-executed operations.
143    #[must_use]
144    pub const fn metrics_sink(mut self, sink: &'static dyn MetricsSink) -> Self {
145        self.metrics = Some(sink);
146        self
147    }
148
149    fn with_metrics<T>(&self, f: impl FnOnce() -> T) -> T {
150        if let Some(sink) = self.metrics {
151            with_metrics_sink(sink, f)
152        } else {
153            f()
154        }
155    }
156}
icydb_core/db/session/mod.rs

icydb_core/db/session/
mod.rs
