sombra 0.3.6

High-performance graph database with ACID transactions, single-file storage, and bindings for Rust, TypeScript, and Python
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
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
use super::graphdb::GraphDB;
use crate::error::{GraphError, Result};
use crate::model::{Edge, EdgeDirection, NodeId, NULL_EDGE_ID};
use rayon::prelude::*;
use std::collections::{HashMap, HashSet};
use std::sync::Arc;

impl GraphDB {
    pub fn get_neighbors(&mut self, node_id: NodeId) -> Result<Vec<NodeId>> {
        if let Some(neighbors) = self.outgoing_neighbors_cache.get(&node_id) {
            return Ok(neighbors.clone());
        }

        let node = self
            .get_node(node_id)?
            .ok_or(GraphError::NotFound("node"))?;
        let mut neighbors = Vec::new();
        let mut edge_ids = Vec::new();
        let mut edge_id = node.first_outgoing_edge_id;
        while edge_id != NULL_EDGE_ID {
            self.metrics.edge_traversals += 1;
            let edge = self.load_edge(edge_id)?;
            neighbors.push(edge.target_node_id);
            edge_ids.push(edge_id);
            edge_id = edge.next_outgoing_edge_id;
        }

        self.outgoing_adjacency.insert(node_id, edge_ids);
        self.outgoing_neighbors_cache
            .insert(node_id, neighbors.clone());
        Ok(neighbors)
    }

    pub fn get_incoming_neighbors(&mut self, node_id: NodeId) -> Result<Vec<NodeId>> {
        if let Some(neighbors) = self.incoming_neighbors_cache.get(&node_id) {
            return Ok(neighbors.clone());
        }

        let node = self
            .get_node(node_id)?
            .ok_or(GraphError::NotFound("node"))?;
        let mut neighbors = Vec::new();
        let mut edge_ids = Vec::new();
        let mut edge_id = node.first_incoming_edge_id;
        while edge_id != NULL_EDGE_ID {
            let edge = self.load_edge(edge_id)?;
            neighbors.push(edge.source_node_id);
            edge_ids.push(edge_id);
            edge_id = edge.next_incoming_edge_id;
        }

        self.incoming_adjacency.insert(node_id, edge_ids);
        self.incoming_neighbors_cache
            .insert(node_id, neighbors.clone());
        Ok(neighbors)
    }

    pub fn get_neighbors_two_hops(&mut self, node_id: NodeId) -> Result<Vec<NodeId>> {
        let mut visited = HashSet::new();
        let mut result = Vec::new();

        visited.insert(node_id);

        let first_hop = self.get_neighbors(node_id)?;

        for neighbor_id in &first_hop {
            visited.insert(*neighbor_id);
        }

        let mut all_second_hop_neighbors = HashSet::new();
        for neighbor_id in first_hop {
            let second_hop = self.get_neighbors(neighbor_id)?;
            for second_neighbor_id in second_hop {
                if !visited.contains(&second_neighbor_id) {
                    all_second_hop_neighbors.insert(second_neighbor_id);
                }
            }
        }

        result.extend(all_second_hop_neighbors);
        Ok(result)
    }

    pub fn get_neighbors_three_hops(&mut self, node_id: NodeId) -> Result<Vec<NodeId>> {
        let mut visited = HashSet::new();
        let mut result = Vec::new();

        visited.insert(node_id);

        let first_hop = self.get_neighbors(node_id)?;
        for neighbor_id in first_hop {
            visited.insert(neighbor_id);

            let second_hop = self.get_neighbors(neighbor_id)?;
            for second_neighbor_id in second_hop {
                visited.insert(second_neighbor_id);

                let third_hop = self.get_neighbors(second_neighbor_id)?;
                for third_neighbor_id in third_hop {
                    if visited.insert(third_neighbor_id) {
                        result.push(third_neighbor_id);
                    }
                }
            }
        }

        Ok(result)
    }

    pub fn bfs_traversal(
        &mut self,
        start_node_id: NodeId,
        max_depth: usize,
    ) -> Result<Vec<(NodeId, usize)>> {
        let mut visited = HashSet::new();
        let mut current_level = vec![start_node_id];
        let mut result = Vec::new();

        visited.insert(start_node_id);

        for depth in 0..=max_depth {
            let mut next_level = Vec::new();

            for node_id in &current_level {
                result.push((*node_id, depth));
            }

            if depth == max_depth {
                break;
            }

            for node_id in current_level.drain(..) {
                let neighbors = self.get_neighbors_fast(node_id)?;
                for target in neighbors {
                    if visited.insert(target) {
                        next_level.push(target);
                    }
                }
            }

            if next_level.is_empty() {
                break;
            }
            current_level = next_level;
        }

        Ok(result)
    }

    pub fn parallel_bfs(
        &mut self,
        start_node_id: NodeId,
        max_depth: usize,
    ) -> Result<Vec<(NodeId, usize)>> {
        let mut visited = HashSet::new();
        let mut current_level = vec![start_node_id];
        let mut result = Vec::new();
        let mut adjacency_cache = HashMap::new();

        visited.insert(start_node_id);

        for depth in 0..=max_depth {
            result.extend(current_level.iter().map(|&node_id| (node_id, depth)));

            if depth == max_depth {
                break;
            }

            let neighbor_lists =
                self.collect_neighbors_for_frontier(&current_level, &mut adjacency_cache)?;
            let total_neighbors: usize = neighbor_lists.iter().map(|n| n.len()).sum();

            let next_candidates: Vec<NodeId> =
                if self.should_parallelize_frontier(current_level.len(), total_neighbors) {
                    neighbor_lists
                        .into_par_iter()
                        .flat_map(|neighbors| neighbors)
                        .collect()
                } else {
                    neighbor_lists.into_iter().flatten().collect()
                };

            let mut next_level = Vec::new();
            for node_id in next_candidates {
                if visited.insert(node_id) {
                    next_level.push(node_id);
                }
            }

            if next_level.is_empty() {
                break;
            }
            current_level = next_level;
        }

        Ok(result)
    }

    pub fn parallel_multi_hop_neighbors(
        &mut self,
        node_ids: &[NodeId],
        hops: usize,
    ) -> Result<HashMap<NodeId, Vec<NodeId>>> {
        if node_ids.is_empty() {
            return Ok(HashMap::new());
        }

        if hops == 0 {
            return Ok(node_ids
                .iter()
                .copied()
                .map(|node_id| (node_id, Vec::new()))
                .collect());
        }

        let mut adjacency_cache = HashMap::new();
        let snapshot = self.build_snapshot_for_roots(node_ids, hops, &mut adjacency_cache)?;
        let snapshot = Arc::new(snapshot);
        let should_parallelize = self.should_parallelize_frontier(node_ids.len(), snapshot.len());

        if should_parallelize {
            Ok(node_ids
                .par_iter()
                .map(|&node_id| {
                    let neighbors = Self::multi_hop_from_snapshot(snapshot.as_ref(), node_id, hops);
                    (node_id, neighbors)
                })
                .collect())
        } else {
            Ok(node_ids
                .iter()
                .map(|&node_id| {
                    let neighbors = Self::multi_hop_from_snapshot(snapshot.as_ref(), node_id, hops);
                    (node_id, neighbors)
                })
                .collect())
        }
    }

    fn collect_neighbors_for_frontier(
        &mut self,
        frontier: &[NodeId],
        cache: &mut HashMap<NodeId, Vec<NodeId>>,
    ) -> Result<Vec<Vec<NodeId>>> {
        let mut neighbor_lists = Vec::with_capacity(frontier.len());
        for &node_id in frontier {
            if let Some(neighbors) = cache.get(&node_id) {
                neighbor_lists.push(neighbors.clone());
            } else {
                let neighbors = self.get_neighbors_fast(node_id)?;
                cache.insert(node_id, neighbors.clone());
                neighbor_lists.push(neighbors);
            }
        }
        Ok(neighbor_lists)
    }

    fn build_snapshot_for_roots(
        &mut self,
        roots: &[NodeId],
        hops: usize,
        cache: &mut HashMap<NodeId, Vec<NodeId>>,
    ) -> Result<HashMap<NodeId, Vec<NodeId>>> {
        let mut visited: HashSet<NodeId> = roots.iter().copied().collect();
        let mut frontier: Vec<NodeId> = roots.to_vec();

        for _ in 0..hops {
            if frontier.is_empty() {
                break;
            }

            let neighbor_lists = self.collect_neighbors_for_frontier(&frontier, cache)?;
            let mut next_frontier = Vec::new();

            for neighbors in neighbor_lists {
                for neighbor in neighbors {
                    if visited.insert(neighbor) {
                        next_frontier.push(neighbor);
                    }
                }
            }

            frontier = next_frontier;
        }

        Ok(cache.clone())
    }

    fn should_parallelize_traversal(&self, workload: usize) -> bool {
        workload >= self.config.parallel_traversal_threshold
    }

    fn should_parallelize_frontier(&self, frontier_len: usize, total_neighbors: usize) -> bool {
        self.should_parallelize_traversal(frontier_len)
            || self.should_parallelize_traversal(total_neighbors)
    }

    fn multi_hop_from_snapshot(
        snapshot: &HashMap<NodeId, Vec<NodeId>>,
        start: NodeId,
        hops: usize,
    ) -> Vec<NodeId> {
        if hops == 0 {
            return Vec::new();
        }

        let mut visited = HashSet::new();
        let mut current_level = vec![start];
        visited.insert(start);

        for _ in 0..hops {
            let mut next_level = Vec::new();
            for node_id in &current_level {
                if let Some(neighbors) = snapshot.get(node_id) {
                    for &neighbor in neighbors {
                        if visited.insert(neighbor) {
                            next_level.push(neighbor);
                        }
                    }
                }
            }

            if next_level.is_empty() {
                break;
            }
            current_level = next_level;
        }

        visited.remove(&start);
        visited.into_iter().collect()
    }

    fn get_neighbors_fast(&mut self, node_id: NodeId) -> Result<Vec<NodeId>> {
        if let Some(neighbors) = self.outgoing_neighbors_cache.get(&node_id) {
            return Ok(neighbors.clone());
        }

        let node = self
            .get_node(node_id)?
            .ok_or(GraphError::NotFound("node"))?;
        let mut neighbors = Vec::new();
        let mut edge_ids = Vec::new();
        let mut edge_id = node.first_outgoing_edge_id;

        while edge_id != NULL_EDGE_ID {
            self.metrics.edge_traversals += 1;
            let edge = self.load_edge(edge_id)?;
            neighbors.push(edge.target_node_id);
            edge_ids.push(edge_id);
            edge_id = edge.next_outgoing_edge_id;
        }

        self.outgoing_adjacency.insert(node_id, edge_ids);
        self.outgoing_neighbors_cache
            .insert(node_id, neighbors.clone());
        Ok(neighbors)
    }

    /// Gets neighbors filtered by edge type and direction.
    ///
    /// This method traverses edges from the given node, filtering by the provided
    /// edge types (using OR semantics) and following the specified direction.
    ///
    /// # Arguments
    /// * `node_id` - The node to start from
    /// * `edge_types` - Array of edge type names to match (logical OR)
    /// * `direction` - Direction to traverse (Outgoing, Incoming, or Both)
    ///
    /// # Returns
    /// * `Ok(Vec<NodeId>)` - List of neighbor node IDs matching the criteria
    ///
    /// # Time Complexity
    /// O(E) where E is the number of edges connected to the node
    ///
    /// # Space Complexity
    /// O(N) where N is the number of matching neighbors
    pub fn get_neighbors_by_edge_type(
        &mut self,
        node_id: NodeId,
        edge_types: &[&str],
        direction: EdgeDirection,
    ) -> Result<Vec<NodeId>> {
        let mut neighbors = Vec::new();

        match direction {
            EdgeDirection::Outgoing => {
                let node = self
                    .get_node(node_id)?
                    .ok_or(GraphError::NotFound("node"))?;
                let mut edge_id = node.first_outgoing_edge_id;
                while edge_id != NULL_EDGE_ID {
                    self.metrics.edge_traversals += 1;
                    let edge = self.load_edge(edge_id)?;
                    if edge_types.is_empty() || edge_types.iter().any(|&t| t == edge.type_name) {
                        neighbors.push(edge.target_node_id);
                    }
                    edge_id = edge.next_outgoing_edge_id;
                }
            }
            EdgeDirection::Incoming => {
                let node = self
                    .get_node(node_id)?
                    .ok_or(GraphError::NotFound("node"))?;
                let mut edge_id = node.first_incoming_edge_id;
                while edge_id != NULL_EDGE_ID {
                    let edge = self.load_edge(edge_id)?;
                    if edge_types.is_empty() || edge_types.iter().any(|&t| t == edge.type_name) {
                        neighbors.push(edge.source_node_id);
                    }
                    edge_id = edge.next_incoming_edge_id;
                }
            }
            EdgeDirection::Both => {
                let node = self
                    .get_node(node_id)?
                    .ok_or(GraphError::NotFound("node"))?;
                let mut edge_id = node.first_outgoing_edge_id;
                while edge_id != NULL_EDGE_ID {
                    self.metrics.edge_traversals += 1;
                    let edge = self.load_edge(edge_id)?;
                    if edge_types.is_empty() || edge_types.iter().any(|&t| t == edge.type_name) {
                        neighbors.push(edge.target_node_id);
                    }
                    edge_id = edge.next_outgoing_edge_id;
                }
                let mut edge_id = node.first_incoming_edge_id;
                while edge_id != NULL_EDGE_ID {
                    let edge = self.load_edge(edge_id)?;
                    if edge_types.is_empty() || edge_types.iter().any(|&t| t == edge.type_name) {
                        neighbors.push(edge.source_node_id);
                    }
                    edge_id = edge.next_incoming_edge_id;
                }
            }
        }

        Ok(neighbors)
    }

    /// Gets neighbors with their connecting edges, filtered by edge type and direction.
    ///
    /// This method is similar to `get_neighbors_by_edge_type` but returns both the
    /// neighbor nodes and the edges connecting them. This is useful when you need
    /// edge properties or IDs during traversal.
    ///
    /// # Arguments
    /// * `node_id` - The node to start from
    /// * `edge_types` - Array of edge type names to match (logical OR)
    /// * `direction` - Direction to traverse (Outgoing, Incoming, or Both)
    ///
    /// # Returns
    /// * `Ok(Vec<(NodeId, Edge)>)` - List of (neighbor_id, edge) tuples
    ///
    /// # Time Complexity
    /// O(E) where E is the number of edges connected to the node
    ///
    /// # Space Complexity
    /// O(N) where N is the number of matching neighbors
    pub fn get_neighbors_with_edges_by_type(
        &mut self,
        node_id: NodeId,
        edge_types: &[&str],
        direction: EdgeDirection,
    ) -> Result<Vec<(NodeId, Edge)>> {
        let mut results = Vec::new();

        match direction {
            EdgeDirection::Outgoing => {
                let node = self
                    .get_node(node_id)?
                    .ok_or(GraphError::NotFound("node"))?;
                let mut edge_id = node.first_outgoing_edge_id;
                while edge_id != NULL_EDGE_ID {
                    self.metrics.edge_traversals += 1;
                    let edge = self.load_edge(edge_id)?;
                    if edge_types.is_empty() || edge_types.iter().any(|&t| t == edge.type_name) {
                        results.push((edge.target_node_id, edge.clone()));
                    }
                    edge_id = edge.next_outgoing_edge_id;
                }
            }
            EdgeDirection::Incoming => {
                let node = self
                    .get_node(node_id)?
                    .ok_or(GraphError::NotFound("node"))?;
                let mut edge_id = node.first_incoming_edge_id;
                while edge_id != NULL_EDGE_ID {
                    let edge = self.load_edge(edge_id)?;
                    if edge_types.is_empty() || edge_types.iter().any(|&t| t == edge.type_name) {
                        results.push((edge.source_node_id, edge.clone()));
                    }
                    edge_id = edge.next_incoming_edge_id;
                }
            }
            EdgeDirection::Both => {
                let node = self
                    .get_node(node_id)?
                    .ok_or(GraphError::NotFound("node"))?;
                let mut edge_id = node.first_outgoing_edge_id;
                while edge_id != NULL_EDGE_ID {
                    self.metrics.edge_traversals += 1;
                    let edge = self.load_edge(edge_id)?;
                    if edge_types.is_empty() || edge_types.iter().any(|&t| t == edge.type_name) {
                        results.push((edge.target_node_id, edge.clone()));
                    }
                    edge_id = edge.next_outgoing_edge_id;
                }
                let mut edge_id = node.first_incoming_edge_id;
                while edge_id != NULL_EDGE_ID {
                    let edge = self.load_edge(edge_id)?;
                    if edge_types.is_empty() || edge_types.iter().any(|&t| t == edge.type_name) {
                        results.push((edge.source_node_id, edge.clone()));
                    }
                    edge_id = edge.next_incoming_edge_id;
                }
            }
        }

        Ok(results)
    }

    pub fn shortest_path(
        &mut self,
        start: NodeId,
        end: NodeId,
        edge_types: Option<&[&str]>,
    ) -> Result<Option<Vec<NodeId>>> {
        if start == end {
            return Ok(Some(vec![start]));
        }

        let mut visited = HashSet::new();
        let mut queue = std::collections::VecDeque::new();
        let mut parent = HashMap::new();

        queue.push_back(start);
        visited.insert(start);

        while let Some(current) = queue.pop_front() {
            let neighbors = if let Some(types) = edge_types {
                self.get_neighbors_by_edge_type(current, types, EdgeDirection::Outgoing)?
            } else {
                self.get_neighbors(current)?
            };

            for neighbor in neighbors {
                if !visited.contains(&neighbor) {
                    visited.insert(neighbor);
                    parent.insert(neighbor, current);
                    queue.push_back(neighbor);

                    if neighbor == end {
                        let mut path = Vec::new();
                        let mut current = end;
                        path.push(current);
                        while let Some(&prev) = parent.get(&current) {
                            path.push(prev);
                            current = prev;
                        }
                        path.reverse();
                        return Ok(Some(path));
                    }
                }
            }
        }

        Ok(None)
    }

    pub fn find_paths(
        &mut self,
        start: NodeId,
        end: NodeId,
        min_depth: usize,
        max_depth: usize,
        edge_types: Option<&[&str]>,
    ) -> Result<Vec<Vec<NodeId>>> {
        if max_depth == 0 {
            return Ok(Vec::new());
        }

        if start == end && min_depth == 0 {
            return Ok(vec![vec![start]]);
        }

        let mut paths = Vec::new();
        let mut current_path = vec![start];
        let mut visited = HashSet::new();
        visited.insert(start);

        self.find_paths_dfs(
            start,
            end,
            min_depth,
            max_depth,
            edge_types,
            &mut current_path,
            &mut visited,
            &mut paths,
        )?;

        Ok(paths)
    }

    #[allow(clippy::too_many_arguments)]
    fn find_paths_dfs(
        &mut self,
        current: NodeId,
        end: NodeId,
        min_depth: usize,
        max_depth: usize,
        edge_types: Option<&[&str]>,
        current_path: &mut Vec<NodeId>,
        visited: &mut HashSet<NodeId>,
        paths: &mut Vec<Vec<NodeId>>,
    ) -> Result<()> {
        if current_path.len() > max_depth {
            return Ok(());
        }

        if current == end && current_path.len() >= min_depth {
            paths.push(current_path.clone());
            return Ok(());
        }

        let neighbors = if let Some(types) = edge_types {
            self.get_neighbors_by_edge_type(current, types, EdgeDirection::Outgoing)?
        } else {
            self.get_neighbors(current)?
        };

        for neighbor in neighbors {
            if !visited.contains(&neighbor) {
                visited.insert(neighbor);
                current_path.push(neighbor);

                self.find_paths_dfs(
                    neighbor,
                    end,
                    min_depth,
                    max_depth,
                    edge_types,
                    current_path,
                    visited,
                    paths,
                )?;

                current_path.pop();
                visited.remove(&neighbor);
            }
        }

        Ok(())
    }
}