Go to file
Yueh-Hsuan Chiang a77527f2af Add ReadOptions to TransactionLogIterator.
Summary:
Add an optional input parameter ReadOptions to DB::GetUpdateSince(),
which allows the verification of checksums to be disabled by setting
ReadOptions::verify_checksums to false.

Test Plan: Tests are done off-line and will not be included in the regular unit test.

Reviewers: igor

Reviewed By: igor

CC: leveldb, xjin, dhruba

Differential Revision: https://reviews.facebook.net/D16305
2014-02-28 11:50:36 -08:00
build_tools Merge pull request #74 from alberts/lz4 2014-02-10 15:46:56 -08:00
coverage Disable the html-based coverage report by default 2014-02-06 12:58:13 -08:00
db Add ReadOptions to TransactionLogIterator. 2014-02-28 11:50:36 -08:00
doc doc: table_stats_collectors -> table_properties_collectors. 2014-02-07 12:19:25 -08:00
hdfs thread local pointer storage 2014-02-25 17:47:37 -08:00
helpers/memenv Fsync directory after we create a new file 2014-01-27 11:02:21 -08:00
include Add ReadOptions to TransactionLogIterator. 2014-02-28 11:50:36 -08:00
linters allow lambda function syntax in cpplint 2014-02-20 12:47:05 -08:00
port cache SuperVersion in thread local storage to avoid mutex lock 2014-02-27 11:38:55 -08:00
table Fix inconsistent code format 2014-02-26 18:56:39 -08:00
tools Merge pull request #74 from alberts/lz4 2014-02-10 15:46:56 -08:00
util Fix some compilation bugs in different platforms 2014-02-27 22:20:17 -08:00
utilities IOError cleanup 2014-02-12 11:42:54 -08:00
.arcconfig Improve/fix bugs for the cpp linter 2014-02-13 17:48:11 -08:00
.clang-format A script that automatically reformat affected lines 2014-01-14 12:21:24 -08:00
.gitignore Put *.out to the ignore list (for MacOS) 2014-02-13 14:15:02 -08:00
CONTRIBUTING.md Update to CONTRIBUTING.md 2014-02-20 10:55:54 -08:00
HISTORY.md thread local pointer storage 2014-02-25 17:47:37 -08:00
INSTALL.md Update the instruction to build shared library 2014-02-24 12:29:26 -08:00
LICENSE
Makefile Fix some compilation bugs in different platforms 2014-02-27 22:20:17 -08:00
PATENTS
README
README.fb update the latest version in README.fb to 2.7 2013-12-30 16:16:24 -08:00

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/