Skip to main content

uqa_engine/capabilities/
referential.rs

1//
2// Unified Query Algebra
3//
4// Copyright (c) 2023-2026 Cognica, Inc.
5//
6
7//! Bind referential execution to transaction queues and mutation snapshots.
8use crate::Engine;
9use uqa_core::DocId;
10use uqa_execution::mutation::referential::{
11    ReferentialContext, ReferentialDeferrals, ReferentialReadSnapshot, ReferentialSnapshots,
12};
13use uqa_sql::{ast::ForeignKey, SQLError};
14impl Engine {
15    pub(crate) fn referential_execution_context(
16        &self,
17    ) -> ReferentialContext<'_, crate::session::StatementReadSnapshot> {
18        ReferentialContext {
19            constraints: self.constraint_execution_context(),
20            locking: self.row_lock_context(),
21            assignment: self.mutation_assignment_context(),
22            identifiers: self,
23            triggers: self.trigger_execution_context(),
24            deferrals: self,
25            snapshots: self,
26        }
27    }
28}
29impl ReferentialDeferrals for Engine {
30    fn defer_foreign_key_check(
31        &self,
32        constraint_table: &str,
33        firing_table: &str,
34        row_table: &str,
35        doc_id: DocId,
36        foreign_key: &ForeignKey,
37        derived: Option<&uqa_sql::ast::ReferencedPartitionConstraint>,
38    ) -> Result<(), SQLError> {
39        Engine::defer_foreign_key_check(
40            self,
41            crate::transactions::DeferredReferencedKey {
42                constraint_table,
43                firing_table,
44                foreign_key,
45                derived,
46            },
47            row_table,
48            doc_id,
49        )
50    }
51    fn defer_foreign_key_parent_event(
52        &self,
53        constraint_table: &str,
54        firing_table: &str,
55        foreign_key: &ForeignKey,
56        derived: Option<&uqa_sql::ast::ReferencedPartitionConstraint>,
57    ) -> Result<(), SQLError> {
58        Engine::defer_foreign_key_parent_event(
59            self,
60            crate::transactions::DeferredReferencedKey {
61                constraint_table,
62                firing_table,
63                foreign_key,
64                derived,
65            },
66        )
67    }
68}
69
70/// Own or borrow the existing snapshot resource; referential scan policy belongs to execution.
71struct ReferenceSnapshotEngine<T: std::ops::Deref<Target = Engine>>(T);
72
73impl<T: std::ops::Deref<Target = Engine>> ReferentialReadSnapshot for ReferenceSnapshotEngine<T> {
74    fn doc_ids(&self, table: &str) -> Result<Vec<DocId>, SQLError> {
75        self.0.live_table_doc_ids(table)
76    }
77    fn doc_id_page(
78        &self,
79        table: &str,
80        after: Option<DocId>,
81        limit: usize,
82        control: &uqa_storage::read_control::StorageReadControl,
83    ) -> Result<uqa_core::memory::BudgetedVec<DocId>, SQLError> {
84        uqa_execution::mutation::constraints::context::MutationRead::live_table_doc_id_page(
85            &*self.0, table, after, limit, control,
86        )
87    }
88    fn value_index_scan_key(
89        &self,
90        table: &str,
91        key: &uqa_storage::ValueIndexKey,
92        predicate: &uqa_core::Predicate,
93    ) -> Result<Option<uqa_core::PostingList>, SQLError> {
94        self.0.value_index_scan_key(table, key, predicate)
95    }
96    fn visit_value_index_equal(
97        &self,
98        table: &str,
99        key: &uqa_storage::ValueIndexKey,
100        value: &uqa_core::Value,
101        visit: &mut dyn FnMut(DocId) -> Result<(), SQLError>,
102    ) -> Result<bool, SQLError> {
103        self.0.visit_value_index_equal(table, key, value, visit)
104    }
105    fn document(
106        &self,
107        table: &str,
108        doc_id: DocId,
109    ) -> Result<Option<uqa_storage::document_store::Document>, SQLError> {
110        self.0.get_live_document(table, doc_id)
111    }
112    fn metadata(
113        &self,
114        table: &str,
115        doc_id: DocId,
116    ) -> Result<Option<uqa_storage::DocumentMetadata>, SQLError> {
117        self.0
118            .require_table(table)?
119            .document_store
120            .read()
121            .get_metadata(doc_id)
122            .map_err(|error| SQLError::Internal(format!("read reference tuple metadata: {error}")))
123    }
124}
125impl ReferentialSnapshots for Engine {
126    fn latest_reference_snapshot(&self) -> Result<Box<dyn ReferentialReadSnapshot + '_>, SQLError> {
127        let Some(backend) = self.storage.backend.as_ref() else {
128            return Ok(Box::new(ReferenceSnapshotEngine(self)));
129        };
130        if backend.transaction_has_written().map_err(|error| {
131            SQLError::Internal(format!("inspect reference snapshot transaction: {error}"))
132        })? {
133            Ok(Box::new(ReferenceSnapshotEngine(self)))
134        } else {
135            Ok(Box::new(ReferenceSnapshotEngine(
136                self.open_independent_pinned_read_snapshot()?,
137            )))
138        }
139    }
140    fn transaction_document_metadata(
141        &self,
142        table: &str,
143        doc_id: DocId,
144    ) -> Result<Option<uqa_storage::DocumentMetadata>, SQLError> {
145        self.get_query_document_metadata(table, doc_id)
146    }
147}