Need help with heed?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

Kerollmops
138 Stars 10 Forks Other 263 Commits 16 Opened issues

Description

A fully typed LMDB/MDBX wrapper with minimum overhead

Services available

!
?

Need anything else?

Contributors list

# 12,892
Rust
Shell
synonym...
Common ...
196 commits
# 28,867
Rust
Shell
JavaScr...
synonym...
2 commits
# 532,894
Rust
Shell
Python
kafka
1 commit

heed

A fully typed LMDB/MDBX wrapper with minimum overhead, uses bytemuck internally.

Build Status Dependency Status Heed Doc Crates.io

the opposite of heed

This library is able to serialize all kind of types, not just bytes slices, even Serde types are supported.

Using MDBX instead of LMDB

Heed can also be used with MDBX, this is a compatible backend, you can activate it by using the

mdbx
feature. When MDBX is used the generated databases cannot be read by using the
lmdb
feature, those two kv-stores are not compatible and vice-versa.

Notice that some specific features will only be accessible by using the

mdbx
cargo feature. Environment creation flags depends on the backend you chose.

To test that heed works with MDBX you can run this command:

cargo test --features 'mdbx serde-json' --no-default-features

Example Usage

fs::create_dir_all("target/heed.mdb")?;
let env = EnvOpenOptions::new().open("target/heed.mdb")?;

// We open the default unamed database. // Specifying the type of the newly created database. // Here we specify that the key is an str and the value a simple integer. let db: Database> = env.create_database(None)?;

// We then open a write transaction and start writing into the database. // All of those puts are type checked at compile time, // therefore you cannot write an integer instead of a string. let mut wtxn = env.write_txn()?; db.put(&mut wtxn, "seven", &7)?; db.put(&mut wtxn, "zero", &0)?; db.put(&mut wtxn, "five", &5)?; db.put(&mut wtxn, "three", &3)?; wtxn.commit()?;

// We open a read transaction to check if those values are available. // When we read we also type check at compile time. let rtxn = env.read_txn()?;

let ret = db.get(&rtxn, "zero")?; assert_eq!(ret, Some(0));

let ret = db.get(&rtxn, "five")?; assert_eq!(ret, Some(5));

You want to see more about all the possibilities? Go check out the examples.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.