sqlitegraph 2.1.2

Embedded graph database with full ACID transactions, HNSW vector search, dual backend support, and comprehensive graph algorithms library
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
//! SQLite backend snapshot isolation validation tests
//!
//! These tests verify that the SQLite backend correctly rejects historical
//! snapshot requests and only accepts SnapshotId::current().
//!
//! **Background**: SQLite backend does not support historical snapshot isolation.
//! Only SnapshotId::current() (which has as_lsn() == 0) is supported.
//!
//! Historical snapshot isolation would require:
//! - WAL-based versioning with timestamp/LSN indexing
//! - AS OF queries or point-in-time recovery mechanisms
//! - Multi-version concurrency control (MVCC) extensions
//!
//! These are not implemented in the current SQLite backend.

use sqlitegraph::{
    NodeSpec, SnapshotId,
    backend::{BackendDirection, GraphBackend, NeighborQuery, SqliteGraphBackend},
    multi_hop::ChainStep,
    pattern::PatternQuery,
};

/// Test that historical snapshot_id (non-zero LSN) is rejected in get_node
#[test]
fn test_sqlite_historical_snapshot_rejected_get_node() {
    let backend = SqliteGraphBackend::in_memory().unwrap();

    // Insert a test node
    let node_id = backend
        .insert_node(NodeSpec {
            kind: "test".to_string(),
            name: "test_node".to_string(),
            file_path: None,
            data: serde_json::json!(null),
        })
        .unwrap();

    // Historical snapshot should be rejected
    let historical_snapshot = SnapshotId::from_lsn(12345);
    let result = backend.get_node(historical_snapshot, node_id);

    assert!(result.is_err(), "Historical snapshot should be rejected");
    let err_msg = result.unwrap_err().to_string();
    assert!(
        err_msg.contains("does not support historical snapshots"),
        "Error message should explain limitation: {}",
        err_msg
    );
}

/// Test that SnapshotId::current() (lsn == 0) works in get_node
#[test]
fn test_sqlite_current_snapshot_works_get_node() {
    let backend = SqliteGraphBackend::in_memory().unwrap();

    // Insert a test node
    let node_id = backend
        .insert_node(NodeSpec {
            kind: "test".to_string(),
            name: "test_node".to_string(),
            file_path: None,
            data: serde_json::json!(null),
        })
        .unwrap();

    // Current snapshot should work
    let current_snapshot = SnapshotId::current();
    let result = backend.get_node(current_snapshot, node_id);

    assert!(result.is_ok(), "Current snapshot should work: {:?}", result);
    let node = result.unwrap();
    assert_eq!(node.name, "test_node");
}

/// Test that historical snapshot_id is rejected in neighbors
#[test]
fn test_sqlite_historical_snapshot_rejected_neighbors() {
    let backend = SqliteGraphBackend::in_memory().unwrap();

    // Insert two test nodes and an edge
    let node1 = backend
        .insert_node(NodeSpec {
            kind: "test".to_string(),
            name: "node1".to_string(),
            file_path: None,
            data: serde_json::json!(null),
        })
        .unwrap();
    let node2 = backend
        .insert_node(NodeSpec {
            kind: "test".to_string(),
            name: "node2".to_string(),
            file_path: None,
            data: serde_json::json!(null),
        })
        .unwrap();

    backend
        .insert_edge(sqlitegraph::EdgeSpec {
            from: node1,
            to: node2,
            edge_type: "test_edge".to_string(),
            data: serde_json::json!(null),
        })
        .unwrap();

    // Historical snapshot should be rejected
    let historical_snapshot = SnapshotId::from_lsn(999);
    let query = NeighborQuery {
        direction: BackendDirection::Outgoing,
        edge_type: None,
    };
    let result = backend.neighbors(historical_snapshot, node1, query);

    assert!(
        result.is_err(),
        "Historical snapshot should be rejected in neighbors"
    );
    let err_msg = result.unwrap_err().to_string();
    assert!(
        err_msg.contains("does not support historical snapshots"),
        "Error message should explain limitation: {}",
        err_msg
    );
}

/// Test that historical snapshot_id is rejected in bfs
#[test]
fn test_sqlite_historical_snapshot_rejected_bfs() {
    let backend = SqliteGraphBackend::in_memory().unwrap();

    // Insert test nodes
    let node1 = backend
        .insert_node(NodeSpec {
            kind: "test".to_string(),
            name: "node1".to_string(),
            file_path: None,
            data: serde_json::json!(null),
        })
        .unwrap();

    // Historical snapshot should be rejected in bfs
    let historical_snapshot = SnapshotId::from_lsn(555);
    let result = backend.bfs(historical_snapshot, node1, 2);

    assert!(
        result.is_err(),
        "Historical snapshot should be rejected in bfs"
    );
    let err_msg = result.unwrap_err().to_string();
    assert!(
        err_msg.contains("does not support historical snapshots"),
        "Error message should explain limitation: {}",
        err_msg
    );
}

/// Test that historical snapshot_id is rejected in shortest_path
#[test]
fn test_sqlite_historical_snapshot_rejected_shortest_path() {
    let backend = SqliteGraphBackend::in_memory().unwrap();

    // Insert test nodes
    let node1 = backend
        .insert_node(NodeSpec {
            kind: "test".to_string(),
            name: "node1".to_string(),
            file_path: None,
            data: serde_json::json!(null),
        })
        .unwrap();
    let node2 = backend
        .insert_node(NodeSpec {
            kind: "test".to_string(),
            name: "node2".to_string(),
            file_path: None,
            data: serde_json::json!(null),
        })
        .unwrap();

    // Historical snapshot should be rejected in shortest_path
    let historical_snapshot = SnapshotId::from_lsn(777);
    let result = backend.shortest_path(historical_snapshot, node1, node2);

    assert!(
        result.is_err(),
        "Historical snapshot should be rejected in shortest_path"
    );
    let err_msg = result.unwrap_err().to_string();
    assert!(
        err_msg.contains("does not support historical snapshots"),
        "Error message should explain limitation: {}",
        err_msg
    );
}

/// Test that historical snapshot_id is rejected in node_degree
#[test]
fn test_sqlite_historical_snapshot_rejected_node_degree() {
    let backend = SqliteGraphBackend::in_memory().unwrap();

    // Insert test node
    let node1 = backend
        .insert_node(NodeSpec {
            kind: "test".to_string(),
            name: "node1".to_string(),
            file_path: None,
            data: serde_json::json!(null),
        })
        .unwrap();

    // Historical snapshot should be rejected in node_degree
    let historical_snapshot = SnapshotId::from_lsn(333);
    let result = backend.node_degree(historical_snapshot, node1);

    assert!(
        result.is_err(),
        "Historical snapshot should be rejected in node_degree"
    );
    let err_msg = result.unwrap_err().to_string();
    assert!(
        err_msg.contains("does not support historical snapshots"),
        "Error message should explain limitation: {}",
        err_msg
    );
}

/// Test that historical snapshot_id is rejected in k_hop
#[test]
fn test_sqlite_historical_snapshot_rejected_k_hop() {
    let backend = SqliteGraphBackend::in_memory().unwrap();

    // Insert test node
    let node1 = backend
        .insert_node(NodeSpec {
            kind: "test".to_string(),
            name: "node1".to_string(),
            file_path: None,
            data: serde_json::json!(null),
        })
        .unwrap();

    // Historical snapshot should be rejected in k_hop
    let historical_snapshot = SnapshotId::from_lsn(444);
    let result = backend.k_hop(historical_snapshot, node1, 2, BackendDirection::Outgoing);

    assert!(
        result.is_err(),
        "Historical snapshot should be rejected in k_hop"
    );
    let err_msg = result.unwrap_err().to_string();
    assert!(
        err_msg.contains("does not support historical snapshots"),
        "Error message should explain limitation: {}",
        err_msg
    );
}

/// Test that historical snapshot_id is rejected in k_hop_filtered
#[test]
fn test_sqlite_historical_snapshot_rejected_k_hop_filtered() {
    let backend = SqliteGraphBackend::in_memory().unwrap();

    // Insert test node
    let node1 = backend
        .insert_node(NodeSpec {
            kind: "test".to_string(),
            name: "node1".to_string(),
            file_path: None,
            data: serde_json::json!(null),
        })
        .unwrap();

    // Historical snapshot should be rejected in k_hop_filtered
    let historical_snapshot = SnapshotId::from_lsn(666);
    let allowed_types = vec!["test_edge"];
    let result = backend.k_hop_filtered(
        historical_snapshot,
        node1,
        2,
        BackendDirection::Outgoing,
        &allowed_types,
    );

    assert!(
        result.is_err(),
        "Historical snapshot should be rejected in k_hop_filtered"
    );
    let err_msg = result.unwrap_err().to_string();
    assert!(
        err_msg.contains("does not support historical snapshots"),
        "Error message should explain limitation: {}",
        err_msg
    );
}

/// Test that historical snapshot_id is rejected in chain_query
#[test]
fn test_sqlite_historical_snapshot_rejected_chain_query() {
    let backend = SqliteGraphBackend::in_memory().unwrap();

    // Insert test node
    let node1 = backend
        .insert_node(NodeSpec {
            kind: "test".to_string(),
            name: "node1".to_string(),
            file_path: None,
            data: serde_json::json!(null),
        })
        .unwrap();

    // Historical snapshot should be rejected in chain_query
    let historical_snapshot = SnapshotId::from_lsn(888);
    let chain = vec![ChainStep {
        direction: BackendDirection::Outgoing,
        edge_type: None,
    }];
    let result = backend.chain_query(historical_snapshot, node1, &chain);

    assert!(
        result.is_err(),
        "Historical snapshot should be rejected in chain_query"
    );
    let err_msg = result.unwrap_err().to_string();
    assert!(
        err_msg.contains("does not support historical snapshots"),
        "Error message should explain limitation: {}",
        err_msg
    );
}

/// Test that historical snapshot_id is rejected in pattern_search
#[test]
fn test_sqlite_historical_snapshot_rejected_pattern_search() {
    let backend = SqliteGraphBackend::in_memory().unwrap();

    // Insert test node
    let node1 = backend
        .insert_node(NodeSpec {
            kind: "test".to_string(),
            name: "node1".to_string(),
            file_path: None,
            data: serde_json::json!(null),
        })
        .unwrap();

    // Historical snapshot should be rejected in pattern_search
    let historical_snapshot = SnapshotId::from_lsn(111);
    let pattern = PatternQuery::default();
    let result = backend.pattern_search(historical_snapshot, node1, &pattern);

    assert!(
        result.is_err(),
        "Historical snapshot should be rejected in pattern_search"
    );
    let err_msg = result.unwrap_err().to_string();
    assert!(
        err_msg.contains("does not support historical snapshots"),
        "Error message should explain limitation: {}",
        err_msg
    );
}

/// Test that historical snapshot_id is rejected in query_nodes_by_kind
#[test]
fn test_sqlite_historical_snapshot_rejected_query_nodes_by_kind() {
    let backend = SqliteGraphBackend::in_memory().unwrap();

    // Insert test node
    backend
        .insert_node(NodeSpec {
            kind: "test_kind".to_string(),
            name: "node1".to_string(),
            file_path: None,
            data: serde_json::json!(null),
        })
        .unwrap();

    // Historical snapshot should be rejected in query_nodes_by_kind
    let historical_snapshot = SnapshotId::from_lsn(222);
    let result = backend.query_nodes_by_kind(historical_snapshot, "test_kind");

    assert!(
        result.is_err(),
        "Historical snapshot should be rejected in query_nodes_by_kind"
    );
    let err_msg = result.unwrap_err().to_string();
    assert!(
        err_msg.contains("does not support historical snapshots"),
        "Error message should explain limitation: {}",
        err_msg
    );
}

/// Test that historical snapshot_id is rejected in query_nodes_by_name_pattern
#[test]
fn test_sqlite_historical_snapshot_rejected_query_nodes_by_name_pattern() {
    let backend = SqliteGraphBackend::in_memory().unwrap();

    // Insert test node
    backend
        .insert_node(NodeSpec {
            kind: "test".to_string(),
            name: "node1".to_string(),
            file_path: None,
            data: serde_json::json!(null),
        })
        .unwrap();

    // Historical snapshot should be rejected in query_nodes_by_name_pattern
    let historical_snapshot = SnapshotId::from_lsn(333);
    let result = backend.query_nodes_by_name_pattern(historical_snapshot, "node*");

    assert!(
        result.is_err(),
        "Historical snapshot should be rejected in query_nodes_by_name_pattern"
    );
    let err_msg = result.unwrap_err().to_string();
    assert!(
        err_msg.contains("does not support historical snapshots"),
        "Error message should explain limitation: {}",
        err_msg
    );
}

/// Test that SnapshotId::current() works for all operations
#[test]
fn test_sqlite_current_snapshot_works_all_operations() {
    let backend = SqliteGraphBackend::in_memory().unwrap();

    // Create a simple graph
    let node1 = backend
        .insert_node(NodeSpec {
            kind: "test".to_string(),
            name: "node1".to_string(),
            file_path: None,
            data: serde_json::json!(null),
        })
        .unwrap();
    let node2 = backend
        .insert_node(NodeSpec {
            kind: "test".to_string(),
            name: "node2".to_string(),
            file_path: None,
            data: serde_json::json!(null),
        })
        .unwrap();
    let node3 = backend
        .insert_node(NodeSpec {
            kind: "test".to_string(),
            name: "node3".to_string(),
            file_path: None,
            data: serde_json::json!(null),
        })
        .unwrap();

    backend
        .insert_edge(sqlitegraph::EdgeSpec {
            from: node1,
            to: node2,
            edge_type: "test_edge".to_string(),
            data: serde_json::json!(null),
        })
        .unwrap();
    backend
        .insert_edge(sqlitegraph::EdgeSpec {
            from: node2,
            to: node3,
            edge_type: "test_edge".to_string(),
            data: serde_json::json!(null),
        })
        .unwrap();

    let current = SnapshotId::current();

    // All operations should work with current snapshot
    assert!(backend.get_node(current, node1).is_ok());
    assert!(
        backend
            .neighbors(
                current,
                node1,
                NeighborQuery {
                    direction: BackendDirection::Outgoing,
                    edge_type: None,
                }
            )
            .is_ok()
    );
    assert!(backend.bfs(current, node1, 2).is_ok());
    assert!(backend.shortest_path(current, node1, node3).is_ok());
    assert!(backend.node_degree(current, node1).is_ok());
    assert!(
        backend
            .k_hop(current, node1, 2, BackendDirection::Outgoing)
            .is_ok()
    );
    assert!(
        backend
            .k_hop_filtered(
                current,
                node1,
                2,
                BackendDirection::Outgoing,
                &["test_edge"]
            )
            .is_ok()
    );
    assert!(
        backend
            .chain_query(
                current,
                node1,
                &[ChainStep {
                    direction: BackendDirection::Outgoing,
                    edge_type: None,
                }]
            )
            .is_ok()
    );
    assert!(
        backend
            .pattern_search(current, node1, &PatternQuery::default())
            .is_ok()
    );
    assert!(backend.query_nodes_by_kind(current, "test").is_ok());
    assert!(
        backend
            .query_nodes_by_name_pattern(current, "node*")
            .is_ok()
    );
}