Packages

rocksdb

0.26.0
3.1.2 3.1.1 3.1.0 3.0.0 2.6.2 2.6.1 retired 2.6.0 retired 2.5.0 2.4.1 2.4.0 2.3.0 2.2.0 2.1.0 2.0.0 1.9.0 1.8.0 1.7.0 1.6.0 1.5.1 1.5.0 1.4.0 1.3.2 1.3.1 1.3.0 1.2.0 1.1.1 1.1.0 1.0.0 0.26.2 0.26.1 0.26.0 0.25.0 0.24.0 0.23.3 0.23.2 0.23.1 0.23.0 0.22.0 0.21.0 0.20.1 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.1 0.13.0 0.12.0 0.11.0 0.10.0 0.9.1 0.9.0 0.8.2 0.8.1 0.8.0 0.7.1 0.7.0 0.6.4 0.6.3 0.6.2 0.6.1 0.6.0

RocksDB for Erlang

HexDocs

Current section

Files

Jump to
Readme
64 Versions
0 Dependencies
Dependants
Files
Activity
rocksdb deps rocksdb tools rdb README.md
Raw

deps/rocksdb/tools/rdb/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 `node-gyp` commands.



1. 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`.



2. Run `node-gyp configure` to generate the build.



3. 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.