uqa-engine 0.4.5

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
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
//
// Unified Query Algebra
//
// Copyright (c) 2023-2026 Cognica, Inc.
//

//! Column registration, index rebuild, and table or column rename.

use super::{
    table_next_id_metadata_key, table_not_found, Engine, RelationIdentity, StorageBackendError,
    StorageBackendResult,
};
use crate::VectorIndexSpec;

impl Engine {
    /// Append a column to the schema. No data migration is needed because
    /// the document store is sparse; rows missing the column read back as
    /// `Value::Null`.
    pub fn register_column(
        &self,
        table: &str,
        column: uqa_sql::ast::ColumnDef,
    ) -> StorageBackendResult<()> {
        self.try_register_column(table, column)
    }

    pub(crate) fn try_register_column(
        &self,
        table: &str,
        column: uqa_sql::ast::ColumnDef,
    ) -> StorageBackendResult<()> {
        self.with_implicit_storage_transaction(|engine| {
            engine.try_register_column_inner(table, column, None)
        })
    }

    pub(super) fn try_register_column_inner(
        &self,
        table: &str,
        column: uqa_sql::ast::ColumnDef,
        check_columns: Option<&[uqa_sql::ast::ColumnDef]>,
    ) -> StorageBackendResult<()> {
        uqa_execution::schema::publication::register_column(
            &self.schema_publication_context(),
            table,
            column,
            check_columns,
            &[],
        )
    }

    pub fn drop_column(&self, table: &str, column: &str) -> StorageBackendResult<bool> {
        self.with_implicit_storage_transaction(|engine| {
            let mut rewritten = Vec::new();
            if let Some(canonical) =
                engine.resolve_table_ddl_target(table, "ALTER TABLE DROP COLUMN")?
            {
                if engine.table_has_column_in_execution(&canonical, column)? {
                    engine
                        .drop_column_routine_dependents(&canonical, column, false)
                        .map_err(|error| StorageBackendError::Other(error.to_string()))?;
                    rewritten = engine
                        .prepare_routine_column_alias_drop(
                            std::collections::BTreeSet::from([(canonical, column.to_string())]),
                            &[],
                        )
                        .map_err(|error| StorageBackendError::Other(error.to_string()))?;
                }
            }
            let dropped = engine.try_drop_column_inner(table, column)?;
            if dropped {
                engine
                    .publish_stored_routine_body_rewrites(rewritten)
                    .map_err(|error| StorageBackendError::Other(error.to_string()))?;
                engine
                    .refresh_stored_merge_target_plans()
                    .map_err(|error| StorageBackendError::Other(error.to_string()))?;
            }
            Ok(dropped)
        })
    }

    pub(crate) fn try_drop_column(&self, table: &str, column: &str) -> StorageBackendResult<bool> {
        self.with_implicit_storage_transaction(|engine| engine.try_drop_column_inner(table, column))
    }

    pub(crate) fn try_drop_column_cascade(
        &self,
        table: &str,
        column: &str,
    ) -> StorageBackendResult<bool> {
        self.with_implicit_storage_transaction(|engine| {
            engine.try_drop_column_inner_with_sequence_cascade(table, column, true)
        })
    }

    pub(crate) fn try_drop_column_inner(
        &self,
        table: &str,
        column: &str,
    ) -> StorageBackendResult<bool> {
        self.try_drop_column_inner_with_sequence_cascade(table, column, false)
    }

    fn try_drop_column_inner_with_sequence_cascade(
        &self,
        table: &str,
        column: &str,
        cascade: bool,
    ) -> StorageBackendResult<bool> {
        uqa_execution::schema::publication::removal::drop_column(
            &self.column_drop_publication_context(),
            table,
            column,
            cascade,
        )
    }

    pub(crate) fn try_drop_vector_indexes_for_column(
        &self,
        table: &str,
        column: &str,
    ) -> StorageBackendResult<bool> {
        self.with_implicit_storage_transaction(|engine| {
            engine.try_drop_vector_indexes_for_column_inner(table, column)
        })
    }

    pub(super) fn try_drop_vector_indexes_for_column_inner(
        &self,
        table: &str,
        column: &str,
    ) -> StorageBackendResult<bool> {
        let Some(table_name) = self.resolve_table_ddl_target(table, "ALTER TABLE ALTER COLUMN")?
        else {
            return Ok(false);
        };
        uqa_execution::catalog::index::vectors::remove_for_column_conversion(
            &self.index_registry_context(),
            &table_name,
            column,
            || {
                let state = self
                    .try_table(&table_name)?
                    .ok_or_else(|| table_not_found(&table_name))?;
                let dimensions = state
                    .vector_indexes
                    .read()
                    .get(column)
                    .map(uqa_storage::VectorIndex::dimensions);
                if let Some(dimensions) = dimensions {
                    self.prepare_vector_column_rewrite(&table_name, column, dimensions)?;
                    state.vector_indexes.write().live_mut()?.remove(column);
                }
                self.try_save_table_schema(&table_name, &state)
            },
        )?;
        Ok(true)
    }

    pub(crate) fn prepare_vector_column_rewrite(
        &self,
        table: &str,
        column: &str,
        dimensions: u32,
    ) -> StorageBackendResult<()> {
        let table_name = self
            .try_resolve_table_name(table)?
            .ok_or_else(|| table_not_found(table))?;
        let state = self
            .try_table(&table_name)?
            .ok_or_else(|| table_not_found(&table_name))?;
        uqa_execution::schema::indexes::diskann::retire_column(
            &self.index_registry_context(),
            &table_name,
            column,
        )?;
        let canonical = self.build_vector_index_with_mode(
            &table_name,
            column,
            dimensions,
            VectorIndexSpec::BruteForce,
            uqa_storage::VectorIndexOpenMode::Create,
        )?;
        uqa_execution::catalog::index::vectors::prepare_column_rewrite(
            &mut state.vector_indexes.write(),
            column,
            canonical,
        )?;
        Ok(())
    }

    pub(crate) fn try_rebuild_vector_index_for_column(
        &self,
        table: &str,
        column: &str,
        dimensions: u32,
    ) -> StorageBackendResult<bool> {
        self.with_implicit_storage_transaction(|engine| {
            engine.try_rebuild_vector_index_for_column_inner(table, column, dimensions)
        })
    }

    pub(super) fn try_rebuild_vector_index_for_column_inner(
        &self,
        table: &str,
        column: &str,
        dimensions: u32,
    ) -> StorageBackendResult<bool> {
        let table_name = self
            .try_resolve_table_name(table)?
            .ok_or_else(|| table_not_found(table))?;
        let spec = self
            .vector_index_spec_for_column(&table_name, column, dimensions)?
            .unwrap_or(VectorIndexSpec::BruteForce);
        let t = self
            .try_table(&table_name)?
            .ok_or_else(|| table_not_found(&table_name))?;
        self.try_save_table_schema(&table_name, &t)?;
        if uqa_execution::schema::indexes::diskann::create_column(
            &self.index_registry_context(),
            &table_name,
            column,
        )? {
            return Ok(true);
        }
        let rebuilt = self.rebuild_vector_field_with_spec(&table_name, column, dimensions, spec)?;
        if !rebuilt {
            return Err(StorageBackendError::Other(format!(
                "failed to rebuild vector index for `{table_name}`.`{column}`"
            )));
        }
        Ok(true)
    }

    pub fn rename_column(&self, table: &str, from: &str, to: &str) -> StorageBackendResult<bool> {
        self.try_rename_column(table, from, to)
    }

    pub(crate) fn try_rename_column(
        &self,
        table: &str,
        from: &str,
        to: &str,
    ) -> StorageBackendResult<bool> {
        self.with_implicit_storage_transaction(|engine| {
            engine.try_rename_column_inner(table, from, to)
        })
    }

    fn rename_column_acl(table: &super::TableState, from: &str, to: &str) {
        if from == to {
            return;
        }
        let mut security = table.security.write();
        security.rename_column_acl(from, to);
    }

    fn rename_column_analyzer_assignments(&self, table_name: &str, from: &str, to: &str) {
        let mut analyzers = self.durable.table_field_analyzers.write();
        let mut moved = Vec::new();
        analyzers.retain(|(table, field), value| {
            if table == table_name && field == from {
                moved.push(((table_name.to_string(), to.to_string()), value.clone()));
                false
            } else {
                true
            }
        });
        analyzers.extend(moved);
    }

    fn rename_document_fields(
        &self,
        table_name: &str,
        table: &super::TableState,
        from: &str,
        to: &str,
    ) -> StorageBackendResult<()> {
        let ids = table.document_store.read().doc_ids()?;
        for doc_id in ids {
            let Some(mut doc) = table.document_store.read().get(doc_id)? else {
                continue;
            };
            if let Some(value) = doc.remove(from) {
                doc.insert(to.to_string(), value);
                self.rewrite_document_for_schema_change(table_name, doc_id, doc)
                    .map_err(|err| StorageBackendError::Other(err.to_string()))?;
            }
        }
        Ok(())
    }

    fn bind_renamed_vector_field(
        &self,
        table: &str,
        field: &str,
        dimensions: u32,
        restore: bool,
    ) -> StorageBackendResult<()> {
        let Some(spec) = self.vector_index_spec_for_column(table, field, dimensions)? else {
            return Ok(());
        };
        let bound = if restore {
            self.restore_vector_field_index(table, field, dimensions, spec)?
        } else {
            self.rebuild_vector_field_with_spec(table, field, dimensions, spec)?
        };
        if !bound {
            return Err(StorageBackendError::Other(format!(
                "failed to bind renamed vector index for `{table}`.`{field}`"
            )));
        }
        Ok(())
    }

    pub(super) fn try_rename_column_inner(
        &self,
        table: &str,
        from: &str,
        to: &str,
    ) -> StorageBackendResult<bool> {
        let Some(table_name) = self.resolve_table_ddl_target(table, "ALTER TABLE RENAME COLUMN")?
        else {
            return Ok(false);
        };
        let Some(t) = self.try_table(table)? else {
            return Ok(false);
        };
        {
            let columns = t.columns.read();
            if !columns.iter().any(|candidate| candidate.name == from) {
                return Ok(false);
            }
            if from != to && columns.iter().any(|candidate| candidate.name == to) {
                return Ok(false);
            }
        }
        let analyzer_binding = if from != to && t.fts_fields().iter().any(|field| field == from) {
            Some(
                self.current_field_analyzer_binding(&table_name, &t, from)
                    .map_err(StorageBackendError::Other)?,
            )
        } else {
            None
        };
        self.rewrite_column_rename_dependencies(&table_name, from, to)?;
        Self::value_indexes_clear(&t);
        {
            let mut cols = t.columns.write();
            for c in cols.iter_mut() {
                if c.name == from {
                    c.name = to.to_string();
                }
            }
        }
        Self::rename_column_acl(&t, from, to);
        for constraint in t.key_constraints.write().iter_mut() {
            for column in &mut constraint.columns {
                if column == from {
                    *column = to.to_string();
                }
            }
        }
        {
            let mut fts = t.fts_fields.write();
            for f in fts.iter_mut() {
                if f == from {
                    *f = to.to_string();
                }
            }
        }
        // Schema rewrites index the renamed source immediately, so its exact revisions must move before the first document write.
        if let Some(binding) = &analyzer_binding {
            binding.install(to, t.inverted_index.write().as_mut())?;
        }
        self.rename_column_analyzer_assignments(&table_name, from, to);
        let vector_rename = uqa_execution::catalog::index::vectors::detach_for_column_rename(
            &mut t.vector_indexes.write(),
            from,
        )?;
        let vector_dimensions = vector_rename.as_ref().map(|rename| rename.dimensions);
        let retained_vector = vector_rename.and_then(|rename| rename.retained);
        let restore_vector = retained_vector.is_some();
        self.rename_document_fields(&table_name, &t, from, to)?;
        if analyzer_binding.is_some() {
            t.inverted_index
                .write()
                .remove_field_analyzers(from)
                .map_err(StorageBackendError::Other)?;
        }
        if let Some(index) = retained_vector {
            t.vector_indexes
                .write()
                .live_mut()?
                .insert(to.into(), index);
        } else if let Some(dimensions) = vector_dimensions {
            self.create_vector_field(&table_name, to, dimensions)?;
        }
        self.rename_catalog_index_column_refs(&table_name, from, to)?;
        if self.is_persistent() {
            if let Some(catalog) = self.storage.catalog.as_ref() {
                catalog.rename_column_data(&table_name, from, to)?;
            }
            self.try_save_table_schema(&table_name, &t)?;
            if let Some(dimensions) = vector_dimensions {
                self.bind_renamed_vector_field(&table_name, to, dimensions, restore_vector)?;
            }
        }
        let relation = Self::resolved_relation_identity(&table_name)?;
        self.rewrite_routine_column_references(&relation, from, to)
            .map_err(|error| {
                StorageBackendError::Other(format!("rewrite routine column references: {error}"))
            })?;
        self.event_lifecycle_context()
            .rename_event_column_inner(&table_name, from, to)?;
        self.mark_column_stats_dirty(&table_name, &t)?;
        self.refresh_value_indexes_for_table(&table_name)?;
        Ok(true)
    }

    pub fn rename_table(&self, from: &str, to: &str) -> StorageBackendResult<bool> {
        self.try_rename_table(from, to)
    }

    pub(crate) fn try_rename_table(&self, from: &str, to: &str) -> StorageBackendResult<bool> {
        self.with_implicit_storage_transaction(|engine| engine.try_rename_table_inner(from, to))
    }

    pub(super) fn try_rename_table_inner(
        &self,
        from: &str,
        to: &str,
    ) -> StorageBackendResult<bool> {
        let Some(from) = self.resolve_table_ddl_target(from, "ALTER TABLE RENAME")? else {
            return Ok(false);
        };
        let from_relation = Self::resolved_relation_identity(&from)?;
        let (target_schema, target_name) =
            RelationIdentity::parse_reference(to).map_err(StorageBackendError::Other)?;
        let to_relation = RelationIdentity::new(
            target_schema.unwrap_or_else(|| from_relation.schema.clone()),
            target_name,
        );
        if to_relation.schema != self.temporary_schema_name()
            && !self
                .durable
                .schemas
                .read()
                .contains_key(&to_relation.schema)
        {
            return Err(StorageBackendError::Other(format!(
                "schema `{}` does not exist",
                to_relation.schema
            )));
        }
        let to = to_relation.qualified_name();
        if let Some(kind) = self.relation_kind_at(&to)? {
            return Err(StorageBackendError::Other(format!(
                "relation `{to}` already exists as {kind}"
            )));
        }
        self.relation_creation_context()
            .reserve_row_type_name(&to)
            .map_err(|error| StorageBackendError::backend("ALTER TABLE name", error))?;
        let persist_catalog = {
            let tables = self.storage.tables.read();
            if !tables.contains_key(&from_relation) || tables.contains_key(&to_relation) {
                return Ok(false);
            }
            self.is_persistent()
                && tables.get(&from_relation).is_some_and(|table| {
                    table.persistence != uqa_sql::ast::RelationPersistence::Temporary
                })
        };
        self.rewrite_table_rename_dependencies(&from, &to)?;
        if persist_catalog {
            if let Some(catalog) = self.storage.catalog.as_ref() {
                catalog.rename_table_data(&from, &to)?;
            }
        }
        let mut tables = self.storage.tables.write();
        if tables.contains_key(&to_relation) {
            return Ok(false);
        }
        let Some(state) = tables.remove(&from_relation) else {
            return Ok(false);
        };
        tables.insert(to_relation.clone(), state.clone());
        drop(tables);
        self.rewrite_relation_rename_dependents(&from_relation, &to_relation)?;
        self.rename_catalog_index_table_refs(&from, &to);
        {
            let mut analyzers = self.durable.table_field_analyzers.write();
            let mut moved = Vec::new();
            analyzers.retain(|(table, field), value| {
                if table == &from {
                    moved.push(((to.clone(), field.clone()), value.clone()));
                    false
                } else {
                    true
                }
            });
            analyzers.extend(moved);
        }
        if persist_catalog {
            self.rebind_persistent_table_stores(&to, &state)?;
            self.try_save_table_schema(&to, &state)?;
            if state.columns.read().iter().any(|column| {
                column
                    .auto_increment
                    .as_ref()
                    .is_some_and(uqa_sql::ast::AutoIncrement::is_legacy)
            }) {
                self.persist_next_id(&to)?;
            }
            if let Some(catalog) = self.storage.catalog.as_ref() {
                catalog.set_metadata(&table_next_id_metadata_key(&from), "")?;
            }
        }
        self.mark_column_stats_dirty(&to, &state)?;
        self.refresh_value_indexes_for_table(&to)?;
        self.rename_constraint_transaction_relation(&from_relation, &to_relation);
        Ok(true)
    }
}