Go to file
Evan Shaw 7a23e4d8ca New amalgamation target
This commit adds two new targets to the Makefile: rocksdb.cc and rocksdb.h

These files, when combined with the c.h header, are a self-contained RocksDB
source distribution called an amalgamation. (The name comes from SQLite's, which
is similar in concept.)

The main benefit of an amalgamation is that it's very easy to drop into a
new project. It also compiles faster compared to compiling individual source
files and potentially gives the compiler more opportunity to make optimizations
since it can see all functions at once.

rocksdb.cc and rocksdb.h are generated by a new script, amalgamate.py.
A detailed description of how amalgamate.py works is in a comment at the top of
the file.

There are also some small changes to existing files to enable the amalgamation:
* Use quotes for includes in unity build
* Fix an old header inclusion in util/xfunc.cc
* Move some includes outside ifdef in util/env_hdfs.cc
* Separate out tool sources in Makefile so they won't be included in unity.cc
* Unity build now produces a static library

Closes #733
2015-10-01 08:29:31 +13:00
arcanist_util Fix linters on non-fb machines 2015-08-11 11:36:12 -07:00
build_tools New amalgamation target 2015-10-01 08:29:31 +13:00
coverage Fix coverage script 2014-11-03 14:53:00 -08:00
db Add max_file_opening_threads to db_bench 2015-09-30 09:51:31 -07:00
doc
examples RocksDB Options file format and its serialization / deserialization. 2015-09-29 14:42:40 -07:00
hdfs [Cleanup] Remove RandomRWFile 2015-08-12 10:18:59 -07:00
include/rocksdb Return MergeInProgress when fetching from transactions or WBWI with overwrite_key 2015-09-30 11:14:42 -07:00
java [RocksJava] Fix test failure of InfoLogLevelTest 2015-09-21 18:26:21 -07:00
port Re-work to support size_t max constant for 32/64-bit. 2015-09-22 10:34:21 -07:00
table Fix the bug of using freed memory introduced by recent plain table reader patch 2015-09-23 16:16:26 -07:00
third-party "make format" against last 10 commits 2015-07-13 13:50:18 -07:00
tools Fixed a tsan warning in db_stress.cc 2015-09-28 12:06:43 -07:00
util New amalgamation target 2015-10-01 08:29:31 +13:00
utilities Return MergeInProgress when fetching from transactions or WBWI with overwrite_key 2015-09-30 11:14:42 -07:00
.arcconfig Integrate Jenkins with Phabricator 2015-04-07 11:56:29 -07:00
.clang-format
.gitignore New amalgamation target 2015-10-01 08:29:31 +13:00
.travis.yml Fix clang-format on Travis 2015-09-18 10:15:02 -07:00
AUTHORS Add AUTHORS file. Fix #203 2014-09-29 10:52:18 -07:00
CMakeLists.txt Improve CI build and fix Windows build breakage 2015-09-30 11:20:23 -07:00
CONTRIBUTING.md facebook accounts are not required for CLA signers 2014-07-08 05:57:54 -04:00
DUMP_FORMAT.md First version of rocksdb_dump and rocksdb_undump. 2015-06-19 16:24:36 -07:00
HISTORY.md Add experimental DB::AddFile() to plug sst files into empty DB 2015-09-23 12:42:43 -07:00
INSTALL.md Fixed a typo in INSTALL.md 2015-09-03 19:46:09 -07:00
LICENSE
Makefile New amalgamation target 2015-10-01 08:29:31 +13:00
PATENTS Update Patent Grant. 2015-04-13 10:33:43 +01: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 Optimistic Transactions 2015-05-29 14:36:35 -07:00
USERS.md Add Cloudera's blog post to USERS.md 2015-09-02 14:04:51 -07:00
Vagrantfile RocksDB on FreeBSD support 2015-02-26 15:19:17 -08:00
WINDOWS_PORT.md Commit both PR and internal code review changes 2015-07-07 16:58:20 -07:00
appveyor.yml Improve CI build and build switches 2015-09-29 12:22:48 -07:00
appveyordailytests.yml Improve CI build and fix Windows build breakage 2015-09-30 11:20:23 -07:00
src.mk New amalgamation target 2015-10-01 08:29:31 +13:00
thirdparty.inc Improve CI build and fix Windows build breakage 2015-09-30 11:20:23 -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/