You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Ankit Gupta cea2be20b6 Fix formatting 11 years ago
build_tools Rename "benchmark" back to "bench". 11 years ago
coverage Disable the html-based coverage report by default 11 years ago
db Rename "benchmark" back to "bench". 11 years ago
doc doc: table_stats_collectors -> table_properties_collectors. 11 years ago
hdfs Env to add a function to allow users to query waiting queue length 11 years ago
helpers/memenv Expose in memory Env to the world 11 years ago
include RocksDBLite 11 years ago
java Fix formatting 11 years ago
linters allow lambda function syntax in cpplint 11 years ago
port db_bench cleanup 11 years ago
table Fix SIGFAULT when running sst_dump on v2.6 db 11 years ago
tools Fix SIGFAULT when running sst_dump on v2.6 db 11 years ago
util Flush before Fsync()/Sync() 11 years ago
utilities RocksDBLite 11 years ago
.arcconfig Improve/fix bugs for the cpp linter 11 years ago
.clang-format A script that automatically reformat affected lines 11 years ago
.gitignore Rename "benchmark" back to "bench". 11 years ago
CONTRIBUTING.md Update to CONTRIBUTING.md 11 years ago
HISTORY.md Added period 11 years ago
INSTALL.md Make RocksDB compile for iOS 11 years ago
LICENSE Fix copyright year 11 years ago
Makefile Single-threaded asan_crash_test 11 years ago
PATENTS Fix the patent format 11 years ago
README Add a pointer to the engineering design discussion forum. 11 years ago
README.fb update the latest version in README.fb to 2.7 11 years ago
ROCKSDB_LITE.md RocksDBLite 11 years ago

README

rocksdb: A persistent key-value store for flash storage
Authors: * The Facebook Database Engineering Team
* Build on earlier work on 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 an 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.

The core of this code has been derived from open-source leveldb.

The code under this directory implements a system for maintaining a
persistent key/value store.

See doc/index.html and 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.

Guide to header files:

include/rocksdb/db.h
Main interface to the DB: Start here

include/rocksdb/options.h
Control over the behavior of an entire database, and also
control over the behavior of individual reads and writes.

include/rocksdb/comparator.h
Abstraction for user-specified comparison function. If you want
just bytewise comparison of keys, you can use the default comparator,
but clients can write their own comparator implementations if they
want custom ordering (e.g. to handle different character
encodings, etc.)

include/rocksdb/iterator.h
Interface for iterating over data. You can get an iterator
from a DB object.

include/rocksdb/write_batch.h
Interface for atomically applying multiple updates to a database.

include/rocksdb/slice.h
A simple module for maintaining a pointer and a length into some
other byte array.

include/rocksdb/status.h
Status is returned from many of the public interfaces and is used
to report success and various kinds of errors.

include/rocksdb/env.h
Abstraction of the OS environment. A posix implementation of
this interface is in util/env_posix.cc

include/rocksdb/table_builder.h
Lower-level modules that most clients probably won't use directly

include/rocksdb/cache.h
An API for the block cache.

include/rocksdb/compaction_filter.h
An API for a application filter invoked on every compaction.

include/rocksdb/filter_policy.h
An API for configuring a bloom filter.

include/rocksdb/memtablerep.h
An API for implementing a memtable.

include/rocksdb/statistics.h
An API to retrieve various database statistics.

include/rocksdb/transaction_log.h
An API to retrieve transaction logs from a database.

Design discussions are conducted in https://www.facebook.com/groups/rocksdb.dev/