#lsm-tree #persistence #multi-threading #embedded

bijou-rocksdb

Rust wrapper for Facebook's RocksDB embeddable database

2 releases

0.21.1 Oct 13, 2023
0.21.0 Sep 30, 2023

#738 in Database interfaces

44 downloads per month
Used in 2 crates (via bijou)

Apache-2.0

450KB
8K SLoC

rust-rocksdb

This is a fork of rust-rocksdb.

RocksDB build crates.io documentation license Gitter chat rust 1.63.0 required

GitHub commits (since latest release)

Requirements

  • Clang and LLVM

Contributing

Feedback and pull requests welcome! If a particular feature of RocksDB is important to you, please let me know by opening an issue, and I'll prioritize it.

Usage

This binding is statically linked with a specific version of RocksDB. If you want to build it yourself, make sure you've also cloned the RocksDB and compression submodules:

git submodule update --init --recursive

Compression Support

By default, support for the Snappy, LZ4, Zstd, Zlib, and Bzip2 compression is enabled through crate features. If support for all of these compression algorithms is not needed, default features can be disabled and specific compression algorithms can be enabled. For example, to enable only LZ4 compression support, make these changes to your Cargo.toml:

[dependencies.rocksdb]
default-features = false
features = ["lz4"]

Multithreaded ColumnFamily alternation

The underlying RocksDB does allow column families to be created and dropped from multiple threads concurrently. But this crate doesn't allow it by default for compatibility. If you need to modify column families concurrently, enable crate feature called multi-threaded-cf, which makes this binding's data structures to use RwLock by default. Alternatively, you can directly create DBWithThreadMode<MultiThreaded> without enabling the crate feature.

Dependencies

~21MB
~442K SLoC