[ceph.git] / ceph / src / rocksdb / README.md

## RocksDB: A Persistent Key-Value Store for Flash and RAM Storage

[![CircleCI Status](https://circleci.com/gh/facebook/rocksdb.svg?style=svg)](https://circleci.com/gh/facebook/rocksdb)
[![Appveyor Build status](https://ci.appveyor.com/api/projects/status/fbgfu0so3afcno78/branch/main?svg=true)](https://ci.appveyor.com/project/Facebook/rocksdb/branch/main)
[![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)

RocksDB is developed and maintained by Facebook Database Engineering Team.
It is built on earlier work on [LevelDB](https://github.com/google/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](https://github.com/facebook/rocksdb/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](https://www.facebook.com/groups/rocksdb.dev/) Facebook group and [email list](https://groups.google.com/g/rocksdb) 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.
Commit	Line	Data
7c673cae FG	1	## RocksDB: A Persistent Key-Value Store for Flash and RAM Storage
7c673cae FG	2
20effc67	3	[![CircleCI Status](https://circleci.com/gh/facebook/rocksdb.svg?style=svg)](https://circleci.com/gh/facebook/rocksdb)
1e59de90	4	[![Appveyor Build status](https://ci.appveyor.com/api/projects/status/fbgfu0so3afcno78/branch/main?svg=true)](https://ci.appveyor.com/project/Facebook/rocksdb/branch/main)
20effc67	5	[![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)
7c673cae FG	6
7c673cae FG	7	RocksDB is developed and maintained by Facebook Database Engineering Team.
494da23a	8	It is built on earlier work on [LevelDB](https://github.com/google/leveldb) by Sanjay Ghemawat (sanjay@google.com)
7c673cae FG	9	and Jeff Dean (jeff@google.com)
	10
	11	This code is a library that forms the core building block for a fast
f67539c2	12	key-value server, especially suited for storing data on flash drives.
7c673cae FG	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,
f67539c2	16	making it especially suitable for storing multiple terabytes of data in a
7c673cae FG	17	single database.
7c673cae FG	18
1e59de90	19	Start with example usage here: https://github.com/facebook/rocksdb/tree/main/examples
7c673cae FG	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
1e59de90	27	Questions and discussions are welcome on the [RocksDB Developers Public](https://www.facebook.com/groups/rocksdb.dev/) Facebook group and [email list](https://groups.google.com/g/rocksdb) on Google Groups.
11fdf7f2 TL	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.