Go to file
krad 697380f3d7 Repairer documentation improvement.
Summary: Adding verbosity to existing comments.

Test Plan: None

Reviewers: sdong

CC: leveldb

Task ID: #6718960

Blame Rev:
2015-04-10 12:35:28 -07:00
arcanist_util Integrate Jenkins with Phabricator 2015-04-07 11:56:29 -07:00
build_tools Remove use of whole-archive to include jemalloc 2015-04-09 15:10:53 -07:00
coverage Fix coverage script 2014-11-03 14:53:00 -08:00
db Repairer documentation improvement. 2015-04-10 12:35:28 -07:00
doc Remove seek compaction 2014-06-20 10:23:02 +02:00
examples Fix formatting 2015-02-09 09:53:30 -08:00
hdfs Remove unused parameter in CancelAllBackgroundWork 2015-03-16 21:07:54 -07:00
include Add thread-safety documentation to MemTable and related classes 2015-04-08 21:10:35 -07:00
java Fixed a typo in RocksDBSample.java 2015-03-25 11:09:30 -07:00
port stack_trace.cc: fix #elif check for OS_MACOSX 2015-03-17 12:00:55 +01:00
table Clean up compression logging 2015-04-06 12:50:44 -07:00
third-party Update COMMIT.md 2015-03-30 17:48:16 -07:00
tools Script to check whether RocksDB can read DB generated by previous releases and vice versa 2015-04-08 16:04:59 -07:00
util Fixed xfunc related compile errors in ROCKSDB_LITE 2015-04-09 21:05:18 -07:00
utilities Fix the compilation error in flashcache.cc on Mac 2015-04-07 15:27:23 -07:00
.arcconfig Integrate Jenkins with Phabricator 2015-04-07 11:56:29 -07:00
.clang-format A script that automatically reformat affected lines 2014-01-14 12:21:24 -08:00
.gitignore run 'make check's rules (and even subtests) in parallel 2015-04-06 12:35:25 -07:00
.travis.yml Only run db_test in Travis 2015-03-17 15:24:16 -07:00
AUTHORS Add AUTHORS file. Fix #203 2014-09-29 10:52:18 -07:00
CONTRIBUTING.md facebook accounts are not required for CLA signers 2014-07-08 05:57:54 -04:00
HISTORY.md A new call back to TablePropertiesCollector to allow users know the entry is add, delete or merge 2015-04-06 10:27:21 -07:00
INSTALL.md Optimize default compile to compilation platform by default 2014-12-15 11:29:41 +01:00
LICENSE Fix copyright year 2014-03-12 12:06:58 -07:00
Makefile MemTableList tests 2015-04-09 18:01:11 -07:00
PATENTS Fix the patent format 2013-10-16 15:37:32 -07:00
README.md Replaced "built on on earlier work" by "built on earlier work" in README.md 2014-09-17 01:16:17 -07:00
ROCKSDB_LITE.md RocksDBLite 2014-04-15 13:39:26 -07:00
USERS.md Add LinkedIn back to USERS.md 2015-04-10 09:50:19 -07:00
Vagrantfile RocksDB on FreeBSD support 2015-02-26 15:19:17 -08:00
src.mk build: don't use a glob for java/rocksjni/* 2015-04-07 15:19:25 -07:00

README.md

RocksDB: A Persistent Key-Value Store for Flash and RAM Storage

Build Status

RocksDB is developed and maintained by Facebook Database Engineering Team. It is built on earlier work on LevelDB by Sanjay Ghemawat (sanjay@google.com) and Jeff Dean (jeff@google.com)

This code is a library that forms the core building block for a fast key value server, especially suited for storing data on flash drives. It has a Log-Structured-Merge-Database (LSM) design with flexible tradeoffs between Write-Amplification-Factor (WAF), Read-Amplification-Factor (RAF) and Space-Amplification-Factor (SAF). It has multi-threaded compactions, making it specially suitable for storing multiple terabytes of data in a single database.

Start with example usage here: https://github.com/facebook/rocksdb/tree/master/examples

See the github wiki for more explanation.

The public interface is in include/. Callers should not include or rely on the details of any other header files in this package. Those internal APIs may be changed without warning.

Design discussions are conducted in https://www.facebook.com/groups/rocksdb.dev/