citadeldb-sql 0.7.0

SQL parser, planner, and executor for Citadel encrypted database
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
use citadel::{Argon2Profile, DatabaseBuilder};
use citadel_sql::{Connection, ExecutionResult, Value};

fn create_db(dir: &std::path::Path) -> citadel::Database {
    let db_path = dir.join("test.db");
    DatabaseBuilder::new(db_path)
        .passphrase(b"test-passphrase")
        .argon2_profile(Argon2Profile::Iot)
        .create()
        .unwrap()
}

fn open_db(dir: &std::path::Path) -> citadel::Database {
    let db_path = dir.join("test.db");
    DatabaseBuilder::new(db_path)
        .passphrase(b"test-passphrase")
        .argon2_profile(Argon2Profile::Iot)
        .open()
        .unwrap()
}

fn assert_rows_affected(result: ExecutionResult, expected: u64) {
    match result {
        ExecutionResult::RowsAffected(n) => assert_eq!(n, expected),
        other => panic!("expected RowsAffected({expected}), got {other:?}"),
    }
}

fn assert_ok(result: ExecutionResult) {
    match result {
        ExecutionResult::Ok => {}
        other => panic!("expected Ok, got {other:?}"),
    }
}

fn setup_users(conn: &mut Connection) {
    assert_ok(conn.execute(
        "CREATE TABLE users (id INTEGER NOT NULL PRIMARY KEY, name TEXT, email TEXT, age INTEGER)"
    ).unwrap());
    assert_rows_affected(
        conn.execute(
            "INSERT INTO users (id, name, email, age) VALUES (1, 'Alice', 'alice@test.com', 30)",
        )
        .unwrap(),
        1,
    );
    assert_rows_affected(
        conn.execute(
            "INSERT INTO users (id, name, email, age) VALUES (2, 'Bob', 'bob@test.com', 25)",
        )
        .unwrap(),
        1,
    );
    assert_rows_affected(conn.execute(
        "INSERT INTO users (id, name, email, age) VALUES (3, 'Charlie', 'charlie@test.com', 35)"
    ).unwrap(), 1);
}

// ═══════════════════════════════════════════════════════════════════
//  Stress tests
// ═══════════════════════════════════════════════════════════════════

#[test]
fn stress_many_views() {
    let dir = tempfile::tempdir().unwrap();
    let db = create_db(dir.path());
    let mut conn = Connection::open(&db).unwrap();
    setup_users(&mut conn);

    for i in 0..20 {
        assert_ok(
            conn.execute(&format!(
                "CREATE VIEW v{i} AS SELECT * FROM users WHERE age >= {}",
                20 + i
            ))
            .unwrap(),
        );
    }

    for i in 0..20 {
        let qr = conn.query(&format!("SELECT COUNT(*) FROM v{i}")).unwrap();
        let count = match &qr.rows[0][0] {
            Value::Integer(n) => *n,
            _ => panic!("expected integer"),
        };
        assert!((0..=3).contains(&count));
    }
}

#[test]
fn stress_deeply_nested_views() {
    let dir = tempfile::tempdir().unwrap();
    let db = create_db(dir.path());
    let mut conn = Connection::open(&db).unwrap();
    setup_users(&mut conn);

    assert_ok(
        conn.execute("CREATE VIEW v0 AS SELECT * FROM users")
            .unwrap(),
    );
    for i in 1..=5 {
        assert_ok(
            conn.execute(&format!("CREATE VIEW v{i} AS SELECT * FROM v{}", i - 1))
                .unwrap(),
        );
    }

    let qr = conn.query("SELECT COUNT(*) FROM v5").unwrap();
    assert_eq!(qr.rows[0][0], Value::Integer(3));
}

#[test]
fn stress_view_on_large_table() {
    let dir = tempfile::tempdir().unwrap();
    let db = create_db(dir.path());
    let mut conn = Connection::open(&db).unwrap();

    assert_ok(
        conn.execute("CREATE TABLE big (id INTEGER NOT NULL PRIMARY KEY, val INTEGER)")
            .unwrap(),
    );

    conn.execute("BEGIN").unwrap();
    for i in 0..200 {
        assert_rows_affected(
            conn.execute(&format!(
                "INSERT INTO big (id, val) VALUES ({i}, {})",
                i % 10
            ))
            .unwrap(),
            1,
        );
    }
    conn.execute("COMMIT").unwrap();

    assert_ok(
        conn.execute("CREATE VIEW v AS SELECT * FROM big WHERE val < 5")
            .unwrap(),
    );

    let qr = conn.query("SELECT COUNT(*) FROM v").unwrap();
    assert_eq!(qr.rows[0][0], Value::Integer(100));
}

#[test]
fn stress_create_drop_cycle() {
    let dir = tempfile::tempdir().unwrap();
    let db = create_db(dir.path());
    let mut conn = Connection::open(&db).unwrap();
    setup_users(&mut conn);

    for _ in 0..10 {
        assert_ok(
            conn.execute("CREATE VIEW v AS SELECT * FROM users")
                .unwrap(),
        );
        let qr = conn.query("SELECT COUNT(*) FROM v").unwrap();
        assert_eq!(qr.rows[0][0], Value::Integer(3));
        assert_ok(conn.execute("DROP VIEW v").unwrap());
    }
}

#[test]
fn stress_multiple_selects_different_where() {
    let dir = tempfile::tempdir().unwrap();
    let db = create_db(dir.path());
    let mut conn = Connection::open(&db).unwrap();
    setup_users(&mut conn);

    assert_ok(
        conn.execute("CREATE VIEW v AS SELECT * FROM users")
            .unwrap(),
    );

    let qr = conn.query("SELECT * FROM v WHERE age = 25").unwrap();
    assert_eq!(qr.rows.len(), 1);

    let qr = conn.query("SELECT * FROM v WHERE age = 30").unwrap();
    assert_eq!(qr.rows.len(), 1);

    let qr = conn.query("SELECT * FROM v WHERE age > 24").unwrap();
    assert_eq!(qr.rows.len(), 3);

    let qr = conn.query("SELECT * FROM v WHERE name LIKE 'A%'").unwrap();
    assert_eq!(qr.rows.len(), 1);
}

#[test]
fn stress_view_over_indexed_table() {
    let dir = tempfile::tempdir().unwrap();
    let db = create_db(dir.path());
    let mut conn = Connection::open(&db).unwrap();
    setup_users(&mut conn);

    assert_ok(conn.execute("CREATE INDEX idx_age ON users (age)").unwrap());
    assert_ok(
        conn.execute("CREATE UNIQUE INDEX idx_email ON users (email)")
            .unwrap(),
    );

    assert_ok(
        conn.execute("CREATE VIEW v AS SELECT * FROM users")
            .unwrap(),
    );

    let qr = conn.query("SELECT * FROM v WHERE age = 30").unwrap();
    assert_eq!(qr.rows.len(), 1);
    assert_eq!(qr.rows[0][1], Value::Text("Alice".into()));
}

// ═══════════════════════════════════════════════════════════════════
//  Complex interactions
// ═══════════════════════════════════════════════════════════════════

#[test]
fn view_with_prepared_stmt() {
    let dir = tempfile::tempdir().unwrap();
    let db = create_db(dir.path());
    let mut conn = Connection::open(&db).unwrap();
    setup_users(&mut conn);

    assert_ok(
        conn.execute("CREATE VIEW v AS SELECT * FROM users")
            .unwrap(),
    );

    let qr = conn
        .query_params("SELECT * FROM v WHERE age > $1", &[Value::Integer(28)])
        .unwrap();
    assert_eq!(qr.rows.len(), 2);
}

#[test]
fn view_union_with_table() {
    let dir = tempfile::tempdir().unwrap();
    let db = create_db(dir.path());
    let mut conn = Connection::open(&db).unwrap();
    setup_users(&mut conn);

    assert_ok(conn.execute(
        "CREATE TABLE admins (id INTEGER NOT NULL PRIMARY KEY, name TEXT, email TEXT, age INTEGER)"
    ).unwrap());
    assert_rows_affected(
        conn.execute(
            "INSERT INTO admins (id, name, email, age) VALUES (100, 'Root', 'root@test.com', 50)",
        )
        .unwrap(),
        1,
    );

    assert_ok(
        conn.execute("CREATE VIEW v AS SELECT id, name FROM users")
            .unwrap(),
    );

    let qr = conn
        .query("SELECT id, name FROM v UNION ALL SELECT id, name FROM admins")
        .unwrap();
    assert_eq!(qr.rows.len(), 4);
}

#[test]
fn view_in_cte_body() {
    let dir = tempfile::tempdir().unwrap();
    let db = create_db(dir.path());
    let mut conn = Connection::open(&db).unwrap();
    setup_users(&mut conn);

    assert_ok(
        conn.execute("CREATE VIEW adults AS SELECT * FROM users WHERE age >= 30")
            .unwrap(),
    );

    let qr = conn.query(
        "WITH adult_names AS (SELECT name FROM adults) SELECT name FROM adult_names ORDER BY name"
    ).unwrap();
    assert_eq!(qr.rows.len(), 2);
    assert_eq!(qr.rows[0][0], Value::Text("Alice".into()));
    assert_eq!(qr.rows[1][0], Value::Text("Charlie".into()));
}

#[test]
fn view_with_case_between_like() {
    let dir = tempfile::tempdir().unwrap();
    let db = create_db(dir.path());
    let mut conn = Connection::open(&db).unwrap();
    setup_users(&mut conn);

    assert_ok(
        conn.execute("CREATE VIEW v AS SELECT * FROM users")
            .unwrap(),
    );

    let qr = conn
        .query("SELECT name, CASE WHEN age >= 30 THEN 'senior' ELSE 'junior' END AS tier FROM v")
        .unwrap();
    assert_eq!(qr.rows.len(), 3);

    let qr = conn
        .query("SELECT * FROM v WHERE age BETWEEN 25 AND 30")
        .unwrap();
    assert_eq!(qr.rows.len(), 2);

    let qr = conn
        .query("SELECT * FROM v WHERE name LIKE '%li%'")
        .unwrap();
    assert_eq!(qr.rows.len(), 2); // Alice, Charlie
}

#[test]
fn view_with_coalesce_cast() {
    let dir = tempfile::tempdir().unwrap();
    let db = create_db(dir.path());
    let mut conn = Connection::open(&db).unwrap();
    setup_users(&mut conn);

    assert_ok(
        conn.execute("CREATE VIEW v AS SELECT * FROM users")
            .unwrap(),
    );

    let qr = conn
        .query("SELECT COALESCE(email, 'none') FROM v WHERE id = 1")
        .unwrap();
    assert_eq!(qr.rows[0][0], Value::Text("alice@test.com".into()));

    let qr = conn
        .query("SELECT CAST(age AS REAL) FROM v WHERE id = 1")
        .unwrap();
    assert_eq!(qr.rows[0][0], Value::Real(30.0));
}

#[test]
fn view_over_constrained_table() {
    let dir = tempfile::tempdir().unwrap();
    let db = create_db(dir.path());
    let mut conn = Connection::open(&db).unwrap();

    assert_ok(conn.execute(
        "CREATE TABLE items (id INTEGER NOT NULL PRIMARY KEY, name TEXT NOT NULL, price REAL CHECK (price > 0))"
    ).unwrap());
    assert_rows_affected(
        conn.execute("INSERT INTO items (id, name, price) VALUES (1, 'Widget', 9.99)")
            .unwrap(),
        1,
    );
    assert_rows_affected(
        conn.execute("INSERT INTO items (id, name, price) VALUES (2, 'Gadget', 19.99)")
            .unwrap(),
        1,
    );

    assert_ok(
        conn.execute("CREATE VIEW v AS SELECT * FROM items")
            .unwrap(),
    );

    let qr = conn.query("SELECT * FROM v ORDER BY price").unwrap();
    assert_eq!(qr.rows.len(), 2);
    assert_eq!(qr.rows[0][1], Value::Text("Widget".into()));
}

#[test]
fn explain_view_query() {
    let dir = tempfile::tempdir().unwrap();
    let db = create_db(dir.path());
    let mut conn = Connection::open(&db).unwrap();
    setup_users(&mut conn);

    assert_ok(
        conn.execute("CREATE VIEW v AS SELECT * FROM users")
            .unwrap(),
    );

    let qr = conn.query("EXPLAIN SELECT * FROM v WHERE id = 1").unwrap();
    assert!(!qr.rows.is_empty());
    // After fusion, should reference real table "users"
    let plan = match &qr.rows[0][0] {
        Value::Text(s) => s.to_string(),
        _ => panic!("expected text"),
    };
    assert!(
        plan.contains("users"),
        "plan should reference real table: {plan}"
    );
}

// ═══════════════════════════════════════════════════════════════════
//  Performance: fusion verification
// ═══════════════════════════════════════════════════════════════════

#[test]
fn fusion_simple_view_merges_where() {
    let dir = tempfile::tempdir().unwrap();
    let db = create_db(dir.path());
    let mut conn = Connection::open(&db).unwrap();
    setup_users(&mut conn);

    assert_ok(
        conn.execute("CREATE VIEW active AS SELECT * FROM users WHERE age >= 25")
            .unwrap(),
    );

    // After fusion: SELECT * FROM users WHERE age >= 25 AND age <= 30
    let qr = conn
        .query("SELECT name FROM active WHERE age <= 30 ORDER BY name")
        .unwrap();
    assert_eq!(qr.rows.len(), 2);
    assert_eq!(qr.rows[0][0], Value::Text("Alice".into()));
    assert_eq!(qr.rows[1][0], Value::Text("Bob".into()));
}

#[test]
fn fusion_view_with_pk_lookup() {
    let dir = tempfile::tempdir().unwrap();
    let db = create_db(dir.path());
    let mut conn = Connection::open(&db).unwrap();
    setup_users(&mut conn);

    assert_ok(
        conn.execute("CREATE VIEW v AS SELECT * FROM users")
            .unwrap(),
    );

    // After fusion: SELECT * FROM users WHERE id = 1 → PK lookup
    let qr = conn.query("SELECT name FROM v WHERE id = 1").unwrap();
    assert_eq!(qr.rows.len(), 1);
    assert_eq!(qr.rows[0][0], Value::Text("Alice".into()));

    // Verify via EXPLAIN
    let explain = conn
        .query("EXPLAIN SELECT name FROM v WHERE id = 1")
        .unwrap();
    let plan = match &explain.rows[0][0] {
        Value::Text(s) => s.to_string(),
        _ => panic!("expected text"),
    };
    assert!(
        plan.contains("PRIMARY KEY") || plan.contains("SEARCH"),
        "should use PK: {plan}"
    );
}

#[test]
fn complex_view_does_not_fuse() {
    let dir = tempfile::tempdir().unwrap();
    let db = create_db(dir.path());
    let mut conn = Connection::open(&db).unwrap();
    setup_users(&mut conn);

    // View with GROUP BY — cannot fuse
    assert_ok(
        conn.execute(
            "CREATE VIEW age_counts AS SELECT age, COUNT(*) AS cnt FROM users GROUP BY age",
        )
        .unwrap(),
    );

    let qr = conn.query("SELECT * FROM age_counts ORDER BY age").unwrap();
    assert_eq!(qr.rows.len(), 3);

    // View with DISTINCT — cannot fuse
    assert_ok(
        conn.execute("CREATE VIEW unique_ages AS SELECT DISTINCT age FROM users")
            .unwrap(),
    );

    let qr = conn
        .query("SELECT * FROM unique_ages ORDER BY age")
        .unwrap();
    assert_eq!(qr.rows.len(), 3);
}

#[test]
fn persistence_cycle_with_views() {
    let dir = tempfile::tempdir().unwrap();

    {
        let db = create_db(dir.path());
        let mut conn = Connection::open(&db).unwrap();
        setup_users(&mut conn);
        assert_ok(
            conn.execute("CREATE VIEW v AS SELECT * FROM users WHERE age >= 30")
                .unwrap(),
        );
    }

    for _ in 0..3 {
        let db = open_db(dir.path());
        let mut conn = Connection::open(&db).unwrap();
        let qr = conn.query("SELECT COUNT(*) FROM v").unwrap();
        assert_eq!(qr.rows[0][0], Value::Integer(2));
    }
}