4 * DB::ResetStats() to reset internal stats.
5 * Statistics::Reset() to reset user stats.
6 * ldb add option --try_load_options, which will open DB with its own option file.
10 * Support dynamically change `stats_dump_period_sec` option via SetDBOptions().
11 * Added ReadOptions::max_skippable_internal_keys to set a threshold to fail a request as incomplete when too many keys are being skipped when using iterators.
12 * DB::Get in place of std::string accepts PinnableSlice, which avoids the extra memcpy of value to std::string in most of cases.
13 * PinnableSlice releases the pinned resources that contain the value when it is destructed or when ::Reset() is called on it.
14 * The old API that accepts std::string, although discouraged, is still supported.
15 * Replace Options::use_direct_writes with Options::use_direct_io_for_flush_and_compaction. Read Direct IO wiki for details.
16 * Added CompactionEventListener and EventListener::OnFlushBegin interfaces.
19 * Memtable flush can be avoided during checkpoint creation if total log file size is smaller than a threshold specified by the user.
20 * Introduce level-based L0->L0 compactions to reduce file count, so write delays are incurred less often.
21 * (Experimental) Partitioning filters which creates an index on the partitions. The feature can be enabled by setting partition_filters when using kFullFilter. Currently the feature also requires two-level indexing to be enabled. Number of partitions is the same as the number of partitions for indexes, which is controlled by metadata_block_size.
25 * Remove disableDataSync option.
26 * Remove timeout_hint_us option from WriteOptions. The option has been deprecated and has no effect since 3.13.0.
27 * Remove option min_partial_merge_operands. Partial merge operands will always be merged in flush or compaction if there are more than one.
28 * Remove option verify_checksums_in_compaction. Compaction will always verify checksum.
31 * Fix the bug that iterator may skip keys
35 * NewLRUCache() will determine number of shard bits automatically based on capacity, if the user doesn't pass one. This also impacts the default block cache when the user doesn't explict provide one.
36 * Change the default of delayed slowdown value to 16MB/s and further increase the L0 stop condition to 36 files.
37 * Options::use_direct_writes and Options::use_direct_reads are now ready to use.
38 * (Experimental) Two-level indexing that partition the index and creates a 2nd level index on the partitions. The feature can be enabled by setting kTwoLevelIndexSearch as IndexType and configuring index_per_partition.
41 * Added new overloaded function GetApproximateSizes that allows to specify if memtable stats should be computed only without computing SST files' stats approximations.
42 * Added new function GetApproximateMemTableStats that approximates both number of records and size of memtables.
43 * Add Direct I/O mode for SST file I/O
46 * RangeSync() should work if ROCKSDB_FALLOCATE_PRESENT is not set
47 * Fix wrong results in a data race case in Get()
48 * Some fixes related to 2PC.
49 * Fix bugs of data corruption in direct I/O
52 * Support dynamically change `delete_obsolete_files_period_micros` option via SetDBOptions().
53 * Added EventListener::OnExternalFileIngested which will be called when IngestExternalFile() add a file successfully.
54 * BackupEngine::Open and BackupEngineReadOnly::Open now always return error statuses matching those of the backup Env.
57 * Fix the bug that if 2PC is enabled, checkpoints may loss some recent transactions.
58 * When file copying is needed when creating checkpoints or bulk loading files, fsync the file after the file copying.
62 * Options::max_bytes_for_level_multiplier is now a double along with all getters and setters.
63 * Support dynamically change `delayed_write_rate` and `max_total_wal_size` options via SetDBOptions().
64 * Introduce DB::DeleteRange for optimized deletion of large ranges of contiguous keys.
65 * Support dynamically change `delayed_write_rate` option via SetDBOptions().
66 * Options::allow_concurrent_memtable_write and Options::enable_write_thread_adaptive_yield are now true by default.
67 * Remove Tickers::SEQUENCE_NUMBER to avoid confusion if statistics object is shared among RocksDB instance. Alternatively DB::GetLatestSequenceNumber() can be used to get the same value.
68 * Options.level0_stop_writes_trigger default value changes from 24 to 32.
69 * New compaction filter API: CompactionFilter::FilterV2(). Allows to drop ranges of keys.
70 * Removed flashcache support.
71 * DB::AddFile() is deprecated and is replaced with DB::IngestExternalFile(). DB::IngestExternalFile() remove all the restrictions that existed for DB::AddFile.
74 * Add avoid_flush_during_shutdown option, which speeds up DB shutdown by not flushing unpersisted data (i.e. with disableWAL = true). Unpersisted data will be lost. The options is dynamically changeable via SetDBOptions().
75 * Add memtable_insert_with_hint_prefix_extractor option. The option is mean to reduce CPU usage for inserting keys into memtable, if keys can be group by prefix and insert for each prefix are sequential or almost sequential. See include/rocksdb/options.h for more details.
76 * Add LuaCompactionFilter in utilities. This allows developers to write compaction filters in Lua. To use this feature, LUA_PATH needs to be set to the root directory of Lua.
77 * No longer populate "LATEST_BACKUP" file in backup directory, which formerly contained the number of the latest backup. The latest backup can be determined by finding the highest numbered file in the "meta/" subdirectory.
79 ## 4.13.0 (10/18/2016)
81 * DB::GetOptions() reflect dynamic changed options (i.e. through DB::SetOptions()) and return copy of options instead of reference.
82 * Added Statistics::getAndResetTickerCount().
85 * Add DB::SetDBOptions() to dynamic change base_background_compactions and max_background_compactions.
86 * Added Iterator::SeekForPrev(). This new API will seek to the last key that less than or equal to the target key.
90 * CancelAllBackgroundWork() flushes all memtables for databases containing writes that have bypassed the WAL (writes issued with WriteOptions::disableWAL=true) before shutting down background threads.
91 * Merge options source_compaction_factor, max_grandparent_overlap_bytes and expanded_compaction_factor into max_compaction_bytes.
92 * Remove ImmutableCFOptions.
93 * Add a compression type ZSTD, which can work with ZSTD 0.8.0 or up. Still keep ZSTDNotFinal for compatibility reasons.
96 * Introduce NewClockCache, which is based on CLOCK algorithm with better concurrent performance in some cases. It can be used to replace the default LRU-based block cache and table cache. To use it, RocksDB need to be linked with TBB lib.
97 * Change ticker/histogram statistics implementations to accumulate data in thread-local storage, which improves CPU performance by reducing cache coherency costs. Callers of CreateDBStatistics do not need to change anything to use this feature.
98 * Block cache mid-point insertion, where index and filter block are inserted into LRU block cache with higher priority. The feature can be enabled by setting BlockBasedTableOptions::cache_index_and_filter_blocks_with_high_priority to true and high_pri_pool_ratio > 0 when creating NewLRUCache.
101 ### Public API Change
102 * options.memtable_prefix_bloom_huge_page_tlb_size => memtable_huge_page_size. When it is set, RocksDB will try to allocate memory from huge page for memtable too, rather than just memtable bloom filter.
105 * A tool to migrate DB after options change. See include/rocksdb/utilities/option_change_migration.h.
106 * Add ReadOptions.background_purge_on_iterator_cleanup. If true, we avoid file deletion when destorying iterators.
109 ### Public API Change
110 * options.memtable_prefix_bloom_bits changes to options.memtable_prefix_bloom_bits_ratio and deprecate options.memtable_prefix_bloom_probes
111 * enum type CompressionType and PerfLevel changes from char to unsigned char. Value of all PerfLevel shift by one.
112 * Deprecate options.filter_deletes.
115 * Add avoid_flush_during_recovery option.
116 * Add a read option background_purge_on_iterator_cleanup to avoid deleting files in foreground when destroying iterators. Instead, a job is scheduled in high priority queue and would be executed in a separate background thread.
117 * RepairDB support for column families. RepairDB now associates data with non-default column families using information embedded in the SST/WAL files (4.7 or later). For data written by 4.6 or earlier, RepairDB associates it with the default column family.
118 * Add options.write_buffer_manager which allows users to control total memtable sizes across multiple DB instances.
121 ### Public API changes
122 * Add bottommost_compression option, This option can be used to set a specific compression algorithm for the bottommost level (Last level containing files in the DB).
123 * Introduce CompactionJobInfo::compression, This field state the compression algorithm used to generate the output files of the compaction.
124 * Deprecate BlockBaseTableOptions.hash_index_allow_collision=false
125 * Deprecate options builder (GetOptions()).
128 * Introduce NewSimCache() in rocksdb/utilities/sim_cache.h. This function creates a block cache that is able to give simulation results (mainly hit rate) of simulating block behavior with a configurable cache size.
131 ### Public API Change
132 * Allow preset compression dictionary for improved compression of block-based tables. This is supported for zlib, zstd, and lz4. The compression dictionary's size is configurable via CompressionOptions::max_dict_bytes.
133 * Delete deprecated classes for creating backups (BackupableDB) and restoring from backups (RestoreBackupableDB). Now, BackupEngine should be used for creating backups, and BackupEngineReadOnly should be used for restorations. For more details, see https://github.com/facebook/rocksdb/wiki/How-to-backup-RocksDB%3F
134 * Expose estimate of per-level compression ratio via DB property: "rocksdb.compression-ratio-at-levelN".
135 * Added EventListener::OnTableFileCreationStarted. EventListener::OnTableFileCreated will be called on failure case. User can check creation status via TableFileCreationInfo::status.
138 * Add ReadOptions::readahead_size. If non-zero, NewIterator will create a new table reader which performs reads of the given size.
141 ### Public API Change
142 * rename options compaction_measure_io_stats to report_bg_io_stats and include flush too.
143 * Change some default options. Now default options will optimize for server-workloads. Also enable slowdown and full stop triggers for pending compaction bytes. These changes may cause sub-optimal performance or significant increase of resource usage. To avoid these risks, users can open existing RocksDB with options extracted from RocksDB option files. See https://github.com/facebook/rocksdb/wiki/RocksDB-Options-File for how to use RocksDB option files. Or you can call Options.OldDefaults() to recover old defaults. DEFAULT_OPTIONS_HISTORY.md will track change history of default options.
146 ### Public API Changes
147 * Change default of BlockBasedTableOptions.format_version to 2. It means default DB created by 4.6 or up cannot be opened by RocksDB version 3.9 or earlier.
148 * Added strict_capacity_limit option to NewLRUCache. If the flag is set to true, insert to cache will fail if no enough capacity can be free. Signature of Cache::Insert() is updated accordingly.
149 * Tickers [NUMBER_DB_NEXT, NUMBER_DB_PREV, NUMBER_DB_NEXT_FOUND, NUMBER_DB_PREV_FOUND, ITER_BYTES_READ] are not updated immediately. The are updated when the Iterator is deleted.
150 * Add monotonically increasing counter (DB property "rocksdb.current-super-version-number") that increments upon any change to the LSM tree.
153 * Add CompactionPri::kMinOverlappingRatio, a compaction picking mode friendly to write amplification.
154 * Deprecate Iterator::IsKeyPinned() and replace it with Iterator::GetProperty() with prop_name="rocksdb.iterator.is.key.pinned"
157 ### Public API Changes
158 * Add a new perf context level between kEnableCount and kEnableTime. Level 2 now does not include timers for mutexes.
159 * Statistics of mutex operation durations will not be measured by default. If you want to have them enabled, you need to set Statistics::stats_level_ to kAll.
160 * DBOptions::delete_scheduler and NewDeleteScheduler() are removed, please use DBOptions::sst_file_manager and NewSstFileManager() instead
163 * ldb tool now supports operations to non-default column families.
164 * Add kPersistedTier to ReadTier. This option allows Get and MultiGet to read only the persited data and skip mem-tables if writes were done with disableWAL = true.
165 * Add DBOptions::sst_file_manager. Use NewSstFileManager() in include/rocksdb/sst_file_manager.h to create a SstFileManager that can be used to track the total size of SST files and control the SST files deletion rate.
168 ### Public API Changes
169 * Change names in CompactionPri and add a new one.
170 * Deprecate options.soft_rate_limit and add options.soft_pending_compaction_bytes_limit.
171 * If options.max_write_buffer_number > 3, writes will be slowed down when writing to the last write buffer to delay a full stop.
172 * Introduce CompactionJobInfo::compaction_reason, this field include the reason to trigger the compaction.
173 * After slow down is triggered, if estimated pending compaction bytes keep increasing, slowdown more.
174 * Increase default options.delayed_write_rate to 2MB/s.
175 * Added a new parameter --path to ldb tool. --path accepts the name of either MANIFEST, SST or a WAL file. Either --db or --path can be used when calling ldb.
179 * CompactionFilter has new member function called IgnoreSnapshots which allows CompactionFilter to be called even if there are snapshots later than the key.
180 * RocksDB will now persist options under the same directory as the RocksDB database on successful DB::Open, CreateColumnFamily, DropColumnFamily, and SetOptions.
181 * Introduce LoadLatestOptions() in rocksdb/utilities/options_util.h. This function can construct the latest DBOptions / ColumnFamilyOptions used by the specified RocksDB intance.
182 * Introduce CheckOptionsCompatibility() in rocksdb/utilities/options_util.h. This function checks whether the input set of options is able to open the specified DB successfully.
184 ### Public API Changes
185 * When options.db_write_buffer_size triggers, only the column family with the largest column family size will be flushed, not all the column families.
189 * Introduce CreateLoggerFromOptions(), this function create a Logger for provided DBOptions.
190 * Add GetAggregatedIntProperty(), which returns the sum of the GetIntProperty of all the column families.
191 * Add MemoryUtil in rocksdb/utilities/memory.h. It currently offers a way to get the memory usage by type from a list rocksdb instances.
193 ### Public API Changes
194 * CompactionFilter::Context includes information of Column Family ID
195 * The need-compaction hint given by TablePropertiesCollector::NeedCompact() will be persistent and recoverable after DB recovery. This introduces a breaking format change. If you use this experimental feature, including NewCompactOnDeletionCollectorFactory() in the new version, you may not be able to directly downgrade the DB back to version 4.0 or lower.
196 * TablePropertiesCollectorFactory::CreateTablePropertiesCollector() now takes an option Context, containing the information of column family ID for the file being written.
197 * Remove DefaultCompactionFilterFactory.
202 * Added single delete operation as a more efficient way to delete keys that have not been overwritten.
203 * Added experimental AddFile() to DB interface that allow users to add files created by SstFileWriter into an empty Database, see include/rocksdb/sst_file_writer.h and DB::AddFile() for more info.
204 * Added support for opening SST files with .ldb suffix which enables opening LevelDB databases.
205 * CompactionFilter now supports filtering of merge operands and merge results.
207 ### Public API Changes
208 * Added SingleDelete() to the DB interface.
209 * Added AddFile() to DB interface.
210 * Added SstFileWriter class.
211 * CompactionFilter has a new method FilterMergeOperand() that RocksDB applies to every merge operand during compaction to decide whether to filter the operand.
212 * We removed CompactionFilterV2 interfaces from include/rocksdb/compaction_filter.h. The functionality was deprecated already in version 3.13.
216 * Added support for transactions. See include/rocksdb/utilities/transaction.h for more info.
217 * DB::GetProperty() now accepts "rocksdb.aggregated-table-properties" and "rocksdb.aggregated-table-properties-at-levelN", in which case it returns aggregated table properties of the target column family, or the aggregated table properties of the specified level N if the "at-level" version is used.
218 * Add compression option kZSTDNotFinalCompression for people to experiment ZSTD although its format is not finalized.
219 * We removed the need for LATEST_BACKUP file in BackupEngine. We still keep writing it when we create new backups (because of backward compatibility), but we don't read it anymore.
221 ### Public API Changes
222 * Removed class Env::RandomRWFile and Env::NewRandomRWFile().
223 * Renamed DBOptions.num_subcompactions to DBOptions.max_subcompactions to make the name better match the actual functionality of the option.
224 * Added Equal() method to the Comparator interface that can optionally be overwritten in cases where equality comparisons can be done more efficiently than three-way comparisons.
225 * Previous 'experimental' OptimisticTransaction class has been replaced by Transaction class.
229 * RollbackToSavePoint() in WriteBatch/WriteBatchWithIndex
230 * Add NewCompactOnDeletionCollectorFactory() in utilities/table_properties_collectors, which allows rocksdb to mark a SST file as need-compaction when it observes at least D deletion entries in any N consecutive entries in that SST file. Note that this feature depends on an experimental NeedCompact() API --- the result of this API will not persist after DB restart.
231 * Add DBOptions::delete_scheduler. Use NewDeleteScheduler() in include/rocksdb/delete_scheduler.h to create a DeleteScheduler that can be shared among multiple RocksDB instances to control the file deletion rate of SST files that exist in the first db_path.
233 ### Public API Changes
234 * Deprecated WriteOptions::timeout_hint_us. We no longer support write timeout. If you really need this option, talk to us and we might consider returning it.
235 * Deprecated purge_redundant_kvs_while_flush option.
236 * Removed BackupEngine::NewBackupEngine() and NewReadOnlyBackupEngine() that were deprecated in RocksDB 3.8. Please use BackupEngine::Open() instead.
237 * Deprecated Compaction Filter V2. We are not aware of any existing use-cases. If you use this filter, your compile will break with RocksDB 3.13. Please let us know if you use it and we'll put it back in RocksDB 3.14.
238 * Env::FileExists now returns a Status instead of a boolean
239 * Add statistics::getHistogramString() to print detailed distribution of a histogram metric.
240 * Add DBOptions::skip_stats_update_on_db_open. When it is on, DB::Open() will run faster as it skips the random reads required for loading necessary stats from SST files to optimize compaction.
244 * Added experimental support for optimistic transactions. See include/rocksdb/utilities/optimistic_transaction.h for more info.
245 * Added a new way to report QPS from db_bench (check out --report_file and --report_interval_seconds)
246 * Added a cache for individual rows. See DBOptions::row_cache for more info.
247 * Several new features on EventListener (see include/rocksdb/listener.h):
248 - OnCompationCompleted() now returns per-compaciton job statistics, defined in include/rocksdb/compaction_job_stats.h.
249 - Added OnTableFileCreated() and OnTableFileDeleted().
250 * Add compaction_options_universal.enable_trivial_move to true, to allow trivial move while performing universal compaction. Trivial move will happen only when all the input files are non overlapping.
252 ### Public API changes
253 * EventListener::OnFlushCompleted() now passes FlushJobInfo instead of a list of parameters.
254 * DB::GetDbIdentity() is now a const function. If this function is overridden in your application, be sure to also make GetDbIdentity() const to avoid compile error.
255 * Move listeners from ColumnFamilyOptions to DBOptions.
256 * Add max_write_buffer_number_to_maintain option
257 * DB::CompactRange()'s parameter reduce_level is changed to change_level, to allow users to move levels to lower levels if allowed. It can be used to migrate a DB from options.level_compaction_dynamic_level_bytes=false to options.level_compaction_dynamic_level_bytes.true.
258 * Change default value for options.compaction_filter_factory and options.compaction_filter_factory_v2 to nullptr instead of DefaultCompactionFilterFactory and DefaultCompactionFilterFactoryV2.
259 * If CancelAllBackgroundWork is called without doing a flush after doing loads with WAL disabled, the changes which haven't been flushed before the call to CancelAllBackgroundWork will be lost.
260 * WBWIIterator::Entry() now returns WriteEntry instead of `const WriteEntry&`
261 * options.hard_rate_limit is deprecated.
262 * When options.soft_rate_limit or options.level0_slowdown_writes_trigger is triggered, the way to slow down writes is changed to: write rate to DB is limited to to options.delayed_write_rate.
263 * DB::GetApproximateSizes() adds a parameter to allow the estimation to include data in mem table, with default to be not to include. It is now only supported in skip list mem table.
264 * DB::CompactRange() now accept CompactRangeOptions instead of multiple parameters. CompactRangeOptions is defined in include/rocksdb/options.h.
265 * CompactRange() will now skip bottommost level compaction for level based compaction if there is no compaction filter, bottommost_level_compaction is introduced in CompactRangeOptions to control when it's possible to skip bottommost level compaction. This mean that if you want the compaction to produce a single file you need to set bottommost_level_compaction to BottommostLevelCompaction::kForce.
266 * Add Cache.GetPinnedUsage() to get the size of memory occupied by entries that are in use by the system.
267 * DB:Open() will fail if the compression specified in Options is not linked with the binary. If you see this failure, recompile RocksDB with compression libraries present on your system. Also, previously our default compression was snappy. This behavior is now changed. Now, the default compression is snappy only if it's available on the system. If it isn't we change the default to kNoCompression.
268 * We changed how we account for memory used in block cache. Previously, we only counted the sum of block sizes currently present in block cache. Now, we count the actual memory usage of the blocks. For example, a block of size 4.5KB will use 8KB memory with jemalloc. This might decrease your memory usage and possibly decrease performance. Increase block cache size if you see this happening after an upgrade.
269 * Add BackupEngineImpl.options_.max_background_operations to specify the maximum number of operations that may be performed in parallel. Add support for parallelized backup and restore.
270 * Add DB::SyncWAL() that does a WAL sync without blocking writers.
272 ## 3.11.0 (5/19/2015)
274 * Added a new API Cache::SetCapacity(size_t capacity) to dynamically change the maximum configured capacity of the cache. If the new capacity is less than the existing cache usage, the implementation will try to lower the usage by evicting the necessary number of elements following a strict LRU policy.
275 * Added an experimental API for handling flashcache devices (blacklists background threads from caching their reads) -- NewFlashcacheAwareEnv
276 * If universal compaction is used and options.num_levels > 1, compact files are tried to be stored in none-L0 with smaller files based on options.target_file_size_base. The limitation of DB size when using universal compaction is greatly mitigated by using more levels. You can set num_levels = 1 to make universal compaction behave as before. If you set num_levels > 1 and want to roll back to a previous version, you need to compact all files to a big file in level 0 (by setting target_file_size_base to be large and CompactRange(<cf_handle>, nullptr, nullptr, true, 0) and reopen the DB with the same version to rewrite the manifest, and then you can open it using previous releases.
277 * More information about rocksdb background threads are available in Env::GetThreadList(), including the number of bytes read / written by a compaction job, mem-table size and current number of bytes written by a flush job and many more. Check include/rocksdb/thread_status.h for more detail.
279 ### Public API changes
280 * TablePropertiesCollector::AddUserKey() is added to replace TablePropertiesCollector::Add(). AddUserKey() exposes key type, sequence number and file size up to now to users.
281 * DBOptions::bytes_per_sync used to apply to both WAL and table files. As of 3.11 it applies only to table files. If you want to use this option to sync WAL in the background, please use wal_bytes_per_sync
283 ## 3.10.0 (3/24/2015)
285 * GetThreadStatus() is now able to report detailed thread status, including:
286 - Thread Operation including flush and compaction.
287 - The stage of the current thread operation.
288 - The elapsed time in micros since the current thread operation started.
289 More information can be found in include/rocksdb/thread_status.h. In addition, when running db_bench with --thread_status_per_interval, db_bench will also report thread status periodically.
290 * Changed the LRU caching algorithm so that referenced blocks (by iterators) are never evicted. This change made parameter removeScanCountLimit obsolete. Because of that NewLRUCache doesn't take three arguments anymore. table_cache_remove_scan_limit option is also removed
291 * By default we now optimize the compilation for the compilation platform (using -march=native). If you want to build portable binary, use 'PORTABLE=1' before the make command.
292 * We now allow level-compaction to place files in different paths by
293 specifying them in db_paths along with the target_size.
294 Lower numbered levels will be placed earlier in the db_paths and higher
295 numbered levels will be placed later in the db_paths vector.
296 * Potentially big performance improvements if you're using RocksDB with lots of column families (100-1000)
297 * Added BlockBasedTableOptions.format_version option, which allows user to specify which version of block based table he wants. As a general guideline, newer versions have more features, but might not be readable by older versions of RocksDB.
298 * Added new block based table format (version 2), which you can enable by setting BlockBasedTableOptions.format_version = 2. This format changes how we encode size information in compressed blocks and should help with memory allocations if you're using Zlib or BZip2 compressions.
299 * MemEnv (env that stores data in memory) is now available in default library build. You can create it by calling NewMemEnv().
300 * Add SliceTransform.SameResultWhenAppended() to help users determine it is safe to apply prefix bloom/hash.
301 * Block based table now makes use of prefix bloom filter if it is a full fulter.
302 * Block based table remembers whether a whole key or prefix based bloom filter is supported in SST files. Do a sanity check when reading the file with users' configuration.
303 * Fixed a bug in ReadOnlyBackupEngine that deleted corrupted backups in some cases, even though the engine was ReadOnly
304 * options.level_compaction_dynamic_level_bytes, a feature to allow RocksDB to pick dynamic base of bytes for levels. With this feature turned on, we will automatically adjust max bytes for each level. The goal of this feature is to have lower bound on size amplification. For more details, see comments in options.h.
305 * Added an abstract base class WriteBatchBase for write batches
306 * Fixed a bug where we start deleting files of a dropped column families even if there are still live references to it
308 ### Public API changes
309 * Deprecated skip_log_error_on_recovery and table_cache_remove_scan_count_limit options.
310 * Logger method logv with log level parameter is now virtual
313 * Added compression per level API.
314 * MemEnv is now available in RocksJava via RocksMemEnv class.
315 * lz4 compression is now included in rocksjava static library when running `make rocksdbjavastatic`.
316 * Overflowing a size_t when setting rocksdb options now throws an IllegalArgumentException, which removes the necessity for a developer to catch these Exceptions explicitly.
321 * Add rocksdb::GetThreadList(), which in the future will return the current status of all
322 rocksdb-related threads. We will have more code instruments in the following RocksDB
324 * Change convert function in rocksdb/utilities/convenience.h to return Status instead of boolean.
325 Also add support for nested options in convert function
327 ### Public API changes
328 * New API to create a checkpoint added. Given a directory name, creates a new
329 database which is an image of the existing database.
330 * New API LinkFile added to Env. If you implement your own Env class, an
331 implementation of the API LinkFile will have to be provided.
332 * MemTableRep takes MemTableAllocator instead of Arena
335 * RocksDBLite library now becomes smaller and will be compiled with -fno-exceptions flag.
337 ## 3.8.0 (11/14/2014)
339 ### Public API changes
340 * BackupEngine::NewBackupEngine() was deprecated; please use BackupEngine::Open() from now on.
341 * BackupableDB/RestoreBackupableDB have new GarbageCollect() methods, which will clean up files from corrupt and obsolete backups.
342 * BackupableDB/RestoreBackupableDB have new GetCorruptedBackups() methods which list corrupt backups.
345 * Bunch of code cleanup, some extra warnings turned on (-Wshadow, -Wshorten-64-to-32, -Wnon-virtual-dtor)
348 * CompactFiles and EventListener, although they are still in experimental state
349 * Full ColumnFamily support in RocksJava.
352 ### Public API changes
353 * Introduce SetOptions() API to allow adjusting a subset of options dynamically online
354 * Introduce 4 new convenient functions for converting Options from string: GetColumnFamilyOptionsFromMap(), GetColumnFamilyOptionsFromString(), GetDBOptionsFromMap(), GetDBOptionsFromString()
355 * Remove WriteBatchWithIndex.Delete() overloads using SliceParts
356 * When opening a DB, if options.max_background_compactions is larger than the existing low pri pool of options.env, it will enlarge it. Similarly, options.max_background_flushes is larger than the existing high pri pool of options.env, it will enlarge it.
359 ### Disk format changes
360 * If you're using RocksDB on ARM platforms and you're using default bloom filter, there is a disk format change you need to be aware of. There are three steps you need to do when you convert to new release: 1. turn off filter policy, 2. compact the whole database, 3. turn on filter policy
363 * We have refactored our system of stalling writes. Any stall-related statistics' meanings are changed. Instead of per-write stall counts, we now count stalls per-epoch, where epochs are periods between flushes and compactions. You'll find more information in our Tuning Perf Guide once we release RocksDB 3.6.
364 * When disableDataSync=true, we no longer sync the MANIFEST file.
365 * Add identity_as_first_hash property to CuckooTable. SST file needs to be rebuilt to be opened by reader properly.
367 ### Public API changes
368 * Change target_file_size_base type to uint64_t from int.
369 * Remove allow_thread_local. This feature was proved to be stable, so we are turning it always-on.
373 * Add include/utilities/write_batch_with_index.h, providing a utility class to query data out of WriteBatch when building it.
374 * Move BlockBasedTable related options to BlockBasedTableOptions from Options. Change corresponding JNI interface. Options affected include:
375 no_block_cache, block_cache, block_cache_compressed, block_size, block_size_deviation, block_restart_interval, filter_policy, whole_key_filtering. filter_policy is changed to shared_ptr from a raw pointer.
376 * Remove deprecated options: disable_seek_compaction and db_stats_log_interval
377 * OptimizeForPointLookup() takes one parameter for block cache size. It now builds hash index, bloom filter, and block cache.
379 ### Public API changes
380 * The Prefix Extractor used with V2 compaction filters is now passed user key to SliceTransform::Transform instead of unparsed RocksDB key.
384 * Support Multiple DB paths in universal style compactions
385 * Add feature of storing plain table index and bloom filter in SST file.
386 * CompactRange() will never output compacted files to level 0. This used to be the case when all the compaction input files were at level 0.
387 * Added iterate_upper_bound to define the extent upto which the forward iterator will return entries. This will prevent iterating over delete markers and overwritten entries for edge cases where you want to break out the iterator anyways. This may improve performance in case there are a large number of delete markers or overwritten entries.
389 ### Public API changes
390 * DBOptions.db_paths now is a vector of a DBPath structure which indicates both of path and target size
391 * NewPlainTableFactory instead of bunch of parameters now accepts PlainTableOptions, which is defined in include/rocksdb/table.h
392 * Moved include/utilities/*.h to include/rocksdb/utilities/*.h
393 * Statistics APIs now take uint32_t as type instead of Tickers. Also make two access functions getTickerCount and histogramData const
394 * Add DB property rocksdb.estimate-num-keys, estimated number of live keys in DB.
395 * Add DB::GetIntProperty(), which returns DB properties that are integer as uint64_t.
396 * The Prefix Extractor used with V2 compaction filters is now passed user key to SliceTransform::Transform instead of unparsed RocksDB key.
400 * Added JSON API prototype.
401 * HashLinklist reduces performance outlier caused by skewed bucket by switching data in the bucket from linked list to skip list. Add parameter threshold_use_skiplist in NewHashLinkListRepFactory().
402 * RocksDB is now able to reclaim storage space more effectively during the compaction process. This is done by compensating the size of each deletion entry by the 2X average value size, which makes compaction to be triggered by deletion entries more easily.
403 * Add TimeOut API to write. Now WriteOptions have a variable called timeout_hint_us. With timeout_hint_us set to non-zero, any write associated with this timeout_hint_us may be aborted when it runs longer than the specified timeout_hint_us, and it is guaranteed that any write completes earlier than the specified time-out will not be aborted due to the time-out condition.
404 * Add a rate_limiter option, which controls total throughput of flush and compaction. The throughput is specified in bytes/sec. Flush always has precedence over compaction when available bandwidth is constrained.
406 ### Public API changes
407 * Removed NewTotalOrderPlainTableFactory because it is not used and implemented semantically incorrect.
409 ## 3.2.0 (06/20/2014)
411 ### Public API changes
412 * We removed seek compaction as a concept from RocksDB because:
413 1) It makes more sense for spinning disk workloads, while RocksDB is primarily designed for flash and memory,
414 2) It added some complexity to the important code-paths,
415 3) None of our internal customers were really using it.
416 Because of that, Options::disable_seek_compaction is now obsolete. It is still a parameter in Options, so it does not break the build, but it does not have any effect. We plan to completely remove it at some point, so we ask users to please remove this option from your code base.
417 * Add two parameters to NewHashLinkListRepFactory() for logging on too many entries in a hash bucket when flushing.
418 * Added new option BlockBasedTableOptions::hash_index_allow_collision. When enabled, prefix hash index for block-based table will not store prefix and allow hash collision, reducing memory consumption.
421 * PlainTable now supports a new key encoding: for keys of the same prefix, the prefix is only written once. It can be enabled through encoding_type parameter of NewPlainTableFactory()
422 * Add AdaptiveTableFactory, which is used to convert from a DB of PlainTable to BlockBasedTabe, or vise versa. It can be created using NewAdaptiveTableFactory()
424 ### Performance Improvements
425 * Tailing Iterator re-implemeted with ForwardIterator + Cascading Search Hint , see ~20% throughput improvement.
427 ## 3.1.0 (05/21/2014)
429 ### Public API changes
430 * Replaced ColumnFamilyOptions::table_properties_collectors with ColumnFamilyOptions::table_properties_collector_factories
433 * Hash index for block-based table will be materialized and reconstructed more efficiently. Previously hash index is constructed by scanning the whole table during every table open.
434 * FIFO compaction style
436 ## 3.0.0 (05/05/2014)
438 ### Public API changes
439 * Added _LEVEL to all InfoLogLevel enums
440 * Deprecated ReadOptions.prefix and ReadOptions.prefix_seek. Seek() defaults to prefix-based seek when Options.prefix_extractor is supplied. More detail is documented in https://github.com/facebook/rocksdb/wiki/Prefix-Seek-API-Changes
441 * MemTableRepFactory::CreateMemTableRep() takes info logger as an extra parameter.
444 * Column family support
445 * Added an option to use different checksum functions in BlockBasedTableOptions
446 * Added ApplyToAllCacheEntries() function to Cache
448 ## 2.8.0 (04/04/2014)
450 * Removed arena.h from public header files.
451 * By default, checksums are verified on every read from database
452 * Change default value of several options, including: paranoid_checks=true, max_open_files=5000, level0_slowdown_writes_trigger=20, level0_stop_writes_trigger=24, disable_seek_compaction=true, max_background_flushes=1 and allow_mmap_writes=false
453 * Added is_manual_compaction to CompactionFilter::Context
454 * Added "virtual void WaitForJoin()" in class Env. Default operation is no-op.
455 * Removed BackupEngine::DeleteBackupsNewerThan() function
456 * Added new option -- verify_checksums_in_compaction
457 * Changed Options.prefix_extractor from raw pointer to shared_ptr (take ownership)
458 Changed HashSkipListRepFactory and HashLinkListRepFactory constructor to not take SliceTransform object (use Options.prefix_extractor implicitly)
459 * Added Env::GetThreadPoolQueueLen(), which returns the waiting queue length of thread pools
460 * Added a command "checkconsistency" in ldb tool, which checks
461 if file system state matches DB state (file existence and file sizes)
462 * Separate options related to block based table to a new struct BlockBasedTableOptions.
463 * WriteBatch has a new function Count() to return total size in the batch, and Data() now returns a reference instead of a copy
464 * Add more counters to perf context.
465 * Supports several more DB properties: compaction-pending, background-errors and cur-size-active-mem-table.
468 * If we find one truncated record at the end of the MANIFEST or WAL files,
469 we will ignore it. We assume that writers of these records were interrupted
470 and that we can safely ignore it.
471 * A new SST format "PlainTable" is added, which is optimized for memory-only workloads. It can be created through NewPlainTableFactory() or NewTotalOrderPlainTableFactory().
472 * A new mem table implementation hash linked list optimizing for the case that there are only few keys for each prefix, which can be created through NewHashLinkListRepFactory().
473 * Merge operator supports a new function PartialMergeMulti() to allow users to do partial merges against multiple operands.
474 * Now compaction filter has a V2 interface. It buffers the kv-pairs sharing the same key prefix, process them in batches, and return the batched results back to DB. The new interface uses a new structure CompactionFilterContext for the same purpose as CompactionFilter::Context in V1.
475 * Geo-spatial support for locations and radial-search.
477 ## 2.7.0 (01/28/2014)
479 ### Public API changes
481 * Renamed `StackableDB::GetRawDB()` to `StackableDB::GetBaseDB()`.
482 * Renamed `WriteBatch::Data()` `const std::string& Data() const`.
483 * Renamed class `TableStats` to `TableProperties`.
484 * Deleted class `PrefixHashRepFactory`. Please use `NewHashSkipListRepFactory()` instead.
485 * Supported multi-threaded `EnableFileDeletions()` and `DisableFileDeletions()`.
486 * Added `DB::GetOptions()`.
487 * Added `DB::GetDbIdentity()`.
491 * Added [BackupableDB](https://github.com/facebook/rocksdb/wiki/How-to-backup-RocksDB%3F)
492 * Implemented [TailingIterator](https://github.com/facebook/rocksdb/wiki/Tailing-Iterator), a special type of iterator that
493 doesn't create a snapshot (can be used to read newly inserted data)
494 and is optimized for doing sequential reads.
495 * Added property block for table, which allows (1) a table to store
496 its metadata and (2) end user to collect and store properties they
498 * Enabled caching index and filter block in block cache (turned off by default).
499 * Supported error report when doing manual compaction.
500 * Supported additional Linux platform flavors and Mac OS.
501 * Put with `SliceParts` - Variant of `Put()` that gathers output like `writev(2)`
502 * Bug fixes and code refactor for compatibility with upcoming Column
505 ### Performance Improvements
507 * Huge benchmark performance improvements by multiple efforts. For example, increase in readonly QPS from about 530k in 2.6 release to 1.1 million in 2.7 [1]
508 * Speeding up a way RocksDB deleted obsolete files - no longer listing the whole directory under a lock -- decrease in p99
509 * Use raw pointer instead of shared pointer for statistics: [5b825d](https://github.com/facebook/rocksdb/commit/5b825d6964e26ec3b4bb6faa708ebb1787f1d7bd) -- huge increase in performance -- shared pointers are slow
510 * Optimized locking for `Get()` -- [1fdb3f](https://github.com/facebook/rocksdb/commit/1fdb3f7dc60e96394e3e5b69a46ede5d67fb976c) -- 1.5x QPS increase for some workloads
511 * Cache speedup - [e8d40c3](https://github.com/facebook/rocksdb/commit/e8d40c31b3cca0c3e1ae9abe9b9003b1288026a9)
512 * Implemented autovector, which allocates first N elements on stack. Most of vectors in RocksDB are small. Also, we never want to allocate heap objects while holding a mutex. -- [c01676e4](https://github.com/facebook/rocksdb/commit/c01676e46d3be08c3c140361ef1f5884f47d3b3c)
513 * Lots of efforts to move malloc, memcpy and IO outside of locks
projects / ceph.git / blob