diff options
Diffstat (limited to 'src/rocksdb/README.md')
| -rw-r--r-- | src/rocksdb/README.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/src/rocksdb/README.md b/src/rocksdb/README.md new file mode 100644 index 00000000..f1bc0c05 --- /dev/null +++ b/src/rocksdb/README.md @@ -0,0 +1,31 @@ +## RocksDB: A Persistent Key-Value Store for Flash and RAM Storage + +[](https://travis-ci.org/facebook/rocksdb) +[](https://ci.appveyor.com/project/Facebook/rocksdb/branch/master) +[](http://140.211.168.68: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 specially suitable for storing multiple terabytes of data in a +single database. + +Start with example usage here: https://github.com/facebook/rocksdb/tree/master/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. + +Design discussions are conducted in https://www.facebook.com/groups/rocksdb.dev/ + +## 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. |