Skip to content

Latest commit

 

History

History
66 lines (49 loc) · 2.81 KB

README.md

File metadata and controls

66 lines (49 loc) · 2.81 KB

rust-rocksdb

RocksDB build crates.io documentation license Gitter chat rust 1.66.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 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

RocksDB allows 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 the crate feature multi-threaded-cf, which makes this binding's data structures use RwLock by default. Alternatively, you can directly create DBWithThreadMode<MultiThreaded> without enabling the crate feature.

Portable builds

RocksDB's build, unlike Cargo, will default to setting -march=native, which generate code that fully takes advantage of build machine's CPU's features. This may create a binary that isn't compatible with other CPUs on the same architecture. For example, building on a machine with AVX512 support will create a binary that fails with SIGILL on machines without AVX512.

Set the portable feature on this crate to pass PORTABLE=1 to RocksDB's build, which will create a portable binary at the cost of some performance.