1# RDB - RocksDB Shell 2 3RDB is a NodeJS-based shell interface to RocksDB. It can also be used as a 4JavaScript binding for RocksDB within a Node application. 5 6## Setup/Compilation 7 8### Requirements 9 10* static RocksDB library (i.e. librocksdb.a) 11* libsnappy 12* node (tested onv0.10.33, no guarantees on anything else!) 13* node-gyp 14* python2 (for node-gyp; tested with 2.7.8) 15 16### Installation 17 18NOTE: If your default `python` binary is not a version of python2, add 19the arguments `--python /path/to/python2` to the `node-gyp` commands. 20 211. Make sure you have the static library (i.e. "librocksdb.a") in the root 22directory of your rocksdb installation. If not, `cd` there and run 23`make static_lib`. 24 252. Run `node-gyp configure` to generate the build. 26 273. Run `node-gyp build` to compile RDB. 28 29## Usage 30 31### Running the shell 32 33Assuming everything compiled correctly, you can run the `rdb` executable 34located in the root of the `tools/rdb` directory to start the shell. The file is 35just a shell script that runs the node shell and loads the constructor for the 36RDB object into the top-level function `RDB`. 37 38### JavaScript API 39 40See `API.md` for how to use RocksDB from the shell. 41