icydb-core 0.79.1

IcyDB — A type-safe, embedded ORM and schema system for the Internet Computer
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
593
594
595
596
597
598
599
600
601
602
use super::*;

#[test]
fn global_aggregate_value_matrix_matches_expected_values() {
    reset_session_sql_store();
    let session = sql_session();
    seed_session_sql_entities(&session, &[("aggregate-a", 20), ("aggregate-b", 32)]);

    let cases = [
        (
            "count star",
            "SELECT COUNT(*) FROM SessionSqlEntity",
            Value::Uint(2),
        ),
        (
            "count field",
            "SELECT COUNT(age) FROM SessionSqlEntity",
            Value::Uint(2),
        ),
        (
            "sum",
            "SELECT SUM(age) FROM SessionSqlEntity",
            Value::Decimal(crate::types::Decimal::from(52u64)),
        ),
        (
            "avg",
            "SELECT AVG(age) FROM SessionSqlEntity",
            Value::Decimal(crate::types::Decimal::from(26u64)),
        ),
        (
            "min",
            "SELECT MIN(age) FROM SessionSqlEntity",
            Value::Uint(20),
        ),
        (
            "max",
            "SELECT MAX(age) FROM SessionSqlEntity",
            Value::Uint(32),
        ),
        (
            "qualified sum",
            "SELECT SUM(SessionSqlEntity.age) FROM SessionSqlEntity",
            Value::Decimal(crate::types::Decimal::from(52u64)),
        ),
        (
            "empty sum",
            "SELECT SUM(age) FROM SessionSqlEntity WHERE age < 0",
            Value::Null,
        ),
        (
            "empty min",
            "SELECT MIN(age) FROM SessionSqlEntity WHERE age < 0",
            Value::Null,
        ),
        (
            "empty max",
            "SELECT MAX(age) FROM SessionSqlEntity WHERE age < 0",
            Value::Null,
        ),
    ];

    for (context, sql, expected) in cases {
        assert_session_sql_scalar_value::<SessionSqlEntity>(&session, sql, expected, context);
    }
}

#[test]
fn global_aggregate_distinct_value_matrix_matches_expected_values() {
    reset_session_sql_store();
    let session = sql_session();
    seed_session_sql_entities(
        &session,
        &[
            ("aggregate-distinct-a", 20),
            ("aggregate-distinct-b", 20),
            ("aggregate-distinct-c", 32),
        ],
    );

    let cases = [
        (
            "distinct count",
            "SELECT COUNT(DISTINCT age) FROM SessionSqlEntity",
            Value::Uint(2),
        ),
        (
            "distinct sum",
            "SELECT SUM(DISTINCT age) FROM SessionSqlEntity",
            Value::Decimal(crate::types::Decimal::from(52u64)),
        ),
        (
            "distinct avg",
            "SELECT AVG(DISTINCT age) FROM SessionSqlEntity",
            Value::Decimal(crate::types::Decimal::from(26u64)),
        ),
        (
            "distinct min",
            "SELECT MIN(DISTINCT age) FROM SessionSqlEntity",
            Value::Uint(20),
        ),
        (
            "distinct max",
            "SELECT MAX(DISTINCT age) FROM SessionSqlEntity",
            Value::Uint(32),
        ),
    ];

    for (context, sql, expected) in cases {
        assert_session_sql_scalar_value::<SessionSqlEntity>(&session, sql, expected, context);
    }
}

// This parity test is intentionally table-shaped so whole-window and bounded
// aggregate equivalence stay on one readable contract table.
#[expect(
    clippy::too_many_lines,
    reason = "aggregate SQL/fluent parity matrix is intentionally table-shaped"
)]
#[test]
fn global_aggregate_sql_matches_canonical_fluent_terminals() {
    reset_session_sql_store();
    let session = sql_session();
    seed_session_sql_entities(
        &session,
        &[
            ("aggregate-window-a", 20),
            ("aggregate-window-b", 20),
            ("aggregate-window-c", 32),
            ("aggregate-window-d", 40),
        ],
    );

    // Phase 1: prove whole-window aggregate SQL shapes against their
    // canonical fluent terminal representations.
    assert_session_sql_scalar_value::<SessionSqlEntity>(
        &session,
        "SELECT COUNT(*) FROM SessionSqlEntity",
        Value::Uint(u64::from(
            session
                .load::<SessionSqlEntity>()
                .count()
                .expect("fluent count should succeed"),
        )),
        "COUNT(*)",
    );
    assert_session_sql_scalar_value::<SessionSqlEntity>(
        &session,
        "SELECT SUM(age) FROM SessionSqlEntity",
        session
            .load::<SessionSqlEntity>()
            .sum_by("age")
            .expect("fluent sum_by(age) should succeed")
            .map_or(Value::Null, Value::Decimal),
        "SUM(age)",
    );
    assert_session_sql_scalar_value::<SessionSqlEntity>(
        &session,
        "SELECT AVG(age) FROM SessionSqlEntity",
        session
            .load::<SessionSqlEntity>()
            .avg_by("age")
            .expect("fluent avg_by(age) should succeed")
            .map_or(Value::Null, Value::Decimal),
        "AVG(age)",
    );
    assert_session_sql_scalar_value::<SessionSqlEntity>(
        &session,
        "SELECT COUNT(DISTINCT age) FROM SessionSqlEntity",
        Value::Uint(u64::from(
            session
                .load::<SessionSqlEntity>()
                .count_distinct_by("age")
                .expect("fluent count_distinct_by(age) should succeed"),
        )),
        "COUNT(DISTINCT age)",
    );
    assert_session_sql_scalar_value::<SessionSqlEntity>(
        &session,
        "SELECT SUM(DISTINCT age) FROM SessionSqlEntity",
        session
            .load::<SessionSqlEntity>()
            .sum_distinct_by("age")
            .expect("fluent sum_distinct_by(age) should succeed")
            .map_or(Value::Null, Value::Decimal),
        "SUM(DISTINCT age)",
    );
    assert_session_sql_scalar_value::<SessionSqlEntity>(
        &session,
        "SELECT AVG(DISTINCT age) FROM SessionSqlEntity",
        session
            .load::<SessionSqlEntity>()
            .avg_distinct_by("age")
            .expect("fluent avg_distinct_by(age) should succeed")
            .map_or(Value::Null, Value::Decimal),
        "AVG(DISTINCT age)",
    );

    // Phase 2: prove bounded aggregate windows against the same fluent
    // aggregate terminals over equivalent ordered windows.
    assert_session_sql_scalar_value::<SessionSqlEntity>(
        &session,
        "SELECT COUNT(*) FROM SessionSqlEntity ORDER BY age DESC LIMIT 2 OFFSET 1",
        Value::Uint(u64::from(
            session
                .load::<SessionSqlEntity>()
                .order_by_desc("age")
                .limit(2)
                .offset(1)
                .count()
                .expect("bounded fluent count should succeed"),
        )),
        "bounded COUNT(*) window",
    );
    assert_session_sql_scalar_value::<SessionSqlEntity>(
        &session,
        "SELECT SUM(age) FROM SessionSqlEntity ORDER BY age DESC LIMIT 2 OFFSET 1",
        session
            .load::<SessionSqlEntity>()
            .order_by_desc("age")
            .limit(2)
            .offset(1)
            .sum_by("age")
            .expect("bounded fluent sum_by(age) should succeed")
            .map_or(Value::Null, Value::Decimal),
        "bounded SUM(age) window",
    );
    assert_session_sql_scalar_value::<SessionSqlEntity>(
        &session,
        "SELECT AVG(age) FROM SessionSqlEntity ORDER BY age ASC LIMIT 2 OFFSET 1",
        session
            .load::<SessionSqlEntity>()
            .order_by("age")
            .limit(2)
            .offset(1)
            .avg_by("age")
            .expect("bounded fluent avg_by(age) should succeed")
            .map_or(Value::Null, Value::Decimal),
        "bounded AVG(age) window",
    );
}

#[test]
fn fluent_helper_terminals_map_to_admitted_sql_query_terms() {
    reset_session_sql_store();
    let session = sql_session();
    seed_session_sql_entities(
        &session,
        &[
            ("helper-a", 20),
            ("helper-b", 20),
            ("helper-c", 32),
            ("helper-d", 40),
        ],
    );

    // Phase 1: prove existence helpers are only ergonomic sugar over admitted
    // SQL aggregate query terms, not separate capability lanes.
    let existing_count = statement_projection_scalar_value::<SessionSqlEntity>(
        &session,
        "SELECT COUNT(*) FROM SessionSqlEntity",
    )
    .expect("COUNT(*) SQL should execute for exists() parity");
    assert_eq!(
        session
            .load::<SessionSqlEntity>()
            .exists()
            .expect("fluent exists() should succeed"),
        matches!(existing_count, Value::Uint(count) if count > 0),
        "exists() should match COUNT(*) > 0 over the same SQL window",
    );

    let missing_count = statement_projection_scalar_value::<SessionSqlEntity>(
        &session,
        "SELECT COUNT(*) FROM SessionSqlEntity WHERE name = 'missing-helper'",
    )
    .expect("empty COUNT(*) SQL should execute for not_exists() parity");
    assert_eq!(
        session
            .load::<SessionSqlEntity>()
            .filter(Predicate::eq(
                "name".to_string(),
                "missing-helper".to_string().into(),
            ))
            .not_exists()
            .expect("fluent not_exists() should succeed"),
        matches!(missing_count, Value::Uint(0)),
        "not_exists() should match COUNT(*) == 0 over the same SQL window",
    );

    // Phase 2: prove the order-sensitive id helpers map onto ordinary ordered
    // SQL projection windows instead of requiring a separate SQL helper family.
    assert_session_sql_scalar_value::<SessionSqlEntity>(
        &session,
        "SELECT id FROM SessionSqlEntity ORDER BY id ASC LIMIT 1",
        session
            .load::<SessionSqlEntity>()
            .min()
            .expect("fluent min() should succeed")
            .map_or(Value::Null, |id| Value::Ulid(id.key())),
        "min()",
    );
    assert_session_sql_scalar_value::<SessionSqlEntity>(
        &session,
        "SELECT id FROM SessionSqlEntity ORDER BY id DESC LIMIT 1",
        session
            .load::<SessionSqlEntity>()
            .max()
            .expect("fluent max() should succeed")
            .map_or(Value::Null, |id| Value::Ulid(id.key())),
        "max()",
    );
    assert_session_sql_scalar_value::<SessionSqlEntity>(
        &session,
        "SELECT id FROM SessionSqlEntity ORDER BY age ASC, id ASC LIMIT 1",
        session
            .load::<SessionSqlEntity>()
            .min_by("age")
            .expect("fluent min_by(age) should succeed")
            .map_or(Value::Null, |id| Value::Ulid(id.key())),
        "min_by(age)",
    );
    assert_session_sql_scalar_value::<SessionSqlEntity>(
        &session,
        "SELECT id FROM SessionSqlEntity ORDER BY age DESC, id ASC LIMIT 1",
        session
            .load::<SessionSqlEntity>()
            .max_by("age")
            .expect("fluent max_by(age) should succeed")
            .map_or(Value::Null, |id| Value::Ulid(id.key())),
        "max_by(age)",
    );
    assert_session_sql_scalar_value::<SessionSqlEntity>(
        &session,
        "SELECT id FROM SessionSqlEntity ORDER BY age ASC, id ASC LIMIT 1 OFFSET 1",
        session
            .load::<SessionSqlEntity>()
            .nth_by("age", 1)
            .expect("fluent nth_by(age, 1) should succeed")
            .map_or(Value::Null, |id| Value::Ulid(id.key())),
        "nth_by(age, 1)",
    );
}

#[test]
fn global_aggregate_window_matrix_returns_expected_values() {
    // Phase 1: keep the aggregate window semantics table-driven so bounded
    // windows and offset-empty windows stay covered under one contract.
    let cases = [
        (
            "bounded aggregate window",
            vec![
                ("window-a", 10_u64),
                ("window-b", 20_u64),
                ("window-c", 30_u64),
            ],
            vec![
                (
                    "SELECT COUNT(*) FROM SessionSqlEntity ORDER BY age DESC LIMIT 2 OFFSET 1",
                    Value::Uint(2),
                ),
                (
                    "SELECT SUM(age) FROM SessionSqlEntity ORDER BY age DESC LIMIT 1 OFFSET 1",
                    Value::Decimal(crate::types::Decimal::from(20u64)),
                ),
                (
                    "SELECT AVG(age) FROM SessionSqlEntity ORDER BY age ASC LIMIT 2 OFFSET 1",
                    Value::Decimal(crate::types::Decimal::from(25u64)),
                ),
            ],
        ),
        (
            "offset beyond bounded window",
            vec![("beyond-window-a", 10_u64), ("beyond-window-b", 20_u64)],
            vec![
                (
                    "SELECT COUNT(*) FROM SessionSqlEntity ORDER BY age ASC LIMIT 1 OFFSET 10",
                    Value::Uint(0),
                ),
                (
                    "SELECT SUM(age) FROM SessionSqlEntity ORDER BY age ASC LIMIT 1 OFFSET 10",
                    Value::Null,
                ),
                (
                    "SELECT AVG(age) FROM SessionSqlEntity ORDER BY age ASC LIMIT 1 OFFSET 10",
                    Value::Null,
                ),
                (
                    "SELECT MIN(age) FROM SessionSqlEntity ORDER BY age ASC LIMIT 1 OFFSET 10",
                    Value::Null,
                ),
                (
                    "SELECT MAX(age) FROM SessionSqlEntity ORDER BY age ASC LIMIT 1 OFFSET 10",
                    Value::Null,
                ),
            ],
        ),
    ];

    // Phase 2: seed and assert each aggregate window case independently so
    // setup stays local to the expected window semantics.
    for (context, seed_rows, assertions) in cases {
        reset_session_sql_store();
        let session = sql_session();
        seed_session_sql_entities(&session, seed_rows.as_slice());

        for (sql, expected) in assertions {
            assert_session_sql_scalar_value::<SessionSqlEntity>(&session, sql, expected, context);
        }
    }
}

#[test]
fn execute_sql_statement_global_aggregate_payload_matrix_preserves_projection_labels() {
    reset_session_sql_store();
    let session = sql_session();

    for (sql, expected_columns, context) in [
        (
            "SELECT COUNT(*) FROM SessionSqlEntity",
            vec!["COUNT(*)".to_string()],
            "plain global aggregate statement payload",
        ),
        (
            "SELECT COUNT(*) AS total_rows FROM SessionSqlEntity",
            vec!["total_rows".to_string()],
            "aliased global aggregate statement payload",
        ),
    ] {
        let payload = execute_sql_statement_for_tests::<SessionSqlEntity>(&session, sql)
            .unwrap_or_else(|err| panic!("{context} should succeed: {err}"));

        let SqlStatementResult::Projection {
            columns,
            rows,
            row_count,
        } = payload
        else {
            panic!("{context} should return projection payload");
        };

        assert_eq!(
            columns, expected_columns,
            "{context} should preserve aggregate projection labels",
        );
        assert_eq!(
            rows,
            vec![vec![Value::Uint(0)]],
            "{context} should preserve empty-store scalar aggregate value",
        );
        assert_eq!(
            row_count, 1,
            "{context} should expose one scalar aggregate row",
        );
    }
}

#[test]
fn global_aggregate_matrix_queries_match_expected_values() {
    reset_session_sql_store();
    let session = sql_session();

    // Phase 1: seed deterministic rows used by aggregate matrix queries.
    seed_session_sql_entities(
        &session,
        &[
            ("agg-matrix-a", 10),
            ("agg-matrix-b", 10),
            ("agg-matrix-c", 20),
            ("agg-matrix-d", 30),
            ("agg-matrix-e", 30),
            ("agg-matrix-f", 30),
        ],
    );

    // Phase 2: execute table-driven aggregate SQL cases.
    let cases = vec![
        ("SELECT COUNT(*) FROM SessionSqlEntity", Value::Uint(6)),
        (
            "SELECT SUM(age) FROM SessionSqlEntity",
            Value::Decimal(crate::types::Decimal::from(130_u64)),
        ),
        (
            "SELECT AVG(age) FROM SessionSqlEntity ORDER BY age DESC LIMIT 2",
            Value::Decimal(crate::types::Decimal::from(30_u64)),
        ),
        (
            "SELECT MIN(age) FROM SessionSqlEntity WHERE age >= 20",
            Value::Uint(20),
        ),
        (
            "SELECT MAX(age) FROM SessionSqlEntity WHERE age <= 20",
            Value::Uint(20),
        ),
        (
            "SELECT COUNT(*) FROM SessionSqlEntity WHERE age < 0",
            Value::Uint(0),
        ),
        (
            "SELECT SUM(age) FROM SessionSqlEntity WHERE age < 0",
            Value::Null,
        ),
    ];

    // Phase 3: assert aggregate outputs for each SQL input.
    for (sql, expected_value) in cases {
        assert_session_sql_scalar_value::<SessionSqlEntity>(&session, sql, expected_value, sql);
    }
}

#[test]
fn sql_aggregate_unknown_target_field_matrix_stays_fail_closed() {
    reset_session_sql_store();
    let session = sql_session();

    let cases = [
        (
            statement_projection_rows::<SessionSqlEntity>(
                &session,
                "SELECT SUM(missing_field) FROM SessionSqlEntity",
            )
            .map(|_| ()),
            "global aggregate statement unknown target field",
        ),
        (
            statement_explain_sql::<SessionSqlEntity>(
                &session,
                "EXPLAIN EXECUTION SELECT SUM(missing_field) FROM SessionSqlEntity",
            )
            .map(|_| ()),
            "global aggregate EXPLAIN unknown target field",
        ),
    ];

    for (result, context) in cases {
        let err = result.expect_err("unknown aggregate target field should fail");

        assert!(
            matches!(
                err,
                QueryError::Execute(crate::db::query::intent::QueryExecutionError::Unsupported(
                    _
                ))
            ),
            "{context} should map to unsupported execution error boundary",
        );
    }
}

#[test]
fn explain_sql_global_aggregate_surface_matrix_returns_expected_tokens() {
    reset_session_sql_store();
    let session = sql_session();

    let cases = [
        (
            "logical aggregate explain",
            "EXPLAIN SELECT COUNT(*) FROM SessionSqlEntity",
            vec!["mode=Load", "access="],
            false,
        ),
        (
            "execution aggregate explain",
            "EXPLAIN EXECUTION SELECT COUNT(*) FROM SessionSqlEntity",
            vec!["AggregateCount execution_mode=", "node_id=0"],
            false,
        ),
        (
            "json aggregate explain",
            "EXPLAIN JSON SELECT COUNT(*) FROM SessionSqlEntity",
            vec!["\"mode\":{\"type\":\"Load\""],
            true,
        ),
    ];

    for (context, sql, tokens, require_json_object) in cases {
        assert_session_sql_explain_tokens::<SessionSqlEntity>(
            &session,
            sql,
            tokens.as_slice(),
            require_json_object,
            context,
        );
    }

    let qualified = statement_explain_sql::<SessionSqlEntity>(
        &session,
        "EXPLAIN JSON SELECT SUM(SessionSqlEntity.age) \
             FROM public.SessionSqlEntity \
             WHERE SessionSqlEntity.age >= 21",
    )
    .expect("qualified global aggregate EXPLAIN JSON should succeed");
    let unqualified = statement_explain_sql::<SessionSqlEntity>(
        &session,
        "EXPLAIN JSON SELECT SUM(age) FROM SessionSqlEntity WHERE age >= 21",
    )
    .expect("unqualified global aggregate EXPLAIN JSON should succeed");

    assert_eq!(
        qualified, unqualified,
        "qualified identifiers should normalize to the same global aggregate EXPLAIN JSON output",
    );
}