From e7c64fb115d255a03cf17f8d54b3f088f29464ca Mon Sep 17 00:00:00 2001 From: Islam AbdelRahman Date: Tue, 29 Mar 2016 13:20:26 -0700 Subject: [PATCH] Imporve sst_file_manager comment Summary: Improve the comment for sst_file_manager Test Plan: none Reviewers: yhchiang, sdong Reviewed By: sdong Subscribers: andrewkr, dhruba Differential Revision: https://reviews.facebook.net/D56001 --- include/rocksdb/options.h | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/include/rocksdb/options.h b/include/rocksdb/options.h index 60f9cd1212..c70e322551 100644 --- a/include/rocksdb/options.h +++ b/include/rocksdb/options.h @@ -837,10 +837,19 @@ struct DBOptions { // Default: nullptr std::shared_ptr rate_limiter; - // Use to track SST files and control their file deletion rate, can be used - // among multiple RocksDB instances, sst_file_manager only track and throttle - // deletes of SST files in first db_path (db_name if db_paths is empty), other - // files and other db_paths wont be tracked or affected by sst_file_manager. + // Use to track SST files and control their file deletion rate. + // + // Features: + // - Throttle the deletion rate of the SST files. + // - Keep track the total size of all SST files. + // - Set a maximum allowed space limit for SST files that when reached + // the DB wont do any further flushes or compactions and will set the + // background error. + // - Can be shared between multiple dbs. + // Limitations: + // - Only track and throttle deletes of SST files in + // first db_path (db_name if db_paths is empty). + // // Default: nullptr std::shared_ptr sst_file_manager;