You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Duarte Nunes db377fd1e3
Allow cloning the Cache and Env (#533)
4 years ago
.github/workflows Remove need for &mut self in create_cf and drop_cf (v2) (#506) 4 years ago
librocksdb-sys Upgrade librocksdb-sys to 6.20.3 (#531) 4 years ago
src Allow cloning the Cache and Env (#533) 4 years ago
tests Merge branch 'master' into set_zstd_max_train_bytes 4 years ago
.gitignore Use DBPath for backup_restore test and remove _rust_rocksdb* from .gitignore (#419) 5 years ago
.gitmodules Adding Zlib and Bzip2 compression support... 6 years ago
CHANGELOG.md Upgrade librocksdb-sys to 6.20.3 (#531) 4 years ago
CONTRIBUTING.md includes licensing note for code contributions 6 years ago
Cargo.toml Bump `librocksdb-sys` up to 6.19.3 (#525) 4 years ago
LICENSE Add clippy linter in CI (#417) 5 years ago
MAINTAINERSHIP.md Update MAINTAINERSHIP.md 6 years ago
README.md Remove travis badge 4 years ago
code-of-conduct.md Create code-of-conduct.md 6 years ago

README.md

rust-rocksdb

RocksDB build crates.io documentation license Gitter chat

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"]

Multi-threaded 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.