aeternusdb 1.0.1

An embeddable, persistent key-value store built on an LSM-tree architecture.
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
//! SSTable `get()` — intra-file LSN-resolution tests.
//!
//! `SSTable::get(key)` returns the **single winning record** for a key by
//! comparing points, point-deletes, and range-deletes at their LSNs.
//! These tests verify every precedence combination:
//!
//! Coverage:
//! - Single put → `GetResult::Put`
//! - Point-delete over put → `GetResult::Delete`
//! - Range-delete with no point entries → `GetResult::RangeDelete`
//! - Point put vs range-delete — point wins (higher LSN)
//! - Point put vs range-delete — range wins (higher LSN)
//! - Point-delete vs range-delete — range wins
//! - Point-delete vs range-delete — point wins
//! - Multiple versions of same key — max LSN wins
//!
//! ## See also
//! - [`tests_basic`] — SSTable build / open / structural validation
//! - [`tests_scan`] — raw unresolved SSTable scan output

#[cfg(test)]
mod tests {
    use crate::sstable::{self, GetResult, PointEntry, RangeTombstone, SSTable};
    use tempfile::TempDir;
    use tracing::Level;
    use tracing_subscriber::fmt::Subscriber;

    fn init_tracing() {
        let _ = Subscriber::builder()
            .with_max_level(Level::TRACE)
            .try_init();
    }

    fn point(key: &[u8], value: &[u8], lsn: u64, timestamp: u64) -> PointEntry {
        PointEntry {
            key: key.to_vec(),
            value: Some(value.to_vec()),
            lsn,
            timestamp,
        }
    }

    fn del(key: &[u8], lsn: u64, timestamp: u64) -> PointEntry {
        PointEntry {
            key: key.to_vec(),
            value: None,
            lsn,
            timestamp,
        }
    }

    fn rdel(start: &[u8], end: &[u8], lsn: u64, timestamp: u64) -> RangeTombstone {
        RangeTombstone {
            start: start.to_vec(),
            end: end.to_vec(),
            lsn,
            timestamp,
        }
    }

    // ----------------------------------------------------------------
    // Single put
    // ----------------------------------------------------------------

    /// # Scenario
    /// A single put entry is retrieved by exact key lookup.
    ///
    /// # Starting environment
    /// SSTable with one point entry `("a", "val1", lsn=10)`.
    ///
    /// # Actions
    /// 1. `sst.get(b"a")`.
    ///
    /// # Expected behavior
    /// `GetResult::Put { value: "val1", lsn: 10, timestamp: 100 }`.
    #[test]
    fn get_single_put() {
        init_tracing();

        let tmp = TempDir::new().unwrap();
        let path = tmp.path().join("sst_single_put.bin");

        let points = vec![point(b"a", b"val1", 10, 100)];
        let ranges: Vec<RangeTombstone> = vec![];

        let pt_count = points.len();

        let rt_count = ranges.len();

        sstable::SstWriter::new(&path)
            .build(points.into_iter(), pt_count, ranges.into_iter(), rt_count)
            .unwrap();
        let sst = SSTable::open(&path).unwrap();

        assert_eq!(
            sst.get(b"a").unwrap(),
            GetResult::Put {
                value: b"val1".to_vec(),
                lsn: 10,
                timestamp: 100
            }
        );
    }

    // ----------------------------------------------------------------
    // Point-delete over put
    // ----------------------------------------------------------------

    /// # Scenario
    /// A point-delete at a higher LSN shadows an earlier put.
    ///
    /// # Starting environment
    /// SSTable with `put("a", lsn=10)` and `del("a", lsn=20)`.
    ///
    /// # Actions
    /// 1. `sst.get(b"a")`.
    ///
    /// # Expected behavior
    /// `GetResult::Delete { lsn: 20, timestamp: 110 }`.
    #[test]
    fn get_point_delete() {
        init_tracing();

        let tmp = TempDir::new().unwrap();
        let path = tmp.path().join("sst_point_delete.bin");

        let points = vec![point(b"a", b"val1", 10, 100), del(b"a", 20, 110)];
        let ranges: Vec<RangeTombstone> = vec![];

        let pt_count = points.len();

        let rt_count = ranges.len();

        sstable::SstWriter::new(&path)
            .build(points.into_iter(), pt_count, ranges.into_iter(), rt_count)
            .unwrap();
        let sst = SSTable::open(&path).unwrap();

        assert_eq!(
            sst.get(b"a").unwrap(),
            GetResult::Delete {
                lsn: 20,
                timestamp: 110
            }
        );
    }

    // ----------------------------------------------------------------
    // Range-delete only (no point data for key)
    // ----------------------------------------------------------------

    /// # Scenario
    /// A range-delete covers the queried key and there are no point
    /// entries at all.
    ///
    /// # Starting environment
    /// SSTable with only `range_delete("a".."z", lsn=30)`.
    ///
    /// # Actions
    /// 1. `sst.get(b"m")` — key inside the range.
    ///
    /// # Expected behavior
    /// `GetResult::RangeDelete { lsn: 30, timestamp: 200 }`.
    #[test]
    fn get_range_delete_only() {
        init_tracing();

        let tmp = TempDir::new().unwrap();
        let path = tmp.path().join("sst_range_delete.bin");

        let points = vec![];
        let ranges = vec![rdel(b"a", b"z", 30, 200)];

        let pt_count = points.len();

        let rt_count = ranges.len();

        sstable::SstWriter::new(&path)
            .build(points.into_iter(), pt_count, ranges.into_iter(), rt_count)
            .unwrap();
        let sst = SSTable::open(&path).unwrap();

        assert_eq!(
            sst.get(b"m").unwrap(),
            GetResult::RangeDelete {
                lsn: 30,
                timestamp: 200
            }
        );
    }

    // ----------------------------------------------------------------
    // Point put vs range-delete — point wins (higher LSN)
    // ----------------------------------------------------------------

    /// # Scenario
    /// A point put at LSN 50 and a range-delete at LSN 40 compete.
    /// The put has the higher LSN and wins.
    ///
    /// # Starting environment
    /// SSTable with `put("a", lsn=50)` and `range_delete("a".."z", lsn=40)`.
    ///
    /// # Actions
    /// 1. `sst.get(b"a")`.
    ///
    /// # Expected behavior
    /// `GetResult::Put { value: "val1", lsn: 50, timestamp: 100 }`.
    #[test]
    fn get_point_and_range_delete_point_wins() {
        init_tracing();

        let tmp = TempDir::new().unwrap();
        let path = tmp.path().join("sst_point_range.bin");

        let points = vec![point(b"a", b"val1", 50, 100)];
        let ranges = vec![rdel(b"a", b"z", 40, 90)];

        let pt_count = points.len();

        let rt_count = ranges.len();

        sstable::SstWriter::new(&path)
            .build(points.into_iter(), pt_count, ranges.into_iter(), rt_count)
            .unwrap();
        let sst = SSTable::open(&path).unwrap();

        assert_eq!(
            sst.get(b"a").unwrap(),
            GetResult::Put {
                value: b"val1".to_vec(),
                lsn: 50,
                timestamp: 100
            }
        );
    }

    // ----------------------------------------------------------------
    // Point put vs range-delete — range wins (higher LSN)
    // ----------------------------------------------------------------

    /// # Scenario
    /// A range-delete at LSN 60 shadows a point put at LSN 50.
    ///
    /// # Starting environment
    /// SSTable with `put("a", lsn=50)` and `range_delete("a".."z", lsn=60)`.
    ///
    /// # Actions
    /// 1. `sst.get(b"a")`.
    ///
    /// # Expected behavior
    /// `GetResult::RangeDelete { lsn: 60, timestamp: 110 }`.
    #[test]
    fn get_point_and_range_delete_range_wins() {
        init_tracing();

        let tmp = TempDir::new().unwrap();
        let path = tmp.path().join("sst_point_range2.bin");

        let points = vec![point(b"a", b"val1", 50, 100)];
        let ranges = vec![rdel(b"a", b"z", 60, 110)];

        let pt_count = points.len();

        let rt_count = ranges.len();

        sstable::SstWriter::new(&path)
            .build(points.into_iter(), pt_count, ranges.into_iter(), rt_count)
            .unwrap();
        let sst = SSTable::open(&path).unwrap();

        assert_eq!(
            sst.get(b"a").unwrap(),
            GetResult::RangeDelete {
                lsn: 60,
                timestamp: 110
            }
        );
    }

    // ----------------------------------------------------------------
    // Point-delete vs range-delete — range wins (higher LSN)
    // ----------------------------------------------------------------

    /// # Scenario
    /// A point-delete (lsn=50) competes with a range-delete (lsn=60).
    /// The range-delete has the higher LSN and wins.
    ///
    /// # Starting environment
    /// SSTable with `del("a", lsn=50)` and `range_delete("a".."z", lsn=60)`.
    ///
    /// # Actions
    /// 1. `sst.get(b"a")`.
    ///
    /// # Expected behavior
    /// `GetResult::RangeDelete { lsn: 60, timestamp: 110 }`.
    #[test]
    fn get_point_delete_and_range_delete_range_wins() {
        init_tracing();

        let tmp = TempDir::new().unwrap();
        let path = tmp.path().join("sst_point_range_delete.bin");

        let points = vec![
            del(b"a", 50, 100), // point delete
        ];
        let ranges = vec![
            rdel(b"a", b"z", 60, 110), // range delete with newer LSN
        ];

        let pt_count = points.len();

        let rt_count = ranges.len();

        sstable::SstWriter::new(&path)
            .build(points.into_iter(), pt_count, ranges.into_iter(), rt_count)
            .unwrap();
        let sst = SSTable::open(&path).unwrap();

        // Range delete wins because its LSN is higher
        assert_eq!(
            sst.get(b"a").unwrap(),
            GetResult::RangeDelete {
                lsn: 60,
                timestamp: 110
            }
        );
    }

    // ----------------------------------------------------------------
    // Point-delete vs range-delete — point wins (higher LSN)
    // ----------------------------------------------------------------

    /// # Scenario
    /// A point-delete (lsn=70) competes with a range-delete (lsn=60).
    /// The point-delete has the higher LSN and wins.
    ///
    /// # Starting environment
    /// SSTable with `del("a", lsn=70)` and `range_delete("a".."z", lsn=60)`.
    ///
    /// # Actions
    /// 1. `sst.get(b"a")`.
    ///
    /// # Expected behavior
    /// `GetResult::Delete { lsn: 70, timestamp: 120 }`.
    #[test]
    fn get_point_delete_and_range_delete_point_wins() {
        init_tracing();

        let tmp = TempDir::new().unwrap();
        let path = tmp.path().join("sst_point_range_delete2.bin");

        let points = vec![
            del(b"a", 70, 120), // point delete with newer LSN
        ];
        let ranges = vec![
            rdel(b"a", b"z", 60, 110), // older range delete
        ];

        let pt_count = points.len();

        let rt_count = ranges.len();

        sstable::SstWriter::new(&path)
            .build(points.into_iter(), pt_count, ranges.into_iter(), rt_count)
            .unwrap();
        let sst = SSTable::open(&path).unwrap();

        // Point delete wins because its LSN is higher
        assert_eq!(
            sst.get(b"a").unwrap(),
            GetResult::Delete {
                lsn: 70,
                timestamp: 120
            }
        );
    }

    // ----------------------------------------------------------------
    // Multiple versions — max LSN wins
    // ----------------------------------------------------------------

    /// # Scenario
    /// Three versions of the same key at different LSNs.
    /// `get()` must return the version with the highest LSN.
    ///
    /// # Starting environment
    /// SSTable with `put("a", "v1", lsn=10)`, `put("a", "v2", lsn=20)`,
    /// and `put("a", "v3", lsn=15)`.
    ///
    /// # Actions
    /// 1. `sst.get(b"a")`.
    ///
    /// # Expected behavior
    /// `GetResult::Put { value: "v2", lsn: 20, timestamp: 120 }`.
    #[test]
    fn get_multiple_versions_point_pick_max_lsn() {
        init_tracing();

        let tmp = TempDir::new().unwrap();
        let path = tmp.path().join("sst_multi_point.bin");

        let points = vec![
            point(b"a", b"v1", 10, 100),
            point(b"a", b"v2", 20, 120),
            point(b"a", b"v3", 15, 110),
        ];
        let ranges: Vec<RangeTombstone> = vec![];

        let pt_count = points.len();

        let rt_count = ranges.len();

        sstable::SstWriter::new(&path)
            .build(points.into_iter(), pt_count, ranges.into_iter(), rt_count)
            .unwrap();
        let sst = SSTable::open(&path).unwrap();

        assert_eq!(
            sst.get(b"a").unwrap(),
            GetResult::Put {
                value: b"v2".to_vec(),
                lsn: 20,
                timestamp: 120
            }
        );
    }
}