Go to file
Andrew Kryczka 5a9ecf6614 Automated modernization (#12210)
Summary: Pull Request resolved: https://github.com/facebook/rocksdb/pull/12210

Reviewed By: hx235

Differential Revision: D52559771

Pulled By: ajkr

fbshipit-source-id: 1ccdd3a0180cc02bc0441f20b0e4a1db50841b03
2024-01-05 11:53:57 -08:00
.circleci Initial CircleCI -> GitHub Actions migration (#12163) 2023-12-21 15:40:21 -08:00
.github Disable GitHub Actions jobs on forks (#12191) 2023-12-28 17:23:18 -08:00
buckifier Error out in case of std errors in blackbox test and export file in TARGETS 2023-10-24 11:46:18 -07:00
build_tools Initial CircleCI -> GitHub Actions migration (#12163) 2023-12-21 15:40:21 -08:00
cache Add some compressed and tiered secondary cache stats (#12150) 2023-12-15 11:34:08 -08:00
cmake gcc-11 and cmake related cleanup (#9286) 2021-12-17 17:04:35 -08:00
coverage Remove platform009 and default to platform010 (#11333) 2023-03-30 09:56:37 -07:00
db Automated modernization (#12210) 2024-01-05 11:53:57 -08:00
db_stress_tool Group SST write in flush, compaction and db open with new stats (#11910) 2023-12-29 15:29:23 -08:00
docs FIX new blog post (JNI performance) Locate images correctly (#12050) 2023-11-07 11:58:58 -08:00
env Refactor FilePrefetchBuffer code (#12097) 2024-01-05 09:29:01 -08:00
examples Fix compact_files_example (#12084) 2023-11-21 09:34:59 -08:00
file Refactor FilePrefetchBuffer code (#12097) 2024-01-05 09:29:01 -08:00
fuzz Block per key-value checksum (#11287) 2023-04-25 12:08:23 -07:00
include/rocksdb Group SST write in flush, compaction and db open with new stats (#11910) 2023-12-29 15:29:23 -08:00
java Format async io for Java API (#12192) 2024-01-02 13:19:08 -08:00
logging Group SST write in flush, compaction and db open with new stats (#11910) 2023-12-29 15:29:23 -08:00
memory internal_repo_rocksdb (-8794174668376270091) (#12114) 2023-12-01 11:10:30 -08:00
memtable internal_repo_rocksdb (-8794174668376270091) (#12114) 2023-12-01 11:10:30 -08:00
microbench internal_repo_rocksdb (-8794174668376270091) (#12114) 2023-12-01 11:10:30 -08:00
monitoring Group SST write in flush, compaction and db open with new stats (#11910) 2023-12-29 15:29:23 -08:00
options Group SST write in flush, compaction and db open with new stats (#11910) 2023-12-29 15:29:23 -08:00
plugin Add initial CMake support to plugin (#9214) 2021-11-30 17:16:53 -08:00
port internal_repo_rocksdb (-8794174668376270091) (#12114) 2023-12-01 11:10:30 -08:00
table Fix a case of ignored corruption in creating backups (#12200) 2024-01-05 09:48:19 -08:00
test_util Group SST write in flush, compaction and db open with new stats (#11910) 2023-12-29 15:29:23 -08:00
third-party fix optimization-disabled test builds with platform010 (#11361) 2023-04-10 13:59:44 -07:00
tools Fix and defend against FilePrefetchBuffer combined with mmap reads (#12206) 2024-01-04 18:39:05 -08:00
trace_replay Trace analyzer: replace number with enumeration type (#10827) 2023-12-27 10:38:53 -08:00
unreleased_history Fix a case of ignored corruption in creating backups (#12200) 2024-01-05 09:48:19 -08:00
util Group SST write in flush, compaction and db open with new stats (#11910) 2023-12-29 15:29:23 -08:00
utilities Fix a case of ignored corruption in creating backups (#12200) 2024-01-05 09:48:19 -08:00
.clang-format A script that automatically reformat affected lines 2014-01-14 12:21:24 -08:00
.gitignore Add .arcconfig to .gitignore (fb internal use) (#11803) 2023-09-07 14:57:39 -07:00
.lgtm.yml Create lgtm.yml for LGTM.com C/C++ analysis (#4058) 2018-06-26 12:43:04 -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 Initial CircleCI -> GitHub Actions migration (#12163) 2023-12-21 15:40:21 -08: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 Add GPLv2 as an alternative license. 2017-04-27 18:06:12 -07:00
DEFAULT_OPTIONS_HISTORY.md Add Options::DisableExtraChecks, clarify force_consistency_checks (#9363) 2022-01-18 17:31:03 -08:00
DUMP_FORMAT.md First version of rocksdb_dump and rocksdb_undump. 2015-06-19 16:24:36 -07:00
HISTORY.md Update HISTORY/version/format compatibility script for the 8.10 release (#12154) 2023-12-15 14:44:23 -08:00
INSTALL.md RocksDB now requires gflags v2.2.0 (#10933) 2023-10-03 09:58:49 -07:00
LANGUAGE-BINDINGS.md Add grocksdb in Go language bindings (#10498) 2022-08-23 15:02:10 -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 Add support for linux-riscv64 (#12139) 2023-12-14 11:27:17 -08:00
PLUGINS.md Add encfs plugin link (#12070) 2023-11-14 07:33:21 -08:00
README.md Remove deprecated integration tests from README.md (#11354) 2023-04-07 16:52:50 -07:00
TARGETS Make OffpeakTimeInfo available in VersionSet (#12018) 2023-10-27 15:56:48 -07:00
USERS.md Add Qdrant to USERS.md (#12072) 2023-11-16 10:35:08 -08:00
Vagrantfile Adding CentOS 7 Vagrantfile & build script 2018-02-26 15:27:17 -08:00
WINDOWS_PORT.md Update branch name in WINDOWS_PORT.md (#8745) 2021-09-01 19:26:39 -07:00
common.mk Clean up variables for temporary directory (#9961) 2022-05-06 16:38:06 -07:00
crash_test.mk Stress/Crash Test for OptimisticTransactionDB (#11513) 2023-06-17 16:27:37 -07:00
issue_template.md Add Google Group to Issue Template 2020-01-28 14:40:37 -08:00
rocksdb.pc.in build: fix pkg-config file generation (#9953) 2022-05-30 12:46:40 -07:00
src.mk Add deletion-triggered compaction to RocksJava (#12028) 2023-12-18 13:43:01 -08: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

CircleCI 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 especially suitable for storing multiple terabytes of data in a single database.

Start with example usage here: https://github.com/facebook/rocksdb/tree/main/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.

Questions and discussions are welcome on the RocksDB Developers Public Facebook group and email list on Google Groups.

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.