Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Clone this wiki locally
Welcome to RocksDB
RocksDB is a C++ library providing an embedded key-value store, where keys and values are arbitrary byte streams. It was developed at Facebook based on LevelDB and provides backwards-compatible support for LevelDB APIs.
RocksDB is optimized for Flash with extremely low latencies. RocksDB uses a Log Structured Database Engine for storage, written entirely in C++. A Java version called RocksJava is currently in development. See RocksJava Basics.
RocksDB features highly flexible configuration settings that may be tuned to run on a variety of production environments, including pure memory, Flash, hard disks or HDFS. It supports various compression algorithms and good tools for production support and debugging.
- Designed for application servers wanting to store up to a few terabytes of data on locally attached Flash drives or in RAM
- Optimized for storing small to medium size key-values on fast storage -- flash devices or in-memory
- Scales linearly with number of CPUs so that it works well on processors with many cores
Features Not in LevelDB
RocksDB introduces dozens of new major features. See the list of features not in LevelDB.
For a complete Table of Contents, see the sidebar to the left. Most readers will want to start with the Overview and the Basic Operations section of the Developer's Guide. Get your initial options set-up following Set Up Options. Also check RocksDB FAQ. There is a also a RocksDB Tuning Guide for advanced RocksDB users.
Reporting bugs and asking for help
If you will run into any issues then please use these guidelines to report bugs and ask for help.
- Check out our blog at rocksdb.org/blog