Go to file
Sagar Vemuri 1cd45cd1b3 FIFO Compaction with TTL
Summary:
Introducing FIFO compactions with TTL.

FIFO compaction is based on size only which makes it tricky to enable in production as use cases can have organic growth. A user requested an option to drop files based on the time of their creation instead of the total size.

To address that request:
- Added a new TTL option to FIFO compaction options.
- Updated FIFO compaction score to take TTL into consideration.
- Added a new table property, creation_time, to keep track of when the SST file is created.
- Creation_time is set as below:
  - On Flush: Set to the time of flush.
  - On Compaction: Set to the max creation_time of all the files involved in the compaction.
  - On Repair and Recovery: Set to the time of repair/recovery.
  - Old files created prior to this code change will have a creation_time of 0.
- FIFO compaction with TTL is enabled when ttl > 0. All files older than ttl will be deleted during compaction. i.e. `if (file.creation_time < (current_time - ttl)) then delete(file)`. This will enable cases where you might want to delete all files older than, say, 1 day.
- FIFO compaction will fall back to the prior way of deleting files based on size if:
  - the creation_time of all files involved in compaction is 0.
  - the total size (of all SST files combined) does not drop below `compaction_options_fifo.max_table_files_size` even if the files older than ttl are deleted.

This feature is not supported if max_open_files != -1 or with table formats other than Block-based.

**Test Plan:**
Added tests.

**Benchmark results:**
Base: FIFO with max size: 100MB ::
```
svemuri@dev15905 ~/rocksdb (fifo-compaction) $ TEST_TMPDIR=/dev/shm ./db_bench --benchmarks=readwhilewriting --num=5000000 --threads=16 --compaction_style=2 --fifo_compaction_max_table_files_size_mb=100

readwhilewriting :       1.924 micros/op 519858 ops/sec;   13.6 MB/s (1176277 of 5000000 found)
```

With TTL (a low one for testing) ::
```
svemuri@dev15905 ~/rocksdb (fifo-compaction) $ TEST_TMPDIR=/dev/shm ./db_bench --benchmarks=readwhilewriting --num=5000000 --threads=16 --compaction_style=2 --fifo_compaction_max_table_files_size_mb=100 --fifo_compaction_ttl=20

readwhilewriting :       1.902 micros/op 525817 ops/sec;   13.7 MB/s (1185057 of 5000000 found)
```
Example Log lines:
```
2017/06/26-15:17:24.609249 7fd5a45ff700 (Original Log Time 2017/06/26-15:17:24.609177) [db/compaction_picker.cc:1471] [default] FIFO compaction: picking file 40 with creation time 1498515423 for deletion
2017/06/26-15:17:24.609255 7fd5a45ff700 (Original Log Time 2017/06/26-15:17:24.609234) [db/db_impl_compaction_flush.cc:1541] [default] Deleted 1 files
...
2017/06/26-15:17:25.553185 7fd5a61a5800 [DEBUG] [db/db_impl_files.cc:309] [JOB 0] Delete /dev/shm/dbbench/000040.sst type=2 #40 -- OK
2017/06/26-15:17:25.553205 7fd5a61a5800 EVENT_LOG_v1 {"time_micros": 1498515445553199, "job": 0, "event": "table_file_deletion", "file_number": 40}
```

SST Files remaining in the dbbench dir, after db_bench execution completed:
```
svemuri@dev15905 ~/rocksdb (fifo-compaction)  $ ls -l /dev/shm//dbbench/*.sst
-rw-r--r--. 1 svemuri users 30749887 Jun 26 15:17 /dev/shm//dbbench/000042.sst
-rw-r--r--. 1 svemuri users 30768779 Jun 26 15:17 /dev/shm//dbbench/000044.sst
-rw-r--r--. 1 svemuri users 30757481 Jun 26 15:17 /dev/shm//dbbench/000046.sst
```
Closes https://github.com/facebook/rocksdb/pull/2480

Differential Revision: D5305116

Pulled By: sagar0

fbshipit-source-id: 3e5cfcf5dd07ed2211b5b37492eb235b45139174
2017-06-27 17:11:48 -07:00
arcanist_util Fix arc setting for Facebook internal tools 2017-02-02 13:24:16 -08:00
buckifier Fix TARGETS file tests list 2017-06-27 14:12:02 -07:00
build_tools fixed typo 2017-06-05 11:27:34 -07:00
cache Add GPLv2 as an alternative license. 2017-04-27 18:06:12 -07:00
cmake/modules CMake: more MinGW fixes 2017-04-06 14:09:13 -07:00
coverage Fix coverage script 2014-11-03 14:53:00 -08:00
db FIFO Compaction with TTL 2017-06-27 17:11:48 -07:00
docs Intra-L0 blog post 2017-06-26 13:11:41 -07:00
env Encryption at rest support 2017-06-26 16:56:24 -07:00
examples CMake: more MinGW fixes 2017-04-06 14:09:13 -07:00
hdfs New API for background work in single thread pool 2017-05-23 11:12:27 -07:00
include/rocksdb FIFO Compaction with TTL 2017-06-27 17:11:48 -07:00
java CLANG Tidy 2017-06-27 11:00:59 -07:00
memtable WriteBufferManager will not trigger flush if much data is already being flushed 2017-06-21 10:41:37 -07:00
monitoring revert perf_context and io_stats to __thread 2017-06-26 15:27:17 -07:00
options FIFO Compaction with TTL 2017-06-27 17:11:48 -07:00
port Implement ReopenWritibaleFile on Windows and other fixes 2017-06-20 10:31:13 -07:00
table FIFO Compaction with TTL 2017-06-27 17:11:48 -07:00
third-party fixed typo 2017-06-13 16:58:01 -07:00
tools FIFO Compaction with TTL 2017-06-27 17:11:48 -07:00
util revert perf_context and io_stats to __thread 2017-06-26 15:27:17 -07:00
utilities Fix TARGETS file tests list 2017-06-27 14:12:02 -07:00
.clang-format A script that automatically reformat affected lines 2014-01-14 12:21:24 -08:00
.deprecated_arcconfig Update ShipIt to honor TARGETS updates 2017-04-13 16:12:03 -07:00
.gitignore Simple blob file dumper 2017-05-23 10:42:59 -07:00
.travis.yml Force travis to build with clang on MacOS 2017-06-05 15:41:57 -07:00
AUTHORS Add AUTHORS file. Fix #203 2014-09-29 10:52:18 -07:00
CMakeLists.txt Fix TARGETS file tests list 2017-06-27 14:12:02 -07:00
CONTRIBUTING.md facebook accounts are not required for CLA signers 2014-07-08 05:57:54 -04:00
COPYING Add GPLv2 as an alternative license. 2017-04-27 18:06:12 -07:00
DEFAULT_OPTIONS_HISTORY.md options.delayed_write_rate use the rate of rate_limiter by default. 2017-05-24 09:58:24 -07:00
DUMP_FORMAT.md First version of rocksdb_dump and rocksdb_undump. 2015-06-19 16:24:36 -07:00
HISTORY.md FIFO Compaction with TTL 2017-06-27 17:11:48 -07:00
INSTALL.md cross-platform compatibility improvements 2017-05-15 16:15:38 -07:00
LANGUAGE-BINDINGS.md Adding Dlang to the list 2017-02-16 17:24:10 -08:00
LICENSE Updated all copyright headers to the new format. 2016-02-09 15:12:00 -08:00
Makefile Fix TARGETS file tests list 2017-06-27 14:12:02 -07:00
PATENTS Update Patent Grant. 2015-04-13 10:33:43 +01:00
README.md Appveyor badge to show master branch 2016-07-26 13:54:08 -07:00
ROCKSDB_LITE.md Optimistic Transactions 2015-05-29 14:36:35 -07:00
TARGETS Fix TARGETS file tests list 2017-06-27 14:12:02 -07:00
USERS.md fixed typo 2017-06-13 16:58:01 -07:00
Vagrantfile Update Vagrant file (test internal phabricator workflow) 2016-10-28 15:39:19 -07:00
WINDOWS_PORT.md Commit both PR and internal code review changes 2015-07-07 16:58:20 -07:00
appveyor.yml Rework test running script. 2017-04-05 11:39:20 -07:00
src.mk Fix TARGETS file tests list 2017-06-27 14:12:02 -07:00
thirdparty.inc Introduce XPRESS compresssion on Windows. (#1081) 2016-04-19 22:54:24 -07:00

README.md

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

Build Status Build status

RocksDB is developed and maintained by Facebook Database Engineering Team. It is built 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 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 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/