status-im
/
nim-rocksdb
mirror of https://github.com/status-im/nim-rocksdb.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
nim-rocksdb/README.md

59 lines
2.6 KiB
Markdown
Raw Normal View History

initial commit
2018-01-27 10:34:54 +00:00
# Nim-RocksDB
readme: fix license, badges
2018-09-05 05:02:57 +00:00
[![Build Status (Travis)](https://img.shields.io/travis/status-im/nim-rocksdb/master.svg?label=Linux%20/%20macOS "Linux/macOS build status (Travis)")](https://travis-ci.org/status-im/nim-rocksdb)
[![Windows build status (Appveyor)](https://img.shields.io/appveyor/ci/nimbus/nim-rocksdb/master.svg?label=Windows "Windows build status (Appveyor)")](https://ci.appveyor.com/project/nimbus/nim-rocksdb)
[![License: Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg)
initial commit
2018-01-27 10:34:54 +00:00
A Nim wrapper for [Facebook's RocksDB](https://github.com/facebook/rocksdb), a persistent key-value store for Flash and RAM Storage.
Add nim-rocksdb usage example
2018-01-27 16:01:14 +00:00
## Current status
Rocksdb rewrite integration (#38) * Column families support (#34) * Update library to support column families. If not specified, uses the 'default' column family. * Added tests for column family changes. * Update library version and readme. * Updated the librocksdb c library to the latest stable version. * Started rewrite of library. * Commit library rewrite progress. * Completed initial rewrite and refactored tests. * Completed implementation of backup engine. * Added tests for new types. * Completed tests for existing features. * Remove features not supported by older versions of RocksDB to fix CI (temporary fix). * Remove flush before backup support from BackupEngine to fix CI. * Transactions support (#36) * Update library to support column families. If not specified, uses the 'default' column family. * Added tests for column family changes. * Update library version and readme. * Updated the librocksdb c library to the latest stable version. * Started rewrite of library. * Commit library rewrite progress. * Completed initial rewrite and refactored tests. * Completed implementation of backup engine. * Added tests for new types. * Completed tests for existing features. * Remove features not supported by older versions of RocksDB to fix CI (temporary fix). * Remove flush before backup support from BackupEngine to fix CI. * Implemented RocksDB iterator. * Implemented pairs iterator. * Completed implementation of WriteBatch with tests. * Fix example code. * Completed implementation of TransactionDb. * Support setting default column family. * Remove unneeded usage of var for ref type parameters. * Completed transactiondb tests. * Improve and refactor rocksdb test. * Added support for ingesting sst files using the SstFileWriter. (#37) * Create ColFamilyReadOnly and ColFamilyReadWrite types for using a specific column family. * Use inline pragma for small procs and add lock to RocksDbRef type close to prevent double free. * Added documentation for the public API. * Initial implementation of sst filewriter. * Added tests for sstfilewriter. * Documentation minor improvements.
2024-03-05 03:12:37 +00:00
Nim-RocksDB provides a wrapper for the low-level functions in the librocksdb c library.
Add nim-rocksdb usage example
2018-01-27 16:01:14 +00:00
use dynamic linking instead of dlopen on all Linux distros - also document the need for "librocksdb-dev" on Debian
2018-12-25 10:56:20 +00:00
## 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`.
Add nim-rocksdb usage example
2018-01-27 16:01:14 +00:00
## Usage
See [simple_example](examples/simple_example.nim)
allow statically linking librocksdb (#29)
2022-03-22 09:02:39 +00:00
### Static linking
To statically link librocksdb, you would do something like:
```nim
nim c -d:LibrocksbStaticArgs='-l:librocksdb.a' --gcc.linkerexe=g++ --threads:on your_program.nim
```
(we need the C++ linker profile because it's a C++ library)
initial commit
2018-01-27 10:34:54 +00:00
### Contribution
Any contribution intentionally submitted for inclusion in the work by you shall be dual licensed as above, without any
remove example from README - linked code is more recent
2018-08-16 19:13:34 +00:00
additional terms or conditions.
readme: fix license, badges
2018-09-05 05:02:57 +00:00
## License
License update to respect original repo (#16)
2019-01-03 13:04:11 +00:00
### Wrapper License
This repository is licensed and distributed under either of
readme: update license
2018-09-05 18:48:31 +00:00
* MIT license: [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT
Update README.md
2019-01-02 13:57:34 +00:00
or
* Apache License, Version 2.0, ([LICENSE-APACHEv2](LICENSE-APACHEv2) or http://www.apache.org/licenses/LICENSE-2.0)
readme: fix license, badges
2018-09-05 05:02:57 +00:00
Update README.md
2019-01-02 13:57:34 +00:00
at your option. This file may not be copied, modified, or distributed except according to those terms.
License update to respect original repo (#16)
2019-01-03 13:04:11 +00:00
### 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](https://github.com/facebook/rocksdb/blob/master/COPYING) and Apache License, Version 2.0, ([LICENSE-APACHEv2](LICENSE-APACHEv2) or http://www.apache.org/licenses/LICENSE-2.0). You may select, at your option, one of the above-listed licenses.