|
|
|
@ -1,5 +1,5 @@ |
|
|
|
|
rust-rocksdb |
|
|
|
|
============ |
|
|
|
|
# rust-rocksdb |
|
|
|
|
|
|
|
|
|
![RocksDB build](https://github.com/rust-rocksdb/rust-rocksdb/workflows/RocksDB%20build/badge.svg?branch=master) |
|
|
|
|
[![crates.io](https://img.shields.io/crates/v/rocksdb.svg)](https://crates.io/crates/rocksdb) |
|
|
|
|
[![documentation](https://docs.rs/rocksdb/badge.svg)](https://docs.rs/rocksdb) |
|
|
|
@ -7,7 +7,6 @@ rust-rocksdb |
|
|
|
|
[![Gitter chat](https://badges.gitter.im/rust-rocksdb/gitter.png)](https://gitter.im/rust-rocksdb/lobby) |
|
|
|
|
![rust 1.60.0 required](https://img.shields.io/badge/rust-1.60.0-blue.svg?label=MSRV) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
![GitHub commits (since latest release)](https://img.shields.io/github/commits-since/rust-rocksdb/rust-rocksdb/latest.svg) |
|
|
|
|
|
|
|
|
|
## Requirements |
|
|
|
@ -20,27 +19,30 @@ rust-rocksdb |
|
|
|
|
pkg_add llvm |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
## Contributing |
|
|
|
|
### On macos |
|
|
|
|
|
|
|
|
|
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. |
|
|
|
|
``` |
|
|
|
|
port install clang |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
## Usage |
|
|
|
|
### On windows |
|
|
|
|
|
|
|
|
|
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: |
|
|
|
|
download from [here](https://github.com/llvm/llvm-project/releases/download/llvmorg-16.0.0/LLVM-16.0.0-win64.exe) |
|
|
|
|
|
|
|
|
|
git submodule update --init --recursive |
|
|
|
|
## 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](https://github.com/google/snappy), |
|
|
|
|
[LZ4](https://github.com/lz4/lz4), [Zstd](https://github.com/facebook/zstd), |
|
|
|
|
[Zlib](https://zlib.net), and [Bzip2](http://www.bzip.org) 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 |
|
|
|
|
|
|
|
|
|
By default, support for the [Snappy](https://github.com/google/snappy), |
|
|
|
|
[LZ4](https://github.com/lz4/lz4), [Zstd](https://github.com/facebook/zstd), |
|
|
|
|
[Zlib](https://zlib.net), and [Bzip2](http://www.bzip.org) 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: |
|
|
|
|
|
|
|
|
|
``` |
|
|
|
|