#lsm-tree #persistence #embedded-database #embedded

sys ng-rocksdb

Rust wrapper for Facebook's RocksDB embeddable database, fork for Nextgraph.org

3 releases

0.21.0 May 23, 2024

#1886 in Database interfaces

41 downloads per month

Apache-2.0

1.5MB
30K SLoC

C 15K SLoC // 0.2% comments Rust 9K SLoC // 0.1% comments Visual Studio Project 4.5K SLoC Python 793 SLoC // 0.1% comments C++ 544 SLoC // 0.1% comments Visual Studio Solution 329 SLoC Shell 157 SLoC // 0.1% comments Bitbake 69 SLoC // 0.3% comments

ng-rocksdb

This is a fork of https://github.com/rust-rocksdb/rust-rocksdb that also includes a subtree of a fork of https://github.com/facebook/rocksdb for the needs of NextGraph.org project.

Requirements

  • Clang and LLVM

https://rust-lang.github.io/rust-bindgen/requirements.html

  • before using this crate, you have to download our fork of rocksdb here and unzip its content in src/branch/master/librocksdb-sys/rocksdb

On OpenBSD

pkg_add llvm
//choose the 17 version

On macOS

port install clang

On Linux

apt install llvm-dev libclang-dev clang

On windows

download from here

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.

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:

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

~0.3–6MB
~113K SLoC