iridium-db 0.3.0

A high-performance vector-graph hybrid storage and indexing engine
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
use std::collections::VecDeque;

use crate::features::storage::api as storage_api;

#[non_exhaustive]
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum IngestEvent {
    InsertNode {
        node_id: u64,
        version: u64,
        adjacency: Vec<u64>,
        bitmap_terms: Vec<(String, String)>,
        /// When `true`, the node's embedding will arrive later via `UpdateVectorDelta`.
        /// The node is immediately graph-queryable but excluded from ANN/vector-scan results
        /// until the embedding lands.
        embedding_pending: bool,
    },
    AddEdgeDelta {
        node_id: u64,
        version: u64,
        payload: Vec<u8>,
    },
    UpdateVectorDelta {
        node_id: u64,
        version: u64,
        payload: Vec<u8>,
    },
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct IngestConfig {
    pub max_queue_depth: usize,
    pub max_batch_size: usize,
}

impl Default for IngestConfig {
    fn default() -> Self {
        Self {
            max_queue_depth: 16384,
            max_batch_size: 1024,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct IngestAck {
    pub accepted: usize,
    pub rejected: usize,
    pub flushed: usize,
    pub queue_depth: usize,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum IngestError {
    InvalidInput(String),
    Backpressure {
        queue_depth: usize,
        max_queue_depth: usize,
    },
    Storage(String),
}

pub type Result<T> = std::result::Result<T, IngestError>;

pub struct IngestPipeline {
    config: IngestConfig,
    queue: VecDeque<IngestEvent>,
}

impl IngestPipeline {
    pub fn new(config: IngestConfig) -> Result<Self> {
        if config.max_queue_depth == 0 {
            return Err(IngestError::InvalidInput(
                "max_queue_depth must be > 0".to_string(),
            ));
        }
        if config.max_batch_size == 0 {
            return Err(IngestError::InvalidInput(
                "max_batch_size must be > 0".to_string(),
            ));
        }
        Ok(Self {
            config,
            queue: VecDeque::new(),
        })
    }

    pub fn queue_depth(&self) -> usize {
        self.queue.len()
    }

    pub fn ingest_event(
        &mut self,
        handle: &mut storage_api::StorageHandle,
        event: IngestEvent,
    ) -> Result<IngestAck> {
        self.validate_event(&event)?;
        self.push_event(event)?;
        let flushed = self.flush_if_needed(handle)?;
        Ok(IngestAck {
            accepted: 1,
            rejected: 0,
            flushed,
            queue_depth: self.queue_depth(),
        })
    }

    pub fn ingest_batch(
        &mut self,
        handle: &mut storage_api::StorageHandle,
        events: &[IngestEvent],
    ) -> Result<IngestAck> {
        if self.can_use_edge_batch_fast_path(events) {
            return self.ingest_batch_edge_fast_path(handle, events);
        }

        let mut accepted = 0usize;
        let mut rejected = 0usize;
        let mut flushed = 0usize;

        for event in events {
            self.validate_event(event)?;
            if self.queue.len() >= self.config.max_queue_depth {
                rejected += 1;
                continue;
            }
            self.queue.push_back(event.clone());
            accepted += 1;
            while self.queue.len() >= self.config.max_batch_size {
                flushed += self.flush_once(handle)?;
            }
        }

        if accepted == 0 && rejected > 0 {
            return Err(IngestError::Backpressure {
                queue_depth: self.queue_depth(),
                max_queue_depth: self.config.max_queue_depth,
            });
        }

        Ok(IngestAck {
            accepted,
            rejected,
            flushed,
            queue_depth: self.queue_depth(),
        })
    }

    pub fn ingest_edge_delta_range(
        &mut self,
        handle: &mut storage_api::StorageHandle,
        start_node_id: u64,
        count: u64,
        version: u64,
        payload_prefix: &str,
    ) -> Result<IngestAck> {
        if version == 0 {
            return Err(IngestError::InvalidInput(
                "delta version must be > 0".to_string(),
            ));
        }

        let mut accepted = 0usize;
        let rejected = 0usize;
        let mut flushed = 0usize;

        if !self.queue.is_empty() {
            flushed += self.flush_all(handle)?;
        }

        let mut deltas: Vec<Vec<u8>> = Vec::with_capacity(self.config.max_batch_size);
        for i in 0..count {
            let payload = format!("{}-{}", payload_prefix, i).into_bytes();
            let node_id = start_node_id + i;
            deltas.push(storage_api::encode_delta(node_id, version, &payload));
            accepted += 1;

            if deltas.len() >= self.config.max_batch_size {
                storage_api::put_edge_deltas_batch(handle, &deltas).map_err(storage_err)?;
                flushed += deltas.len();
                deltas.clear();
            }
        }

        if !deltas.is_empty() {
            storage_api::put_edge_deltas_batch(handle, &deltas).map_err(storage_err)?;
            flushed += deltas.len();
        }

        Ok(IngestAck {
            accepted,
            rejected,
            flushed,
            queue_depth: self.queue_depth(),
        })
    }

    fn can_use_edge_batch_fast_path(&self, events: &[IngestEvent]) -> bool {
        if !self.queue.is_empty() {
            return false;
        }
        if self.config.max_batch_size > self.config.max_queue_depth {
            // Preserve backpressure behavior for constrained configs.
            return false;
        }
        events
            .iter()
            .all(|event| matches!(event, IngestEvent::AddEdgeDelta { .. }))
    }

    fn ingest_batch_edge_fast_path(
        &mut self,
        handle: &mut storage_api::StorageHandle,
        events: &[IngestEvent],
    ) -> Result<IngestAck> {
        let mut accepted = 0usize;
        let mut rejected = 0usize;
        let mut flushed = 0usize;
        let mut edge_batch: Vec<(u64, u64, Vec<u8>)> =
            Vec::with_capacity(self.config.max_batch_size);

        for event in events {
            self.validate_event(event)?;
            if self.queue.len() + edge_batch.len() >= self.config.max_queue_depth {
                rejected += 1;
                continue;
            }

            if let IngestEvent::AddEdgeDelta {
                node_id,
                version,
                payload,
            } = event
            {
                edge_batch.push((*node_id, *version, payload.clone()));
                accepted += 1;
                if edge_batch.len() >= self.config.max_batch_size {
                    let deltas = edge_batch
                        .iter()
                        .map(|(node_id, version, payload)| {
                            storage_api::encode_delta(*node_id, *version, payload)
                        })
                        .collect::<Vec<Vec<u8>>>();
                    storage_api::put_edge_deltas_batch(handle, &deltas).map_err(storage_err)?;
                    flushed += deltas.len();
                    edge_batch.clear();
                }
            }
        }

        // Keep remainder in queue so flush behavior mirrors the general ingest path.
        for (node_id, version, payload) in edge_batch {
            self.queue.push_back(IngestEvent::AddEdgeDelta {
                node_id,
                version,
                payload,
            });
        }

        if accepted == 0 && rejected > 0 {
            return Err(IngestError::Backpressure {
                queue_depth: self.queue_depth(),
                max_queue_depth: self.config.max_queue_depth,
            });
        }

        Ok(IngestAck {
            accepted,
            rejected,
            flushed,
            queue_depth: self.queue_depth(),
        })
    }

    pub fn flush_all(&mut self, handle: &mut storage_api::StorageHandle) -> Result<usize> {
        let mut total_flushed = 0usize;
        while !self.queue.is_empty() {
            total_flushed += self.flush_once(handle)?;
        }
        Ok(total_flushed)
    }

    fn validate_event(&self, event: &IngestEvent) -> Result<()> {
        match event {
            IngestEvent::InsertNode {
                node_id: _,
                version,
                adjacency: _,
                bitmap_terms,
                embedding_pending: _,
            } => {
                if *version == 0 {
                    return Err(IngestError::InvalidInput(
                        "InsertNode version must be > 0".to_string(),
                    ));
                }
                for (index_name, value_key) in bitmap_terms {
                    if index_name.trim().is_empty() || value_key.trim().is_empty() {
                        return Err(IngestError::InvalidInput(
                            "bitmap terms require non-empty index name and value key".to_string(),
                        ));
                    }
                }
            }
            IngestEvent::AddEdgeDelta {
                node_id: _,
                version,
                payload,
            }
            | IngestEvent::UpdateVectorDelta {
                node_id: _,
                version,
                payload,
            } => {
                if *version == 0 {
                    return Err(IngestError::InvalidInput(
                        "delta version must be > 0".to_string(),
                    ));
                }
                if payload.is_empty() {
                    return Err(IngestError::InvalidInput(
                        "delta payload must not be empty".to_string(),
                    ));
                }
            }
        }
        Ok(())
    }

    fn push_event(&mut self, event: IngestEvent) -> Result<()> {
        if self.queue.len() >= self.config.max_queue_depth {
            return Err(IngestError::Backpressure {
                queue_depth: self.queue_depth(),
                max_queue_depth: self.config.max_queue_depth,
            });
        }
        self.queue.push_back(event);
        Ok(())
    }

    fn flush_if_needed(&mut self, handle: &mut storage_api::StorageHandle) -> Result<usize> {
        if self.queue.len() < self.config.max_batch_size {
            return Ok(0);
        }
        self.flush_once(handle)
    }

    fn flush_once(&mut self, handle: &mut storage_api::StorageHandle) -> Result<usize> {
        let take_count = self.config.max_batch_size.min(self.queue.len());
        if take_count == 0 {
            return Ok(0);
        }

        let mut batch = Vec::with_capacity(take_count);
        for _ in 0..take_count {
            if let Some(event) = self.queue.pop_front() {
                batch.push(event);
            }
        }

        // Group edge delta writes so they can use the batched WAL+memtable path.
        let mut edge_deltas = Vec::new();
        for event in batch {
            match event {
                IngestEvent::InsertNode {
                    node_id,
                    version,
                    adjacency,
                    bitmap_terms,
                    embedding_pending,
                } => {
                    storage_api::put_full_node(handle, node_id, version, &adjacency)
                        .map_err(storage_err)?;
                    for (index_name, value_key) in bitmap_terms {
                        storage_api::bitmap_add_posting(handle, &index_name, &value_key, node_id)
                            .map_err(storage_err)?;
                    }
                    if embedding_pending {
                        storage_api::put_embedding_pending(handle, node_id)
                            .map_err(storage_err)?;
                    }
                }
                IngestEvent::AddEdgeDelta {
                    node_id,
                    version,
                    payload,
                } => edge_deltas.push(storage_api::encode_delta(node_id, version, &payload)),
                IngestEvent::UpdateVectorDelta {
                    node_id,
                    version,
                    payload,
                } => {
                    let delta = storage_api::encode_delta(node_id, version, &payload);
                    storage_api::put_vector_delta(handle, &delta).map_err(storage_err)?;
                }
            }
        }

        if !edge_deltas.is_empty() {
            storage_api::put_edge_deltas_batch(handle, &edge_deltas).map_err(storage_err)?;
        }
        Ok(take_count)
    }
}

pub fn ingest_event(
    pipeline: &mut IngestPipeline,
    handle: &mut storage_api::StorageHandle,
    event: IngestEvent,
) -> Result<IngestAck> {
    pipeline.ingest_event(handle, event)
}

pub fn ingest_batch(
    pipeline: &mut IngestPipeline,
    handle: &mut storage_api::StorageHandle,
    events: &[IngestEvent],
) -> Result<IngestAck> {
    pipeline.ingest_batch(handle, events)
}

pub fn ingest_edge_delta_range(
    pipeline: &mut IngestPipeline,
    handle: &mut storage_api::StorageHandle,
    start_node_id: u64,
    count: u64,
    version: u64,
    payload_prefix: &str,
) -> Result<IngestAck> {
    pipeline.ingest_edge_delta_range(handle, start_node_id, count, version, payload_prefix)
}

fn storage_err(err: storage_api::StorageError) -> IngestError {
    IngestError::Storage(format!("{:?}", err))
}

#[cfg(test)]
mod tests;