Go to file
Siying Dong 6267ed251a Improve comment in db_impl.h (#5338)
Summary:
Add some comments in db_impl.h. Also reordered function order a little bit so that I can add a comment to flag the area of functions implementing DB interface.
Pull Request resolved: https://github.com/facebook/rocksdb/pull/5338

Differential Revision: D15498284

Pulled By: siying

fbshipit-source-id: 3d7c59c8303577fe44d13c74ae84c7ce05164f77
2019-05-24 13:09:55 -07:00
buckifier Add copyright headers per FB open-source checkup tool. (#5199) 2019-04-18 10:55:01 -07:00
build_tools Fixes for build_detect_platform 2019-05-15 16:01:08 -07:00
cache Consolidate hash function used for non-persistent data in a new function (#5155) 2019-04-08 13:32:06 -07:00
cmake Make FindZLIB consistent with official definitions (#4823) 2019-01-02 12:49:57 -08:00
coverage Add copyright headers per FB open-source checkup tool. (#5199) 2019-04-18 10:55:01 -07:00
db Improve comment in db_impl.h (#5338) 2019-05-24 13:09:55 -07:00
docs Text lint all .gitignore files 2019-05-15 11:37:27 -07:00
env Break large file writes into 1GB chunks (#5213) 2019-05-15 14:20:24 -07:00
examples Support for single-primary, multi-secondary instances (#4899) 2019-03-26 16:45:31 -07:00
hdfs Add copyright headers per FB open-source checkup tool. (#5199) 2019-04-18 10:55:01 -07:00
include/rocksdb Improve comments for StatsHistoryIterator and InMemoryStatsHistoryIterator 2019-05-24 11:40:05 -07:00
java Use separate status code for column family drop and db shutdown in progress (#5275) 2019-05-20 10:47:32 -07:00
memtable WriteBufferManager's dummy entry size to block cache 1MB -> 256KB (#5175) 2019-04-16 12:03:07 -07:00
monitoring Fix compilation errors for 32bits/LITE/ios build. (#5220) 2019-04-22 16:02:16 -07:00
options Pass OptionTypeInfo maps by const& (#5295) 2019-05-15 14:25:57 -07:00
port Remove PATENTS text from a few straggler files (#5326) 2019-05-21 16:22:35 -07:00
table Comments for BlockBasedTable 2019-05-24 12:35:25 -07:00
third-party/gtest-1.7.0/fused-src/gtest remove bundled but unused fbson library (#5108) 2019-03-26 16:37:52 -07:00
tools fixed db_stress.cc build error (#5307) 2019-05-23 14:03:25 -07:00
util Document AlignedBuffer (#5345) 2019-05-24 10:05:40 -07:00
utilities WritePrepared: Clarify the need for two_write_queues in unordered_write (#5313) 2019-05-20 07:49:20 -07:00
.clang-format A script that automatically reformat affected lines 2014-01-14 12:21:24 -08:00
.gitignore RocksDB Trace Analyzer (#4091) 2018-08-13 11:44:02 -07:00
.lgtm.yml Create lgtm.yml for LGTM.com C/C++ analysis (#4058) 2018-06-26 12:43:04 -07:00
.travis.yml Fix printf formatting on MacOS (#4533) 2018-10-19 14:46:09 -07:00
AUTHORS Update RocksDB Authors File 2017-10-18 14:42:10 -07:00
CMakeLists.txt RocksDB Cmake changes for Arm64 CRC32 Optimization (#5304) 2019-05-15 13:28:03 -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 Add GPLv2 as an alternative license. 2017-04-27 18:06:12 -07:00
DEFAULT_OPTIONS_HISTORY.md options.delayed_write_rate use the rate of rate_limiter by default. 2017-05-24 09:58:24 -07:00
DUMP_FORMAT.md First version of rocksdb_dump and rocksdb_undump. 2015-06-19 16:24:36 -07:00
HISTORY.md Provide an option so that SST ingestion won't fall back to copy after hard linking fails (#5333) 2019-05-23 21:58:52 -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 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 Allow builds of RocksJava debug releases (#5274) 2019-05-02 14:27:20 -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 Support for single-primary, multi-secondary instances (#4899) 2019-03-26 16:45:31 -07:00
USERS.md Adding IOTA Foundation to USERS.MD (#4436) 2018-10-02 10:03:46 -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 Add RocksJava build to AppVeyor 2019-01-03 10:44:44 -08:00
defs.bzl Add copyright headers per FB open-source checkup tool. (#5199) 2019-04-18 10:55:01 -07:00
issue_template.md Add a template for issues 2017-09-29 11:41:28 -07:00
src.mk RocksDB CRC32c optimization with ARMv8 Intrinsic (#5221) 2019-04-30 10:59:05 -07:00
thirdparty.inc Add copyright headers per FB open-source checkup tool. (#5199) 2019-04-18 10:55:01 -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.