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.
 
 
 
 
 
 
Kai Liu bba6595b1f Fix the valgrind error 11 years ago
build_tools Conversion of db_bench, db_stress and db_repl_stress to use gflags 11 years ago
coverage Fix the gcov/lcov related issues 11 years ago
db Fix the valgrind error 11 years ago
doc Add draft logo. 11 years ago
hdfs Add appropriate LICENSE and Copyright message. 11 years ago
helpers/memenv Change Function names from Compaction->Flush When they really mean Flush 11 years ago
include Flush the log outside of lock 11 years ago
linters/src fixing linters. 12 years ago
port Add appropriate LICENSE and Copyright message. 11 years ago
snappy Add appropriate LICENSE and Copyright message. 11 years ago
table Fix stress test failure when using mmap-reads. 11 years ago
tools WAL log retention policy based on archive size. 11 years ago
util Flush the log outside of lock 11 years ago
utilities Making the transaction log iterator more robust 11 years ago
.arcconfig Enable linting in arc. 12 years ago
.gitignore Remove invalid items in .gitignore 11 years ago
LICENSE Add appropriate LICENSE and Copyright message. 11 years ago
Makefile [RocksDB] prefixhash memtable test 11 years ago
PATENTS Fix the patent format 11 years ago
README Update README file for public interface 11 years ago
README.fb Update the latest rocksdb version 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-Stuctured-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 for more explanation.
See doc/impl.html for a brief overview of the implementation.

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.