trine-kv 0.5.13

Embedded LSM MVCC key-value 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
use crate::{Db, DbOptions, KeyRange};

fn memory_db() -> Db {
    Db::open_sync(DbOptions::memory()).expect("open in-memory db")
}

#[test]
fn branch_reads_parent_then_shadows_with_local_writes() {
    let db = memory_db();
    let bucket = db.bucket_sync("data").expect("bucket");
    bucket.put_sync(b"k1".to_vec(), b"v1".to_vec()).expect("p1");
    bucket.put_sync(b"k2".to_vec(), b"v2".to_vec()).expect("p2");

    let mut branch = db.branch_from_latest().expect("branch");
    assert_eq!(
        branch.get("data", b"k1").expect("get"),
        Some(b"v1".to_vec())
    );

    branch
        .put("data", b"k1", b"v1-branch".to_vec())
        .expect("put");
    branch.delete("data", b"k2").expect("delete");
    assert_eq!(
        branch.get("data", b"k1").expect("get"),
        Some(b"v1-branch".to_vec())
    );
    assert_eq!(branch.get("data", b"k2").expect("get"), None);

    // The parent is untouched.
    assert_eq!(bucket.get_sync(b"k1").expect("get"), Some(b"v1".to_vec()));
    assert_eq!(bucket.get_sync(b"k2").expect("get"), Some(b"v2".to_vec()));
}

#[test]
fn branch_pins_its_fork_while_the_parent_diverges() {
    let db = memory_db();
    let bucket = db.bucket_sync("data").expect("bucket");
    bucket.put_sync(b"k".to_vec(), b"v1".to_vec()).expect("p1");

    let branch = db.branch_from_latest().expect("branch");
    bucket.put_sync(b"k".to_vec(), b"v2".to_vec()).expect("p2");

    assert_eq!(
        branch.get("data", b"k").expect("get"),
        Some(b"v1".to_vec()),
        "the branch stays frozen at its fork while the parent diverges"
    );
    assert_eq!(bucket.get_sync(b"k").expect("get"), Some(b"v2".to_vec()));
}

#[test]
fn branch_at_a_retained_past_version_time_travels() {
    let db = Db::open_sync(DbOptions::memory().with_keep_last_read_versions(8))
        .expect("open with retention");
    let bucket = db.bucket_sync("data").expect("bucket");
    bucket.put_sync(b"k".to_vec(), b"v1".to_vec()).expect("p1");
    let v1 = db.latest_read_version();
    bucket.put_sync(b"k".to_vec(), b"v2".to_vec()).expect("p2");

    let old = db.branch_at(v1).expect("branch at v1");
    assert_eq!(old.get("data", b"k").expect("get"), Some(b"v1".to_vec()));
    let now = db.branch_from_latest().expect("branch now");
    assert_eq!(now.get("data", b"k").expect("get"), Some(b"v2".to_vec()));
}

#[test]
fn ephemeral_branch_range_merges_overlay_over_parent() {
    let db = memory_db();
    let bucket = db.bucket_sync("data").expect("bucket");
    for (k, v) in [(b"a", b"1"), (b"b", b"2"), (b"c", b"3")] {
        bucket.put_sync(k.to_vec(), v.to_vec()).expect("seed");
    }

    let mut branch = db.branch_from_latest().expect("branch");
    branch
        .put("data", b"b", b"2-branch".to_vec())
        .expect("override b");
    branch.delete("data", b"c").expect("delete c");
    branch.put("data", b"d", b"4".to_vec()).expect("add d");

    let rows = branch.range("data", &KeyRange::all()).expect("range");
    let got: Vec<(Vec<u8>, Vec<u8>)> = rows
        .map(|kv| {
            let kv = kv.expect("row");
            (kv.key, kv.value)
        })
        .collect();
    assert_eq!(
        got,
        vec![
            (b"a".to_vec(), b"1".to_vec()),
            (b"b".to_vec(), b"2-branch".to_vec()),
            (b"d".to_vec(), b"4".to_vec()),
        ]
    );
}

#[test]
fn durable_branch_persists_writes_and_shadows_parent() {
    let db = Db::open_sync(DbOptions::memory().with_keep_last_read_versions(64)).expect("open");
    let bucket = db.bucket_sync("data").expect("bucket");
    bucket
        .put_sync(b"k1".to_vec(), b"parent".to_vec())
        .expect("p1");
    bucket
        .put_sync(b"k2".to_vec(), b"parent".to_vec())
        .expect("p2");

    db.create_branch("dev", db.latest_read_version())
        .expect("create");
    {
        let mut dev = db.open_branch("dev").expect("open");
        dev.put("data", b"k1", b"dev".to_vec()).expect("put");
        dev.delete("data", b"k2").expect("delete");
    }

    // A freshly opened handle sees the persisted branch writes; the parent is
    // untouched.
    let dev = db.open_branch("dev").expect("reopen");
    assert_eq!(dev.get("data", b"k1").expect("get"), Some(b"dev".to_vec()));
    assert_eq!(
        dev.get("data", b"k2").expect("get"),
        None,
        "branch tombstone hides parent"
    );
    assert_eq!(dev.get("data", b"k3").expect("get"), None);
    assert_eq!(
        bucket.get_sync(b"k1").expect("get"),
        Some(b"parent".to_vec())
    );
    assert_eq!(
        bucket.get_sync(b"k2").expect("get"),
        Some(b"parent".to_vec())
    );

    assert_eq!(db.list_branches().expect("list"), vec!["dev".to_string()]);
    assert!(dev.is_durable());
}

#[test]
fn durable_branch_survives_reopen_with_default_retention() {
    let dir = std::env::temp_dir().join(format!("trine-branch-{}", std::process::id()));
    let _ = std::fs::remove_dir_all(&dir);
    // Default retention keeps only the latest version, yet the branch's fork
    // checkpoint pins its fork history durably — so it reopens with no manual
    // retention configuration (slice 3).
    {
        let db = Db::open_sync(&dir).expect("open");
        let bucket = db.bucket_sync("data").expect("bucket");
        bucket
            .put_sync(b"k".to_vec(), b"parent".to_vec())
            .expect("seed");
        db.create_branch("dev", db.latest_read_version())
            .expect("create");
        let mut dev = db.open_branch("dev").expect("open");
        dev.put("data", b"k", b"dev".to_vec()).expect("put");
        db.flush_sync().expect("flush");
    }
    // Reopen: the durable branch, its fork, and its writes all survive.
    let db = Db::open_sync(&dir).expect("reopen");
    assert_eq!(db.list_branches().expect("list"), vec!["dev".to_string()]);
    let dev = db.open_branch("dev").expect("open after reopen");
    assert_eq!(dev.get("data", b"k").expect("get"), Some(b"dev".to_vec()));
    let _ = std::fs::remove_dir_all(&dir);
}

#[test]
fn durable_branch_fork_is_pinned_against_aggressive_gc() {
    // keep_last_read_versions(1) retains only the latest version, so without a
    // pin the fork would expire after the next parent write.
    let db = Db::open_sync(DbOptions::memory().with_keep_last_read_versions(1)).expect("open");
    let bucket = db.bucket_sync("data").expect("bucket");
    bucket
        .put_sync(b"k".to_vec(), b"forked".to_vec())
        .expect("seed");
    db.create_branch("dev", db.latest_read_version())
        .expect("create");

    // Hammer the parent well past the fork; the fork checkpoint keeps that
    // history retained.
    for i in 0..50 {
        bucket
            .put_sync(b"k".to_vec(), format!("v{i}").into_bytes())
            .expect("churn");
    }

    let dev = db.open_branch("dev").expect("fork still openable");
    assert_eq!(
        dev.get("data", b"k").expect("get"),
        Some(b"forked".to_vec()),
        "the branch still reads its fork value despite aggressive parent GC"
    );
}

#[test]
fn delete_branch_releases_the_fork_pin() {
    let db = Db::open_sync(DbOptions::memory().with_keep_last_read_versions(1)).expect("open");
    let bucket = db.bucket_sync("data").expect("bucket");
    bucket
        .put_sync(b"k".to_vec(), b"forked".to_vec())
        .expect("seed");
    let fork = db.latest_read_version();
    db.create_branch("dev", fork).expect("create");

    // While the branch lives, the fork stays pinned even past parent writes.
    bucket
        .put_sync(b"k".to_vec(), b"after".to_vec())
        .expect("write");
    assert!(
        db.branch_at(fork).is_ok(),
        "fork pinned while branch exists"
    );

    db.delete_branch("dev").expect("delete");
    assert!(
        db.open_branch("dev").is_err(),
        "deleted branch cannot be opened"
    );
    // The pin is released: with only the latest retained, a further write
    // pushes the floor past the fork, which is now expired.
    bucket
        .put_sync(b"k".to_vec(), b"later".to_vec())
        .expect("write");
    assert!(
        db.branch_at(fork).is_err(),
        "the fork is no longer pinned after the branch is deleted"
    );
}

#[test]
fn durable_branch_range_merges_over_parent() {
    let db = Db::open_sync(DbOptions::memory().with_keep_last_read_versions(64)).expect("open");
    let bucket = db.bucket_sync("data").expect("bucket");
    for (k, v) in [(b"a", b"1"), (b"b", b"2"), (b"c", b"3")] {
        bucket.put_sync(k.to_vec(), v.to_vec()).expect("seed");
    }
    db.create_branch("dev", db.latest_read_version())
        .expect("create");
    let mut dev = db.open_branch("dev").expect("open");
    dev.put("data", b"b", b"2-dev".to_vec()).expect("override");
    dev.delete("data", b"c").expect("delete");
    dev.put("data", b"d", b"4".to_vec()).expect("add");

    let rows = dev.range("data", &KeyRange::all()).expect("range");
    let got: Vec<(Vec<u8>, Vec<u8>)> = rows
        .map(|kv| {
            let kv = kv.expect("row");
            (kv.key, kv.value)
        })
        .collect();
    assert_eq!(
        got,
        vec![
            (b"a".to_vec(), b"1".to_vec()),
            (b"b".to_vec(), b"2-dev".to_vec()),
            (b"d".to_vec(), b"4".to_vec()),
        ]
    );
}

#[test]
fn branch_of_branch_reads_through_the_whole_chain() {
    let db = Db::open_sync(DbOptions::memory().with_keep_last_read_versions(64)).expect("open");
    let bucket = db.bucket_sync("data").expect("bucket");
    bucket
        .put_sync(b"base".to_vec(), b"root".to_vec())
        .expect("seed");
    bucket
        .put_sync(b"shared".to_vec(), b"root".to_vec())
        .expect("seed");

    // a forks root and overrides `shared`, adds `a-only`.
    db.create_branch("a", db.latest_read_version())
        .expect("create a");
    {
        let mut a = db.open_branch("a").expect("open a");
        a.put("data", b"shared", b"a".to_vec()).expect("a override");
        a.put("data", b"a-only", b"a".to_vec()).expect("a add");
    }

    // b forks a, overrides `shared` again, adds `b-only`, deletes `a-only`.
    db.create_branch_from("b", "a").expect("create b from a");
    let mut b = db.open_branch("b").expect("open b");
    b.put("data", b"shared", b"b".to_vec()).expect("b override");
    b.put("data", b"b-only", b"b".to_vec()).expect("b add");
    b.delete("data", b"a-only").expect("b delete a-only");

    // b sees: its own writes, then a's, then root's, in that precedence.
    assert_eq!(b.get("data", b"shared").expect("get"), Some(b"b".to_vec()));
    assert_eq!(b.get("data", b"b-only").expect("get"), Some(b"b".to_vec()));
    assert_eq!(
        b.get("data", b"a-only").expect("get"),
        None,
        "b deleted a's key"
    );
    assert_eq!(
        b.get("data", b"base").expect("get"),
        Some(b"root".to_vec()),
        "falls through a (untouched) to the root"
    );

    // The range view merges the whole chain.
    let rows = b.range("data", &KeyRange::all()).expect("range");
    let got: Vec<(Vec<u8>, Vec<u8>)> = rows
        .map(|kv| {
            let kv = kv.expect("row");
            (kv.key, kv.value)
        })
        .collect();
    assert_eq!(
        got,
        vec![
            (b"b-only".to_vec(), b"b".to_vec()),
            (b"base".to_vec(), b"root".to_vec()),
            (b"shared".to_vec(), b"b".to_vec()),
        ]
    );

    // a is unaffected by b.
    let a = db.open_branch("a").expect("reopen a");
    assert_eq!(a.get("data", b"shared").expect("get"), Some(b"a".to_vec()));
    assert_eq!(a.get("data", b"a-only").expect("get"), Some(b"a".to_vec()));
    assert_eq!(a.get("data", b"b-only").expect("get"), None);
}

#[test]
fn branch_of_branch_is_frozen_when_its_parent_advances() {
    let db = Db::open_sync(DbOptions::memory().with_keep_last_read_versions(64)).expect("open");
    db.bucket_sync("data").expect("bucket");
    db.create_branch("a", db.latest_read_version())
        .expect("create a");
    {
        let mut a = db.open_branch("a").expect("open a");
        a.put("data", b"k", b"a1".to_vec()).expect("a write");
    }
    // b forks a at this point.
    db.create_branch_from("b", "a").expect("create b");
    // a keeps writing after the fork.
    {
        let mut a = db.open_branch("a").expect("reopen a");
        a.put("data", b"k", b"a2".to_vec()).expect("a write later");
    }
    // b sees a's value as of the fork, not a's later write.
    let b = db.open_branch("b").expect("open b");
    assert_eq!(b.get("data", b"k").expect("get"), Some(b"a1".to_vec()));
}

#[test]
fn cannot_delete_branch_with_children() {
    let db = Db::open_sync(DbOptions::memory().with_keep_last_read_versions(64)).expect("open");
    db.bucket_sync("data").expect("bucket");
    db.create_branch("a", db.latest_read_version())
        .expect("create a");
    db.create_branch_from("b", "a").expect("create b");

    assert!(
        db.delete_branch("a").is_err(),
        "a still has child b, so it cannot be deleted"
    );
    // Delete the child first, then the parent.
    db.delete_branch("b").expect("delete child");
    db.delete_branch("a")
        .expect("delete parent after child gone");
    assert!(db.list_branches().expect("list").is_empty());
}

#[test]
fn recreated_branch_does_not_inherit_deleted_branch_data() {
    let db = Db::open_sync(DbOptions::memory().with_keep_last_read_versions(64)).expect("open");
    let bucket = db.bucket_sync("data").expect("bucket");
    bucket
        .put_sync(b"k".to_vec(), b"parent".to_vec())
        .expect("seed");

    db.create_branch("dev", db.latest_read_version())
        .expect("create");
    {
        let mut dev = db.open_branch("dev").expect("open");
        dev.put("data", b"k", b"old".to_vec()).expect("write");
        dev.put("data", b"only-old", b"x".to_vec()).expect("write2");
    }
    db.delete_branch("dev")
        .expect("delete (clears the data bucket)");

    // Recreate the same name and write to the same bucket. The branch must
    // start from the parent, not inherit the deleted branch's rows.
    db.create_branch("dev", db.latest_read_version())
        .expect("recreate");
    let mut dev = db.open_branch("dev").expect("reopen");
    dev.put("data", b"k", b"new".to_vec()).expect("write");
    assert_eq!(dev.get("data", b"k").expect("get"), Some(b"new".to_vec()));
    assert_eq!(
        dev.get("data", b"only-old").expect("get"),
        None,
        "the deleted branch's data was cleared, not inherited"
    );
}

#[test]
fn branch_info_exposes_fork_and_parent_without_opening_data() {
    let db = Db::open_sync(DbOptions::memory().with_keep_last_read_versions(64)).expect("open");
    db.bucket_sync("data").expect("bucket");
    assert!(
        db.branch_info("missing").expect("info").is_none(),
        "an unknown branch has no lineage"
    );

    let fork = db.latest_read_version();
    db.create_branch("a", fork).expect("create a");
    let a = db.branch_info("a").expect("info").expect("a present");
    assert_eq!(a.fork(), fork, "exposes the fork version for fall-through");
    assert_eq!(a.parent(), None, "a forked the root lineage");

    db.create_branch_from("b", "a").expect("create b");
    let b = db.branch_info("b").expect("info").expect("b present");
    assert_eq!(b.parent(), Some("a"), "exposes the parent for nesting");
}

#[test]
fn drop_bucket_removes_it_in_memory() {
    let db = memory_db();
    let bucket = db.bucket_sync("scratch").expect("bucket");
    bucket.put_sync(b"k".to_vec(), b"v".to_vec()).expect("put");

    db.drop_bucket_sync("scratch").expect("drop");
    assert!(
        db.drop_bucket_sync("scratch").is_err(),
        "dropping a gone bucket errors"
    );
    assert!(
        db.drop_bucket_sync("default").is_err(),
        "the default bucket cannot be dropped"
    );

    // Recreating the name yields a fresh, empty bucket.
    let fresh = db.bucket_sync("scratch").expect("recreate");
    assert_eq!(fresh.get_sync(b"k").expect("get"), None);
}

#[test]
fn drop_bucket_persists_across_reopen() {
    let dir = std::env::temp_dir().join(format!("trine-drop-{}", std::process::id()));
    let _ = std::fs::remove_dir_all(&dir);
    {
        let db = Db::open_sync(&dir).expect("open");
        db.bucket_sync("scratch")
            .expect("scratch")
            .put_sync(b"k".to_vec(), b"v".to_vec())
            .expect("put");
        db.bucket_sync("keep")
            .expect("keep")
            .put_sync(b"k".to_vec(), b"keep".to_vec())
            .expect("put");
        db.drop_bucket_sync("scratch").expect("drop");
    }
    // Reopen: the dropped bucket is gone (recreates empty); the other survives.
    let db = Db::open_sync(&dir).expect("reopen");
    assert_eq!(
        db.bucket_sync("scratch")
            .expect("scratch")
            .get_sync(b"k")
            .expect("get"),
        None,
        "dropped bucket did not come back with its data"
    );
    assert_eq!(
        db.bucket_sync("keep")
            .expect("keep")
            .get_sync(b"k")
            .expect("get"),
        Some(b"keep".to_vec()),
        "an untouched bucket survives the drop"
    );
    let _ = std::fs::remove_dir_all(&dir);
}