kitedb 0.2.2

High-performance embedded graph 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
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
//! Traversal iterators
//!
//! Provides iterators for traversing nodes and edges in the graph.
//! These iterators merge snapshot and delta state.

use crate::types::*;

use super::db::GraphDB;

// ============================================================================
// Node Iterator
// ============================================================================

/// Iterator over all nodes in the database
pub struct NodeIter<'a> {
  db: &'a GraphDB,
  /// Current snapshot physical index
  snapshot_phys: u64,
  /// Iterator over delta created nodes
  delta_iter: Option<std::collections::hash_map::Keys<'a, NodeId, NodeDelta>>,
  /// Tracks yielded snapshot node IDs to avoid duplicates
  yielded_from_snapshot: std::collections::HashSet<NodeId>,
  /// Phase of iteration
  phase: NodeIterPhase,
}

enum NodeIterPhase {
  Snapshot,
  DeltaCreated,
  Done,
}

impl<'a> NodeIter<'a> {
  pub fn new(db: &'a GraphDB) -> Self {
    Self {
      db,
      snapshot_phys: 0,
      delta_iter: None,
      yielded_from_snapshot: std::collections::HashSet::new(),
      phase: NodeIterPhase::Snapshot,
    }
  }
}

impl<'a> Iterator for NodeIter<'a> {
  type Item = NodeId;

  fn next(&mut self) -> Option<Self::Item> {
    let delta = self.db.delta.read();

    loop {
      match self.phase {
        NodeIterPhase::Snapshot => {
          if let Some(ref snapshot) = self.db.snapshot {
            while self.snapshot_phys < snapshot.header.num_nodes {
              let phys = self.snapshot_phys as u32;
              self.snapshot_phys += 1;

              if let Some(node_id) = snapshot.get_node_id(phys) {
                // Skip if deleted in delta
                if delta.deleted_nodes.contains(&node_id) {
                  continue;
                }

                self.yielded_from_snapshot.insert(node_id);
                return Some(node_id);
              }
            }
          }

          // Move to delta phase
          self.phase = NodeIterPhase::DeltaCreated;
        }

        NodeIterPhase::DeltaCreated => {
          // Iterate over created nodes
          if self.delta_iter.is_none() {
            // We need to drop the read guard before re-acquiring
            drop(delta);
            let delta = self.db.delta.read();

            // Return created nodes one at a time
            for &node_id in delta.created_nodes.keys() {
              if !self.yielded_from_snapshot.contains(&node_id)
                && !delta.deleted_nodes.contains(&node_id)
              {
                // We found one - but we can't hold the iterator
                // So just return it and continue next time
                self.yielded_from_snapshot.insert(node_id);
                return Some(node_id);
              }
            }

            self.phase = NodeIterPhase::Done;
            return None;
          }

          self.phase = NodeIterPhase::Done;
          return None;
        }

        NodeIterPhase::Done => {
          return None;
        }
      }
    }
  }
}

// ============================================================================
// Edge Iterator (Outgoing)
// ============================================================================

/// Iterator over outgoing edges from a source node
pub struct OutEdgeIter<'a> {
  db: &'a GraphDB,
  src: NodeId,
  /// Current index into snapshot edges
  snapshot_idx: usize,
  /// Total snapshot edges for this node
  snapshot_count: usize,
  /// Source physical node in snapshot
  src_phys: Option<u32>,
  /// Iterator over delta added edges
  delta_add_iter: Option<std::collections::btree_set::Iter<'a, EdgePatch>>,
  /// Phase
  phase: OutEdgeIterPhase,
}

#[derive(Debug, Clone, Copy)]
enum OutEdgeIterPhase {
  Snapshot,
  DeltaAdded,
  Done,
}

/// An edge with its edge type and destination
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Edge {
  pub etype: ETypeId,
  pub dst: NodeId,
}

impl<'a> OutEdgeIter<'a> {
  pub fn new(db: &'a GraphDB, src: NodeId) -> Self {
    let src_phys = db.snapshot.as_ref().and_then(|s| s.get_phys_node(src));
    let snapshot_count = src_phys
      .and_then(|p| db.snapshot.as_ref()?.get_out_degree(p))
      .unwrap_or(0);

    Self {
      db,
      src,
      snapshot_idx: 0,
      snapshot_count,
      src_phys,
      delta_add_iter: None,
      phase: OutEdgeIterPhase::Snapshot,
    }
  }
}

impl<'a> Iterator for OutEdgeIter<'a> {
  type Item = Edge;

  fn next(&mut self) -> Option<Self::Item> {
    let delta = self.db.delta.read();

    loop {
      match self.phase {
        OutEdgeIterPhase::Snapshot => {
          // Iterate snapshot edges
          if let (Some(snapshot), Some(phys)) = (&self.db.snapshot, self.src_phys) {
            while self.snapshot_idx < self.snapshot_count {
              let idx = self.snapshot_idx;
              self.snapshot_idx += 1;

              // Get edge from snapshot
              let mut iter = snapshot.iter_out_edges(phys);
              // Skip to current index
              for _ in 0..idx {
                iter.next();
              }

              if let Some((etype, dst_phys)) = iter.next() {
                // Convert dst_phys to node_id
                if let Some(dst) = snapshot.get_node_id(dst_phys) {
                  // Skip if deleted in delta
                  if delta.is_edge_deleted(self.src, etype, dst) {
                    continue;
                  }

                  return Some(Edge { etype, dst });
                }
              }
            }
          }

          self.phase = OutEdgeIterPhase::DeltaAdded;
        }

        OutEdgeIterPhase::DeltaAdded => {
          // Iterate delta added edges
          if let Some(add_set) = delta.out_add.get(&self.src) {
            if let Some(patch) = add_set.iter().next() {
              // Return each added edge
              return Some(Edge {
                etype: patch.etype,
                dst: patch.other,
              });
            }
          }

          self.phase = OutEdgeIterPhase::Done;
          return None;
        }

        OutEdgeIterPhase::Done => {
          return None;
        }
      }
    }
  }
}

// ============================================================================
// Simplified list_nodes function
// ============================================================================

/// List all node IDs in the database
pub fn list_nodes(db: &GraphDB) -> Vec<NodeId> {
  let delta = db.delta.read();
  let mut nodes = Vec::new();
  let mut seen = std::collections::HashSet::new();

  // From snapshot
  if let Some(ref snapshot) = db.snapshot {
    for phys in 0..snapshot.header.num_nodes {
      if let Some(node_id) = snapshot.get_node_id(phys as u32) {
        if !delta.deleted_nodes.contains(&node_id) {
          nodes.push(node_id);
          seen.insert(node_id);
        }
      }
    }
  }

  // From delta created
  for &node_id in delta.created_nodes.keys() {
    if !seen.contains(&node_id) && !delta.deleted_nodes.contains(&node_id) {
      nodes.push(node_id);
    }
  }

  nodes
}

/// List outgoing edges from a source node
pub fn list_out_edges(db: &GraphDB, src: NodeId) -> Vec<Edge> {
  let delta = db.delta.read();
  let mut edges = Vec::new();

  // From snapshot
  if let Some(ref snapshot) = db.snapshot {
    if let Some(phys) = snapshot.get_phys_node(src) {
      for (dst_phys, etype) in snapshot.iter_out_edges(phys) {
        if let Some(dst) = snapshot.get_node_id(dst_phys) {
          if !delta.is_edge_deleted(src, etype, dst) {
            edges.push(Edge { etype, dst });
          }
        }
      }
    }
  }

  // From delta added
  if let Some(add_set) = delta.out_add.get(&src) {
    for patch in add_set {
      edges.push(Edge {
        etype: patch.etype,
        dst: patch.other,
      });
    }
  }

  edges
}

/// Count all nodes in the database
pub fn count_nodes(db: &GraphDB) -> u64 {
  let delta = db.delta.read();

  // Start with snapshot count
  let mut count = db
    .snapshot
    .as_ref()
    .map(|s| s.header.num_nodes)
    .unwrap_or(0);

  // Subtract deleted snapshot nodes
  for &node_id in &delta.deleted_nodes {
    if let Some(ref snapshot) = db.snapshot {
      if snapshot.has_node(node_id) {
        count = count.saturating_sub(1);
      }
    }
  }

  // Add created nodes (that weren't deleted)
  for &node_id in delta.created_nodes.keys() {
    if !delta.deleted_nodes.contains(&node_id) {
      count += 1;
    }
  }

  count
}

/// Count all edges in the database, optionally filtered by edge type
pub fn count_edges(db: &GraphDB, etype_filter: Option<ETypeId>) -> u64 {
  let delta = db.delta.read();

  // Start with snapshot count (approximate - doesn't filter by type)
  let mut count = db
    .snapshot
    .as_ref()
    .map(|s| s.header.num_edges)
    .unwrap_or(0);

  // Subtract deleted edges
  for del_set in delta.out_del.values() {
    for patch in del_set {
      if etype_filter.is_none() || etype_filter == Some(patch.etype) {
        count = count.saturating_sub(1);
      }
    }
  }

  // Add created edges
  for add_set in delta.out_add.values() {
    for patch in add_set {
      if etype_filter.is_none() || etype_filter == Some(patch.etype) {
        count += 1;
      }
    }
  }

  count
}

/// List incoming edges to a destination node
pub fn list_in_edges(db: &GraphDB, dst: NodeId) -> Vec<Edge> {
  let delta = db.delta.read();
  let mut edges = Vec::new();

  // From snapshot (if in-edges are available)
  if let Some(ref snapshot) = db.snapshot {
    if let Some(phys) = snapshot.get_phys_node(dst) {
      for (src_phys, etype, _out_index) in snapshot.iter_in_edges(phys) {
        if let Some(src) = snapshot.get_node_id(src_phys) {
          if !delta.is_edge_deleted(src, etype, dst) {
            edges.push(Edge { etype, dst: src }); // Note: dst field holds src here
          }
        }
      }
    }
  }

  // From delta added
  if let Some(add_set) = delta.in_add.get(&dst) {
    for patch in add_set {
      edges.push(Edge {
        etype: patch.etype,
        dst: patch.other, // This is actually the source
      });
    }
  }

  edges
}

/// Full edge with source, destination, and type
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct FullEdge {
  pub src: NodeId,
  pub etype: ETypeId,
  pub dst: NodeId,
}

/// Options for listing edges
#[derive(Debug, Clone, Default)]
pub struct ListEdgesOptions {
  /// Filter by edge type
  pub etype: Option<ETypeId>,
}

/// List all edges in the database
///
/// This iterates over all nodes and their outgoing edges.
/// Optionally filter by edge type.
pub fn list_edges(db: &GraphDB, options: ListEdgesOptions) -> Vec<FullEdge> {
  let delta = db.delta.read();
  let mut edges = Vec::new();
  let mut seen_nodes = std::collections::HashSet::new();

  // From snapshot
  if let Some(ref snapshot) = db.snapshot {
    for phys in 0..snapshot.header.num_nodes as u32 {
      if let Some(src) = snapshot.get_node_id(phys) {
        if delta.deleted_nodes.contains(&src) {
          continue;
        }
        seen_nodes.insert(src);

        for (dst_phys, etype) in snapshot.iter_out_edges(phys) {
          if let Some(dst) = snapshot.get_node_id(dst_phys) {
            // Apply etype filter
            if let Some(filter_etype) = options.etype {
              if etype != filter_etype {
                continue;
              }
            }

            // Skip deleted edges
            if delta.is_edge_deleted(src, etype, dst) {
              continue;
            }

            edges.push(FullEdge { src, etype, dst });
          }
        }
      }
    }
  }

  // From delta created nodes and added edges
  for &src in delta.created_nodes.keys() {
    if delta.deleted_nodes.contains(&src) {
      continue;
    }
    seen_nodes.insert(src);
  }

  // Add delta edges
  for (&src, add_set) in &delta.out_add {
    for patch in add_set {
      // Apply etype filter
      if let Some(filter_etype) = options.etype {
        if patch.etype != filter_etype {
          continue;
        }
      }

      edges.push(FullEdge {
        src,
        etype: patch.etype,
        dst: patch.other,
      });
    }
  }

  edges
}

#[cfg(test)]
mod tests {
  use super::*;
  use crate::graph::db::{close_graph_db, open_graph_db, OpenOptions};
  use crate::graph::edges::add_edge;
  use crate::graph::nodes::{create_node, NodeOpts};
  use crate::graph::tx::{begin_tx, commit};
  use tempfile::tempdir;

  #[test]
  fn test_list_nodes_empty() {
    let temp_dir = tempdir().unwrap();
    let db = open_graph_db(temp_dir.path(), OpenOptions::new()).unwrap();

    let nodes = list_nodes(&db);
    assert!(nodes.is_empty());

    close_graph_db(db).unwrap();
  }

  #[test]
  fn test_list_nodes_with_data() {
    let temp_dir = tempdir().unwrap();
    let db = open_graph_db(temp_dir.path(), OpenOptions::new()).unwrap();

    let mut tx = begin_tx(&db).unwrap();
    let n1 = create_node(&mut tx, NodeOpts::new()).unwrap();
    let n2 = create_node(&mut tx, NodeOpts::new()).unwrap();
    let n3 = create_node(&mut tx, NodeOpts::new()).unwrap();
    commit(&mut tx).unwrap();

    let nodes = list_nodes(&db);
    assert_eq!(nodes.len(), 3);
    assert!(nodes.contains(&n1));
    assert!(nodes.contains(&n2));
    assert!(nodes.contains(&n3));

    close_graph_db(db).unwrap();
  }

  #[test]
  fn test_list_out_edges() {
    let temp_dir = tempdir().unwrap();
    let db = open_graph_db(temp_dir.path(), OpenOptions::new()).unwrap();

    let mut tx = begin_tx(&db).unwrap();
    let alice = create_node(&mut tx, NodeOpts::new()).unwrap();
    let bob = create_node(&mut tx, NodeOpts::new()).unwrap();
    let charlie = create_node(&mut tx, NodeOpts::new()).unwrap();

    add_edge(&mut tx, alice, 1, bob).unwrap();
    add_edge(&mut tx, alice, 1, charlie).unwrap();
    commit(&mut tx).unwrap();

    let edges = list_out_edges(&db, alice);
    assert_eq!(edges.len(), 2);

    close_graph_db(db).unwrap();
  }
}