ceph/src/rocksdb/README.md

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