]> git.proxmox.com Git - ceph.git/blame - ceph/src/rocksdb/README.md
add subtree-ish sources for 12.0.3
[ceph.git] / ceph / src / rocksdb / README.md
CommitLineData
7c673cae
FG
1## RocksDB: A Persistent Key-Value Store for Flash and RAM Storage
2
3[![Build Status](https://travis-ci.org/facebook/rocksdb.svg?branch=master)](https://travis-ci.org/facebook/rocksdb)
4[![Build status](https://ci.appveyor.com/api/projects/status/fbgfu0so3afcno78/branch/master?svg=true)](https://ci.appveyor.com/project/Facebook/rocksdb/branch/master)
5
6
7RocksDB is developed and maintained by Facebook Database Engineering Team.
8It is built on earlier work on LevelDB by Sanjay Ghemawat (sanjay@google.com)
9and Jeff Dean (jeff@google.com)
10
11This code is a library that forms the core building block for a fast
12key value server, especially suited for storing data on flash drives.
13It has a Log-Structured-Merge-Database (LSM) design with flexible tradeoffs
14between Write-Amplification-Factor (WAF), Read-Amplification-Factor (RAF)
15and Space-Amplification-Factor (SAF). It has multi-threaded compactions,
16making it specially suitable for storing multiple terabytes of data in a
17single database.
18
19Start with example usage here: https://github.com/facebook/rocksdb/tree/master/examples
20
21See the [github wiki](https://github.com/facebook/rocksdb/wiki) for more explanation.
22
23The public interface is in `include/`. Callers should not include or
24rely on the details of any other header files in this package. Those
25internal APIs may be changed without warning.
26
27Design discussions are conducted in https://www.facebook.com/groups/rocksdb.dev/