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
//
// Unified Query Algebra
//
// Copyright (c) 2023-2026 Cognica, Inc.
//

use super::*;

#[test]
fn native_cache_views_retain_private_and_committed_boundaries_after_undo_and_another_commit() {
    let connection = ManagedConnection::open_in_memory().unwrap();
    let catalog = Catalog::open(connection.clone()).unwrap();
    connection
        .bind_native_records(uqa_storage::mvcc::VersionedSessionOptions::default())
        .unwrap();
    let other = Catalog::open(connection.new_session()).unwrap();
    let initial = connection.native_snapshot().unwrap().unwrap();
    let baseline = initial.cache_revisions().unwrap();
    connection.begin_transaction().unwrap();
    catalog.save_scoring_params("private", "{}").unwrap();
    let retained = connection.native_snapshot().unwrap().unwrap();
    let private = retained.cache_revisions().unwrap();
    other.save_scoring_params("outside", "{}").unwrap();
    assert_eq!(catalog.cache_revisions().unwrap(), private);
    connection.rollback_transaction().unwrap();
    assert_ne!(catalog.cache_revisions().unwrap(), baseline);
    assert_ne!(catalog.cache_revisions().unwrap(), private);
    assert_eq!(retained.cache_revisions().unwrap(), private);
    assert_eq!(initial.cache_revisions().unwrap(), baseline);
}

#[test]
fn metadata_cache_names_preserve_embedded_zero_and_unicode() {
    for native in [false, true] {
        let connection = ManagedConnection::open_in_memory().unwrap();
        let catalog = Catalog::open(connection.clone()).unwrap();
        if native {
            connection
                .bind_native_records(uqa_storage::mvcc::VersionedSessionOptions::default())
                .unwrap();
        }
        let graph = "g\0日本語";
        catalog.save_named_graph(graph).unwrap();
        let baseline = catalog.cache_revisions().unwrap();
        catalog
            .set_metadata(&format!("graph_label_registry::{graph}"), "{}")
            .unwrap();
        let updated = catalog.cache_revisions().unwrap();
        assert_ne!(
            updated.graphs.as_ref().unwrap()[graph],
            baseline.graphs.as_ref().unwrap()[graph]
        );
        assert!(!updated.graphs.as_ref().unwrap().contains_key("g"));
        assert_eq!(updated.registries, baseline.registries);
        for prefix in ["uqa.table_next_id.v1:", "uqa.statistics.maintenance.v1:"] {
            catalog
                .set_metadata(&format!("{prefix}{graph}"), "1")
                .unwrap();
        }
        let revisions = catalog.cache_revisions().unwrap();
        assert!(revisions.table_data.contains_key(graph));
        assert!(revisions.statistics_maintenance.contains_key(graph));
        let guard = uqa_storage::catalog::graph_guards::GraphRecordGuard::new(
            uqa_storage::GraphEntityKind::Vertex,
            1,
        );
        for name in [
            guard.lifetime(),
            guard.references(),
            guard.membership_references(graph),
        ] {
            catalog.set_metadata(&name, "1").unwrap();
        }
        assert_eq!(catalog.cache_revisions().unwrap(), revisions);
    }
}

// Exact released metadata INSERT trigger, independent of the current formatter.
const LEGACY_METADATA_INSERT: &str = "CREATE TRIGGER \"uqa_cache__metadata_INSERT\" AFTER INSERT ON \"_metadata\" BEGIN INSERT INTO _cache_revisions(kind, name, generation) VALUES (CASE WHEN substr(NEW.key, 1, 30) = 'uqa.statistics.maintenance.v1:' THEN 'maintenance' WHEN substr(NEW.key, 1, 21) = 'uqa.table_next_id.v1:' THEN 'data' WHEN substr(NEW.key, 1, 22) = 'graph_label_registry::' THEN 'graph' ELSE 'registry' END, CASE WHEN substr(NEW.key, 1, 30) = 'uqa.statistics.maintenance.v1:' THEN substr(NEW.key, 31) WHEN substr(NEW.key, 1, 21) = 'uqa.table_next_id.v1:' THEN substr(NEW.key, 22) WHEN substr(NEW.key, 1, 22) = 'graph_label_registry::' THEN substr(NEW.key, 23) ELSE '' END, 1) ON CONFLICT(kind, name) DO UPDATE SET generation = generation + 1; END";

#[test]
fn cache_trigger_upgrade_preserves_counters_and_native_history_and_is_idempotent() {
    use uqa_storage::{mvcc::VersionedPersistence, read_control::StorageReadControl};
    for encoding in [0, 1, 2] {
        for native in [false, true] {
            let connection = ManagedConnection::open_in_memory().unwrap();
            let catalog = Catalog::open(connection.clone()).unwrap();
            catalog.save_named_graph("g\0日本語").unwrap();
            let baseline = catalog.cache_revisions().unwrap().graphs;
            let control = StorageReadControl::with_limit(1 << 20);
            let records = native
                .then(|| crate::SQLiteRecordStore::for_native(&connection, &control).unwrap());
            let history = || {
                connection.record_connection().with(|conn| {
            Ok(conn.prepare("SELECT key, sequence, value FROM _uqa_mvcc_versions ORDER BY key, sequence")?
                .query_map([], |row| Ok((row.get::<_, Vec<u8>>(0)?, row.get::<_, Vec<u8>>(1)?, row.get::<_, Option<Vec<u8>>>(2)?)))?
                .collect::<rusqlite::Result<Vec<_>>>()?)
        }).unwrap()
            };
            let before_history = native.then(history);
            connection
                .record_connection()
                .with(|conn| {
                    conn.execute_batch("DROP TRIGGER uqa_cache__metadata_INSERT")?;
                    let mut previous = LEGACY_METADATA_INSERT.to_owned();
                    if encoding != 0 {
                        for offset in [31, 22, 23] {
                            previous = previous.replace(
                                &format!("substr(NEW.key, {offset})"),
                                &format!("CAST(substr(CAST(NEW.key AS BLOB), {offset}) AS TEXT)"),
                            );
                        }
                    }
                    if encoding == 2 {
                        previous = previous.replacen("VALUES (", "SELECT ", 1).replace(
                            ", 1) ON CONFLICT", ", 1 WHERE NEW.key NOT IN ('graph_identifier_generation', 'graph_identifier_data_revision') AND substr(CAST(NEW.key AS BLOB), 1, 32) != CAST('graph_definition_data_revision::' AS BLOB) ON CONFLICT"
                        );
                    }
                    conn.execute_batch(&previous)?;
                    Ok(())
                })
                .unwrap();
            if let Some(records) = records {
                let before = records.snapshot(&control).unwrap().sequence();
                let reopened = crate::SQLiteRecordStore::for_native(&connection, &control).unwrap();
                assert_eq!(reopened.database_id(), records.database_id());
                assert_eq!(reopened.snapshot(&control).unwrap().sequence(), before);
                assert_eq!(Some(history()), before_history);
                connection
                    .bind_native_records(uqa_storage::mvcc::VersionedSessionOptions::default())
                    .unwrap();
            } else {
                Catalog::open(connection.clone()).unwrap();
            }
            assert_eq!(catalog.cache_revisions().unwrap().graphs, baseline);
            let stable = catalog.cache_revisions().unwrap();
            Catalog::open(connection.clone()).unwrap();
            assert_eq!(catalog.cache_revisions().unwrap(), stable);
            catalog
                .set_metadata("graph_label_registry::g\0日本語", "{}")
                .unwrap();
            assert_ne!(catalog.cache_revisions().unwrap().graphs, baseline);
        }
    }
}

#[test]
fn native_conversion_and_reopen_reject_missing_or_changed_cache_tracking() {
    for mapped in [false, true] {
        for changed in [false, true] {
            let connection = ManagedConnection::open_in_memory().unwrap();
            Catalog::open(connection.clone()).unwrap();
            let control = uqa_storage::read_control::StorageReadControl::with_limit(1 << 20);
            if mapped {
                crate::SQLiteRecordStore::for_native(&connection, &control).unwrap();
            }
            connection.record_connection().with(|conn| {
                conn.execute_batch("DROP TRIGGER uqa_cache__metadata_INSERT")?;
                conn.execute_batch(LEGACY_METADATA_INSERT)?;
                conn.execute_batch("DROP TRIGGER uqa_cache__documents_INSERT")?;
                if changed { conn.execute_batch("CREATE TRIGGER uqa_cache__documents_INSERT AFTER INSERT ON _documents BEGIN SELECT 1; END")?; }
                Ok(())
            }).unwrap();
            assert!(crate::SQLiteRecordStore::for_native(&connection, &control).is_err());
            connection
                .record_connection()
                .with(|conn| {
                    let definition: String = conn.query_row(
                        "SELECT sql FROM sqlite_schema WHERE name = 'uqa_cache__metadata_INSERT'",
                        [],
                        |row| row.get(0),
                    )?;
                    assert_eq!(
                        definition, LEGACY_METADATA_INSERT,
                        "failed validation published part of the trigger upgrade"
                    );
                    Ok(())
                })
                .unwrap();
        }
    }
}

#[test]
fn physical_path_pages_and_validity_do_not_invalidate_catalog_definitions() {
    let catalog = fresh();
    catalog.save_named_graph("items").unwrap();
    catalog.save_vertex(1, "Item", "{}").unwrap();
    catalog.save_graph_membership("vertex", 1, "items").unwrap();
    catalog
        .save_path_index("items::links", "[[\"link\"]]")
        .unwrap();
    let before = catalog.cache_revisions().unwrap().registries;
    catalog
        .save_path_index_pairs("items::links", "[\"link\"]", &[(1, 2), (2, 3)])
        .unwrap();
    catalog
        .finish_path_index_data("items::links", "items", "[[\"link\"]]")
        .unwrap();
    assert_eq!(catalog.cache_revisions().unwrap().registries, before);
    catalog
        .save_vertex(1, "Item", "{\"changed\":true}")
        .unwrap();
    assert!(!catalog
        .path_index_data_is_current("items::links", "[[\"link\"]]")
        .unwrap());
    assert_eq!(catalog.cache_revisions().unwrap().registries, before);
    catalog.clear_path_index_data("items::links").unwrap();
    assert_eq!(catalog.cache_revisions().unwrap().registries, before);
    catalog.drop_path_index("items::links").unwrap();
    assert!(catalog.cache_revisions().unwrap().registries > before);
}

#[test]
fn graph_revision_migration_upgrades_existing_graphs_and_legacy_triggers() {
    let connection = ManagedConnection::open_in_memory().unwrap();
    let catalog = Catalog::open(connection.clone()).unwrap();
    catalog.save_named_graph("existing_graph").unwrap();
    catalog.save_vertex(1, "Item", r#"{"value":1}"#).unwrap();
    catalog
        .save_graph_membership("vertex", 1, "existing_graph")
        .unwrap();
    connection.with(|conn| {
        // Reproduce the old graph/metadata triggers, which all invalidated
        // the registry instead of tracking the graph owning the mutation.
        for table in ["_named_graphs", "_graph_vertices", "_graph_edges", "_graph_membership", "_metadata"] {
            for event in ["INSERT", "DELETE", "UPDATE"] {
                let trigger = format!("uqa_cache_{table}_{event}");
                conn.execute_batch(&format!(
                    "DROP TRIGGER {trigger}; CREATE TRIGGER {trigger} AFTER {event} ON {table} BEGIN \
                     INSERT INTO _cache_revisions(kind, name, generation) VALUES ('registry', '', 1) \
                     ON CONFLICT(kind, name) DO UPDATE SET generation = generation + 1; END;"
                ))?;
            }
        }
        conn.execute_batch("DROP INDEX _graph_membership_by_graph; DELETE FROM _cache_revisions WHERE kind = 'graph'; UPDATE _metadata SET value = '44' WHERE key = 'schema_version';")?;
        Ok(())
    }).unwrap();
    drop(catalog);
    let upgraded = Catalog::open(connection.clone()).unwrap();
    assert_eq!(
        upgraded
            .load_named_graph_snapshot("existing_graph")
            .unwrap()
            .unwrap()
            .vertices
            .len(),
        1
    );
    let before = upgraded.cache_revisions().unwrap();
    assert!(before
        .graphs
        .as_ref()
        .unwrap()
        .contains_key("existing_graph"));
    upgraded.save_vertex(1, "Item", r#"{"value":2}"#).unwrap();
    let after = upgraded.cache_revisions().unwrap();
    assert_eq!(before.registries, after.registries);
    assert!(
        after.graphs.as_ref().unwrap()["existing_graph"]
            > before.graphs.as_ref().unwrap()["existing_graph"]
    );
    upgraded
        .set_metadata("graph_label_registry::existing_graph", "{}")
        .unwrap();
    assert_eq!(
        upgraded.cache_revisions().unwrap().registries,
        after.registries
    );
    let after = upgraded.cache_revisions().unwrap();
    drop(upgraded);
    let reopened = Catalog::open(connection).unwrap();
    assert_eq!(
        reopened.cache_revisions().unwrap(),
        after,
        "reopening reran the migration"
    );
}

#[test]
fn cache_revisions_distinguish_data_statistics_and_definitions() {
    let catalog = fresh();
    catalog.save_table(&empty_table("public", "items")).unwrap();
    let before = catalog.cache_revisions().unwrap();
    catalog
        .conn
        .with(|conn| {
            conn.execute(
                "INSERT INTO _documents(table_name, doc_id, body) VALUES ('public.items', 1, '{}')",
                [],
            )?;
            Ok(())
        })
        .unwrap();
    let data = catalog.cache_revisions().unwrap();
    assert_eq!(before.table_catalog, data.table_catalog);
    assert_eq!(before.registries, data.registries);
    assert_eq!(before.column_statistics, data.column_statistics);
    assert_ne!(before.table_data, data.table_data);
    catalog
        .set_metadata("uqa.statistics.maintenance.v1:public.items", "{}")
        .unwrap();
    let maintenance = catalog.cache_revisions().unwrap();
    assert_eq!(data.table_data, maintenance.table_data);
    assert_eq!(data.registries, maintenance.registries);
    assert_ne!(
        data.statistics_maintenance,
        maintenance.statistics_maintenance
    );
    catalog.conn.with(|conn| {
        conn.execute("INSERT INTO _column_stats(table_name, column_name, distinct_count, null_count, row_count) VALUES ('public.items', 'id', 1, 0, 1)", [])?;
        Ok(())
    }).unwrap();
    let stats = catalog.cache_revisions().unwrap();
    assert_eq!(maintenance.table_catalog, stats.table_catalog);
    assert_eq!(maintenance.registries, stats.registries);
    assert_eq!(maintenance.table_data, stats.table_data);
    assert_ne!(maintenance.column_statistics, stats.column_statistics);
}

#[test]
fn cache_revisions_follow_transaction_and_savepoint_visibility() {
    let directory = tempfile::tempdir().unwrap();
    let connection = ManagedConnection::open(&directory.path().join("revisions.db")).unwrap();
    let writer = Catalog::open(connection.clone()).unwrap();
    let observer = Catalog::open(connection.new_session()).unwrap();
    let before = observer.cache_revisions().unwrap();
    connection.begin_transaction().unwrap();
    writer
        .save_table(&empty_table("public", "pending"))
        .unwrap();
    assert_ne!(writer.cache_revisions().unwrap(), before);
    assert_eq!(observer.cache_revisions().unwrap(), before);
    connection.rollback_transaction().unwrap();
    assert_eq!(writer.cache_revisions().unwrap(), before);
    connection.begin_transaction().unwrap();
    writer
        .save_table(&empty_table("public", "committed"))
        .unwrap();
    let after_table = writer.cache_revisions().unwrap();
    connection
        .with(|conn| {
            conn.execute_batch("SAVEPOINT checkpoint")
                .map_err(Into::into)
        })
        .unwrap();
    writer.set_metadata("registry-example", "value").unwrap();
    connection
        .with(|conn| {
            conn.execute_batch("ROLLBACK TO checkpoint; RELEASE checkpoint")
                .map_err(Into::into)
        })
        .unwrap();
    assert_eq!(writer.cache_revisions().unwrap(), after_table);
    connection.commit_transaction().unwrap();
    assert_eq!(observer.cache_revisions().unwrap(), after_table);
}

#[test]
fn graph_revisions_track_memberships_shared_entities_and_label_metadata() {
    let catalog = fresh();
    for name in ["first_graph", "second_graph", "untouched_graph"] {
        catalog.save_named_graph(name).unwrap();
    }
    catalog.save_vertex(1, "Item", "{}").unwrap();
    catalog
        .save_graph_membership("vertex", 1, "first_graph")
        .unwrap();
    catalog
        .save_graph_membership("vertex", 1, "second_graph")
        .unwrap();
    let before = catalog.cache_revisions().unwrap();
    catalog.save_vertex(1, "Item", r#"{"value":2}"#).unwrap();
    let after = catalog.cache_revisions().unwrap();
    assert_eq!(before.registries, after.registries);
    let old = before.graphs.unwrap();
    let graphs = after.graphs.unwrap();
    assert!(graphs["first_graph"] > old["first_graph"]);
    assert!(graphs["second_graph"] > old["second_graph"]);
    assert_eq!(graphs["untouched_graph"], old["untouched_graph"]);
    catalog
        .set_metadata("graph_label_registry::first_graph", "{}")
        .unwrap();
    let labels = catalog.cache_revisions().unwrap();
    assert_eq!(labels.registries, after.registries);
    assert!(labels.graphs.as_ref().unwrap()["first_graph"] > graphs["first_graph"]);
    catalog.set_metadata("unrelated-metadata", "value").unwrap();
    assert_eq!(catalog.cache_revisions().unwrap().graphs, labels.graphs);
}

#[test]
fn graph_revisions_follow_rollback_and_survive_drop_recreate() {
    let catalog = fresh();
    catalog.save_named_graph("versioned_graph").unwrap();
    let before = catalog.cache_revisions().unwrap();
    catalog.conn.begin_transaction().unwrap();
    catalog.save_vertex(1, "Item", "{}").unwrap();
    catalog
        .save_graph_membership("vertex", 1, "versioned_graph")
        .unwrap();
    assert_ne!(catalog.cache_revisions().unwrap().graphs, before.graphs);
    catalog.conn.rollback_transaction().unwrap();
    assert_eq!(catalog.cache_revisions().unwrap(), before);
    catalog.drop_named_graph_data("versioned_graph").unwrap();
    let dropped = catalog.cache_revisions().unwrap().graphs.unwrap()["versioned_graph"];
    catalog.save_named_graph("versioned_graph").unwrap();
    assert!(catalog.cache_revisions().unwrap().graphs.unwrap()["versioned_graph"] > dropped);
}

#[test]
fn graph_snapshot_load_is_scoped_and_rejects_missing_members() {
    let catalog = fresh();
    catalog.save_named_graph("first_graph").unwrap();
    catalog.save_named_graph("second_graph").unwrap();
    for (id, graph) in [(1, "first_graph"), (2, "second_graph")] {
        catalog.save_vertex(id, "Item", "{}").unwrap();
        catalog.save_graph_membership("vertex", id, graph).unwrap();
    }
    let snapshot = catalog
        .load_named_graph_snapshot("first_graph")
        .unwrap()
        .unwrap();
    assert_eq!(snapshot.vertices.len(), 1);
    assert_eq!(snapshot.vertices[0].vertex_id, 1);
    assert!(snapshot.edges.is_empty());
    catalog.delete_vertex(2).unwrap();
    assert!(catalog
        .load_named_graph_snapshot("first_graph")
        .unwrap()
        .is_some());
    assert!(catalog
        .load_named_graph_snapshot("second_graph")
        .unwrap_err()
        .to_string()
        .contains("missing vertex 2"));
    assert!(catalog
        .load_named_graph_snapshot("absent_graph")
        .unwrap()
        .is_none());
    catalog
        .save_graph_membership("vertex", 1, "absent_graph")
        .unwrap();
    assert!(catalog
        .load_named_graph_snapshot("absent_graph")
        .unwrap_err()
        .to_string()
        .contains("unregistered graph"));
}