Go to file
Pooja Malik 892a156267 Advisor: README and blog, and also tests for DBBenchRunner, DatabaseOptions (#4201)
Summary:
This pull request adds a README file and a blog post for the Advisor tool. It also adds the missing tests for some Optimizer modules. Some comments are added to the classes being tested for improved readability.
Pull Request resolved: https://github.com/facebook/rocksdb/pull/4201

Reviewed By: maysamyabandeh

Differential Revision: D9125311

Pulled By: poojam23

fbshipit-source-id: aefcf2f06eaa05490cc2834ef5aa6e21f0d1dc55
2018-08-01 16:13:09 -07:00
buckifier Remove two CI tests (#4110) 2018-07-12 11:43:25 -07:00
build_tools Pass -latomic to linker when using clang 2018-04-25 12:13:41 -07:00
cache Support group commits of version edits (#3944) 2018-06-28 12:34:39 -07:00
cmake Search paths provided by intel's "tbbvars.sh". 2018-05-07 14:28:36 -07:00
coverage Remove unused imports, from python scripts. (#4057) 2018-06-26 12:43:04 -07:00
db Skip range deletions at seqno zero when collapsing (#4216) 2018-08-01 12:12:02 -07:00
docs Advisor: README and blog, and also tests for DBBenchRunner, DatabaseOptions (#4201) 2018-08-01 16:13:09 -07:00
env Per-thread unique test db names (#4135) 2018-07-13 17:27:39 -07:00
examples Pin top-level index on partitioned index/filter blocks (#4037) 2018-06-22 15:27:46 -07:00
hdfs Comment out unused variables 2018-03-05 13:13:41 -08:00
include/rocksdb Trace and Replay for RocksDB (#3837) 2018-08-01 00:27:08 -07:00
java Clarify max_total_wal_size's scope (#4194) 2018-07-27 09:29:44 -07:00
memtable Remove tests from ROCKSDB_VALGRIND_RUN 2018-05-30 16:15:16 -07:00
monitoring Support group commits of version edits (#3944) 2018-06-28 12:34:39 -07:00
options Add DataBlockIndexType option in BlockBasedTableOptions (#4150) 2018-07-27 15:42:27 -07:00
port Reformatting some recent changes (#4161) 2018-07-20 14:43:38 -07:00
table Remove random writes from SST file ingestion (#4172) 2018-07-27 16:12:23 -07:00
third-party Add GCC 8 to Travis (#3433) 2018-07-13 10:58:06 -07:00
tools Advisor: README and blog, and also tests for DBBenchRunner, DatabaseOptions (#4201) 2018-08-01 16:13:09 -07:00
util Trace and Replay for RocksDB (#3837) 2018-08-01 00:27:08 -07:00
utilities Trace and Replay for RocksDB (#3837) 2018-08-01 00:27:08 -07:00
.clang-format
.gitignore Remove leftover references to phutil_module_cache 2017-08-23 12:12:21 -07:00
.lgtm.yml Create lgtm.yml for LGTM.com C/C++ analysis (#4058) 2018-06-26 12:43:04 -07:00
.travis.yml Add GCC 8 to Travis (#3433) 2018-07-13 10:58:06 -07:00
AUTHORS Update RocksDB Authors File 2017-10-18 14:42:10 -07:00
CMakeLists.txt Trace and Replay for RocksDB (#3837) 2018-08-01 00:27:08 -07:00
CODE_OF_CONDUCT.md Add Code of Conduct 2017-12-05 18:42:35 -08: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 Increase version number to 5.16 (#4176) 2018-07-24 13:43:33 -07:00
INSTALL.md Enable compilation on OpenBSD 2018-03-19 12:30:05 -07:00
LANGUAGE-BINDINGS.md Added PingCaps Rust RocksDB and ObjectiveRocks (#4065) 2018-06-27 15:43:21 -07:00
LICENSE.Apache Change RocksDB License 2017-07-15 16:11:23 -07:00
LICENSE.leveldb Add back the LevelDB license file 2017-07-16 18:42:18 -07:00
Makefile Enable cscope to exclude test source files (#4190) 2018-07-26 11:12:29 -07:00
README.md Create lgtm.yml for LGTM.com C/C++ analysis (#4058) 2018-06-26 12:43:04 -07:00
ROCKSDB_LITE.md Fix some typos in comments and docs. 2018-03-08 10:27:25 -08:00
TARGETS Trace and Replay for RocksDB (#3837) 2018-08-01 00:27:08 -07:00
USERS.md Support range deletion tombstones in IngestExternalFile SSTs (#3778) 2018-07-13 22:43:09 -07:00
Vagrantfile Adding CentOS 7 Vagrantfile & build script 2018-02-26 15:27:17 -08:00
WINDOWS_PORT.md Add GCC 8 to Travis (#3433) 2018-07-13 10:58:06 -07:00
appveyor.yml Upgrade Appveyor to VS2017 2018-02-01 13:57:01 -08:00
issue_template.md Add a template for issues 2017-09-29 11:41:28 -07:00
src.mk Trace and Replay for RocksDB (#3837) 2018-08-01 00:27:08 -07:00
thirdparty.inc Provide a way to override windows memory allocator with jemalloc for ZSTD 2018-06-04 12:12:48 -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.