gecko-dev/third_party/rust/lmdb-rkv/README.md

lmdb-rs

Idiomatic and safe APIs for interacting with the Symas Lightning Memory-Mapped Database (LMDB).

This repo is a fork of danburkert/lmdb-rs with fixes for issues encountered by mozilla/rkv.

Building from Source

git clone --recursive git@github.com:mozilla/lmdb-rs.git
cd lmdb-rs
cargo build

Publishing to crates.io

To publish the lmdb-rkv-sys crate to crates.io:

git clone --recursive git@github.com:mozilla/lmdb-rs.git
cd lmdb-rs/lmdb-sys
# Update the version string in lmdb-sys/Cargo.toml and lmdb-sys/src/lib.rs.
cargo publish
git tag lmdb-rkv-sys-$VERSION # where $VERSION is the updated version string
git push git@github.com:mozilla/lmdb-rs.git --tags

To publish the lmdb-rkv crate to crates.io:

git clone --recursive git@github.com:mozilla/lmdb-rs.git
cd lmdb-rs
# Update the version string in Cargo.toml and src/lib.rs and temporarily change
# the lmdb-rkv-sys dependency in Cargo.toml to the latest version on crates.io.
cargo publish
git tag $VERSION # where $VERSION is the updated version string
git push git@github.com:mozilla/lmdb-rs.git --tags
# Change the lmdb-rkv-sys dependency in Cargo.toml back to a path dependency
# on the ./lmdb-sys directory.

Features

• lmdb-sys.
• Cursors.
• Zero-copy put API.
• Nested transactions.
• Database statistics.