Popularity
4.4
Declining
Activity
0.0
Stable
7
1
2

Monthly Downloads: 9
Programming language: C++
License: BSD 3-clause "New" or "Revised" License
Tags: Database     Direct    
Latest version: v0.0.3
Add another 'direct' Package

README

direct-rocksdb

CircleCI Hackage Stackage Nightly

Bindings to RocksDB.

Building

This package builds RocksDB in place by default. This requires:

You can use the NINJA_FLAGS environment variable to pass extra flags to ninja, e.g. NINJA_FLAGS=-j2. This is a hack for building on CI, since ninja seems to fail to detect the actual number of CPU cores available.

To skip building and link with system-wide RocksDB, use the system-rocksdb Cabal flag. This is not recommended, since this package is only developed with the latest release of RocksDB.

Using

[Database.RocksDB.Internals](src/Database/RocksDB/Internals.hs) contains the raw C bindings. All functions and enum values in [rocksdb/c.h](rocksdb-5.8/include/rocksdb/c.h) are covered. The opaque types like rocksdb_t, rocksdb_options_t have corresponding Haskell types like Rocksdb, RocksdbOptions. They are nullary datatypes and are only used to mark the Ptr phantom type.

The higher-level API is being worked on. Using functions like marshalOptions, openDB, you can obtain a ForeignPtr which carries a C resource. The garbage collector can automatically invokes the ForeignPtr finalizers, and you can also use finalizeForeignPtr with something like bracket or ResourceT to ensure scoped finalizing. Also, ByteStrings are used instead of raw buffers.

Some RocksDB functions require passing in a pointer to an error message buffer for error reporting. The higher-level API will obtain the error message and throw it with a RocksDBException when present.

About Windows support

Unsupported for now.