uqa-engine 0.1.9

Engine: schema-aware table store, catalog restore, transactions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
//
// Unified Query Algebra
//
// Copyright (c) 2023-2026 Cognica, Inc.
//

//! COMMIT, ROLLBACK, and nontransactional statistics restoration.

use super::{
    Engine, NontransactionalColumnStats, SQLError, StorageBackendError, StorageBackendResult,
    StorageSavepointId, TransactionDirtyState, TransactionFrame, TransactionIntent,
    TransactionRelationStates, TransactionStatus,
};

impl Engine {
    pub(super) fn commit_transaction_frame(
        &self,
        stack: &mut Vec<TransactionFrame>,
        deferred_constraints_validated: bool,
    ) -> Result<(), SQLError> {
        let storage_savepoint = stack
            .last()
            .ok_or_else(|| SQLError::Internal("COMMIT without an open transaction".into()))?
            .storage_savepoint;
        if !deferred_constraints_validated && storage_savepoint.is_none() {
            return Err(SQLError::Internal(
                "outer COMMIT skipped deferred-constraint preparation".into(),
            ));
        }
        let frame = stack
            .last()
            .ok_or_else(|| SQLError::Internal("COMMIT without an open transaction".into()))?;
        let read_only = frame.intent == TransactionIntent::ReadOnly;
        if read_only && storage_savepoint.is_none() {
            if let Some(backend) = self.storage.backend.as_ref() {
                let violation = match backend.transaction_has_written() {
                    Ok(false) => None,
                    Ok(true) => Some(SQLError::Internal(
                        "read-only SQL execution attempted to mutate persistent storage".into(),
                    )),
                    Err(error) => Some(SQLError::Internal(format!(
                        "inspect read-only transaction before COMMIT: {error}"
                    ))),
                };
                if let Some(violation) = violation {
                    return Err(match self.rollback_transaction_frame(stack) {
                        Ok(()) => violation,
                        Err(rollback_error) => SQLError::Internal(format!(
                            "{violation}; read-only violation rollback also failed: {rollback_error}"
                        )),
                    });
                }
            }
        }
        let change_publication = if storage_savepoint.is_none() && !frame.row_changes.is_empty() {
            Some(
                self.row_locks
                    .begin_change_publication(&self.runtime.cancellation)?,
            )
        } else {
            None
        };
        let savepoints_deferred = Self::backend_savepoints_deferred(stack);
        if let Some(backend) = self.storage.backend.as_ref() {
            let commit_result = if let Some(savepoint) = storage_savepoint {
                if savepoints_deferred {
                    Ok(())
                } else {
                    backend
                        .release_savepoint(savepoint)
                        .map_err(|err| Self::storage_tx_error("nested COMMIT savepoint", &err))
                }
            } else {
                backend
                    .commit_transaction()
                    .map_err(|err| Self::storage_tx_error("COMMIT", &err))
            };
            if let Err(commit_error) = commit_result {
                return Err(self.recover_failed_transaction_finish(
                    stack,
                    storage_savepoint.is_some(),
                    commit_error,
                ));
            }
        }
        let committed = stack
            .pop()
            .ok_or_else(|| SQLError::Internal("COMMIT lost its transaction frame".into()))?;
        if storage_savepoint.is_none() {
            let publication_result = self.row_locks.publish_row_changes(
                self.session_id,
                committed.row_changes.iter().map(|change| change.pending),
            );
            drop(change_publication);
            self.row_locks.release_session(self.session_id);
            self.publish_committed_transaction_epochs();
            publication_result?;
            self.session
                .portals
                .lock()
                .retain(|_, portal| portal.holdable);
        }
        if let Some(parent) = stack.last_mut() {
            parent.next_lock_mark = parent.next_lock_mark.max(committed.next_lock_mark);
            parent.constraint_modes = committed.constraint_modes;
            parent.row_changes.extend(committed.row_changes);
            parent.deferred_foreign_key_checks = committed.deferred_foreign_key_checks;
            parent.first_snapshot_set |= committed.first_snapshot_set;
        }
        Ok(())
    }

    /// A failed outer backend COMMIT/ROLLBACK has already ended the managed
    /// storage transaction; a failed nested savepoint finish aborts the
    /// enclosing transaction explicitly. In every case the engine stack and
    /// session-local caches are restored before the error escapes, so callers
    /// never inherit a ghost transaction or uncommitted catalog state.
    pub(super) fn recover_failed_transaction_finish(
        &self,
        stack: &mut Vec<TransactionFrame>,
        nested: bool,
        finish_error: SQLError,
    ) -> SQLError {
        let raw_nontransactional_column_stats = stack
            .first()
            .map(|frame| frame.nontransactional_column_stats.clone())
            .unwrap_or_default();
        let rollback_relation_states = stack
            .first()
            .map(|frame| frame.relation_states_at_begin.clone())
            .unwrap_or_default();
        let nontransactional_column_stats = self.nontransactional_column_stats_after_rollback(
            &raw_nontransactional_column_stats,
            &rollback_relation_states,
        );
        let session_snapshot = stack.first().map(|frame| frame.session_snapshot.clone());
        let snapshot = stack.first().and_then(|frame| frame.data_snapshot.clone());
        let dirty_at_begin = stack
            .first()
            .map_or_else(TransactionDirtyState::default, |frame| frame.dirty_at_begin);
        let mut cleanup_errors = Vec::new();
        if nested {
            if let Some(backend) = self.storage.backend.as_ref() {
                if let Err(error) = backend.rollback_transaction() {
                    cleanup_errors.push(format!("storage rollback: {error}"));
                }
            }
        }
        stack.clear();
        self.row_locks.release_session(self.session_id);
        self.restore_transaction_dirty_state(dirty_at_begin);
        if let Some(snapshot) = snapshot.as_ref() {
            if let Err(error) = self.restore_transaction_data(snapshot) {
                cleanup_errors.push(format!("memory restore: {error}"));
            }
        }
        if self.storage.backend.is_some() {
            if let Err(error) = self.reload_persistent_value_indexes() {
                cleanup_errors.push(format!("btree restore: {error}"));
            }
            if let Err(error) = self.reload_table_catalog_after_rollback() {
                cleanup_errors.push(format!("table catalog restore: {error}"));
            }
            if let Err(error) = self.reload_catalog_registries_after_rollback() {
                cleanup_errors.push(format!("registry restore: {error}"));
            }
        }
        if let Err(error) = self.persist_nontransactional_column_stats_after_rollback(
            &nontransactional_column_stats,
            true,
        ) {
            cleanup_errors.push(format!("ANALYZE statistics restore: {error}"));
        }
        if let Err(error) = self.apply_nontransactional_column_stats(&nontransactional_column_stats)
        {
            cleanup_errors.push(format!("ANALYZE statistics cache restore: {error}"));
        }
        if let Some(snapshot) = session_snapshot.as_ref() {
            self.restore_session_state(snapshot);
        }
        if cleanup_errors.is_empty() {
            finish_error
        } else {
            SQLError::Internal(format!(
                "{finish_error}; failed transaction cleanup: {}",
                cleanup_errors.join("; ")
            ))
        }
    }

    pub(super) fn retain_nontransactional_stats_for_rollback(
        &self,
        stack: &mut [TransactionFrame],
        relation_states: &TransactionRelationStates,
    ) -> NontransactionalColumnStats {
        let raw_nontransactional_column_stats = stack
            .first()
            .map(|frame| frame.nontransactional_column_stats.clone())
            .unwrap_or_default();
        let nontransactional_column_stats = self.nontransactional_column_stats_after_rollback(
            &raw_nontransactional_column_stats,
            relation_states,
        );
        if let Some(frame) = stack.first_mut() {
            frame
                .nontransactional_column_stats
                .clone_from(&nontransactional_column_stats);
        }
        nontransactional_column_stats
    }

    pub(super) fn rollback_backend_transaction_frame(
        &self,
        stack: &mut Vec<TransactionFrame>,
        storage_savepoint: Option<StorageSavepointId>,
        backend_aborted: bool,
    ) -> Result<(), SQLError> {
        let savepoints_deferred = Self::backend_savepoints_deferred(stack);
        let Some(backend) = self.storage.backend.as_ref().filter(|_| !backend_aborted) else {
            return Ok(());
        };
        let rollback_result = if let Some(savepoint) = storage_savepoint {
            if savepoints_deferred {
                Ok(())
            } else {
                backend
                    .rollback_to_savepoint(savepoint)
                    .map_err(|error| Self::storage_tx_error("nested ROLLBACK savepoint", &error))
                    .and_then(|()| {
                        backend.release_savepoint(savepoint).map_err(|error| {
                            Self::storage_tx_error("nested ROLLBACK release", &error)
                        })
                    })
            }
        } else {
            backend
                .rollback_transaction()
                .map_err(|error| Self::storage_tx_error("ROLLBACK", &error))
        };
        rollback_result.map_err(|rollback_error| {
            self.recover_failed_transaction_finish(
                stack,
                storage_savepoint.is_some(),
                rollback_error,
            )
        })
    }

    pub(super) fn rollback_transaction_frame(
        &self,
        stack: &mut Vec<TransactionFrame>,
    ) -> Result<(), SQLError> {
        let rollback_relation_states = stack
            .last()
            .map(|frame| frame.relation_states_at_begin.clone())
            .unwrap_or_default();
        let nontransactional_column_stats =
            self.retain_nontransactional_stats_for_rollback(stack, &rollback_relation_states);
        let storage_savepoint = stack
            .last()
            .ok_or_else(|| SQLError::Internal("ROLLBACK without an open transaction".into()))?
            .storage_savepoint;
        let backend_aborted = stack
            .last()
            .is_some_and(|frame| frame.status == TransactionStatus::FailedBackendAborted);
        self.rollback_backend_transaction_frame(stack, storage_savepoint, backend_aborted)?;
        let frame = stack.last().ok_or_else(|| {
            SQLError::Internal("ROLLBACK lost its checked transaction frame".into())
        })?;
        let session_snapshot = frame.session_snapshot.clone();
        let mut cleanup_errors = Vec::new();
        if let Some(snapshot) = frame.data_snapshot.as_ref() {
            if let Err(error) = self.restore_transaction_data(snapshot) {
                cleanup_errors.push(format!("memory restore: {error}"));
            }
        }
        let dirty_at_begin = stack
            .last()
            .map_or_else(TransactionDirtyState::default, |frame| frame.dirty_at_begin);
        self.restore_transaction_dirty_state(dirty_at_begin);
        if let Err(error) = self.persist_nontransactional_column_stats_after_rollback(
            &nontransactional_column_stats,
            storage_savepoint.is_none(),
        ) {
            cleanup_errors.push(format!("ANALYZE statistics restore: {error}"));
        }
        if let Err(error) = self.reload_persistent_value_indexes() {
            cleanup_errors.push(format!("btree restore: {error}"));
        }
        if self.storage.backend.is_some() {
            if let Err(error) = self.reload_table_catalog_after_rollback() {
                cleanup_errors.push(format!("table catalog restore: {error}"));
            }
            if let Err(error) = self.reload_catalog_registries_after_rollback() {
                cleanup_errors.push(format!("registry restore: {error}"));
            }
        }
        if let Err(error) = self.apply_nontransactional_column_stats(&nontransactional_column_stats)
        {
            cleanup_errors.push(format!("ANALYZE statistics cache restore: {error}"));
        }
        self.restore_session_state(&session_snapshot);
        let begin_lock_mark = frame.begin_lock_mark;
        let first_snapshot_set = frame.first_snapshot_set;
        stack.pop();
        if stack.is_empty() {
            self.row_locks.release_session(self.session_id);
        } else {
            self.row_locks
                .release_mark_above(self.session_id, begin_lock_mark.saturating_sub(1));
            if let Some(parent) = stack.last_mut() {
                parent.first_snapshot_set |= first_snapshot_set;
            }
        }
        if cleanup_errors.is_empty() {
            Ok(())
        } else {
            Err(SQLError::Internal(format!(
                "ROLLBACK completed but engine state restoration failed: {}",
                cleanup_errors.join("; ")
            )))
        }
    }

    pub(super) fn persist_nontransactional_column_stats_after_rollback(
        &self,
        stats: &NontransactionalColumnStats,
        outer: bool,
    ) -> StorageBackendResult<()> {
        if !stats
            .iter()
            .any(|entry| entry.persistent && !entry.autonomous)
        {
            return Ok(());
        }
        if !outer {
            let catalog = self.storage.catalog.as_ref().ok_or_else(|| {
                StorageBackendError::Other("persistent ANALYZE statistics require a catalog".into())
            })?;
            for entry in stats
                .iter()
                .filter(|entry| entry.persistent && !entry.autonomous)
            {
                Self::persist_column_stats(catalog.as_ref(), &entry.table_name, &entry.stats)?;
            }
            return Ok(());
        }
        let provider = self.storage.provider.as_ref().ok_or_else(|| {
            StorageBackendError::Other(
                "nontransactional ANALYZE statistics require an independent session".into(),
            )
        })?;
        let session = provider.open_session()?;
        session.backend.begin_transaction()?;
        let result = (|| {
            for entry in stats
                .iter()
                .filter(|entry| entry.persistent && !entry.autonomous)
            {
                Self::persist_column_stats(
                    session.catalog.as_ref(),
                    &entry.table_name,
                    &entry.stats,
                )?;
            }
            Ok(())
        })();
        match result {
            Ok(()) => session.backend.commit_transaction(),
            Err(error) => match session.backend.rollback_transaction() {
                Ok(()) => Err(error),
                Err(rollback_error) => Err(StorageBackendError::Other(format!(
                    "restore nontransactional ANALYZE statistics failed: {error}; rollback also failed: {rollback_error}"
                ))),
            },
        }
    }

    pub(super) fn apply_nontransactional_column_stats(
        &self,
        stats: &NontransactionalColumnStats,
    ) -> StorageBackendResult<()> {
        for entry in stats {
            let Some(table) = self.try_table(&entry.table_name)? else {
                continue;
            };
            *table.column_stats.write() = entry.stats.clone();
            table
                .column_stats_loaded
                .store(true, std::sync::atomic::Ordering::Release);
            table
                .column_stats_dirty
                .store(false, std::sync::atomic::Ordering::Release);
            if entry.persistent {
                self.row_locks
                    .publish_column_stats(entry.table_name.clone(), entry.stats.clone());
            }
        }
        Ok(())
    }

    pub(super) fn nontransactional_column_stats_after_rollback(
        &self,
        stats: &NontransactionalColumnStats,
        relation_states: &TransactionRelationStates,
    ) -> NontransactionalColumnStats {
        for entry in stats {
            self.row_locks.invalidate_column_stats(&entry.table_name);
        }
        stats
            .iter()
            .filter(|entry| {
                relation_states.iter().any(|(relation, lifecycle_id)| {
                    relation.qualified_name() == entry.table_name
                        && *lifecycle_id == entry.table_lifecycle_id
                })
            })
            .cloned()
            .collect()
    }
}