fork of https://github.com/oxigraph/rocksdb and https://github.com/facebook/rocksdb for nextgraph and oxigraph

History

Siying Dong 6ef8c620d3 Move auto_roll_logger and filename out of db/ Summary: It is confusing to have auto_roll_logger to stay under db/, which has nothing to do with database. Move filename together as it is a dependency. Closes https://github.com/facebook/rocksdb/pull/2080 Differential Revision: D4821141 Pulled By: siying fbshipit-source-id: ca7d768		9 years ago
..
.gitignore	first rdb commit	11 years ago
API.md	fix typos in comments	10 years ago
README.md	first rdb commit	11 years ago
binding.gyp	first rdb commit	11 years ago
db_wrapper.cc	Move auto_roll_logger and filename out of db/	9 years ago
db_wrapper.h	first rdb commit	11 years ago
rdb	first rdb commit	11 years ago
rdb.cc	Move auto_roll_logger and filename out of db/	9 years ago
unit_test.js	first rdb commit	11 years ago

README.md

RDB - RocksDB Shell

RDB is a NodeJS-based shell interface to RocksDB. It can also be used as a JavaScript binding for RocksDB within a Node application.

Setup/Compilation

Requirements

static RocksDB library (i.e. librocksdb.a)
libsnappy
node (tested onv0.10.33, no guarantees on anything else!)
node-gyp
python2 (for node-gyp; tested with 2.7.8)

Installation

NOTE: If your default python binary is not a version of python2, add the arguments --python /path/to/python2 to the the node-gyp commands.

Make sure you have the static library (i.e. "librocksdb.a") in the root directory of your rocksdb installation. If not, cd there and run make static_lib.
Run node-gyp configure to generate the build.
Run node-gyp build to compile RDB.

Usage

Running the shell

Assuming everything compiled correctly, you can run the rdb executable located in the root of the tools/rdb directory to start the shell. The file is just a shell script that runs the node shell and loads the constructor for the RDB object into the top-level function RDB.

JavaScript API

See API.md for how to use RocksDB from the shell.