Nim wrapper for RocksDB, a persistent key-value store for Flash and RAM Storage.
Go to file
Jacek Sieka 2879227085
expose additional configuration options (#43)
* caches
* table options
* spelling fixes
2024-06-04 12:06:14 +02:00
.github/workflows expose additional configuration options (#43) 2024-06-04 12:06:14 +02:00
examples Rocksdb rewrite integration (#38) 2024-03-05 11:12:37 +08:00
rocksdb expose additional configuration options (#43) 2024-06-04 12:06:14 +02:00
scripts Support for static linking RocksDb. (#40) 2024-03-27 14:18:21 +08:00
tests expose additional configuration options (#43) 2024-06-04 12:06:14 +02:00
vendor Support for static linking RocksDb. (#40) 2024-03-27 14:18:21 +08:00
.gitignore Fix broken CI (#35) 2024-02-13 20:59:41 +07:00
.gitmodules Support for static linking RocksDb. (#40) 2024-03-27 14:18:21 +08:00
LICENSE-APACHEv2 fix license files 2018-11-14 12:57:17 -06:00
LICENSE-MIT fix license files 2018-11-14 12:57:17 -06:00
README.md Support for static linking RocksDb. (#40) 2024-03-27 14:18:21 +08:00
config.nims expose additional configuration options (#43) 2024-06-04 12:06:14 +02:00
nim.cfg Support for static linking RocksDb. (#40) 2024-03-27 14:18:21 +08:00
rocksdb.nim Support for static linking RocksDb. (#40) 2024-03-27 14:18:21 +08:00
rocksdb.nimble Support for static linking RocksDb. (#40) 2024-03-27 14:18:21 +08:00

README.md

Nim-RocksDB

Build Status (Travis) Windows build status (Appveyor) License: Apache License: MIT Stability: experimental

A Nim wrapper for Facebook's RocksDB, a persistent key-value store for Flash and RAM Storage.

Current status

Nim-RocksDB provides a wrapper for the low-level functions in the librocksdb c library.

Requirements

A RocksDB installation that provides librocksdb.so. This means that on Debian, and possibly on other Linux distros, you need "librocksdb-dev", not just a versioned "librocksdbX.Y" package that only provides librocksdb.so.X.Y.Z.

Usage

See simple_example

Static linking

To statically link librocksdb, you would do something like:

nim c -d:rocksdb_static_linking --threads:on your_program.nim

See the config.nims file which contains the static linking configuration which is switched on with the rocksdb_static_linking flag. Note that static linking is currently not supported on windows.

Contribution

Any contribution intentionally submitted for inclusion in the work by you shall be dual licensed as above, without any additional terms or conditions.

License

Wrapper License

This repository is licensed and distributed under either of

or

at your option. This file may not be copied, modified, or distributed except according to those terms.

Dependency License

RocksDB is developed and maintained by Facebook Database Engineering Team. It is built on earlier work on LevelDB by Sanjay Ghemawat (sanjay@google.com) and Jeff Dean (jeff@google.com)

RocksDB is dual-licensed under both the GPLv2 and Apache License, Version 2.0, (LICENSE-APACHEv2 or http://www.apache.org/licenses/LICENSE-2.0). You may select, at your option, one of the above-listed licenses.