uqa-storage-sqlite 0.5.0

SQLite catalog, indexes, compressed storage, graph and key/value providers
Documentation
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
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
//
// Unified Query Algebra
//
// Copyright (c) 2023-2026 Cognica, Inc.
//

//! Sequence and SQL view catalog state.

use super::{
    migration_relation, params, Catalog, OptionalExtension, RelationIdentity, RelationKind, Result,
    SQLiteError, SequenceOptions, SequenceReservationResult, SequenceRow, SequenceSetValueResult,
    ViewRow,
};
use uqa_storage::catalog::{sequence_value_reservation, SequenceLogResult, SequenceValuePosition};

pub(in crate::catalog) mod codec;
use codec::{
    concrete_sequence_options, decode_raw_sequence_row, decode_sequence_identity,
    read_raw_sequence_row,
};

fn with_sequence_value_write<T>(
    connection: &crate::ManagedConnection,
    operation: impl FnOnce(&rusqlite::Connection) -> Result<T>,
) -> Result<T> {
    connection.with_mut(|connection| {
        if connection.is_autocommit() {
            let transaction =
                connection.transaction_with_behavior(rusqlite::TransactionBehavior::Immediate)?;
            let result = operation(&transaction)?;
            transaction.commit()?;
            return Ok(result);
        }
        let transaction = connection.savepoint()?;
        let result = operation(&transaction)?;
        transaction.commit()?;
        Ok(result)
    })
}

/// The physical row of a sequence object, found by its object identity whatever name it currently has.
struct PhysicalSequenceValue {
    relation: RelationIdentity,
    definition_generation: [u8; 16],
    position: SequenceValuePosition,
    increment: i64,
    min_value: i64,
    max_value: i64,
    cycle: bool,
    cache_size: i64,
}

fn physical_sequence_value(
    connection: &rusqlite::Connection,
    object_id: [u8; 16],
) -> Result<Option<PhysicalSequenceValue>> {
    let mut statement = connection.prepare_cached(
        "SELECT schema_name, relation_name, definition_generation, current, called, log_count, increment, min_value, max_value, cycle, cache_size
           FROM _sequences WHERE object_id = ?1",
    )?;
    let mut rows = statement.query(params![object_id.as_slice()])?;
    let Some(row) = rows.next()? else {
        return Ok(None);
    };
    let relation = RelationIdentity::new(row.get::<_, String>(0)?, row.get::<_, String>(1)?);
    let stored = PhysicalSequenceValue {
        definition_generation: decode_sequence_identity(
            &relation,
            "definition generation",
            row.get::<_, Vec<u8>>(2)?,
        )?,
        position: SequenceValuePosition {
            current: row.get(3)?,
            called: row.get(4)?,
            log_count: row.get(5)?,
        },
        increment: row.get(6)?,
        min_value: row.get(7)?,
        max_value: row.get(8)?,
        cycle: row.get(9)?,
        cache_size: row.get(10)?,
        relation,
    };
    if rows.next()?.is_some() {
        return Err(SQLiteError::StorageBackend(format!(
            "sequence `{}` shares its object identity with another sequence",
            stored.relation.qualified_name()
        )));
    }
    Ok(Some(stored))
}

fn update_physical_sequence_value(
    connection: &rusqlite::Connection,
    stored: &PhysicalSequenceValue,
    object_id: [u8; 16],
    position: SequenceValuePosition,
    action: &str,
) -> Result<()> {
    let updated = connection.execute(
        "UPDATE _sequences SET current = ?3, called = ?4, log_count = ?5
          WHERE object_id = ?1 AND definition_generation = ?2",
        params![
            object_id.as_slice(),
            stored.definition_generation.as_slice(),
            position.current,
            position.called,
            position.log_count,
        ],
    )?;
    if updated != 1 {
        return Err(SQLiteError::StorageBackend(format!(
            "sequence `{}` changed while {action}",
            stored.relation.qualified_name()
        )));
    }
    Ok(())
}

fn reserve_sequence_values_in_connection(
    connection: &rusqlite::Connection,
    object_id: [u8; 16],
    definition_generation: [u8; 16],
) -> Result<SequenceReservationResult> {
    let Some(stored) = physical_sequence_value(connection, object_id)? else {
        return Ok(SequenceReservationResult::Missing);
    };
    if stored.definition_generation != definition_generation {
        return Ok(SequenceReservationResult::DefinitionChanged);
    }
    if stored.increment == 0 || stored.cache_size <= 0 {
        return Err(SQLiteError::StorageBackend(format!(
            "corrupt sequence `{}` has increment {} and cache size {}",
            stored.relation.qualified_name(),
            stored.increment,
            stored.cache_size
        )));
    }
    let Some(reservation) = sequence_value_reservation(
        stored.position,
        stored.increment,
        stored.min_value,
        stored.max_value,
        stored.cycle,
        stored.cache_size,
    ) else {
        return Ok(SequenceReservationResult::Exhausted);
    };
    update_physical_sequence_value(
        connection,
        &stored,
        object_id,
        SequenceValuePosition {
            current: reservation.last_value,
            called: true,
            log_count: reservation.log_count,
        },
        "reserving cached values",
    )?;
    Ok(SequenceReservationResult::Reserved(reservation))
}

impl Catalog {
    pub fn create_sequence_row(&self, sequence: &SequenceRow) -> Result<bool> {
        if let Some(result) = self.write_native_sequence(sequence, false)? {
            return Ok(result);
        }
        self.conn.with_mut(|connection| {
            let tx = connection.savepoint()?;
            let exists = tx
                .query_row(
                    "SELECT 1 FROM _sequences
                      WHERE schema_name = ?1 AND relation_name = ?2",
                    params![sequence.relation.schema, sequence.relation.name],
                    |_| Ok(()),
                )
                .optional()?
                .is_some();
            if exists {
                return Ok(false);
            }
            Self::claim_relation(&tx, &sequence.relation, RelationKind::Sequence)?;
            let options = concrete_sequence_options(sequence);
            let owner_table = sequence.owner.map(|owner| owner.table_object_id);
            let owner_column = sequence.owner.map(|owner| owner.column_object_id);
            let owner_dependency = sequence
                .owner
                .map(|owner| owner.dependency.catalog_code());
            let (role_owner, acl_json) = crate::catalog::role_security::encode_sequence(&sequence.security)?;
            tx.execute(
                "INSERT INTO _sequences
                    (schema_name, relation_name, kind, object_id, definition_generation, start, increment, current, called, persistence, data_type, min_value, max_value, cycle, cache_size, owner_table_object_id, owner_column_object_id, owner_dependency, role_owner, acl_json, log_count)
                 VALUES (?1, ?2, 'sequence', ?3, ?4, ?5, ?6, ?7, ?8, ?9, ?10, ?11, ?12, ?13, ?14, ?15, ?16, ?17, ?18, ?19, ?20)",
                params![
                    sequence.relation.schema,
                    sequence.relation.name,
                    sequence.object_id.as_slice(),
                    sequence.definition_generation.as_slice(),
                    sequence.start,
                    sequence.increment,
                    sequence.current,
                    sequence.called,
                    sequence.persistence,
                    options.data_type,
                    options.min_value,
                    options.max_value,
                    options.cycle,
                    options.cache_size,
                    owner_table.as_ref().map(<[u8; 16]>::as_slice),
                    owner_column.as_ref().map(<[u8; 16]>::as_slice),
                    owner_dependency,
                    role_owner,
                    acl_json,
                    sequence.log_count,
                ],
            )?;
            tx.commit()?;
            Ok(true)
        })
    }

    pub fn replace_sequence_row(&self, sequence: &SequenceRow) -> Result<bool> {
        if let Some(result) = self.write_native_sequence(sequence, true)? {
            return Ok(result);
        }
        self.conn.with(|connection| {
            let options = concrete_sequence_options(sequence);
            let owner_table = sequence.owner.map(|owner| owner.table_object_id);
            let owner_column = sequence.owner.map(|owner| owner.column_object_id);
            let owner_dependency = sequence
                .owner
                .map(|owner| owner.dependency.catalog_code());
            let (role_owner, acl_json) = crate::catalog::role_security::encode_sequence(&sequence.security)?;
            Ok(connection.execute(
                "UPDATE _sequences
                    SET object_id = ?3, definition_generation = ?4, start = ?5, increment = ?6,
                        current = CASE WHEN object_id = ?3 AND definition_generation = ?4 THEN current ELSE ?7 END,
                        called = CASE WHEN object_id = ?3 AND definition_generation = ?4 THEN called ELSE ?8 END,
                        persistence = ?9, data_type = ?10, min_value = ?11, max_value = ?12, cycle = ?13, cache_size = ?14,
                        owner_table_object_id = ?15, owner_column_object_id = ?16, owner_dependency = ?17, role_owner = ?18, acl_json = ?19,
                        log_count = CASE WHEN object_id = ?3 AND definition_generation = ?4 THEN log_count ELSE ?20 END
                  WHERE schema_name = ?1 AND relation_name = ?2",
                params![
                    sequence.relation.schema,
                    sequence.relation.name,
                    sequence.object_id.as_slice(),
                    sequence.definition_generation.as_slice(),
                    sequence.start,
                    sequence.increment,
                    sequence.current,
                    sequence.called,
                    sequence.persistence,
                    options.data_type,
                    options.min_value,
                    options.max_value,
                    options.cycle,
                    options.cache_size,
                    owner_table.as_ref().map(<[u8; 16]>::as_slice),
                    owner_column.as_ref().map(<[u8; 16]>::as_slice),
                    owner_dependency,
                    role_owner,
                    acl_json,
                    sequence.log_count,
                ],
            )? != 0)
        })
    }

    pub fn rename_sequence_row(&self, from: &str, to: &str) -> Result<bool> {
        let from_relation = migration_relation(from)?;
        let to_relation = migration_relation(to)?;
        if let Some(result) = self.rename_native_sequence(&from_relation, &to_relation)? {
            return Ok(result);
        }
        self.conn.with_mut(|connection| {
            let tx = connection.savepoint()?;
            let source_exists = tx
                .query_row(
                    "SELECT 1 FROM _sequences
                      WHERE schema_name = ?1 AND relation_name = ?2",
                    params![from_relation.schema, from_relation.name],
                    |_| Ok(()),
                )
                .optional()?
                .is_some();
            if !source_exists {
                return Ok(false);
            }
            if from_relation == to_relation {
                return Ok(true);
            }
            let target_kind = tx
                .query_row(
                    "SELECT kind FROM _relations
                      WHERE schema_name = ?1 AND relation_name = ?2",
                    params![to_relation.schema, to_relation.name],
                    |row| row.get::<_, String>(0),
                )
                .optional()?;
            if let Some(kind) = target_kind {
                return Err(SQLiteError::StorageBackend(format!(
                    "relation `{}` already exists as {kind}",
                    to_relation.qualified_name()
                )));
            }
            Self::claim_relation(&tx, &to_relation, RelationKind::Sequence)?;
            let updated = tx.execute(
                "UPDATE _sequences
                    SET schema_name = ?3, relation_name = ?4
                  WHERE schema_name = ?1 AND relation_name = ?2",
                params![
                    from_relation.schema,
                    from_relation.name,
                    to_relation.schema,
                    to_relation.name
                ],
            )?;
            if updated != 1 {
                return Err(SQLiteError::StorageBackend(format!(
                    "sequence `{from}` changed while renaming"
                )));
            }
            Self::release_relation(&tx, &from_relation, RelationKind::Sequence)?;
            tx.commit()?;
            Ok(true)
        })
    }

    pub fn drop_sequence_row(&self, name: &str) -> Result<bool> {
        let relation = migration_relation(name)?;
        if let Some(result) = self.drop_native_sequence(&relation)? {
            return Ok(result);
        }
        self.conn.with_mut(|connection| {
            let tx = connection.savepoint()?;
            let removed = tx.execute(
                "DELETE FROM _sequences
                  WHERE schema_name = ?1 AND relation_name = ?2",
                params![relation.schema, relation.name],
            )? != 0;
            if removed {
                Self::release_relation(&tx, &relation, RelationKind::Sequence)?;
            }
            tx.commit()?;
            Ok(removed)
        })
    }

    pub fn load_sequence_rows(&self) -> Result<Vec<SequenceRow>> {
        if let Some(result) = self.load_native_sequences()? {
            return Ok(result);
        }
        self.conn.with(|connection| {
            let mut statement = connection.prepare(
                "SELECT schema_name, relation_name, object_id, definition_generation, start, increment, current, called, persistence,
                        data_type, min_value, max_value, cycle, cache_size, owner_table_object_id, owner_column_object_id, owner_dependency, role_owner, acl_json, log_count
                       FROM _sequences ORDER BY schema_name, relation_name",
            )?;
            let sequences = statement
                .query_map([], read_raw_sequence_row)?
                .map(|row| decode_raw_sequence_row(row?))
                .collect();
            sequences
        })
    }

    pub fn reserve_sequence_values(
        &self,
        name: &str,
        object_id: [u8; 16],
        definition_generation: [u8; 16],
    ) -> Result<SequenceReservationResult> {
        let relation = migration_relation(name)?;
        if let Some(result) =
            self.reserve_native_sequence_values(&relation, object_id, definition_generation)?
        {
            return Ok(result);
        }
        with_sequence_value_write(&self.conn, |connection| {
            reserve_sequence_values_in_connection(connection, object_id, definition_generation)
        })
    }

    pub fn set_sequence_value(
        &self,
        name: &str,
        object_id: [u8; 16],
        definition_generation: [u8; 16],
        value: i64,
        called: bool,
        log_count: i64,
    ) -> Result<SequenceSetValueResult> {
        let relation = migration_relation(name)?;
        if let Some(result) = self.set_native_sequence_value(
            &relation,
            object_id,
            definition_generation,
            value,
            called,
            log_count,
        )? {
            return Ok(result);
        }
        with_sequence_value_write(&self.conn, |connection| {
            let Some(stored) = physical_sequence_value(connection, object_id)? else {
                return Ok(SequenceSetValueResult::Missing);
            };
            if stored.definition_generation != definition_generation {
                return Ok(SequenceSetValueResult::DefinitionChanged);
            }
            update_physical_sequence_value(
                connection,
                &stored,
                object_id,
                SequenceValuePosition {
                    current: value,
                    called,
                    log_count,
                },
                "setting its value",
            )?;
            Ok(SequenceSetValueResult::Set(value))
        })
    }

    pub fn log_sequence_values(
        &self,
        name: &str,
        object_id: [u8; 16],
        definition_generation: [u8; 16],
        expected: (i64, bool),
        logged: SequenceValuePosition,
    ) -> Result<SequenceLogResult> {
        let relation = migration_relation(name)?;
        if let Some(result) = self.log_native_sequence_values(
            &relation,
            object_id,
            definition_generation,
            expected,
            logged,
        )? {
            return Ok(result);
        }
        with_sequence_value_write(&self.conn, |connection| {
            let Some(stored) = physical_sequence_value(connection, object_id)? else {
                return Ok(SequenceLogResult::Missing);
            };
            if stored.definition_generation != definition_generation {
                return Ok(SequenceLogResult::DefinitionChanged);
            }
            if logged.log_count < 0 {
                return Err(SQLiteError::StorageBackend(
                    "sequence log count cannot be negative".into(),
                ));
            }
            if (stored.position.current, stored.position.called) != expected {
                return Ok(SequenceLogResult::Changed(stored.position));
            }
            update_physical_sequence_value(
                connection,
                &stored,
                object_id,
                logged,
                "logging its value",
            )?;
            Ok(SequenceLogResult::Logged)
        })
    }

    pub fn save_view(&self, view: &ViewRow) -> Result<()> {
        if self.save_native_view(view)?.is_some() {
            return Ok(());
        }
        self.conn.with_mut(|connection| {
            let tx = connection.savepoint()?;
            Self::claim_relation(&tx, &view.relation, RelationKind::View)?;
            let (role_owner, acl_json, column_acls_json) = super::role_security::encode_relation(&view.security)?;
            tx.execute(
                "INSERT OR REPLACE INTO _views
                    (schema_name, relation_name, kind, role_owner, acl_json, column_acls_json, definition_json)
                 VALUES (?1, ?2, 'view', ?3, ?4, ?5, ?6)",
                params![
                    view.relation.schema,
                    view.relation.name,
                    role_owner,
                    acl_json,
                    column_acls_json,
                    view.definition_json
                ],
            )?;
            tx.commit()?;
            Ok(())
        })
    }

    pub fn rename_view(&self, from: &RelationIdentity, to: &RelationIdentity) -> Result<bool> {
        // A move into another schema, which ALTER SCHEMA RENAME performs for every view the schema holds, re-keys the same rows as a rename.
        if let Some(renamed) =
            self.rename_native_relation(super::native::RelationRecord::View, from, to)?
        {
            return Ok(renamed);
        }
        self.conn.with_mut(|connection| {
            let source_exists = connection.query_row(
                "SELECT EXISTS(SELECT 1 FROM _views WHERE schema_name = ?1 AND relation_name = ?2)",
                params![from.schema, from.name],
                |row| row.get::<_, bool>(0),
            )?;
            if from == to || !source_exists {
                return Ok(source_exists);
            }
            let target_exists = connection.query_row(
                "SELECT EXISTS(SELECT 1 FROM _relations WHERE schema_name = ?1 AND relation_name = ?2)",
                params![to.schema, to.name],
                |row| row.get::<_, bool>(0),
            )?;
            if target_exists {
                return Err(SQLiteError::StorageBackend(format!(
                    "relation `{}` already exists",
                    to.qualified_name()
                )));
            }
            let tx = connection.savepoint()?;
            Self::claim_relation(&tx, to, RelationKind::View)?;
            let updated = tx.execute(
                "UPDATE _views SET schema_name = ?3, relation_name = ?4 WHERE schema_name = ?1 AND relation_name = ?2",
                params![from.schema, from.name, to.schema, to.name],
            )?;
            if updated != 1 {
                return Err(SQLiteError::StorageBackend(format!(
                    "view `{}` disappeared during rename",
                    from.qualified_name()
                )));
            }
            Self::release_relation(&tx, from, RelationKind::View)?;
            tx.commit()?;
            Ok(true)
        })
    }

    pub fn drop_view(&self, relation: &RelationIdentity) -> Result<bool> {
        if let Some(removed) =
            self.drop_native_relation(super::native::RelationRecord::View, relation)?
        {
            return Ok(removed);
        }
        self.conn.with_mut(|connection| {
            let tx = connection.savepoint()?;
            let removed = tx.execute(
                "DELETE FROM _views WHERE schema_name = ?1 AND relation_name = ?2",
                params![relation.schema, relation.name],
            )? != 0;
            if removed {
                Self::release_relation(&tx, relation, RelationKind::View)?;
            }
            tx.commit()?;
            Ok(removed)
        })
    }

    pub fn load_views(&self) -> Result<Vec<ViewRow>> {
        if let Some(views) = self.load_native_views()? {
            return Ok(views);
        }
        self.conn.with(|connection| {
            let mut statement = connection.prepare(
                "SELECT schema_name, relation_name, role_owner, acl_json, column_acls_json, definition_json
                   FROM _views ORDER BY schema_name, relation_name",
            )?;
            let rows = statement.query_map([], |row| {
                Ok((
                    row.get::<_, String>(0)?,
                    row.get::<_, String>(1)?,
                    row.get::<_, rusqlite::types::Value>(2)?,
                    row.get::<_, Option<String>>(3)?,
                    row.get::<_, Option<String>>(4)?,
                    row.get::<_, String>(5)?,
                ))
            })?;
            let mut views = Vec::new();
            for row in rows {
                let (schema, name, role_owner, acl_json, column_acls_json, definition_json) = row?;
                views.push(ViewRow {
                    relation: RelationIdentity::new(schema, name),
                    security: super::role_security::decode_relation((&role_owner).into(), acl_json.as_deref(), column_acls_json.as_deref())?,
                    definition_json,
                });
            }
            Ok(views)
        })
    }
}