0376869f05
Summary: As title. This is part of an fb-internal task. First, remove all `using namespace` statements if applicable. Next, utilize multiple build platforms and see if anything is broken. Should anything become broken, fix the compilation errors with as little extra change as possible. Pull Request resolved: https://github.com/facebook/rocksdb/pull/9369 Test Plan: internal build and make check make clean && make static_lib && cd examples && make all Reviewed By: pdillinger Differential Revision: D33517260 Pulled By: riversand963 fbshipit-source-id: 3fc4ce6402a073421dfd9a9b2d1c79441dca7a40 |
||
---|---|---|
.. | ||
.gitignore | ||
API.md | ||
README.md | ||
binding.gyp | ||
db_wrapper.cc | ||
db_wrapper.h | ||
rdb | ||
rdb.cc | ||
unit_test.js |
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.
-
Make sure you have the static library (i.e. "librocksdb.a") in the root directory of your rocksdb installation. If not,
cd
there and runmake 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.