Go to file
Paul O'Shannessy 9a449865e3 Adopt Contributor Covenant
Summary:
In order to foster healthy open source communities, we're adopting the
[Contributor Covenant](https://www.contributor-covenant.org/). It has been
built by open source community members and represents a shared understanding of
what is expected from a healthy community.

Reviewed By: josephsavona, danobi, rdzhabarov

Differential Revision: D17104640

fbshipit-source-id: d210000de686c5f0d97d602b50472d5869bc6a49
2019-08-29 23:21:01 -07:00
buckifier Change buckifier to support parameterized dependencies (#5648) 2019-08-02 10:55:17 -07:00
build_tools Port folly/synchronization/DistributedMutex to rocksdb (#5642) 2019-08-07 14:34:19 -07:00
cache Cleaned up and simplified LRU cache implementation (#5579) 2019-07-16 19:17:45 -07:00
cmake cmake: s/SNAPPY_LIBRARIES/snappy_LIBRARIES/ (#5687) 2019-08-16 15:49:23 -07:00
coverage Fix interpreter lines for files with python2-only syntax. 2019-07-09 10:51:37 -07:00
db Lower the risk for users to run options.force_consistency_checks = true (#5744) 2019-08-29 14:07:37 -07:00
docs Blog post for write_unprepared (#5711) 2019-08-15 14:41:13 -07:00
env fix compile error: ‘FALLOC_FL_KEEP_SIZE’ undeclared (#5708) 2019-08-16 13:58:05 -07:00
examples Refactor trimming logic for immutable memtables (#5022) 2019-08-23 13:55:34 -07:00
file New API to get all merge operands for a Key (#5604) 2019-08-06 14:26:44 -07:00
hdfs Add copyright headers per FB open-source checkup tool. (#5199) 2019-04-18 10:55:01 -07:00
include/rocksdb Refactor trimming logic for immutable memtables (#5022) 2019-08-23 13:55:34 -07:00
java Refactor trimming logic for immutable memtables (#5022) 2019-08-23 13:55:34 -07:00
logging Auto Roll Logger to add some extra checking to avoid segfault. (#5623) 2019-07-24 15:14:40 -07:00
memory Move some logging related files to logging/ (#5387) 2019-05-31 17:23:59 -07:00
memtable simplify include directive involving inttypes (#5402) 2019-06-06 13:56:07 -07:00
monitoring fix compiling with `-DNPERF_CONTEXT` (#5704) 2019-08-16 14:38:08 -07:00
options Refactor trimming logic for immutable memtables (#5022) 2019-08-23 13:55:34 -07:00
port fix sign compare warnings (#5651) 2019-07-30 14:12:54 -07:00
table Fix comment of function NotifyCollectTableCollectorsOnFinish (#5738) 2019-08-29 10:57:01 -07:00
test_util Refactor trimming logic for immutable memtables (#5022) 2019-08-23 13:55:34 -07:00
third-party Fix TSAN failures in DistributedMutex tests (#5684) 2019-08-14 17:01:31 -07:00
tools crash_test to skip compaction TTL for FIFO compaction. (#5749) 2019-08-27 17:55:37 -07:00
trace_replay Block cache analyzer: Support reading from human readable trace file. (#5679) 2019-08-09 13:13:54 -07:00
util Refactor trimming logic for immutable memtables (#5022) 2019-08-23 13:55:34 -07:00
utilities replace some reinterpret_cast with static_cast_with_check (#5740) 2019-08-27 10:59:11 -07:00
.clang-format
.gitignore Block cache simulator: Add pysim to simulate caches using reinforcement learning. (#5610) 2019-07-26 14:41:13 -07:00
.lgtm.yml Create lgtm.yml for LGTM.com C/C++ analysis (#4058) 2018-06-26 12:43:04 -07:00
.travis.yml Switch Travis to Xenial build (#4789) 2019-06-17 10:20:02 -07:00
.watchmanconfig Added .watchmanconfig file to rocksdb repo (#5593) 2019-07-19 15:00:33 -07:00
AUTHORS Update RocksDB Authors File 2017-10-18 14:42:10 -07:00
CMakeLists.txt Refactor trimming logic for immutable memtables (#5022) 2019-08-23 13:55:34 -07:00
CODE_OF_CONDUCT.md Adopt Contributor Covenant 2019-08-29 23:21:01 -07:00
CONTRIBUTING.md Add Code of Conduct 2017-12-05 18:42:35 -08:00
COPYING
DEFAULT_OPTIONS_HISTORY.md
DUMP_FORMAT.md
HISTORY.md Lower the risk for users to run options.force_consistency_checks = true (#5744) 2019-08-29 14:07:37 -07:00
INSTALL.md Update the version of the dependencies used by the RocksJava static build (#4761) 2018-12-18 20:25:43 -08:00
LANGUAGE-BINDINGS.md LANGUAGE-BINDINGS.md: mention python-rocksdb 2019-03-20 11:10:48 -07:00
LICENSE.Apache
LICENSE.leveldb
Makefile Atomic Flush Crash Test also covers the case that WAL is enabled. (#5729) 2019-08-22 16:32:55 -07:00
README.md Add LevelDB repository link in the Readme 2019-04-01 18:19:09 -07:00
ROCKSDB_LITE.md Fix some typos in comments and docs. 2018-03-08 10:27:25 -08:00
TARGETS Refactor trimming logic for immutable memtables (#5022) 2019-08-23 13:55:34 -07:00
USERS.md Add Crux to USERS.md 2019-08-29 11:29:48 -07:00
Vagrantfile Adding CentOS 7 Vagrantfile & build script 2018-02-26 15:27:17 -08:00
WINDOWS_PORT.md #5145 , rename port/dirent.h to port/port_dirent.h to avoid compile err when use port dir as header dir output (#5152) 2019-04-04 11:38:19 -07:00
appveyor.yml New API to get all merge operands for a Key (#5604) 2019-08-06 14:26:44 -07:00
defs.bzl Change buckifier to support parameterized dependencies (#5648) 2019-08-02 10:55:17 -07:00
issue_template.md Add a template for issues 2017-09-29 11:41:28 -07:00
src.mk Refactor trimming logic for immutable memtables (#5022) 2019-08-23 13:55:34 -07:00
thirdparty.inc Fix build jemalloc api (#5470) 2019-06-24 17:40:32 -07:00

README.md

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

Linux/Mac Build Status Windows Build status PPC64le 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/

License

RocksDB is dual-licensed under both the GPLv2 (found in the COPYING file in the root directory) and Apache 2.0 License (found in the LICENSE.Apache file in the root directory). You may select, at your option, one of the above-listed licenses.