heed 0.22.1

A fully typed LMDB (mdb.master) wrapper with minimum overhead
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

use std::error::Error;

use heed::types::*;
use heed::{Database, EnvFlags, EnvOpenOptions};

// In this test we are checking that we can move to a previous environement snapshot.
fn main() -> Result<(), Box<dyn Error>> {
    let env_path = tempfile::tempdir()?;

    let env = unsafe {
        EnvOpenOptions::new()
            .map_size(10 * 1024 * 1024) // 10MB
            .max_dbs(3)
            .open(&env_path)?
    };

    let mut wtxn = env.write_txn()?;
    let db: Database<Str, Str> = env.create_database(&mut wtxn, None)?;

    // We fill the db database with entries.
    db.put(&mut wtxn, "I am here", "to test things")?;
    db.put(&mut wtxn, "I am here too", "for the same purpose")?;

    wtxn.commit()?;

    env.prepare_for_closing().wait();

    // We can get the env state from before the last commit
    // and therefore see an empty env.
    let env = unsafe {
        EnvOpenOptions::new()
            .map_size(10 * 1024 * 1024) // 10MB
            .max_dbs(3)
            .flags(EnvFlags::PREV_SNAPSHOT)
            .open(&env_path)?
    };

    let mut wtxn = env.write_txn()?;
    let db: Database<Str, Str> = env.create_database(&mut wtxn, None)?;

    assert!(db.is_empty(&wtxn)?);

    wtxn.abort();
    env.prepare_for_closing().wait();

    // However, if we don't commit we can still get
    // back the latest version of the env.
    let env = unsafe {
        EnvOpenOptions::new()
            .map_size(10 * 1024 * 1024) // 10MB
            .max_dbs(3)
            .open(&env_path)?
    };

    let mut wtxn = env.write_txn()?;
    let db: Database<Str, Str> = env.create_database(&mut wtxn, None)?;

    assert_eq!(db.get(&wtxn, "I am here")?, Some("to test things"));
    assert_eq!(db.get(&wtxn, "I am here too")?, Some("for the same purpose"));

    // And write new stuff in the env.
    db.put(&mut wtxn, "I will fade away", "I am so sad")?;

    wtxn.commit()?;
    env.prepare_for_closing().wait();

    // Once again we can get back the previous version
    // of the env and see some entries disappear.
    let env = unsafe {
        EnvOpenOptions::new()
            .map_size(10 * 1024 * 1024) // 10MB
            .max_dbs(3)
            .flags(EnvFlags::PREV_SNAPSHOT)
            .open(&env_path)?
    };

    let rtxn = env.read_txn()?;
    let db: Database<Str, Str> = env.open_database(&rtxn, None)?.unwrap();

    assert_eq!(db.get(&rtxn, "I am here")?, Some("to test things"));
    assert_eq!(db.get(&rtxn, "I am here too")?, Some("for the same purpose"));
    assert_eq!(db.get(&rtxn, "I will fade away")?, None);

    Ok(())
}