ceph/src/rocksdb/README.md

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