Class Options
- java.lang.Object
-
- All Implemented Interfaces:
java.lang.AutoCloseable,AdvancedColumnFamilyOptionsInterface<Options>,AdvancedMutableColumnFamilyOptionsInterface<Options>,ColumnFamilyOptionsInterface<Options>,DBOptionsInterface<Options>,MutableColumnFamilyOptionsInterface<Options>,MutableDBOptionsInterface<Options>
public class Options extends RocksObject implements DBOptionsInterface<Options>, MutableDBOptionsInterface<Options>, ColumnFamilyOptionsInterface<Options>, MutableColumnFamilyOptionsInterface<Options>
Options to control the behavior of a database. It will be used during the creation of aRocksDB(i.e., RocksDB.open()). IfAbstractNativeReference.dispose()function is not called, then it will be GC'd automatically and native resources will be released as part of the process.
-
-
Field Summary
-
Fields inherited from class org.rocksdb.RocksObject
nativeHandle_
-
Fields inherited from class org.rocksdb.AbstractImmutableNativeReference
owningHandle_
-
Fields inherited from interface org.rocksdb.ColumnFamilyOptionsInterface
DEFAULT_COMPACTION_MEMTABLE_MEMORY_BUDGET
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description AccessHintaccessHintOnCompactionStart()Specify the file access pattern once a compaction is started.booleanadviseRandomOnOpen()If set true, will hint the underlying file system that the file access pattern is random, when a sst file is opened.booleanallow2pc()if set to false then recovery will fail when a prepared transaction is encountered in the WAL Default: falsebooleanallowConcurrentMemtableWrite()If true, allow multi-writers to update mem tables in parallel.booleanallowFAllocate()Whether fallocate calls are allowedbooleanallowIngestBehind()Returns true if ingest behind is allowed.booleanallowMmapReads()Allow the OS to mmap file for reading sst tables.booleanallowMmapWrites()Allow the OS to mmap file for writing.longarenaBlockSize()The size of one block in arena memory allocation.booleanatomicFlush()Determine if atomic flush of multiple column families is enabled.booleanavoidFlushDuringRecovery()By default RocksDB replay WAL logs and flush them on DB open, which may create very small SST files.booleanavoidFlushDuringShutdown()By default RocksDB will flush all memtables on DB close if there are unpersisted data (i.e.booleanavoidUnnecessaryBlockingIO()If true, working thread may avoid doing unnecessary and long-latency operation (such as deleting obsolete files directly or deleting memtable) and will instead schedule a background job to do it.intbaseBackgroundCompactions()NOT SUPPORTED ANYMORE: RocksDB automatically decides this based on the value of max_background_jobs.booleanbestEffortsRecovery()By default, RocksDB recovery fails if any table file referenced in MANIFEST are missing after scanning the MANIFEST.longbgerrorResumeRetryInterval()If max_bgerror_resume_count is ≥ 2, db resume is called multiple times.intbloomLocality()Control locality of bloom filter probes to improve cache miss rate.CompressionOptionsbottommostCompressionOptions()Get the bottom most compression options.CompressionTypebottommostCompressionType()Compression algorithm that will be used for the bottommost level that contain files.longbytesPerSync()Allows OS to incrementally sync files to disk while they are being written, asynchronously, in the background.java.util.List<DbPath>cfPaths()AbstractCompactionFilter<? extends AbstractSlice<?>>compactionFilter()Accessor for the CompactionFilter instance in use.AbstractCompactionFilterFactory<? extends AbstractCompactionFilter<?>>compactionFilterFactory()Accessor for the CompactionFilterFactory instance in use.CompactionOptionsFIFOcompactionOptionsFIFO()The options for FIFO compaction styleCompactionOptionsUniversalcompactionOptionsUniversal()The options needed to support Universal Style compactionsCompactionPrioritycompactionPriority()Get the Compaction priority if level compaction is used for all levelslongcompactionReadaheadSize()If non-zero, we perform bigger reads when doing compaction.CompactionStylecompactionStyle()Compaction style for DB.ConcurrentTaskLimitercompactionThreadLimiter()Get compaction thread limiterCompressionOptionscompressionOptions()Get the different options for compression algorithmsjava.util.List<CompressionType>compressionPerLevel()Return the currently setCompressionTypeper instances.CompressionTypecompressionType()Compress blocks using the specified compression algorithm.booleancreateIfMissing()Return true if the create_if_missing flag is set to true.booleancreateMissingColumnFamilies()Return true if the create_missing_column_families flag is set to true.java.lang.StringdbLogDir()Returns the directory of info log.java.util.List<DbPath>dbPaths()A list of paths where SST files can be put into, with its target size.longdbWriteBufferSize()Amount of data to build up in memtables across all column families before writing to disk.longdelayedWriteRate()The limited write rate to DB ifColumnFamilyOptions.softPendingCompactionBytesLimit()orColumnFamilyOptions.level0SlowdownWritesTrigger()is triggered, or we are writing to the last mem table allowed and we allow more than 3 mem tables.longdeleteObsoleteFilesPeriodMicros()The periodicity when obsolete files get deleted.booleandisableAutoCompactions()Disable automatic compactions.protected voiddisposeInternal(long handle)booleandumpMallocStats()If true, then print malloc stats together with rocksdb.stats when printing to LOG.booleanenablePipelinedWrite()Returns true if pipelined writes are enabled.booleanenableThreadTracking()If true, then the status of the threads involved in this DB will be tracked and available via GetThreadList() API.booleanenableWriteThreadAdaptiveYield()If true, threads synchronizing with the write batch group leader will wait for up toDBOptionsInterface.writeThreadMaxYieldUsec()before blocking on a mutex.booleanerrorIfExists()If true, an error will be thrown during RocksDB.open() if the database already exists.booleanfailIfOptionsFileError()If true, then DB::Open / CreateColumnFamily / DropColumnFamily / SetOptions will fail if options file is not detected or properly persisted.booleanforceConsistencyChecks()In debug mode, RocksDB run consistency checks on the LSM every time the LSM change (Flush, Compaction, AddFile).EnvgetEnv()Returns the set RocksEnv instance.static java.lang.StringgetOptionStringFromProps(java.util.Properties properties)Converts the input properties into a Options-style formatted stringlonghardPendingCompactionBytesLimit()All writes are stopped if estimated bytes needed to be compaction exceed this threshold.InfoLogLevelinfoLogLevel()Returns currently set log level.longinplaceUpdateNumLocks()Number of locks used for inplace update Default: 10000, if inplace_update_support = true, else 0.booleaninplaceUpdateSupport()Allows thread-safe inplace updates.booleanisFdCloseOnExec()Disable child process inherit open files.longkeepLogFileNum()Returns the maximum number of info log files to be kept.intlevel0FileNumCompactionTrigger()Number of files to trigger level-0 compaction.intlevel0SlowdownWritesTrigger()Soft limit on number of level-0 files.intlevel0StopWritesTrigger()Maximum number of level-0 files.booleanlevelCompactionDynamicLevelBytes()Return ifLevelCompactionDynamicLevelBytesis enabled.intlevelZeroFileNumCompactionTrigger()The number of files in level 0 to trigger compaction from level-0 to level-1.intlevelZeroSlowdownWritesTrigger()Soft limit on the number of level-0 files.intlevelZeroStopWritesTrigger()Maximum number of level-0 files.java.util.List<AbstractEventListener>listeners()Sets theEventListeners whose callback functions will be called when specific RocksDB event happens.longlogFileTimeToRoll()Returns the time interval for the info log file to roll (in seconds).longlogReadaheadSize()The number of bytes to prefetch when reading the log.longmanifestPreallocationSize()Number of bytes to preallocate (via fallocate) the manifest files.booleanmanualWalFlush()Returns true if automatic WAL flushing is disabled.intmaxBackgroundCompactions()Deprecated.intmaxBackgroundFlushes()Deprecated.intmaxBackgroundJobs()Returns the maximum number of concurrent background jobs (both flushes and compactions combined).intmaxBgerrorResumeCount()It defines how many times db resume is called by a separate thread when background retryable IO Error happens.longmaxBytesForLevelBase()The upper-bound of the total size of level-1 files in bytes.doublemaxBytesForLevelMultiplier()The ratio between the total size of level-(L+1) files and the total size of level-L files for all L.int[]maxBytesForLevelMultiplierAdditional()Different max-size multipliers for different levels.longmaxCompactionBytes()Control maximum size of each compaction (not guaranteed)intmaxFileOpeningThreads()IfMutableDBOptionsInterface.maxOpenFiles()is -1, DB will open all files on DB::Open().longmaxLogFileSize()Returns the maximum size of a info log file.longmaxManifestFileSize()Manifest file is rolled over on reaching this limit.intmaxOpenFiles()Number of open files that can be used by the DB.longmaxSequentialSkipInIterations()An iteration->Next() sequentially skips over keys with the same user-key unless this option is set.intmaxSubcompactions()This value represents the maximum number of threads that will concurrently perform a compaction job by breaking it into multiple, smaller ones that are run simultaneously.longmaxSuccessiveMerges()Maximum number of successive merge operations on a key in the memtable.longmaxTableFilesSizeFIFO()FIFO compaction option.longmaxTotalWalSize()Returns the max total wal size.longmaxWriteBatchGroupSizeBytes()The maximum limit of number of bytes that are written in a single batch of WAL or memtable write.intmaxWriteBufferNumber()Returns maximum number of write buffers.intmaxWriteBufferNumberToMaintain()The total maximum number of write buffers to maintain in memory including copies of buffers that have already been flushed.MemTableConfigmemTableConfig()Get the config for mem-table.java.lang.StringmemTableFactoryName()Returns the name of the current mem table representation.longmemtableHugePageSize()Page size for huge page TLB for bloom in memtable.doublememtablePrefixBloomSizeRatio()if prefix_extractor is set and memtable_prefix_bloom_size_ratio is not 0, create prefix bloom for memtable with the size of write_buffer_size * memtable_prefix_bloom_size_ratio.intminWriteBufferNumberToMerge()The minimum number of write buffers that will be merged together before writing to storage.booleannewTableReaderForCompactionInputs()If true, always create a new file descriptor and new table reader for compaction inputs.intnumLevels()If level-styled compaction is used, then this number determines the total number of levels.OptionsoldDefaults(int majorVersion, int minorVersion)The function recovers options to a previous version.booleanoptimizeFiltersForHits()Returns the current state of theoptimize_filters_for_hitssetting.OptionsoptimizeForPointLookup(long blockCacheSizeMb)Use this if you don't need to keep the data sorted, i.e.OptionsoptimizeForSmallDb()Use this if your DB is very small (like under 1GB) and you don't want to spend lots of memory for memtables.OptionsoptimizeForSmallDb(Cache cache)Some functions that make it easier to optimize RocksDB Use this if your DB is very small (like under 1GB) and you don't want to spend lots of memory for memtables.OptionsoptimizeLevelStyleCompaction()Default values for some parameters in ColumnFamilyOptions are not optimized for heavy workloads and big datasets, which means you might observe write stalls under some conditions.OptionsoptimizeLevelStyleCompaction(long memtableMemoryBudget)Default values for some parameters in ColumnFamilyOptions are not optimized for heavy workloads and big datasets, which means you might observe write stalls under some conditions.OptionsoptimizeUniversalStyleCompaction()Default values for some parameters in ColumnFamilyOptions are not optimized for heavy workloads and big datasets, which means you might observe write stalls under some conditions.OptionsoptimizeUniversalStyleCompaction(long memtableMemoryBudget)Default values for some parameters in ColumnFamilyOptions are not optimized for heavy workloads and big datasets, which means you might observe write stalls under some conditions.booleanparanoidChecks()If true, the implementation will do aggressive checking of the data it is processing and will stop early if it detects any errors.booleanparanoidFileChecks()After writing every SST file, reopen it and read all the keys.booleanpersistStatsToDisk()If true, automatically persist stats to a hidden column family (column family name: ___rocksdb_stats_history___) every stats_persist_period_sec seconds; otherwise, write to an in-memory struct.OptionsprepareForBulkLoad()Set appropriate parameters for bulk loading.booleanpreserveDeletes()Returns true if deletes are preserved.longrandomAccessMaxBufferSize()This is a maximum buffer size that is used by WinMmapReadableFile in unbuffered disk I/O mode.longrecycleLogFileNum()Recycle log files.booleanreportBgIoStats()Determine whether IO stats in compactions and flushes are being measuredCacherowCache()A global cache for table-level rows.OptionssetAccessHintOnCompactionStart(AccessHint accessHint)Specify the file access pattern once a compaction is started.OptionssetAdviseRandomOnOpen(boolean adviseRandomOnOpen)If set true, will hint the underlying file system that the file access pattern is random, when a sst file is opened.OptionssetAllow2pc(boolean allow2pc)if set to false then recovery will fail when a prepared transaction is encountered in the WAL Default: falseOptionssetAllowConcurrentMemtableWrite(boolean allowConcurrentMemtableWrite)If true, allow multi-writers to update mem tables in parallel.OptionssetAllowFAllocate(boolean allowFAllocate)Whether fallocate calls are allowedOptionssetAllowIngestBehind(boolean allowIngestBehind)Set this option to true during creation of database if you want to be able to ingest behind (call IngestExternalFile() skipping keys that already exist, rather than overwriting matching keys).OptionssetAllowMmapReads(boolean allowMmapReads)Allow the OS to mmap file for reading sst tables.OptionssetAllowMmapWrites(boolean allowMmapWrites)Allow the OS to mmap file for writing.OptionssetArenaBlockSize(long arenaBlockSize)The size of one block in arena memory allocation.OptionssetAtomicFlush(boolean atomicFlush)If true, RocksDB supports flushing multiple column families and committing their results atomically to MANIFEST.OptionssetAvoidFlushDuringRecovery(boolean avoidFlushDuringRecovery)By default RocksDB replay WAL logs and flush them on DB open, which may create very small SST files.OptionssetAvoidFlushDuringShutdown(boolean avoidFlushDuringShutdown)By default RocksDB will flush all memtables on DB close if there are unpersisted data (i.e.OptionssetAvoidUnnecessaryBlockingIO(boolean avoidUnnecessaryBlockingIO)If true, working thread may avoid doing unnecessary and long-latency operation (such as deleting obsolete files directly or deleting memtable) and will instead schedule a background job to do it.voidsetBaseBackgroundCompactions(int baseBackgroundCompactions)Deprecated.OptionssetBestEffortsRecovery(boolean bestEffortsRecovery)By default, RocksDB recovery fails if any table file referenced in MANIFEST are missing after scanning the MANIFEST.OptionssetBgerrorResumeRetryInterval(long bgerrorResumeRetryInterval)If max_bgerror_resume_count is ≥ 2, db resume is called multiple times.OptionssetBloomLocality(int bloomLocality)Control locality of bloom filter probes to improve cache miss rate.OptionssetBottommostCompressionOptions(CompressionOptions bottommostCompressionOptions)Set the options for compression algorithms used byColumnFamilyOptionsInterface.bottommostCompressionType()if it is enabled.OptionssetBottommostCompressionType(CompressionType bottommostCompressionType)Compression algorithm that will be used for the bottommost level that contain files.OptionssetBytesPerSync(long bytesPerSync)Allows OS to incrementally sync files to disk while they are being written, asynchronously, in the background.OptionssetCfPaths(java.util.Collection<DbPath> cfPaths)A list of paths where SST files for this column family can be put into, with its target size.OptionssetCompactionFilter(AbstractCompactionFilter<? extends AbstractSlice<?>> compactionFilter)A single CompactionFilter instance to call into during compaction.OptionssetCompactionFilterFactory(AbstractCompactionFilterFactory<? extends AbstractCompactionFilter<?>> compactionFilterFactory)This is a factory that providesAbstractCompactionFilterobjects which allow an application to modify/delete a key-value during background compaction.OptionssetCompactionOptionsFIFO(CompactionOptionsFIFO compactionOptionsFIFO)The options for FIFO compaction styleOptionssetCompactionOptionsUniversal(CompactionOptionsUniversal compactionOptionsUniversal)Set the options needed to support Universal Style compactionsOptionssetCompactionPriority(CompactionPriority compactionPriority)If levelAdvancedColumnFamilyOptionsInterface.compactionStyle()==CompactionStyle.LEVEL, for each level, which files are prioritized to be picked to compact.OptionssetCompactionReadaheadSize(long compactionReadaheadSize)If non-zero, we perform bigger reads when doing compaction.OptionssetCompactionStyle(CompactionStyle compactionStyle)Set compaction style for DB.OptionssetCompactionThreadLimiter(ConcurrentTaskLimiter compactionThreadLimiter)Compaction concurrent thread limiter for the column family.OptionssetComparator(AbstractComparator comparator)Use the specified comparator for key ordering.OptionssetComparator(BuiltinComparator builtinComparator)SetBuiltinComparatorto be used with RocksDB.OptionssetCompressionOptions(CompressionOptions compressionOptions)Set the different options for compression algorithmsOptionssetCompressionPerLevel(java.util.List<CompressionType> compressionLevels)Different levels can have different compression policies.OptionssetCompressionType(CompressionType compressionType)Compress blocks using the specified compression algorithm.OptionssetCreateIfMissing(boolean flag)If this value is set to true, then the database will be created if it is missing duringRocksDB.open().OptionssetCreateMissingColumnFamilies(boolean flag)If true, missing column families will be automatically createdOptionssetDbLogDir(java.lang.String dbLogDir)This specifies the info LOG dir.OptionssetDbPaths(java.util.Collection<DbPath> dbPaths)A list of paths where SST files can be put into, with its target size.OptionssetDbWriteBufferSize(long dbWriteBufferSize)Amount of data to build up in memtables across all column families before writing to disk.OptionssetDelayedWriteRate(long delayedWriteRate)The limited write rate to DB ifColumnFamilyOptions.softPendingCompactionBytesLimit()orColumnFamilyOptions.level0SlowdownWritesTrigger()is triggered, or we are writing to the last mem table allowed and we allow more than 3 mem tables.OptionssetDeleteObsoleteFilesPeriodMicros(long micros)The periodicity when obsolete files get deleted.OptionssetDisableAutoCompactions(boolean disableAutoCompactions)Disable automatic compactions.OptionssetDumpMallocStats(boolean dumpMallocStats)If true, then print malloc stats together with rocksdb.stats when printing to LOG.OptionssetEnablePipelinedWrite(boolean enablePipelinedWrite)By default, a single write thread queue is maintained.OptionssetEnableThreadTracking(boolean enableThreadTracking)If true, then the status of the threads involved in this DB will be tracked and available via GetThreadList() API.OptionssetEnableWriteThreadAdaptiveYield(boolean enableWriteThreadAdaptiveYield)If true, threads synchronizing with the write batch group leader will wait for up toDBOptionsInterface.writeThreadMaxYieldUsec()before blocking on a mutex.OptionssetEnv(Env env)Use the specified object to interact with the environment, e.g.OptionssetErrorIfExists(boolean errorIfExists)If true, an error will be thrown during RocksDB.open() if the database already exists.OptionssetFailIfOptionsFileError(boolean failIfOptionsFileError)If true, then DB::Open / CreateColumnFamily / DropColumnFamily / SetOptions will fail if options file is not detected or properly persisted.OptionssetForceConsistencyChecks(boolean forceConsistencyChecks)In debug mode, RocksDB run consistency checks on the LSM every time the LSM change (Flush, Compaction, AddFile).OptionssetHardPendingCompactionBytesLimit(long hardPendingCompactionBytesLimit)All writes are stopped if estimated bytes needed to be compaction exceed this threshold.OptionssetIncreaseParallelism(int totalThreads)By default, RocksDB uses only one background thread for flush and compaction.OptionssetInfoLogLevel(InfoLogLevel infoLogLevel)Sets the RocksDB log level.OptionssetInplaceUpdateNumLocks(long inplaceUpdateNumLocks)Number of locks used for inplace update Default: 10000, if inplace_update_support = true, else 0.OptionssetInplaceUpdateSupport(boolean inplaceUpdateSupport)Allows thread-safe inplace updates.OptionssetIsFdCloseOnExec(boolean isFdCloseOnExec)Disable child process inherit open files.OptionssetKeepLogFileNum(long keepLogFileNum)Specifies the maximum number of info log files to be kept.OptionssetLevel0FileNumCompactionTrigger(int level0FileNumCompactionTrigger)Number of files to trigger level-0 compaction.OptionssetLevel0SlowdownWritesTrigger(int level0SlowdownWritesTrigger)Soft limit on number of level-0 files.OptionssetLevel0StopWritesTrigger(int level0StopWritesTrigger)Maximum number of level-0 files.OptionssetLevelCompactionDynamicLevelBytes(boolean enableLevelCompactionDynamicLevelBytes)Iftrue, RocksDB will pick target size of each level dynamically.OptionssetLevelZeroFileNumCompactionTrigger(int numFiles)Number of files to trigger level-0 compaction.OptionssetLevelZeroSlowdownWritesTrigger(int numFiles)Soft limit on number of level-0 files.OptionssetLevelZeroStopWritesTrigger(int numFiles)Maximum number of level-0 files.OptionssetListeners(java.util.List<AbstractEventListener> listeners)Sets theEventListeners whose callback functions will be called when specific RocksDB event happens.OptionssetLogFileTimeToRoll(long logFileTimeToRoll)Specifies the time interval for the info log file to roll (in seconds).OptionssetLogger(Logger logger)Any internal progress/error information generated by the db will be written to the Logger if it is non-nullptr, or to a file stored in the same directory as the DB contents if info_log is nullptr.OptionssetLogReadaheadSize(long logReadaheadSize)The number of bytes to prefetch when reading the log.OptionssetManifestPreallocationSize(long size)Number of bytes to preallocate (via fallocate) the manifest files.OptionssetManualWalFlush(boolean manualWalFlush)If true WAL is not flushed automatically after each write.OptionssetMaxBackgroundCompactions(int maxBackgroundCompactions)Deprecated.OptionssetMaxBackgroundFlushes(int maxBackgroundFlushes)Deprecated.OptionssetMaxBackgroundJobs(int maxBackgroundJobs)Specifies the maximum number of concurrent background jobs (both flushes and compactions combined).OptionssetMaxBgErrorResumeCount(int maxBgerrorResumeCount)It defines how many times db resume is called by a separate thread when background retryable IO Error happens.OptionssetMaxBytesForLevelBase(long maxBytesForLevelBase)The upper-bound of the total size of level-1 files in bytes.OptionssetMaxBytesForLevelMultiplier(double multiplier)The ratio between the total size of level-(L+1) files and the total size of level-L files for all L.OptionssetMaxBytesForLevelMultiplierAdditional(int[] maxBytesForLevelMultiplierAdditional)Different max-size multipliers for different levels.OptionssetMaxCompactionBytes(long maxCompactionBytes)Maximum size of each compaction (not guarantee)OptionssetMaxFileOpeningThreads(int maxFileOpeningThreads)IfMutableDBOptionsInterface.maxOpenFiles()is -1, DB will open all files on DB::Open().OptionssetMaxLogFileSize(long maxLogFileSize)Specifies the maximum size of a info log file.OptionssetMaxManifestFileSize(long maxManifestFileSize)Manifest file is rolled over on reaching this limit.OptionssetMaxOpenFiles(int maxOpenFiles)Number of open files that can be used by the DB.OptionssetMaxSequentialSkipInIterations(long maxSequentialSkipInIterations)An iteration->Next() sequentially skips over keys with the same user-key unless this option is set.OptionssetMaxSubcompactions(int maxSubcompactions)This value represents the maximum number of threads that will concurrently perform a compaction job by breaking it into multiple, smaller ones that are run simultaneously.OptionssetMaxSuccessiveMerges(long maxSuccessiveMerges)Maximum number of successive merge operations on a key in the memtable.OptionssetMaxTableFilesSizeFIFO(long maxTableFilesSize)FIFO compaction option.OptionssetMaxTotalWalSize(long maxTotalWalSize)Once write-ahead logs exceed this size, we will start forcing the flush of column families whose memtables are backed by the oldest live WAL file (i.e.OptionssetMaxWriteBatchGroupSizeBytes(long maxWriteBatchGroupSizeBytes)The maximum limit of number of bytes that are written in a single batch of WAL or memtable write.OptionssetMaxWriteBufferNumber(int maxWriteBufferNumber)The maximum number of write buffers that are built up in memory.OptionssetMaxWriteBufferNumberToMaintain(int maxWriteBufferNumberToMaintain)The total maximum number of write buffers to maintain in memory including copies of buffers that have already been flushed.OptionssetMemTableConfig(MemTableConfig config)Set the config for mem-table.OptionssetMemtableHugePageSize(long memtableHugePageSize)Page size for huge page TLB for bloom in memtable.OptionssetMemtablePrefixBloomSizeRatio(double memtablePrefixBloomSizeRatio)if prefix_extractor is set and memtable_prefix_bloom_size_ratio is not 0, create prefix bloom for memtable with the size of write_buffer_size * memtable_prefix_bloom_size_ratio.OptionssetMergeOperator(MergeOperator mergeOperator)Set the merge operator to be used for merging two different key/value pairs that share the same key.OptionssetMergeOperatorName(java.lang.String name)Set the merge operator to be used for merging two merge operands of the same key.OptionssetMinWriteBufferNumberToMerge(int minWriteBufferNumberToMerge)The minimum number of write buffers that will be merged together before writing to storage.OptionssetNewTableReaderForCompactionInputs(boolean newTableReaderForCompactionInputs)If true, always create a new file descriptor and new table reader for compaction inputs.OptionssetNumLevels(int numLevels)Set the number of levels for this database If level-styled compaction is used, then this number determines the total number of levels.OptionssetOptimizeFiltersForHits(boolean optimizeFiltersForHits)This flag specifies that the implementation should optimize the filters mainly for cases where keys are found rather than also optimize for keys missed.OptionssetParanoidChecks(boolean paranoidChecks)If true, the implementation will do aggressive checking of the data it is processing and will stop early if it detects any errors.OptionssetParanoidFileChecks(boolean paranoidFileChecks)After writing every SST file, reopen it and read all the keys.OptionssetPersistStatsToDisk(boolean persistStatsToDisk)If true, automatically persist stats to a hidden column family (column family name: ___rocksdb_stats_history___) every stats_persist_period_sec seconds; otherwise, write to an in-memory struct.OptionssetPreserveDeletes(boolean preserveDeletes)Needed to support differential snapshots.OptionssetRandomAccessMaxBufferSize(long randomAccessMaxBufferSize)This is a maximum buffer size that is used by WinMmapReadableFile in unbuffered disk I/O mode.OptionssetRateLimiter(RateLimiter rateLimiter)Use to control write rate of flush and compaction.OptionssetRecycleLogFileNum(long recycleLogFileNum)Recycle log files.OptionssetReportBgIoStats(boolean reportBgIoStats)Measure IO stats in compactions and flushes, if true.OptionssetRowCache(Cache rowCache)A global cache for table-level rows.OptionssetSkipCheckingSstFileSizesOnDbOpen(boolean skipCheckingSstFileSizesOnDbOpen)If true, thenRocksDB.open(String)will not fetch and check sizes of all sst files.OptionssetSkipStatsUpdateOnDbOpen(boolean skipStatsUpdateOnDbOpen)If true, then DB::Open() will not update the statistics used to optimize compaction decision by loading table properties from many files.OptionssetSoftPendingCompactionBytesLimit(long softPendingCompactionBytesLimit)All writes will be slowed down to at least delayed_write_rate if estimated bytes needed to be compaction exceed this threshold.OptionssetSstFileManager(SstFileManager sstFileManager)Use to track SST files and control their file deletion rate.OptionssetSstPartitionerFactory(SstPartitionerFactory sstPartitionerFactory)If non-nullptr, use the specified factory for a function to determine the partitioning of sst files.OptionssetStatistics(Statistics statistics)Sets the statistics object which collects metrics about database operations.OptionssetStatsDumpPeriodSec(int statsDumpPeriodSec)if not zero, dump rocksdb.stats to LOG every stats_dump_period_sec Default: 600 (10 minutes)OptionssetStatsHistoryBufferSize(long statsHistoryBufferSize)If not zero, periodically take stats snapshots and store in memory, the memory size for stats snapshots is capped atstatsHistoryBufferSizeDefault: 1MBOptionssetStatsPersistPeriodSec(int statsPersistPeriodSec)If not zero, dump rocksdb.stats to RocksDB everystatsPersistPeriodSecDefault: 600OptionssetStrictBytesPerSync(boolean strictBytesPerSync)When true, guarantees WAL files have at mostMutableDBOptionsInterface.walBytesPerSync()bytes submitted for writeback at any given time, and SST files have at mostMutableDBOptionsInterface.bytesPerSync()bytes pending writeback at any given time.OptionssetTableCacheNumshardbits(int tableCacheNumshardbits)Number of shards used for table cache.OptionssetTableFormatConfig(TableFormatConfig config)Set the config for table format.OptionssetTargetFileSizeBase(long targetFileSizeBase)The target file size for compaction.OptionssetTargetFileSizeMultiplier(int multiplier)targetFileSizeMultiplier defines the size ratio between a level-L file and level-(L+1) file.OptionssetTtl(long ttl)Non-bottom-level files older than TTL will go through the compaction process.OptionssetTwoWriteQueues(boolean twoWriteQueues)If enabled it uses two queues for writes, one for the ones with disable_memtable and one for the ones that also write to memtable.OptionssetUnorderedWrite(boolean unorderedWrite)SettingDBOptionsInterface.unorderedWrite()to true trades higher write throughput with relaxing the immutability guarantee of snapshots.OptionssetUseAdaptiveMutex(boolean useAdaptiveMutex)Use adaptive mutex, which spins in the user space before resorting to kernel.OptionssetUseDirectIoForFlushAndCompaction(boolean useDirectIoForFlushAndCompaction)Enable the OS to use direct reads and writes in flush and compaction Default: falseOptionssetUseDirectReads(boolean useDirectReads)Enable the OS to use direct I/O for reading sst tables.OptionssetUseFsync(boolean useFsync)If true, then every store to stable storage will issue a fsync.OptionssetWalBytesPerSync(long walBytesPerSync)Same asMutableDBOptionsInterface.setBytesPerSync(long), but applies to WAL files Default: 0, turned offOptionssetWalDir(java.lang.String walDir)This specifies the absolute dir path for write-ahead logs (WAL).OptionssetWalFilter(AbstractWalFilter walFilter)A filter object supplied to be invoked while processing write-ahead-logs (WALs) during recovery.OptionssetWalRecoveryMode(WALRecoveryMode walRecoveryMode)Recovery mode to control the consistency while replaying WAL Default:WALRecoveryMode.PointInTimeRecoveryOptionssetWalSizeLimitMB(long sizeLimitMB)WalTtlSeconds() and walSizeLimitMB() affect how archived logs will be deleted.OptionssetWalTtlSeconds(long walTtlSeconds)DBOptionsInterface.walTtlSeconds()andDBOptionsInterface.walSizeLimitMB()affect how archived logs will be deleted.OptionssetWritableFileMaxBufferSize(long writableFileMaxBufferSize)This is the maximum buffer size that is used by WritableFileWriter.OptionssetWriteBufferManager(WriteBufferManager writeBufferManager)Use passedWriteBufferManagerto control memory usage across multiple column families and/or DB instances.OptionssetWriteBufferSize(long writeBufferSize)Amount of data to build up in memory (backed by an unsorted log on disk) before converting to a sorted on-disk file.OptionssetWriteDbidToManifest(boolean writeDbidToManifest)Historically DB ID has always been stored in Identity File in DB folder.OptionssetWriteThreadMaxYieldUsec(long writeThreadMaxYieldUsec)The maximum number of microseconds that a write operation will use a yielding spin loop to coordinate with other write threads before blocking on a mutex.OptionssetWriteThreadSlowYieldUsec(long writeThreadSlowYieldUsec)The latency in microseconds after which a std::this_thread::yield call (sched_yield on Linux) is considered to be a signal that other processes or threads would like to use the current core.booleanskipCheckingSstFileSizesOnDbOpen()If true, thenRocksDB.open(String)will not fetch and check sizes of all sst files.booleanskipStatsUpdateOnDbOpen()If true, then DB::Open() will not update the statistics used to optimize compaction decision by loading table properties from many files.longsoftPendingCompactionBytesLimit()All writes will be slowed down to at least delayed_write_rate if estimated bytes needed to be compaction exceed this threshold.SstPartitionerFactorysstPartitionerFactory()Get SST partitioner factoryStatisticsstatistics()Returns statistics object.intstatsDumpPeriodSec()If not zero, dump rocksdb.stats to LOG every stats_dump_period_sec Default: 600 (10 minutes)longstatsHistoryBufferSize()If not zero, periodically take stats snapshots and store in memory, the memory size for stats snapshots is capped atstatsHistoryBufferSizeintstatsPersistPeriodSec()If not zero, dump rocksdb.stats to RocksDB everystatsPersistPeriodSecbooleanstrictBytesPerSync()Return the strict byte limit per sync.inttableCacheNumshardbits()Number of shards used for table cache.java.lang.StringtableFactoryName()TableFormatConfigtableFormatConfig()Get the config for table format.longtargetFileSizeBase()The target file size for compaction.inttargetFileSizeMultiplier()targetFileSizeMultiplier defines the size ratio between a level-(L+1) file and level-L file.longttl()Get the TTL for Non-bottom-level files that will go through the compaction process.booleantwoWriteQueues()Returns true if two write queues are enabled.booleanunorderedWrite()Returns true if unordered write are enabled.booleanuseAdaptiveMutex()Use adaptive mutex, which spins in the user space before resorting to kernel.OptionsuseCappedPrefixExtractor(int n)Same as fixed length prefix extractor, except that when slice is shorter than the fixed length, it will use the full key.booleanuseDirectIoForFlushAndCompaction()Enable the OS to use direct reads and writes in flush and compactionbooleanuseDirectReads()Enable the OS to use direct I/O for reading sst tables.OptionsuseFixedLengthPrefixExtractor(int n)This prefix-extractor uses the first n bytes of a key as its prefix.booleanuseFsync()If true, then every store to stable storage will issue a fsync.longwalBytesPerSync()Same asMutableDBOptionsInterface.bytesPerSync(), but applies to WAL files Default: 0, turned offjava.lang.StringwalDir()Returns the path to the write-ahead-logs (WAL) directory.WalFilterwalFilter()Get's the filter for processing WALs during recovery.WALRecoveryModewalRecoveryMode()Recovery mode to control the consistency while replaying WAL Default:WALRecoveryMode.PointInTimeRecoverylongwalSizeLimitMB()DBOptionsInterface.walTtlSeconds()and#walSizeLimitMB()affect how archived logs will be deleted.longwalTtlSeconds()WalTtlSeconds() and walSizeLimitMB() affect how archived logs will be deleted.longwritableFileMaxBufferSize()This is the maximum buffer size that is used by WritableFileWriter.WriteBufferManagerwriteBufferManager()Reference toWriteBufferManagerused by it.longwriteBufferSize()Return size of write buffer size.booleanwriteDbidToManifest()Historically DB ID has always been stored in Identity File in DB folder.longwriteThreadMaxYieldUsec()The maximum number of microseconds that a write operation will use a yielding spin loop to coordinate with other write threads before blocking on a mutex.longwriteThreadSlowYieldUsec()The latency in microseconds after which a std::this_thread::yield call (sched_yield on Linux) is considered to be a signal that other processes or threads would like to use the current core.-
Methods inherited from class org.rocksdb.RocksObject
disposeInternal, getNativeHandle
-
Methods inherited from class org.rocksdb.AbstractImmutableNativeReference
close, disOwnNativeHandle, isOwningHandle
-
Methods inherited from class org.rocksdb.AbstractNativeReference
dispose, finalize
-
-
-
-
Constructor Detail
-
Options
public Options()
Construct options for opening a RocksDB. This constructor will create (by allocating a block of memory) anrocksdb::Optionsin the c++ side.
-
Options
public Options(DBOptions dbOptions, ColumnFamilyOptions columnFamilyOptions)
Construct options for opening a RocksDB. Reusing database options and column family options.- Parameters:
dbOptions-DBOptionsinstancecolumnFamilyOptions-ColumnFamilyOptionsinstance
-
Options
public Options(Options other)
Copy constructor for ColumnFamilyOptions. NOTE: This does a shallow copy, which means comparator, merge_operator and other pointers will be cloned!- Parameters:
other- The Options to copy.
-
-
Method Detail
-
getOptionStringFromProps
public static java.lang.String getOptionStringFromProps(java.util.Properties properties)
Converts the input properties into a Options-style formatted string- Parameters:
properties- The set of properties to convert- Returns:
- The Options-style representation of those properties.
-
setIncreaseParallelism
public Options setIncreaseParallelism(int totalThreads)
Description copied from interface:DBOptionsInterfaceBy default, RocksDB uses only one background thread for flush and compaction. Calling this function will set it up such that total of `total_threads` is used.
You almost definitely want to call this function if your system is bottlenecked by RocksDB.
- Specified by:
setIncreaseParallelismin interfaceDBOptionsInterface<Options>- Parameters:
totalThreads- The total number of threads to be used by RocksDB. A good value is the number of cores.- Returns:
- the instance of the current Options
-
setCreateIfMissing
public Options setCreateIfMissing(boolean flag)
Description copied from interface:DBOptionsInterfaceIf this value is set to true, then the database will be created if it is missing duringRocksDB.open(). Default: false- Specified by:
setCreateIfMissingin interfaceDBOptionsInterface<Options>- Parameters:
flag- a flag indicating whether to create a database the specified database inRocksDB.open(org.rocksdb.Options, String)operation is missing.- Returns:
- the instance of the current Options
- See Also:
RocksDB.open(org.rocksdb.Options, String)
-
setCreateMissingColumnFamilies
public Options setCreateMissingColumnFamilies(boolean flag)
Description copied from interface:DBOptionsInterfaceIf true, missing column families will be automatically created
Default: false
- Specified by:
setCreateMissingColumnFamiliesin interfaceDBOptionsInterface<Options>- Parameters:
flag- a flag indicating if missing column families shall be created automatically.- Returns:
- true if missing column families shall be created automatically on open.
-
setEnv
public Options setEnv(Env env)
Description copied from interface:DBOptionsInterfaceUse the specified object to interact with the environment, e.g. to read/write files, schedule background work, etc. Default:Env.getDefault()- Specified by:
setEnvin interfaceDBOptionsInterface<Options>- Parameters:
env-Envinstance.- Returns:
- the instance of the current Options.
-
getEnv
public Env getEnv()
Description copied from interface:DBOptionsInterfaceReturns the set RocksEnv instance.- Specified by:
getEnvin interfaceDBOptionsInterface<Options>- Returns:
RocksEnvinstance set in the options.
-
prepareForBulkLoad
public Options prepareForBulkLoad()
Set appropriate parameters for bulk loading. The reason that this is a function that returns "this" instead of a constructor is to enable chaining of multiple similar calls in the future.
All data will be in level 0 without any automatic compaction. It's recommended to manually call CompactRange(NULL, NULL) before reading from the database, because otherwise the read can be very slow.
- Returns:
- the instance of the current Options.
-
createIfMissing
public boolean createIfMissing()
Description copied from interface:DBOptionsInterfaceReturn true if the create_if_missing flag is set to true. If true, the database will be created if it is missing.- Specified by:
createIfMissingin interfaceDBOptionsInterface<Options>- Returns:
- true if the createIfMissing option is set to true.
- See Also:
DBOptionsInterface.setCreateIfMissing(boolean)
-
createMissingColumnFamilies
public boolean createMissingColumnFamilies()
Description copied from interface:DBOptionsInterfaceReturn true if the create_missing_column_families flag is set to true. If true column families be created if missing.- Specified by:
createMissingColumnFamiliesin interfaceDBOptionsInterface<Options>- Returns:
- true if the createMissingColumnFamilies is set to true.
- See Also:
DBOptionsInterface.setCreateMissingColumnFamilies(boolean)
-
oldDefaults
public Options oldDefaults(int majorVersion, int minorVersion)
Description copied from interface:ColumnFamilyOptionsInterfaceThe function recovers options to a previous version. Only 4.6 or later versions are supported.- Specified by:
oldDefaultsin interfaceColumnFamilyOptionsInterface<Options>- Returns:
- the instance of the current object.
-
optimizeForSmallDb
public Options optimizeForSmallDb()
Description copied from interface:DBOptionsInterfaceUse this if your DB is very small (like under 1GB) and you don't want to spend lots of memory for memtables.- Specified by:
optimizeForSmallDbin interfaceColumnFamilyOptionsInterface<Options>- Specified by:
optimizeForSmallDbin interfaceDBOptionsInterface<Options>- Returns:
- the instance of the current object.
-
optimizeForSmallDb
public Options optimizeForSmallDb(Cache cache)
Description copied from interface:ColumnFamilyOptionsInterfaceSome functions that make it easier to optimize RocksDB Use this if your DB is very small (like under 1GB) and you don't want to spend lots of memory for memtables. An optional cache object is passed in to be used as the block cache- Specified by:
optimizeForSmallDbin interfaceColumnFamilyOptionsInterface<Options>- Returns:
- the instance of the current object.
-
optimizeForPointLookup
public Options optimizeForPointLookup(long blockCacheSizeMb)
Description copied from interface:ColumnFamilyOptionsInterfaceUse this if you don't need to keep the data sorted, i.e. you'll never use an iterator, only Put() and Get() API calls- Specified by:
optimizeForPointLookupin interfaceColumnFamilyOptionsInterface<Options>- Parameters:
blockCacheSizeMb- Block cache size in MB- Returns:
- the instance of the current object.
-
optimizeLevelStyleCompaction
public Options optimizeLevelStyleCompaction()
Description copied from interface:ColumnFamilyOptionsInterfaceDefault values for some parameters in ColumnFamilyOptions are not optimized for heavy workloads and big datasets, which means you might observe write stalls under some conditions. As a starting point for tuning RocksDB options, use the following for level style compaction.
Make sure to also call IncreaseParallelism(), which will provide the biggest performance gains.
Note: we might use more memory than memtable_memory_budget during high write rate period
- Specified by:
optimizeLevelStyleCompactionin interfaceColumnFamilyOptionsInterface<Options>- Returns:
- the instance of the current object.
-
optimizeLevelStyleCompaction
public Options optimizeLevelStyleCompaction(long memtableMemoryBudget)
Description copied from interface:ColumnFamilyOptionsInterfaceDefault values for some parameters in ColumnFamilyOptions are not optimized for heavy workloads and big datasets, which means you might observe write stalls under some conditions. As a starting point for tuning RocksDB options, use the following for level style compaction.
Make sure to also call IncreaseParallelism(), which will provide the biggest performance gains.
Note: we might use more memory than memtable_memory_budget during high write rate period
- Specified by:
optimizeLevelStyleCompactionin interfaceColumnFamilyOptionsInterface<Options>- Parameters:
memtableMemoryBudget- memory budget in bytes- Returns:
- the instance of the current object.
-
optimizeUniversalStyleCompaction
public Options optimizeUniversalStyleCompaction()
Description copied from interface:ColumnFamilyOptionsInterfaceDefault values for some parameters in ColumnFamilyOptions are not optimized for heavy workloads and big datasets, which means you might observe write stalls under some conditions. As a starting point for tuning RocksDB options, use the following for universal style compaction.
Universal style compaction is focused on reducing Write Amplification Factor for big data sets, but increases Space Amplification.
Make sure to also call IncreaseParallelism(), which will provide the biggest performance gains.
Note: we might use more memory than memtable_memory_budget during high write rate period
- Specified by:
optimizeUniversalStyleCompactionin interfaceColumnFamilyOptionsInterface<Options>- Returns:
- the instance of the current object.
-
optimizeUniversalStyleCompaction
public Options optimizeUniversalStyleCompaction(long memtableMemoryBudget)
Description copied from interface:ColumnFamilyOptionsInterfaceDefault values for some parameters in ColumnFamilyOptions are not optimized for heavy workloads and big datasets, which means you might observe write stalls under some conditions. As a starting point for tuning RocksDB options, use the following for universal style compaction.
Universal style compaction is focused on reducing Write Amplification Factor for big data sets, but increases Space Amplification.
Make sure to also call IncreaseParallelism(), which will provide the biggest performance gains.
Note: we might use more memory than memtable_memory_budget during high write rate period
- Specified by:
optimizeUniversalStyleCompactionin interfaceColumnFamilyOptionsInterface<Options>- Parameters:
memtableMemoryBudget- memory budget in bytes- Returns:
- the instance of the current object.
-
setComparator
public Options setComparator(BuiltinComparator builtinComparator)
Description copied from interface:ColumnFamilyOptionsInterfaceSetBuiltinComparatorto be used with RocksDB. Note: Comparator can be set once upon database creation. Default: BytewiseComparator.- Specified by:
setComparatorin interfaceColumnFamilyOptionsInterface<Options>- Parameters:
builtinComparator- aBuiltinComparatortype.- Returns:
- the instance of the current object.
-
setComparator
public Options setComparator(AbstractComparator comparator)
Description copied from interface:ColumnFamilyOptionsInterfaceUse the specified comparator for key ordering. Comparator should not be disposed before options instances using this comparator is disposed. If dispose() function is not called, then comparator object will be GC'd automatically. Comparator instance can be re-used in multiple options instances.- Specified by:
setComparatorin interfaceColumnFamilyOptionsInterface<Options>- Parameters:
comparator- java instance.- Returns:
- the instance of the current object.
-
setMergeOperatorName
public Options setMergeOperatorName(java.lang.String name)
Description copied from interface:ColumnFamilyOptionsInterfaceSet the merge operator to be used for merging two merge operands of the same key. The merge function is invoked during compaction and at lookup time, if multiple key/value pairs belonging to the same key are found in the database.
- Specified by:
setMergeOperatorNamein interfaceColumnFamilyOptionsInterface<Options>- Parameters:
name- the name of the merge function, as defined by the MergeOperators factory (see utilities/MergeOperators.h) The merge function is specified by name and must be one of the standard merge operators provided by RocksDB. The available operators are "put", "uint64add", "stringappend" and "stringappendtest".- Returns:
- the instance of the current object.
-
setMergeOperator
public Options setMergeOperator(MergeOperator mergeOperator)
Description copied from interface:ColumnFamilyOptionsInterfaceSet the merge operator to be used for merging two different key/value pairs that share the same key. The merge function is invoked during compaction and at lookup time, if multiple key/value pairs belonging to the same key are found in the database.
- Specified by:
setMergeOperatorin interfaceColumnFamilyOptionsInterface<Options>- Parameters:
mergeOperator-MergeOperatorinstance.- Returns:
- the instance of the current object.
-
setCompactionFilter
public Options setCompactionFilter(AbstractCompactionFilter<? extends AbstractSlice<?>> compactionFilter)
Description copied from interface:ColumnFamilyOptionsInterfaceA single CompactionFilter instance to call into during compaction. Allows an application to modify/delete a key-value during background compaction. If the client requires a new compaction filter to be used for different compaction runs, it can specify callColumnFamilyOptionsInterface.setCompactionFilterFactory(AbstractCompactionFilterFactory)instead. The client should specify only set one of the two.ColumnFamilyOptionsInterface.setCompactionFilter(AbstractCompactionFilter)takes precedence overColumnFamilyOptionsInterface.setCompactionFilterFactory(AbstractCompactionFilterFactory)if the client specifies both. If multithreaded compaction is being used, the supplied CompactionFilter instance may be used from different threads concurrently and so should be thread-safe.- Specified by:
setCompactionFilterin interfaceColumnFamilyOptionsInterface<Options>- Parameters:
compactionFilter-AbstractCompactionFilterinstance.- Returns:
- the instance of the current object.
-
compactionFilter
public AbstractCompactionFilter<? extends AbstractSlice<?>> compactionFilter()
Description copied from interface:ColumnFamilyOptionsInterfaceAccessor for the CompactionFilter instance in use.- Specified by:
compactionFilterin interfaceColumnFamilyOptionsInterface<Options>- Returns:
- Reference to the CompactionFilter, or null if one hasn't been set.
-
setCompactionFilterFactory
public Options setCompactionFilterFactory(AbstractCompactionFilterFactory<? extends AbstractCompactionFilter<?>> compactionFilterFactory)
Description copied from interface:ColumnFamilyOptionsInterfaceThis is a factory that providesAbstractCompactionFilterobjects which allow an application to modify/delete a key-value during background compaction. A new filter will be created on each compaction run. If multithreaded compaction is being used, each created CompactionFilter will only be used from a single thread and so does not need to be thread-safe.- Specified by:
setCompactionFilterFactoryin interfaceColumnFamilyOptionsInterface<Options>- Parameters:
compactionFilterFactory-AbstractCompactionFilterFactoryinstance.- Returns:
- the instance of the current object.
-
compactionFilterFactory
public AbstractCompactionFilterFactory<? extends AbstractCompactionFilter<?>> compactionFilterFactory()
Description copied from interface:ColumnFamilyOptionsInterfaceAccessor for the CompactionFilterFactory instance in use.- Specified by:
compactionFilterFactoryin interfaceColumnFamilyOptionsInterface<Options>- Returns:
- Reference to the CompactionFilterFactory, or null if one hasn't been set.
-
setWriteBufferSize
public Options setWriteBufferSize(long writeBufferSize)
Description copied from interface:MutableColumnFamilyOptionsInterfaceAmount of data to build up in memory (backed by an unsorted log on disk) before converting to a sorted on-disk file. Larger values increase performance, especially during bulk loads. Up tomax_write_buffer_numberwrite buffers may be held in memory at the same time, so you may wish to adjust this parameter to control memory usage. Also, a larger write buffer will result in a longer recovery time the next time the database is opened. Default: 64MB- Specified by:
setWriteBufferSizein interfaceMutableColumnFamilyOptionsInterface<Options>- Parameters:
writeBufferSize- the size of write buffer.- Returns:
- the instance of the current object.
-
writeBufferSize
public long writeBufferSize()
Description copied from interface:MutableColumnFamilyOptionsInterfaceReturn size of write buffer size.- Specified by:
writeBufferSizein interfaceMutableColumnFamilyOptionsInterface<Options>- Returns:
- size of write buffer.
- See Also:
MutableColumnFamilyOptionsInterface.setWriteBufferSize(long)
-
setMaxWriteBufferNumber
public Options setMaxWriteBufferNumber(int maxWriteBufferNumber)
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceThe maximum number of write buffers that are built up in memory. The default is 2, so that when 1 write buffer is being flushed to storage, new writes can continue to the other write buffer. Default: 2- Specified by:
setMaxWriteBufferNumberin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Parameters:
maxWriteBufferNumber- maximum number of write buffers.- Returns:
- the instance of the current options.
-
maxWriteBufferNumber
public int maxWriteBufferNumber()
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceReturns maximum number of write buffers.- Specified by:
maxWriteBufferNumberin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Returns:
- maximum number of write buffers.
- See Also:
AdvancedMutableColumnFamilyOptionsInterface.setMaxWriteBufferNumber(int)
-
errorIfExists
public boolean errorIfExists()
Description copied from interface:DBOptionsInterfaceIf true, an error will be thrown during RocksDB.open() if the database already exists.- Specified by:
errorIfExistsin interfaceDBOptionsInterface<Options>- Returns:
- if true, an error is raised when the specified database already exists before open.
-
setErrorIfExists
public Options setErrorIfExists(boolean errorIfExists)
Description copied from interface:DBOptionsInterfaceIf true, an error will be thrown during RocksDB.open() if the database already exists. Default: false- Specified by:
setErrorIfExistsin interfaceDBOptionsInterface<Options>- Parameters:
errorIfExists- if true, an exception will be thrown duringRocksDB.open()if the database already exists.- Returns:
- the reference to the current option.
- See Also:
RocksDB.open(org.rocksdb.Options, String)
-
paranoidChecks
public boolean paranoidChecks()
Description copied from interface:DBOptionsInterfaceIf true, the implementation will do aggressive checking of the data it is processing and will stop early if it detects any errors. This may have unforeseen ramifications: for example, a corruption of one DB entry may cause a large number of entries to become unreadable or for the entire DB to become unopenable. If any of the writes to the database fails (Put, Delete, Merge, Write), the database will switch to read-only mode and fail all other Write operations.- Specified by:
paranoidChecksin interfaceDBOptionsInterface<Options>- Returns:
- a boolean indicating whether paranoid-check is on.
-
setParanoidChecks
public Options setParanoidChecks(boolean paranoidChecks)
Description copied from interface:DBOptionsInterfaceIf true, the implementation will do aggressive checking of the data it is processing and will stop early if it detects any errors. This may have unforeseen ramifications: for example, a corruption of one DB entry may cause a large number of entries to become unreadable or for the entire DB to become unopenable. If any of the writes to the database fails (Put, Delete, Merge, Write), the database will switch to read-only mode and fail all other Write operations. Default: true- Specified by:
setParanoidChecksin interfaceDBOptionsInterface<Options>- Parameters:
paranoidChecks- a flag to indicate whether paranoid-check is on.- Returns:
- the reference to the current option.
-
maxOpenFiles
public int maxOpenFiles()
Description copied from interface:MutableDBOptionsInterfaceNumber of open files that can be used by the DB. You may need to increase this if your database has a large working set. Value -1 means files opened are always kept open. You can estimate number of files based ontarget_file_size_baseandtarget_file_size_multiplierfor level-based compaction. For universal-style compaction, you can usually set it to -1. Default: -1- Specified by:
maxOpenFilesin interfaceMutableDBOptionsInterface<Options>- Returns:
- the maximum number of open files.
-
setMaxFileOpeningThreads
public Options setMaxFileOpeningThreads(int maxFileOpeningThreads)
Description copied from interface:DBOptionsInterfaceIfMutableDBOptionsInterface.maxOpenFiles()is -1, DB will open all files on DB::Open(). You can use this option to increase the number of threads used to open the files. Default: 16- Specified by:
setMaxFileOpeningThreadsin interfaceDBOptionsInterface<Options>- Parameters:
maxFileOpeningThreads- the maximum number of threads to use to open files- Returns:
- the reference to the current options.
-
maxFileOpeningThreads
public int maxFileOpeningThreads()
Description copied from interface:DBOptionsInterfaceIfMutableDBOptionsInterface.maxOpenFiles()is -1, DB will open all files on DB::Open(). You can use this option to increase the number of threads used to open the files. Default: 16- Specified by:
maxFileOpeningThreadsin interfaceDBOptionsInterface<Options>- Returns:
- the maximum number of threads to use to open files
-
setMaxTotalWalSize
public Options setMaxTotalWalSize(long maxTotalWalSize)
Description copied from interface:MutableDBOptionsInterfaceOnce write-ahead logs exceed this size, we will start forcing the flush of column families whose memtables are backed by the oldest live WAL file (i.e. the ones that are causing all the space amplification).
If set to 0 (default), we will dynamically choose the WAL size limit to be [sum of all write_buffer_size * max_write_buffer_number] * 2
This option takes effect only when there are more than one column family as otherwise the wal size is dictated by the write_buffer_size.
Default: 0
- Specified by:
setMaxTotalWalSizein interfaceMutableDBOptionsInterface<Options>- Parameters:
maxTotalWalSize- max total wal size.- Returns:
- the instance of the current object.
-
maxTotalWalSize
public long maxTotalWalSize()
Description copied from interface:MutableDBOptionsInterfaceReturns the max total wal size. Once write-ahead logs exceed this size, we will start forcing the flush of column families whose memtables are backed by the oldest live WAL file (i.e. the ones that are causing all the space amplification).
If set to 0 (default), we will dynamically choose the WAL size limit to be [sum of all write_buffer_size * max_write_buffer_number] * 2
- Specified by:
maxTotalWalSizein interfaceMutableDBOptionsInterface<Options>- Returns:
- max total wal size
-
setMaxOpenFiles
public Options setMaxOpenFiles(int maxOpenFiles)
Description copied from interface:MutableDBOptionsInterfaceNumber of open files that can be used by the DB. You may need to increase this if your database has a large working set. Value -1 means files opened are always kept open. You can estimate number of files based ontarget_file_size_baseandtarget_file_size_multiplierfor level-based compaction. For universal-style compaction, you can usually set it to -1. Default: -1- Specified by:
setMaxOpenFilesin interfaceMutableDBOptionsInterface<Options>- Parameters:
maxOpenFiles- the maximum number of open files.- Returns:
- the instance of the current object.
-
useFsync
public boolean useFsync()
Description copied from interface:DBOptionsInterfaceIf true, then every store to stable storage will issue a fsync.
If false, then every store to stable storage will issue a fdatasync. This parameter should be set to true while storing data to filesystem like ext3 that can lose files after a reboot.
- Specified by:
useFsyncin interfaceDBOptionsInterface<Options>- Returns:
- boolean value indicating if fsync is used.
-
setUseFsync
public Options setUseFsync(boolean useFsync)
Description copied from interface:DBOptionsInterfaceIf true, then every store to stable storage will issue a fsync.
If false, then every store to stable storage will issue a fdatasync. This parameter should be set to true while storing data to filesystem like ext3 that can lose files after a reboot.
Default: false
- Specified by:
setUseFsyncin interfaceDBOptionsInterface<Options>- Parameters:
useFsync- a boolean flag to specify whether to use fsync- Returns:
- the instance of the current object.
-
setDbPaths
public Options setDbPaths(java.util.Collection<DbPath> dbPaths)
Description copied from interface:DBOptionsInterfaceA list of paths where SST files can be put into, with its target size. Newer data is placed into paths specified earlier in the vector while older data gradually moves to paths specified later in the vector. For example, you have a flash device with 10GB allocated for the DB, as well as a hard drive of 2TB, you should config it to be: [{"/flash_path", 10GB}, {"/hard_drive", 2TB}] The system will try to guarantee data under each path is close to but not larger than the target size. But current and future file sizes used by determining where to place a file are based on best-effort estimation, which means there is a chance that the actual size under the directory is slightly more than target size under some workloads. User should give some buffer room for those cases. If none of the paths has sufficient room to place a file, the file will be placed to the last path anyway, despite to the target size. Placing newer data to earlier paths is also best-efforts. User should expect user files to be placed in higher levels in some extreme cases. If left empty, only one path will be used, which is db_name passed when opening the DB. Default: empty- Specified by:
setDbPathsin interfaceDBOptionsInterface<Options>- Parameters:
dbPaths- the paths and target sizes- Returns:
- the reference to the current options
-
dbPaths
public java.util.List<DbPath> dbPaths()
Description copied from interface:DBOptionsInterfaceA list of paths where SST files can be put into, with its target size. Newer data is placed into paths specified earlier in the vector while older data gradually moves to paths specified later in the vector. For example, you have a flash device with 10GB allocated for the DB, as well as a hard drive of 2TB, you should config it to be: [{"/flash_path", 10GB}, {"/hard_drive", 2TB}] The system will try to guarantee data under each path is close to but not larger than the target size. But current and future file sizes used by determining where to place a file are based on best-effort estimation, which means there is a chance that the actual size under the directory is slightly more than target size under some workloads. User should give some buffer room for those cases. If none of the paths has sufficient room to place a file, the file will be placed to the last path anyway, despite to the target size. Placing newer data to earlier paths is also best-efforts. User should expect user files to be placed in higher levels in some extreme cases. If left empty, only one path will be used, which is db_name passed when opening the DB. Default:Collections.emptyList()- Specified by:
dbPathsin interfaceDBOptionsInterface<Options>- Returns:
- dbPaths the paths and target sizes
-
dbLogDir
public java.lang.String dbLogDir()
Description copied from interface:DBOptionsInterfaceReturns the directory of info log. If it is empty, the log files will be in the same dir as data. If it is non empty, the log files will be in the specified dir, and the db data dir's absolute path will be used as the log file name's prefix.- Specified by:
dbLogDirin interfaceDBOptionsInterface<Options>- Returns:
- the path to the info log directory
-
setDbLogDir
public Options setDbLogDir(java.lang.String dbLogDir)
Description copied from interface:DBOptionsInterfaceThis specifies the info LOG dir. If it is empty, the log files will be in the same dir as data. If it is non empty, the log files will be in the specified dir, and the db data dir's absolute path will be used as the log file name's prefix.- Specified by:
setDbLogDirin interfaceDBOptionsInterface<Options>- Parameters:
dbLogDir- the path to the info log directory- Returns:
- the instance of the current object.
-
walDir
public java.lang.String walDir()
Description copied from interface:DBOptionsInterfaceReturns the path to the write-ahead-logs (WAL) directory. If it is empty, the log files will be in the same dir as data, dbname is used as the data dir by default If it is non empty, the log files will be in kept the specified dir. When destroying the db, all log files in wal_dir and the dir itself is deleted- Specified by:
walDirin interfaceDBOptionsInterface<Options>- Returns:
- the path to the write-ahead-logs (WAL) directory.
-
setWalDir
public Options setWalDir(java.lang.String walDir)
Description copied from interface:DBOptionsInterfaceThis specifies the absolute dir path for write-ahead logs (WAL). If it is empty, the log files will be in the same dir as data, dbname is used as the data dir by default If it is non empty, the log files will be in kept the specified dir. When destroying the db, all log files in wal_dir and the dir itself is deleted- Specified by:
setWalDirin interfaceDBOptionsInterface<Options>- Parameters:
walDir- the path to the write-ahead-log directory.- Returns:
- the instance of the current object.
-
deleteObsoleteFilesPeriodMicros
public long deleteObsoleteFilesPeriodMicros()
Description copied from interface:DBOptionsInterfaceThe periodicity when obsolete files get deleted. The default value is 6 hours. The files that get out of scope by compaction process will still get automatically delete on every compaction, regardless of this setting- Specified by:
deleteObsoleteFilesPeriodMicrosin interfaceDBOptionsInterface<Options>- Specified by:
deleteObsoleteFilesPeriodMicrosin interfaceMutableDBOptionsInterface<Options>- Returns:
- the time interval in micros when obsolete files will be deleted.
-
setDeleteObsoleteFilesPeriodMicros
public Options setDeleteObsoleteFilesPeriodMicros(long micros)
Description copied from interface:DBOptionsInterfaceThe periodicity when obsolete files get deleted. The default value is 6 hours. The files that get out of scope by compaction process will still get automatically delete on every compaction, regardless of this setting- Specified by:
setDeleteObsoleteFilesPeriodMicrosin interfaceDBOptionsInterface<Options>- Specified by:
setDeleteObsoleteFilesPeriodMicrosin interfaceMutableDBOptionsInterface<Options>- Parameters:
micros- the time interval in micros- Returns:
- the instance of the current object.
-
maxBackgroundCompactions
@Deprecated public int maxBackgroundCompactions()
Deprecated.Description copied from interface:MutableDBOptionsInterfaceNOT SUPPORTED ANYMORE: RocksDB automatically decides this based on the value of max_background_jobs. For backwards compatibility we will set `max_background_jobs = max_background_compactions + max_background_flushes` in the case where user sets at least one of `max_background_compactions` or `max_background_flushes` (we replace -1 by 1 in case one option is unset). Returns the maximum number of concurrent background compaction jobs, submitted to the default LOW priority thread pool. When increasing this number, we may also want to consider increasing number of threads in LOW priority thread pool. Default: -1- Specified by:
maxBackgroundCompactionsin interfaceMutableDBOptionsInterface<Options>- Returns:
- the maximum number of concurrent background compaction jobs.
- See Also:
Env.setBackgroundThreads(int),Env.setBackgroundThreads(int, Priority)
-
setStatistics
public Options setStatistics(Statistics statistics)
Description copied from interface:DBOptionsInterfaceSets the statistics object which collects metrics about database operations. Statistics objects should not be shared between DB instances as it does not use any locks to prevent concurrent updates.
- Specified by:
setStatisticsin interfaceDBOptionsInterface<Options>- Parameters:
statistics- The statistics to set- Returns:
- the instance of the current object.
- See Also:
RocksDB.open(org.rocksdb.Options, String)
-
statistics
public Statistics statistics()
Description copied from interface:DBOptionsInterfaceReturns statistics object.
- Specified by:
statisticsin interfaceDBOptionsInterface<Options>- Returns:
- the instance of the statistics object or null if there is no statistics object.
- See Also:
DBOptionsInterface.setStatistics(Statistics)
-
setBaseBackgroundCompactions
@Deprecated public void setBaseBackgroundCompactions(int baseBackgroundCompactions)
Deprecated.Description copied from interface:MutableDBOptionsInterfaceNOT SUPPORTED ANYMORE: RocksDB automatically decides this based on the value of max_background_jobs. This option is ignored. Suggested number of concurrent background compaction jobs, submitted to the default LOW priority thread pool. Default: -1- Specified by:
setBaseBackgroundCompactionsin interfaceMutableDBOptionsInterface<Options>- Parameters:
baseBackgroundCompactions- Suggested number of background compaction jobs
-
baseBackgroundCompactions
public int baseBackgroundCompactions()
Description copied from interface:MutableDBOptionsInterfaceNOT SUPPORTED ANYMORE: RocksDB automatically decides this based on the value of max_background_jobs. This option is ignored. Suggested number of concurrent background compaction jobs, submitted to the default LOW priority thread pool. Default: -1- Specified by:
baseBackgroundCompactionsin interfaceMutableDBOptionsInterface<Options>- Returns:
- Suggested number of background compaction jobs
-
setMaxBackgroundCompactions
@Deprecated public Options setMaxBackgroundCompactions(int maxBackgroundCompactions)
Deprecated.Description copied from interface:MutableDBOptionsInterfaceNOT SUPPORTED ANYMORE: RocksDB automatically decides this based on the value of max_background_jobs. For backwards compatibility we will set `max_background_jobs = max_background_compactions + max_background_flushes` in the case where user sets at least one of `max_background_compactions` or `max_background_flushes` (we replace -1 by 1 in case one option is unset). Specifies the maximum number of concurrent background compaction jobs, submitted to the default LOW priority thread pool. If you're increasing this, also consider increasing number of threads in LOW priority thread pool. For more information, see Default: -1- Specified by:
setMaxBackgroundCompactionsin interfaceMutableDBOptionsInterface<Options>- Parameters:
maxBackgroundCompactions- the maximum number of background compaction jobs.- Returns:
- the instance of the current object.
- See Also:
Env.setBackgroundThreads(int),Env.setBackgroundThreads(int, Priority),DBOptionsInterface.maxBackgroundFlushes()
-
setMaxSubcompactions
public Options setMaxSubcompactions(int maxSubcompactions)
Description copied from interface:DBOptionsInterfaceThis value represents the maximum number of threads that will concurrently perform a compaction job by breaking it into multiple, smaller ones that are run simultaneously. Default: 1 (i.e. no subcompactions)- Specified by:
setMaxSubcompactionsin interfaceDBOptionsInterface<Options>- Parameters:
maxSubcompactions- The maximum number of threads that will concurrently perform a compaction job- Returns:
- the instance of the current object.
-
maxSubcompactions
public int maxSubcompactions()
Description copied from interface:DBOptionsInterfaceThis value represents the maximum number of threads that will concurrently perform a compaction job by breaking it into multiple, smaller ones that are run simultaneously. Default: 1 (i.e. no subcompactions)- Specified by:
maxSubcompactionsin interfaceDBOptionsInterface<Options>- Returns:
- The maximum number of threads that will concurrently perform a compaction job
-
maxBackgroundFlushes
@Deprecated public int maxBackgroundFlushes()
Deprecated.Description copied from interface:DBOptionsInterfaceNOT SUPPORTED ANYMORE: RocksDB automatically decides this based on the value of max_background_jobs. For backwards compatibility we will set `max_background_jobs = max_background_compactions + max_background_flushes` in the case where user sets at least one of `max_background_compactions` or `max_background_flushes`. Returns the maximum number of concurrent background flush jobs. If you're increasing this, also consider increasing number of threads in HIGH priority thread pool. For more information, see Default: -1- Specified by:
maxBackgroundFlushesin interfaceDBOptionsInterface<Options>- Returns:
- the maximum number of concurrent background flush jobs.
- See Also:
Env.setBackgroundThreads(int),Env.setBackgroundThreads(int, Priority)
-
setMaxBackgroundFlushes
@Deprecated public Options setMaxBackgroundFlushes(int maxBackgroundFlushes)
Deprecated.Description copied from interface:DBOptionsInterfaceNOT SUPPORTED ANYMORE: RocksDB automatically decides this based on the value of max_background_jobs. For backwards compatibility we will set `max_background_jobs = max_background_compactions + max_background_flushes` in the case where user sets at least one of `max_background_compactions` or `max_background_flushes`. Specifies the maximum number of concurrent background flush jobs. If you're increasing this, also consider increasing number of threads in HIGH priority thread pool. For more information, see Default: -1- Specified by:
setMaxBackgroundFlushesin interfaceDBOptionsInterface<Options>- Parameters:
maxBackgroundFlushes- number of max concurrent flush jobs- Returns:
- the instance of the current object.
- See Also:
Env.setBackgroundThreads(int),Env.setBackgroundThreads(int, Priority),MutableDBOptionsInterface.maxBackgroundCompactions()
-
maxBackgroundJobs
public int maxBackgroundJobs()
Description copied from interface:MutableDBOptionsInterfaceReturns the maximum number of concurrent background jobs (both flushes and compactions combined). Default: 2- Specified by:
maxBackgroundJobsin interfaceMutableDBOptionsInterface<Options>- Returns:
- the maximum number of concurrent background jobs.
-
setMaxBackgroundJobs
public Options setMaxBackgroundJobs(int maxBackgroundJobs)
Description copied from interface:MutableDBOptionsInterfaceSpecifies the maximum number of concurrent background jobs (both flushes and compactions combined). Default: 2- Specified by:
setMaxBackgroundJobsin interfaceMutableDBOptionsInterface<Options>- Parameters:
maxBackgroundJobs- number of max concurrent background jobs- Returns:
- the instance of the current object.
-
maxLogFileSize
public long maxLogFileSize()
Description copied from interface:DBOptionsInterfaceReturns the maximum size of a info log file. If the current log file is larger than this size, a new info log file will be created. If 0, all logs will be written to one log file.- Specified by:
maxLogFileSizein interfaceDBOptionsInterface<Options>- Returns:
- the maximum size of the info log file.
-
setMaxLogFileSize
public Options setMaxLogFileSize(long maxLogFileSize)
Description copied from interface:DBOptionsInterfaceSpecifies the maximum size of a info log file. If the current log file is larger than `max_log_file_size`, a new info log file will be created. If 0, all logs will be written to one log file.- Specified by:
setMaxLogFileSizein interfaceDBOptionsInterface<Options>- Parameters:
maxLogFileSize- the maximum size of a info log file.- Returns:
- the instance of the current object.
-
logFileTimeToRoll
public long logFileTimeToRoll()
Description copied from interface:DBOptionsInterfaceReturns the time interval for the info log file to roll (in seconds). If specified with non-zero value, log file will be rolled if it has been active longer than `log_file_time_to_roll`. Default: 0 (disabled)- Specified by:
logFileTimeToRollin interfaceDBOptionsInterface<Options>- Returns:
- the time interval in seconds.
-
setLogFileTimeToRoll
public Options setLogFileTimeToRoll(long logFileTimeToRoll)
Description copied from interface:DBOptionsInterfaceSpecifies the time interval for the info log file to roll (in seconds). If specified with non-zero value, log file will be rolled if it has been active longer than `log_file_time_to_roll`. Default: 0 (disabled)- Specified by:
setLogFileTimeToRollin interfaceDBOptionsInterface<Options>- Parameters:
logFileTimeToRoll- the time interval in seconds.- Returns:
- the instance of the current object.
-
keepLogFileNum
public long keepLogFileNum()
Description copied from interface:DBOptionsInterfaceReturns the maximum number of info log files to be kept. Default: 1000- Specified by:
keepLogFileNumin interfaceDBOptionsInterface<Options>- Returns:
- the maximum number of info log files to be kept.
-
setKeepLogFileNum
public Options setKeepLogFileNum(long keepLogFileNum)
Description copied from interface:DBOptionsInterfaceSpecifies the maximum number of info log files to be kept. Default: 1000- Specified by:
setKeepLogFileNumin interfaceDBOptionsInterface<Options>- Parameters:
keepLogFileNum- the maximum number of info log files to be kept.- Returns:
- the instance of the current object.
-
setRecycleLogFileNum
public Options setRecycleLogFileNum(long recycleLogFileNum)
Description copied from interface:DBOptionsInterfaceRecycle log files. If non-zero, we will reuse previously written log files for new logs, overwriting the old data. The value indicates how many such files we will keep around at any point in time for later use. This is more efficient because the blocks are already allocated and fdatasync does not need to update the inode after each write. Default: 0- Specified by:
setRecycleLogFileNumin interfaceDBOptionsInterface<Options>- Parameters:
recycleLogFileNum- the number of log files to keep for recycling- Returns:
- the reference to the current options
-
recycleLogFileNum
public long recycleLogFileNum()
Description copied from interface:DBOptionsInterfaceRecycle log files. If non-zero, we will reuse previously written log files for new logs, overwriting the old data. The value indicates how many such files we will keep around at any point in time for later use. This is more efficient because the blocks are already allocated and fdatasync does not need to update the inode after each write. Default: 0- Specified by:
recycleLogFileNumin interfaceDBOptionsInterface<Options>- Returns:
- the number of log files kept for recycling
-
maxManifestFileSize
public long maxManifestFileSize()
Description copied from interface:DBOptionsInterfaceManifest file is rolled over on reaching this limit. The older manifest file be deleted. The default value is 1GB so that the manifest file can grow, but not reach the limit of storage capacity.- Specified by:
maxManifestFileSizein interfaceDBOptionsInterface<Options>- Returns:
- the size limit of a manifest file.
-
setMaxManifestFileSize
public Options setMaxManifestFileSize(long maxManifestFileSize)
Description copied from interface:DBOptionsInterfaceManifest file is rolled over on reaching this limit. The older manifest file be deleted. The default value is 1GB so that the manifest file can grow, but not reach the limit of storage capacity.- Specified by:
setMaxManifestFileSizein interfaceDBOptionsInterface<Options>- Parameters:
maxManifestFileSize- the size limit of a manifest file.- Returns:
- the instance of the current object.
-
setMaxTableFilesSizeFIFO
public Options setMaxTableFilesSizeFIFO(long maxTableFilesSize)
Description copied from interface:ColumnFamilyOptionsInterfaceFIFO compaction option. The oldest table file will be deleted once the sum of table files reaches this size. The default value is 1GB (1 * 1024 * 1024 * 1024).- Specified by:
setMaxTableFilesSizeFIFOin interfaceColumnFamilyOptionsInterface<Options>- Parameters:
maxTableFilesSize- the size limit of the total sum of table files.- Returns:
- the instance of the current object.
-
maxTableFilesSizeFIFO
public long maxTableFilesSizeFIFO()
Description copied from interface:ColumnFamilyOptionsInterfaceFIFO compaction option. The oldest table file will be deleted once the sum of table files reaches this size. The default value is 1GB (1 * 1024 * 1024 * 1024).- Specified by:
maxTableFilesSizeFIFOin interfaceColumnFamilyOptionsInterface<Options>- Returns:
- the size limit of the total sum of table files.
-
tableCacheNumshardbits
public int tableCacheNumshardbits()
Description copied from interface:DBOptionsInterfaceNumber of shards used for table cache.- Specified by:
tableCacheNumshardbitsin interfaceDBOptionsInterface<Options>- Returns:
- the number of shards used for table cache.
-
setTableCacheNumshardbits
public Options setTableCacheNumshardbits(int tableCacheNumshardbits)
Description copied from interface:DBOptionsInterfaceNumber of shards used for table cache.- Specified by:
setTableCacheNumshardbitsin interfaceDBOptionsInterface<Options>- Parameters:
tableCacheNumshardbits- the number of chards- Returns:
- the instance of the current object.
-
walTtlSeconds
public long walTtlSeconds()
Description copied from interface:DBOptionsInterfaceWalTtlSeconds() and walSizeLimitMB() affect how archived logs will be deleted.- If both set to 0, logs will be deleted asap and will not get into the archive.
- If WAL_ttl_seconds is 0 and WAL_size_limit_MB is not 0, WAL files will be checked every 10 min and if total size is greater then WAL_size_limit_MB, they will be deleted starting with the earliest until size_limit is met. All empty files will be deleted.
- If WAL_ttl_seconds is not 0 and WAL_size_limit_MB is 0, then WAL files will be checked every WAL_ttl_seconds / 2 and those that are older than WAL_ttl_seconds will be deleted.
- If both are not 0, WAL files will be checked every 10 min and both checks will be performed with ttl being first.
- Specified by:
walTtlSecondsin interfaceDBOptionsInterface<Options>- Returns:
- the wal-ttl seconds
- See Also:
DBOptionsInterface.walSizeLimitMB()
-
setWalTtlSeconds
public Options setWalTtlSeconds(long walTtlSeconds)
Description copied from interface:DBOptionsInterfaceDBOptionsInterface.walTtlSeconds()andDBOptionsInterface.walSizeLimitMB()affect how archived logs will be deleted.- If both set to 0, logs will be deleted asap and will not get into the archive.
- If WAL_ttl_seconds is 0 and WAL_size_limit_MB is not 0, WAL files will be checked every 10 min and if total size is greater then WAL_size_limit_MB, they will be deleted starting with the earliest until size_limit is met. All empty files will be deleted.
- If WAL_ttl_seconds is not 0 and WAL_size_limit_MB is 0, then WAL files will be checked every WAL_ttl_seconds / 2 and those that are older than WAL_ttl_seconds will be deleted.
- If both are not 0, WAL files will be checked every 10 min and both checks will be performed with ttl being first.
- Specified by:
setWalTtlSecondsin interfaceDBOptionsInterface<Options>- Parameters:
walTtlSeconds- the ttl seconds- Returns:
- the instance of the current object.
- See Also:
DBOptionsInterface.setWalSizeLimitMB(long)
-
walSizeLimitMB
public long walSizeLimitMB()
Description copied from interface:DBOptionsInterfaceDBOptionsInterface.walTtlSeconds()and#walSizeLimitMB()affect how archived logs will be deleted.- If both set to 0, logs will be deleted asap and will not get into the archive.
- If WAL_ttl_seconds is 0 and WAL_size_limit_MB is not 0, WAL files will be checked every 10 min and if total size is greater then WAL_size_limit_MB, they will be deleted starting with the earliest until size_limit is met. All empty files will be deleted.
- If WAL_ttl_seconds is not 0 and WAL_size_limit_MB is 0, then WAL files will be checked every WAL_ttl_seconds i / 2 and those that are older than WAL_ttl_seconds will be deleted.
- If both are not 0, WAL files will be checked every 10 min and both checks will be performed with ttl being first.
- Specified by:
walSizeLimitMBin interfaceDBOptionsInterface<Options>- Returns:
- size limit in mega-bytes.
- See Also:
DBOptionsInterface.walSizeLimitMB()
-
setMaxWriteBatchGroupSizeBytes
public Options setMaxWriteBatchGroupSizeBytes(long maxWriteBatchGroupSizeBytes)
Description copied from interface:DBOptionsInterfaceThe maximum limit of number of bytes that are written in a single batch of WAL or memtable write. It is followed when the leader write size is larger than 1/8 of this limit. Default: 1 MB- Specified by:
setMaxWriteBatchGroupSizeBytesin interfaceDBOptionsInterface<Options>- Parameters:
maxWriteBatchGroupSizeBytes- the maximum limit of number of bytes, see description.- Returns:
- the instance of the current object.
-
maxWriteBatchGroupSizeBytes
public long maxWriteBatchGroupSizeBytes()
Description copied from interface:DBOptionsInterfaceThe maximum limit of number of bytes that are written in a single batch of WAL or memtable write. It is followed when the leader write size is larger than 1/8 of this limit. Default: 1 MB- Specified by:
maxWriteBatchGroupSizeBytesin interfaceDBOptionsInterface<Options>- Returns:
- the maximum limit of number of bytes, see description.
-
setWalSizeLimitMB
public Options setWalSizeLimitMB(long sizeLimitMB)
Description copied from interface:DBOptionsInterfaceWalTtlSeconds() and walSizeLimitMB() affect how archived logs will be deleted.- If both set to 0, logs will be deleted asap and will not get into the archive.
- If WAL_ttl_seconds is 0 and WAL_size_limit_MB is not 0, WAL files will be checked every 10 min and if total size is greater then WAL_size_limit_MB, they will be deleted starting with the earliest until size_limit is met. All empty files will be deleted.
- If WAL_ttl_seconds is not 0 and WAL_size_limit_MB is 0, then WAL files will be checked every WAL_ttl_secondsi / 2 and those that are older than WAL_ttl_seconds will be deleted.
- If both are not 0, WAL files will be checked every 10 min and both checks will be performed with ttl being first.
- Specified by:
setWalSizeLimitMBin interfaceDBOptionsInterface<Options>- Parameters:
sizeLimitMB- size limit in mega-bytes.- Returns:
- the instance of the current object.
- See Also:
DBOptionsInterface.setWalSizeLimitMB(long)
-
manifestPreallocationSize
public long manifestPreallocationSize()
Description copied from interface:DBOptionsInterfaceNumber of bytes to preallocate (via fallocate) the manifest files. Default is 4mb, which is reasonable to reduce random IO as well as prevent overallocation for mounts that preallocate large amounts of data (such as xfs's allocsize option).- Specified by:
manifestPreallocationSizein interfaceDBOptionsInterface<Options>- Returns:
- size in bytes.
-
setManifestPreallocationSize
public Options setManifestPreallocationSize(long size)
Description copied from interface:DBOptionsInterfaceNumber of bytes to preallocate (via fallocate) the manifest files. Default is 4mb, which is reasonable to reduce random IO as well as prevent overallocation for mounts that preallocate large amounts of data (such as xfs's allocsize option).- Specified by:
setManifestPreallocationSizein interfaceDBOptionsInterface<Options>- Parameters:
size- the size in byte- Returns:
- the instance of the current object.
-
setUseDirectReads
public Options setUseDirectReads(boolean useDirectReads)
Description copied from interface:DBOptionsInterfaceEnable the OS to use direct I/O for reading sst tables. Default: false- Specified by:
setUseDirectReadsin interfaceDBOptionsInterface<Options>- Parameters:
useDirectReads- if true, then direct read is enabled- Returns:
- the instance of the current object.
-
useDirectReads
public boolean useDirectReads()
Description copied from interface:DBOptionsInterfaceEnable the OS to use direct I/O for reading sst tables. Default: false- Specified by:
useDirectReadsin interfaceDBOptionsInterface<Options>- Returns:
- if true, then direct reads are enabled
-
setUseDirectIoForFlushAndCompaction
public Options setUseDirectIoForFlushAndCompaction(boolean useDirectIoForFlushAndCompaction)
Description copied from interface:DBOptionsInterfaceEnable the OS to use direct reads and writes in flush and compaction Default: false- Specified by:
setUseDirectIoForFlushAndCompactionin interfaceDBOptionsInterface<Options>- Parameters:
useDirectIoForFlushAndCompaction- if true, then direct I/O will be enabled for background flush and compactions- Returns:
- the instance of the current object.
-
useDirectIoForFlushAndCompaction
public boolean useDirectIoForFlushAndCompaction()
Description copied from interface:DBOptionsInterfaceEnable the OS to use direct reads and writes in flush and compaction- Specified by:
useDirectIoForFlushAndCompactionin interfaceDBOptionsInterface<Options>- Returns:
- if true, then direct I/O is enabled for flush and compaction
-
setAllowFAllocate
public Options setAllowFAllocate(boolean allowFAllocate)
Description copied from interface:DBOptionsInterfaceWhether fallocate calls are allowed- Specified by:
setAllowFAllocatein interfaceDBOptionsInterface<Options>- Parameters:
allowFAllocate- false if fallocate() calls are bypassed- Returns:
- the reference to the current options.
-
allowFAllocate
public boolean allowFAllocate()
Description copied from interface:DBOptionsInterfaceWhether fallocate calls are allowed- Specified by:
allowFAllocatein interfaceDBOptionsInterface<Options>- Returns:
- false if fallocate() calls are bypassed
-
allowMmapReads
public boolean allowMmapReads()
Description copied from interface:DBOptionsInterfaceAllow the OS to mmap file for reading sst tables. Default: false- Specified by:
allowMmapReadsin interfaceDBOptionsInterface<Options>- Returns:
- true if mmap reads are allowed.
-
setAllowMmapReads
public Options setAllowMmapReads(boolean allowMmapReads)
Description copied from interface:DBOptionsInterfaceAllow the OS to mmap file for reading sst tables. Default: false- Specified by:
setAllowMmapReadsin interfaceDBOptionsInterface<Options>- Parameters:
allowMmapReads- true if mmap reads are allowed.- Returns:
- the instance of the current object.
-
allowMmapWrites
public boolean allowMmapWrites()
Description copied from interface:DBOptionsInterfaceAllow the OS to mmap file for writing. Default: false- Specified by:
allowMmapWritesin interfaceDBOptionsInterface<Options>- Returns:
- true if mmap writes are allowed.
-
setAllowMmapWrites
public Options setAllowMmapWrites(boolean allowMmapWrites)
Description copied from interface:DBOptionsInterfaceAllow the OS to mmap file for writing. Default: false- Specified by:
setAllowMmapWritesin interfaceDBOptionsInterface<Options>- Parameters:
allowMmapWrites- true if mmap writes are allowd.- Returns:
- the instance of the current object.
-
isFdCloseOnExec
public boolean isFdCloseOnExec()
Description copied from interface:DBOptionsInterfaceDisable child process inherit open files. Default: true- Specified by:
isFdCloseOnExecin interfaceDBOptionsInterface<Options>- Returns:
- true if child process inheriting open files is disabled.
-
setIsFdCloseOnExec
public Options setIsFdCloseOnExec(boolean isFdCloseOnExec)
Description copied from interface:DBOptionsInterfaceDisable child process inherit open files. Default: true- Specified by:
setIsFdCloseOnExecin interfaceDBOptionsInterface<Options>- Parameters:
isFdCloseOnExec- true if child process inheriting open files is disabled.- Returns:
- the instance of the current object.
-
statsDumpPeriodSec
public int statsDumpPeriodSec()
Description copied from interface:MutableDBOptionsInterfaceIf not zero, dump rocksdb.stats to LOG every stats_dump_period_sec Default: 600 (10 minutes)- Specified by:
statsDumpPeriodSecin interfaceMutableDBOptionsInterface<Options>- Returns:
- time interval in seconds.
-
setStatsDumpPeriodSec
public Options setStatsDumpPeriodSec(int statsDumpPeriodSec)
Description copied from interface:MutableDBOptionsInterfaceif not zero, dump rocksdb.stats to LOG every stats_dump_period_sec Default: 600 (10 minutes)- Specified by:
setStatsDumpPeriodSecin interfaceMutableDBOptionsInterface<Options>- Parameters:
statsDumpPeriodSec- time interval in seconds.- Returns:
- the instance of the current object.
-
setStatsPersistPeriodSec
public Options setStatsPersistPeriodSec(int statsPersistPeriodSec)
Description copied from interface:MutableDBOptionsInterfaceIf not zero, dump rocksdb.stats to RocksDB everystatsPersistPeriodSecDefault: 600- Specified by:
setStatsPersistPeriodSecin interfaceMutableDBOptionsInterface<Options>- Parameters:
statsPersistPeriodSec- time interval in seconds.- Returns:
- the instance of the current object.
-
statsPersistPeriodSec
public int statsPersistPeriodSec()
Description copied from interface:MutableDBOptionsInterfaceIf not zero, dump rocksdb.stats to RocksDB everystatsPersistPeriodSec- Specified by:
statsPersistPeriodSecin interfaceMutableDBOptionsInterface<Options>- Returns:
- time interval in seconds.
-
setStatsHistoryBufferSize
public Options setStatsHistoryBufferSize(long statsHistoryBufferSize)
Description copied from interface:MutableDBOptionsInterfaceIf not zero, periodically take stats snapshots and store in memory, the memory size for stats snapshots is capped atstatsHistoryBufferSizeDefault: 1MB- Specified by:
setStatsHistoryBufferSizein interfaceMutableDBOptionsInterface<Options>- Parameters:
statsHistoryBufferSize- the size of the buffer.- Returns:
- the instance of the current object.
-
statsHistoryBufferSize
public long statsHistoryBufferSize()
Description copied from interface:MutableDBOptionsInterfaceIf not zero, periodically take stats snapshots and store in memory, the memory size for stats snapshots is capped atstatsHistoryBufferSize- Specified by:
statsHistoryBufferSizein interfaceMutableDBOptionsInterface<Options>- Returns:
- the size of the buffer.
-
adviseRandomOnOpen
public boolean adviseRandomOnOpen()
Description copied from interface:DBOptionsInterfaceIf set true, will hint the underlying file system that the file access pattern is random, when a sst file is opened. Default: true- Specified by:
adviseRandomOnOpenin interfaceDBOptionsInterface<Options>- Returns:
- true if hinting random access is on.
-
setAdviseRandomOnOpen
public Options setAdviseRandomOnOpen(boolean adviseRandomOnOpen)
Description copied from interface:DBOptionsInterfaceIf set true, will hint the underlying file system that the file access pattern is random, when a sst file is opened. Default: true- Specified by:
setAdviseRandomOnOpenin interfaceDBOptionsInterface<Options>- Parameters:
adviseRandomOnOpen- true if hinting random access is on.- Returns:
- the instance of the current object.
-
setDbWriteBufferSize
public Options setDbWriteBufferSize(long dbWriteBufferSize)
Description copied from interface:DBOptionsInterfaceAmount of data to build up in memtables across all column families before writing to disk. This is distinct fromColumnFamilyOptions.writeBufferSize(), which enforces a limit for a single memtable. This feature is disabled by default. Specify a non-zero value to enable it. Default: 0 (disabled)- Specified by:
setDbWriteBufferSizein interfaceDBOptionsInterface<Options>- Parameters:
dbWriteBufferSize- the size of the write buffer- Returns:
- the reference to the current options.
-
setWriteBufferManager
public Options setWriteBufferManager(WriteBufferManager writeBufferManager)
Description copied from interface:DBOptionsInterfaceUse passedWriteBufferManagerto control memory usage across multiple column families and/or DB instances. Check https://github.com/facebook/rocksdb/wiki/Write-Buffer-Manager for more details on when to use it- Specified by:
setWriteBufferManagerin interfaceDBOptionsInterface<Options>- Parameters:
writeBufferManager- The WriteBufferManager to use- Returns:
- the reference of the current options.
-
writeBufferManager
public WriteBufferManager writeBufferManager()
Description copied from interface:DBOptionsInterfaceReference toWriteBufferManagerused by it.
Default: null (Disabled)- Specified by:
writeBufferManagerin interfaceDBOptionsInterface<Options>- Returns:
- a reference to WriteBufferManager
-
dbWriteBufferSize
public long dbWriteBufferSize()
Description copied from interface:DBOptionsInterfaceAmount of data to build up in memtables across all column families before writing to disk. This is distinct fromColumnFamilyOptions.writeBufferSize(), which enforces a limit for a single memtable. This feature is disabled by default. Specify a non-zero value to enable it. Default: 0 (disabled)- Specified by:
dbWriteBufferSizein interfaceDBOptionsInterface<Options>- Returns:
- the size of the write buffer
-
setAccessHintOnCompactionStart
public Options setAccessHintOnCompactionStart(AccessHint accessHint)
Description copied from interface:DBOptionsInterfaceSpecify the file access pattern once a compaction is started. It will be applied to all input files of a compaction. Default:AccessHint.NORMAL- Specified by:
setAccessHintOnCompactionStartin interfaceDBOptionsInterface<Options>- Parameters:
accessHint- The access hint- Returns:
- the reference to the current options.
-
accessHintOnCompactionStart
public AccessHint accessHintOnCompactionStart()
Description copied from interface:DBOptionsInterfaceSpecify the file access pattern once a compaction is started. It will be applied to all input files of a compaction. Default:AccessHint.NORMAL- Specified by:
accessHintOnCompactionStartin interfaceDBOptionsInterface<Options>- Returns:
- The access hint
-
setNewTableReaderForCompactionInputs
public Options setNewTableReaderForCompactionInputs(boolean newTableReaderForCompactionInputs)
Description copied from interface:DBOptionsInterfaceIf true, always create a new file descriptor and new table reader for compaction inputs. Turn this parameter on may introduce extra memory usage in the table reader, if it allocates extra memory for indexes. This will allow file descriptor prefetch options to be set for compaction input files and not to impact file descriptors for the same file used by user queries. Suggest to enableBlockBasedTableConfig.cacheIndexAndFilterBlocks()for this mode if using block-based table. Default: false- Specified by:
setNewTableReaderForCompactionInputsin interfaceDBOptionsInterface<Options>- Parameters:
newTableReaderForCompactionInputs- true if a new file descriptor and table reader should be created for compaction inputs- Returns:
- the reference to the current options.
-
newTableReaderForCompactionInputs
public boolean newTableReaderForCompactionInputs()
Description copied from interface:DBOptionsInterfaceIf true, always create a new file descriptor and new table reader for compaction inputs. Turn this parameter on may introduce extra memory usage in the table reader, if it allocates extra memory for indexes. This will allow file descriptor prefetch options to be set for compaction input files and not to impact file descriptors for the same file used by user queries. Suggest to enableBlockBasedTableConfig.cacheIndexAndFilterBlocks()for this mode if using block-based table. Default: false- Specified by:
newTableReaderForCompactionInputsin interfaceDBOptionsInterface<Options>- Returns:
- true if a new file descriptor and table reader are created for compaction inputs
-
setCompactionReadaheadSize
public Options setCompactionReadaheadSize(long compactionReadaheadSize)
Description copied from interface:MutableDBOptionsInterfaceIf non-zero, we perform bigger reads when doing compaction. If you're running RocksDB on spinning disks, you should set this to at least 2MB. That way RocksDB's compaction is doing sequential instead of random reads. When non-zero, we also forceDBOptionsInterface.newTableReaderForCompactionInputs()to true. Default: 0- Specified by:
setCompactionReadaheadSizein interfaceMutableDBOptionsInterface<Options>- Parameters:
compactionReadaheadSize- The compaction read-ahead size- Returns:
- the reference to the current options.
-
compactionReadaheadSize
public long compactionReadaheadSize()
Description copied from interface:MutableDBOptionsInterfaceIf non-zero, we perform bigger reads when doing compaction. If you're running RocksDB on spinning disks, you should set this to at least 2MB. That way RocksDB's compaction is doing sequential instead of random reads. When non-zero, we also forceDBOptionsInterface.newTableReaderForCompactionInputs()to true. Default: 0- Specified by:
compactionReadaheadSizein interfaceMutableDBOptionsInterface<Options>- Returns:
- The compaction read-ahead size
-
setRandomAccessMaxBufferSize
public Options setRandomAccessMaxBufferSize(long randomAccessMaxBufferSize)
Description copied from interface:DBOptionsInterfaceThis is a maximum buffer size that is used by WinMmapReadableFile in unbuffered disk I/O mode. We need to maintain an aligned buffer for reads. We allow the buffer to grow until the specified value and then for bigger requests allocate one shot buffers. In unbuffered mode we always bypass read-ahead buffer at ReadaheadRandomAccessFile When read-ahead is required we then make use ofMutableDBOptionsInterface.compactionReadaheadSize()value and always try to read ahead. With read-ahead we always pre-allocate buffer to the size instead of growing it up to a limit. This option is currently honored only on Windows Default: 1 Mb Special value: 0 - means do not maintain per instance buffer. Allocate per request buffer and avoid locking.- Specified by:
setRandomAccessMaxBufferSizein interfaceDBOptionsInterface<Options>- Parameters:
randomAccessMaxBufferSize- the maximum size of the random access buffer- Returns:
- the reference to the current options.
-
randomAccessMaxBufferSize
public long randomAccessMaxBufferSize()
Description copied from interface:DBOptionsInterfaceThis is a maximum buffer size that is used by WinMmapReadableFile in unbuffered disk I/O mode. We need to maintain an aligned buffer for reads. We allow the buffer to grow until the specified value and then for bigger requests allocate one shot buffers. In unbuffered mode we always bypass read-ahead buffer at ReadaheadRandomAccessFile When read-ahead is required we then make use ofMutableDBOptionsInterface.compactionReadaheadSize()value and always try to read ahead. With read-ahead we always pre-allocate buffer to the size instead of growing it up to a limit. This option is currently honored only on Windows Default: 1 Mb Special value: 0 - means do not maintain per instance buffer. Allocate per request buffer and avoid locking.- Specified by:
randomAccessMaxBufferSizein interfaceDBOptionsInterface<Options>- Returns:
- the maximum size of the random access buffer
-
setWritableFileMaxBufferSize
public Options setWritableFileMaxBufferSize(long writableFileMaxBufferSize)
Description copied from interface:MutableDBOptionsInterfaceThis is the maximum buffer size that is used by WritableFileWriter. On Windows, we need to maintain an aligned buffer for writes. We allow the buffer to grow until it's size hits the limit. Default: 1024 * 1024 (1 MB)- Specified by:
setWritableFileMaxBufferSizein interfaceMutableDBOptionsInterface<Options>- Parameters:
writableFileMaxBufferSize- the maximum buffer size- Returns:
- the reference to the current options.
-
writableFileMaxBufferSize
public long writableFileMaxBufferSize()
Description copied from interface:MutableDBOptionsInterfaceThis is the maximum buffer size that is used by WritableFileWriter. On Windows, we need to maintain an aligned buffer for writes. We allow the buffer to grow until it's size hits the limit. Default: 1024 * 1024 (1 MB)- Specified by:
writableFileMaxBufferSizein interfaceMutableDBOptionsInterface<Options>- Returns:
- the maximum buffer size
-
useAdaptiveMutex
public boolean useAdaptiveMutex()
Description copied from interface:DBOptionsInterfaceUse adaptive mutex, which spins in the user space before resorting to kernel. This could reduce context switch when the mutex is not heavily contended. However, if the mutex is hot, we could end up wasting spin time. Default: false- Specified by:
useAdaptiveMutexin interfaceDBOptionsInterface<Options>- Returns:
- true if adaptive mutex is used.
-
setUseAdaptiveMutex
public Options setUseAdaptiveMutex(boolean useAdaptiveMutex)
Description copied from interface:DBOptionsInterfaceUse adaptive mutex, which spins in the user space before resorting to kernel. This could reduce context switch when the mutex is not heavily contended. However, if the mutex is hot, we could end up wasting spin time. Default: false- Specified by:
setUseAdaptiveMutexin interfaceDBOptionsInterface<Options>- Parameters:
useAdaptiveMutex- true if adaptive mutex is used.- Returns:
- the instance of the current object.
-
bytesPerSync
public long bytesPerSync()
Description copied from interface:MutableDBOptionsInterfaceAllows OS to incrementally sync files to disk while they are being written, asynchronously, in the background. Issue one request for every bytes_per_sync written. 0 turns it off. Default: 0- Specified by:
bytesPerSyncin interfaceMutableDBOptionsInterface<Options>- Returns:
- size in bytes
-
setBytesPerSync
public Options setBytesPerSync(long bytesPerSync)
Description copied from interface:MutableDBOptionsInterfaceAllows OS to incrementally sync files to disk while they are being written, asynchronously, in the background. Issue one request for every bytes_per_sync written. 0 turns it off. Default: 0- Specified by:
setBytesPerSyncin interfaceMutableDBOptionsInterface<Options>- Parameters:
bytesPerSync- size in bytes- Returns:
- the instance of the current object.
-
setWalBytesPerSync
public Options setWalBytesPerSync(long walBytesPerSync)
Description copied from interface:MutableDBOptionsInterfaceSame asMutableDBOptionsInterface.setBytesPerSync(long), but applies to WAL files Default: 0, turned off- Specified by:
setWalBytesPerSyncin interfaceMutableDBOptionsInterface<Options>- Parameters:
walBytesPerSync- size in bytes- Returns:
- the instance of the current object.
-
walBytesPerSync
public long walBytesPerSync()
Description copied from interface:MutableDBOptionsInterfaceSame asMutableDBOptionsInterface.bytesPerSync(), but applies to WAL files Default: 0, turned off- Specified by:
walBytesPerSyncin interfaceMutableDBOptionsInterface<Options>- Returns:
- size in bytes
-
setStrictBytesPerSync
public Options setStrictBytesPerSync(boolean strictBytesPerSync)
Description copied from interface:MutableDBOptionsInterfaceWhen true, guarantees WAL files have at mostMutableDBOptionsInterface.walBytesPerSync()bytes submitted for writeback at any given time, and SST files have at mostMutableDBOptionsInterface.bytesPerSync()bytes pending writeback at any given time. This can be used to handle cases where processing speed exceeds I/O speed during file generation, which can lead to a huge sync when the file is finished, even withMutableDBOptionsInterface.bytesPerSync()/MutableDBOptionsInterface.walBytesPerSync()properly configured. - If `sync_file_range` is supported it achieves this by waiting for any prior `sync_file_range`s to finish before proceeding. In this way, processing (compression, etc.) can proceed uninhibited in the gap between `sync_file_range`s, and we block only when I/O falls behind. - Otherwise the `WritableFile::Sync` method is used. Note this mechanism always blocks, thus preventing the interleaving of I/O and processing. Note: Enabling this option does not provide any additional persistence guarantees, as it may use `sync_file_range`, which does not write out metadata. Default: false- Specified by:
setStrictBytesPerSyncin interfaceMutableDBOptionsInterface<Options>- Parameters:
strictBytesPerSync- the bytes per sync- Returns:
- the instance of the current object.
-
strictBytesPerSync
public boolean strictBytesPerSync()
Description copied from interface:MutableDBOptionsInterfaceReturn the strict byte limit per sync. SeeMutableDBOptionsInterface.setStrictBytesPerSync(boolean)- Specified by:
strictBytesPerSyncin interfaceMutableDBOptionsInterface<Options>- Returns:
- the limit in bytes.
-
setListeners
public Options setListeners(java.util.List<AbstractEventListener> listeners)
Description copied from interface:DBOptionsInterfaceSets theEventListeners whose callback functions will be called when specific RocksDB event happens. Note: the RocksJava API currently only supports EventListeners implemented in Java. It could be extended in future to also support adding/removing EventListeners implemented in C++.- Specified by:
setListenersin interfaceDBOptionsInterface<Options>- Parameters:
listeners- the listeners who should be notified on various events.- Returns:
- the instance of the current object.
-
listeners
public java.util.List<AbstractEventListener> listeners()
Description copied from interface:DBOptionsInterfaceSets theEventListeners whose callback functions will be called when specific RocksDB event happens. Note: the RocksJava API currently only supports EventListeners implemented in Java. It could be extended in future to also support adding/removing EventListeners implemented in C++.- Specified by:
listenersin interfaceDBOptionsInterface<Options>- Returns:
- the instance of the current object.
-
setEnableThreadTracking
public Options setEnableThreadTracking(boolean enableThreadTracking)
Description copied from interface:DBOptionsInterfaceIf true, then the status of the threads involved in this DB will be tracked and available via GetThreadList() API. Default: false- Specified by:
setEnableThreadTrackingin interfaceDBOptionsInterface<Options>- Parameters:
enableThreadTracking- true to enable tracking- Returns:
- the reference to the current options.
-
enableThreadTracking
public boolean enableThreadTracking()
Description copied from interface:DBOptionsInterfaceIf true, then the status of the threads involved in this DB will be tracked and available via GetThreadList() API. Default: false- Specified by:
enableThreadTrackingin interfaceDBOptionsInterface<Options>- Returns:
- true if tracking is enabled
-
setDelayedWriteRate
public Options setDelayedWriteRate(long delayedWriteRate)
Description copied from interface:MutableDBOptionsInterfaceThe limited write rate to DB ifColumnFamilyOptions.softPendingCompactionBytesLimit()orColumnFamilyOptions.level0SlowdownWritesTrigger()is triggered, or we are writing to the last mem table allowed and we allow more than 3 mem tables. It is calculated using size of user write requests before compression. RocksDB may decide to slow down more if the compaction still gets behind further. If the value is 0, we will infer a value from `rater_limiter` value if it is not empty, or 16MB if `rater_limiter` is empty. Note that if users change the rate in `rate_limiter` after DB is opened, `delayed_write_rate` won't be adjusted. Unit: bytes per second. Default: 0 Dynamically changeable throughRocksDB.setDBOptions(MutableDBOptions).- Specified by:
setDelayedWriteRatein interfaceMutableDBOptionsInterface<Options>- Parameters:
delayedWriteRate- the rate in bytes per second- Returns:
- the reference to the current options.
-
delayedWriteRate
public long delayedWriteRate()
Description copied from interface:MutableDBOptionsInterfaceThe limited write rate to DB ifColumnFamilyOptions.softPendingCompactionBytesLimit()orColumnFamilyOptions.level0SlowdownWritesTrigger()is triggered, or we are writing to the last mem table allowed and we allow more than 3 mem tables. It is calculated using size of user write requests before compression. RocksDB may decide to slow down more if the compaction still gets behind further. If the value is 0, we will infer a value from `rater_limiter` value if it is not empty, or 16MB if `rater_limiter` is empty. Note that if users change the rate in `rate_limiter` after DB is opened, `delayed_write_rate` won't be adjusted. Unit: bytes per second. Default: 0 Dynamically changeable throughRocksDB.setDBOptions(MutableDBOptions).- Specified by:
delayedWriteRatein interfaceMutableDBOptionsInterface<Options>- Returns:
- the rate in bytes per second
-
setEnablePipelinedWrite
public Options setEnablePipelinedWrite(boolean enablePipelinedWrite)
Description copied from interface:DBOptionsInterfaceBy default, a single write thread queue is maintained. The thread gets to the head of the queue becomes write batch group leader and responsible for writing to WAL and memtable for the batch group. IfDBOptionsInterface.enablePipelinedWrite()is true, separate write thread queue is maintained for WAL write and memtable write. A write thread first enter WAL writer queue and then memtable writer queue. Pending thread on the WAL writer queue thus only have to wait for previous writers to finish their WAL writing but not the memtable writing. Enabling the feature may improve write throughput and reduce latency of the prepare phase of two-phase commit. Default: false- Specified by:
setEnablePipelinedWritein interfaceDBOptionsInterface<Options>- Parameters:
enablePipelinedWrite- true to enabled pipelined writes- Returns:
- the reference to the current options.
-
enablePipelinedWrite
public boolean enablePipelinedWrite()
Description copied from interface:DBOptionsInterfaceReturns true if pipelined writes are enabled. SeeDBOptionsInterface.setEnablePipelinedWrite(boolean).- Specified by:
enablePipelinedWritein interfaceDBOptionsInterface<Options>- Returns:
- true if pipelined writes are enabled, false otherwise.
-
setUnorderedWrite
public Options setUnorderedWrite(boolean unorderedWrite)
Description copied from interface:DBOptionsInterfaceSettingDBOptionsInterface.unorderedWrite()to true trades higher write throughput with relaxing the immutability guarantee of snapshots. This violates the repeatability one expects from ::Get from a snapshot, as well as ::MultiGet and Iterator's consistent-point-in-time view property. If the application cannot tolerate the relaxed guarantees, it can implement its own mechanisms to work around that and yet benefit from the higher throughput. Using TransactionDB with WRITE_PREPARED write policy andDBOptionsInterface.twoWriteQueues()true is one way to achieve immutable snapshots despite unordered_write. By default, i.e., when it is false, rocksdb does not advance the sequence number for new snapshots unless all the writes with lower sequence numbers are already finished. This provides the immutability that we except from snapshots. Moreover, since Iterator and MultiGet internally depend on snapshots, the snapshot immutability results into Iterator and MultiGet offering consistent-point-in-time view. If set to true, although Read-Your-Own-Write property is still provided, the snapshot immutability property is relaxed: the writes issued after the snapshot is obtained (with larger sequence numbers) will be still not visible to the reads from that snapshot, however, there still might be pending writes (with lower sequence number) that will change the state visible to the snapshot after they are landed to the memtable.- Specified by:
setUnorderedWritein interfaceDBOptionsInterface<Options>- Parameters:
unorderedWrite- true to enabled unordered write- Returns:
- the reference to the current options.
-
unorderedWrite
public boolean unorderedWrite()
Description copied from interface:DBOptionsInterfaceReturns true if unordered write are enabled. SeeDBOptionsInterface.setUnorderedWrite(boolean).- Specified by:
unorderedWritein interfaceDBOptionsInterface<Options>- Returns:
- true if unordered write are enabled, false otherwise.
-
setAllowConcurrentMemtableWrite
public Options setAllowConcurrentMemtableWrite(boolean allowConcurrentMemtableWrite)
Description copied from interface:DBOptionsInterfaceIf true, allow multi-writers to update mem tables in parallel. Only some memtable factorys support concurrent writes; currently it is implemented only for SkipListFactory. Concurrent memtable writes are not compatible with inplace_update_support or filter_deletes. It is strongly recommended to setDBOptionsInterface.setEnableWriteThreadAdaptiveYield(boolean)if you are going to use this feature. Default: true- Specified by:
setAllowConcurrentMemtableWritein interfaceDBOptionsInterface<Options>- Parameters:
allowConcurrentMemtableWrite- true to enable concurrent writes for the memtable- Returns:
- the reference to the current options.
-
allowConcurrentMemtableWrite
public boolean allowConcurrentMemtableWrite()
Description copied from interface:DBOptionsInterfaceIf true, allow multi-writers to update mem tables in parallel. Only some memtable factorys support concurrent writes; currently it is implemented only for SkipListFactory. Concurrent memtable writes are not compatible with inplace_update_support or filter_deletes. It is strongly recommended to setDBOptionsInterface.setEnableWriteThreadAdaptiveYield(boolean)if you are going to use this feature. Default: true- Specified by:
allowConcurrentMemtableWritein interfaceDBOptionsInterface<Options>- Returns:
- true if concurrent writes are enabled for the memtable
-
setEnableWriteThreadAdaptiveYield
public Options setEnableWriteThreadAdaptiveYield(boolean enableWriteThreadAdaptiveYield)
Description copied from interface:DBOptionsInterfaceIf true, threads synchronizing with the write batch group leader will wait for up toDBOptionsInterface.writeThreadMaxYieldUsec()before blocking on a mutex. This can substantially improve throughput for concurrent workloads, regardless of whetherDBOptionsInterface.allowConcurrentMemtableWrite()is enabled. Default: true- Specified by:
setEnableWriteThreadAdaptiveYieldin interfaceDBOptionsInterface<Options>- Parameters:
enableWriteThreadAdaptiveYield- true to enable adaptive yield for the write threads- Returns:
- the reference to the current options.
-
enableWriteThreadAdaptiveYield
public boolean enableWriteThreadAdaptiveYield()
Description copied from interface:DBOptionsInterfaceIf true, threads synchronizing with the write batch group leader will wait for up toDBOptionsInterface.writeThreadMaxYieldUsec()before blocking on a mutex. This can substantially improve throughput for concurrent workloads, regardless of whetherDBOptionsInterface.allowConcurrentMemtableWrite()is enabled. Default: true- Specified by:
enableWriteThreadAdaptiveYieldin interfaceDBOptionsInterface<Options>- Returns:
- true if adaptive yield is enabled for the writing threads
-
setWriteThreadMaxYieldUsec
public Options setWriteThreadMaxYieldUsec(long writeThreadMaxYieldUsec)
Description copied from interface:DBOptionsInterfaceThe maximum number of microseconds that a write operation will use a yielding spin loop to coordinate with other write threads before blocking on a mutex. (AssumingDBOptionsInterface.writeThreadSlowYieldUsec()is set properly) increasing this value is likely to increase RocksDB throughput at the expense of increased CPU usage. Default: 100- Specified by:
setWriteThreadMaxYieldUsecin interfaceDBOptionsInterface<Options>- Parameters:
writeThreadMaxYieldUsec- maximum number of microseconds- Returns:
- the reference to the current options.
-
writeThreadMaxYieldUsec
public long writeThreadMaxYieldUsec()
Description copied from interface:DBOptionsInterfaceThe maximum number of microseconds that a write operation will use a yielding spin loop to coordinate with other write threads before blocking on a mutex. (AssumingDBOptionsInterface.writeThreadSlowYieldUsec()is set properly) increasing this value is likely to increase RocksDB throughput at the expense of increased CPU usage. Default: 100- Specified by:
writeThreadMaxYieldUsecin interfaceDBOptionsInterface<Options>- Returns:
- the maximum number of microseconds
-
setWriteThreadSlowYieldUsec
public Options setWriteThreadSlowYieldUsec(long writeThreadSlowYieldUsec)
Description copied from interface:DBOptionsInterfaceThe latency in microseconds after which a std::this_thread::yield call (sched_yield on Linux) is considered to be a signal that other processes or threads would like to use the current core. Increasing this makes writer threads more likely to take CPU by spinning, which will show up as an increase in the number of involuntary context switches. Default: 3- Specified by:
setWriteThreadSlowYieldUsecin interfaceDBOptionsInterface<Options>- Parameters:
writeThreadSlowYieldUsec- the latency in microseconds- Returns:
- the reference to the current options.
-
writeThreadSlowYieldUsec
public long writeThreadSlowYieldUsec()
Description copied from interface:DBOptionsInterfaceThe latency in microseconds after which a std::this_thread::yield call (sched_yield on Linux) is considered to be a signal that other processes or threads would like to use the current core. Increasing this makes writer threads more likely to take CPU by spinning, which will show up as an increase in the number of involuntary context switches. Default: 3- Specified by:
writeThreadSlowYieldUsecin interfaceDBOptionsInterface<Options>- Returns:
- writeThreadSlowYieldUsec the latency in microseconds
-
setSkipStatsUpdateOnDbOpen
public Options setSkipStatsUpdateOnDbOpen(boolean skipStatsUpdateOnDbOpen)
Description copied from interface:DBOptionsInterfaceIf true, then DB::Open() will not update the statistics used to optimize compaction decision by loading table properties from many files. Turning off this feature will improve DBOpen time especially in disk environment. Default: false- Specified by:
setSkipStatsUpdateOnDbOpenin interfaceDBOptionsInterface<Options>- Parameters:
skipStatsUpdateOnDbOpen- true if updating stats will be skipped- Returns:
- the reference to the current options.
-
skipStatsUpdateOnDbOpen
public boolean skipStatsUpdateOnDbOpen()
Description copied from interface:DBOptionsInterfaceIf true, then DB::Open() will not update the statistics used to optimize compaction decision by loading table properties from many files. Turning off this feature will improve DBOpen time especially in disk environment. Default: false- Specified by:
skipStatsUpdateOnDbOpenin interfaceDBOptionsInterface<Options>- Returns:
- true if updating stats will be skipped
-
setSkipCheckingSstFileSizesOnDbOpen
public Options setSkipCheckingSstFileSizesOnDbOpen(boolean skipCheckingSstFileSizesOnDbOpen)
Description copied from interface:DBOptionsInterfaceIf true, thenRocksDB.open(String)will not fetch and check sizes of all sst files. This may significantly speed up startup if there are many sst files, especially when using non-default Env with expensive GetFileSize(). We'll still check that all required sst files exist. Ifparanoid_checksis false, this option is ignored, and sst files are not checked at all. Default: false- Specified by:
setSkipCheckingSstFileSizesOnDbOpenin interfaceDBOptionsInterface<Options>- Parameters:
skipCheckingSstFileSizesOnDbOpen- if true, then SST file sizes will not be checked when callingRocksDB.open(String).- Returns:
- the reference to the current options.
-
skipCheckingSstFileSizesOnDbOpen
public boolean skipCheckingSstFileSizesOnDbOpen()
Description copied from interface:DBOptionsInterfaceIf true, thenRocksDB.open(String)will not fetch and check sizes of all sst files. This may significantly speed up startup if there are many sst files, especially when using non-default Env with expensive GetFileSize(). We'll still check that all required sst files exist. Ifparanoid_checksis false, this option is ignored, and sst files are not checked at all. Default: false- Specified by:
skipCheckingSstFileSizesOnDbOpenin interfaceDBOptionsInterface<Options>- Returns:
- true, if file sizes will not be checked when calling
RocksDB.open(String).
-
setWalRecoveryMode
public Options setWalRecoveryMode(WALRecoveryMode walRecoveryMode)
Description copied from interface:DBOptionsInterfaceRecovery mode to control the consistency while replaying WAL Default:WALRecoveryMode.PointInTimeRecovery- Specified by:
setWalRecoveryModein interfaceDBOptionsInterface<Options>- Parameters:
walRecoveryMode- The WAL recover mode- Returns:
- the reference to the current options.
-
walRecoveryMode
public WALRecoveryMode walRecoveryMode()
Description copied from interface:DBOptionsInterfaceRecovery mode to control the consistency while replaying WAL Default:WALRecoveryMode.PointInTimeRecovery- Specified by:
walRecoveryModein interfaceDBOptionsInterface<Options>- Returns:
- The WAL recover mode
-
setAllow2pc
public Options setAllow2pc(boolean allow2pc)
Description copied from interface:DBOptionsInterfaceif set to false then recovery will fail when a prepared transaction is encountered in the WAL Default: false- Specified by:
setAllow2pcin interfaceDBOptionsInterface<Options>- Parameters:
allow2pc- true if two-phase-commit is enabled- Returns:
- the reference to the current options.
-
allow2pc
public boolean allow2pc()
Description copied from interface:DBOptionsInterfaceif set to false then recovery will fail when a prepared transaction is encountered in the WAL Default: false- Specified by:
allow2pcin interfaceDBOptionsInterface<Options>- Returns:
- true if two-phase-commit is enabled
-
setRowCache
public Options setRowCache(Cache rowCache)
Description copied from interface:DBOptionsInterfaceA global cache for table-level rows. Default: null (disabled)- Specified by:
setRowCachein interfaceDBOptionsInterface<Options>- Parameters:
rowCache- The global row cache- Returns:
- the reference to the current options.
-
rowCache
public Cache rowCache()
Description copied from interface:DBOptionsInterfaceA global cache for table-level rows. Default: null (disabled)- Specified by:
rowCachein interfaceDBOptionsInterface<Options>- Returns:
- The global row cache
-
setWalFilter
public Options setWalFilter(AbstractWalFilter walFilter)
Description copied from interface:DBOptionsInterfaceA filter object supplied to be invoked while processing write-ahead-logs (WALs) during recovery. The filter provides a way to inspect log records, ignoring a particular record or skipping replay. The filter is invoked at startup and is invoked from a single-thread currently.- Specified by:
setWalFilterin interfaceDBOptionsInterface<Options>- Parameters:
walFilter- the filter for processing WALs during recovery.- Returns:
- the reference to the current options.
-
walFilter
public WalFilter walFilter()
Description copied from interface:DBOptionsInterfaceGet's the filter for processing WALs during recovery. SeeDBOptionsInterface.setWalFilter(AbstractWalFilter).- Specified by:
walFilterin interfaceDBOptionsInterface<Options>- Returns:
- the filter used for processing WALs during recovery.
-
setFailIfOptionsFileError
public Options setFailIfOptionsFileError(boolean failIfOptionsFileError)
Description copied from interface:DBOptionsInterfaceIf true, then DB::Open / CreateColumnFamily / DropColumnFamily / SetOptions will fail if options file is not detected or properly persisted. DEFAULT: false- Specified by:
setFailIfOptionsFileErrorin interfaceDBOptionsInterface<Options>- Parameters:
failIfOptionsFileError- true if we should fail if there is an error in the options file- Returns:
- the reference to the current options.
-
failIfOptionsFileError
public boolean failIfOptionsFileError()
Description copied from interface:DBOptionsInterfaceIf true, then DB::Open / CreateColumnFamily / DropColumnFamily / SetOptions will fail if options file is not detected or properly persisted. DEFAULT: false- Specified by:
failIfOptionsFileErrorin interfaceDBOptionsInterface<Options>- Returns:
- true if we should fail if there is an error in the options file
-
setDumpMallocStats
public Options setDumpMallocStats(boolean dumpMallocStats)
Description copied from interface:DBOptionsInterfaceIf true, then print malloc stats together with rocksdb.stats when printing to LOG. DEFAULT: false- Specified by:
setDumpMallocStatsin interfaceDBOptionsInterface<Options>- Parameters:
dumpMallocStats- true if malloc stats should be printed to LOG- Returns:
- the reference to the current options.
-
dumpMallocStats
public boolean dumpMallocStats()
Description copied from interface:DBOptionsInterfaceIf true, then print malloc stats together with rocksdb.stats when printing to LOG. DEFAULT: false- Specified by:
dumpMallocStatsin interfaceDBOptionsInterface<Options>- Returns:
- true if malloc stats should be printed to LOG
-
setAvoidFlushDuringRecovery
public Options setAvoidFlushDuringRecovery(boolean avoidFlushDuringRecovery)
Description copied from interface:DBOptionsInterfaceBy default RocksDB replay WAL logs and flush them on DB open, which may create very small SST files. If this option is enabled, RocksDB will try to avoid (but not guarantee not to) flush during recovery. Also, existing WAL logs will be kept, so that if crash happened before flush, we still have logs to recover from. DEFAULT: false- Specified by:
setAvoidFlushDuringRecoveryin interfaceDBOptionsInterface<Options>- Parameters:
avoidFlushDuringRecovery- true to try to avoid (but not guarantee not to) flush during recovery- Returns:
- the reference to the current options.
-
avoidFlushDuringRecovery
public boolean avoidFlushDuringRecovery()
Description copied from interface:DBOptionsInterfaceBy default RocksDB replay WAL logs and flush them on DB open, which may create very small SST files. If this option is enabled, RocksDB will try to avoid (but not guarantee not to) flush during recovery. Also, existing WAL logs will be kept, so that if crash happened before flush, we still have logs to recover from. DEFAULT: false- Specified by:
avoidFlushDuringRecoveryin interfaceDBOptionsInterface<Options>- Returns:
- true to try to avoid (but not guarantee not to) flush during recovery
-
setAvoidFlushDuringShutdown
public Options setAvoidFlushDuringShutdown(boolean avoidFlushDuringShutdown)
Description copied from interface:MutableDBOptionsInterfaceBy default RocksDB will flush all memtables on DB close if there are unpersisted data (i.e. with WAL disabled) The flush can be skip to speedup DB close. Unpersisted data WILL BE LOST. DEFAULT: false Dynamically changeable throughRocksDB.setOptions(ColumnFamilyHandle, MutableColumnFamilyOptions)API.- Specified by:
setAvoidFlushDuringShutdownin interfaceMutableDBOptionsInterface<Options>- Parameters:
avoidFlushDuringShutdown- true if we should avoid flush during shutdown- Returns:
- the reference to the current options.
-
avoidFlushDuringShutdown
public boolean avoidFlushDuringShutdown()
Description copied from interface:MutableDBOptionsInterfaceBy default RocksDB will flush all memtables on DB close if there are unpersisted data (i.e. with WAL disabled) The flush can be skip to speedup DB close. Unpersisted data WILL BE LOST. DEFAULT: false Dynamically changeable throughRocksDB.setOptions(ColumnFamilyHandle, MutableColumnFamilyOptions)API.- Specified by:
avoidFlushDuringShutdownin interfaceMutableDBOptionsInterface<Options>- Returns:
- true if we should avoid flush during shutdown
-
setAllowIngestBehind
public Options setAllowIngestBehind(boolean allowIngestBehind)
Description copied from interface:DBOptionsInterfaceSet this option to true during creation of database if you want to be able to ingest behind (call IngestExternalFile() skipping keys that already exist, rather than overwriting matching keys). Setting this option to true will affect 2 things: 1) Disable some internal optimizations around SST file compression 2) Reserve bottom-most level for ingested files only. 3) Note that num_levels should be >= 3 if this option is turned on. DEFAULT: false- Specified by:
setAllowIngestBehindin interfaceDBOptionsInterface<Options>- Parameters:
allowIngestBehind- true to allow ingest behind, false to disallow.- Returns:
- the reference to the current options.
-
allowIngestBehind
public boolean allowIngestBehind()
Description copied from interface:DBOptionsInterfaceReturns true if ingest behind is allowed. SeeDBOptionsInterface.setAllowIngestBehind(boolean).- Specified by:
allowIngestBehindin interfaceDBOptionsInterface<Options>- Returns:
- true if ingest behind is allowed, false otherwise.
-
setPreserveDeletes
public Options setPreserveDeletes(boolean preserveDeletes)
Description copied from interface:DBOptionsInterfaceNeeded to support differential snapshots. If set to true then DB will only process deletes with sequence number less than what was set by SetPreserveDeletesSequenceNumber(uint64_t ts). Clients are responsible to periodically call this method to advance the cutoff time. If this method is never called and preserve_deletes is set to true NO deletes will ever be processed. At the moment this only keeps normal deletes, SingleDeletes will not be preserved. DEFAULT: false- Specified by:
setPreserveDeletesin interfaceDBOptionsInterface<Options>- Parameters:
preserveDeletes- true to preserve deletes.- Returns:
- the reference to the current options.
-
preserveDeletes
public boolean preserveDeletes()
Description copied from interface:DBOptionsInterfaceReturns true if deletes are preserved. SeeDBOptionsInterface.setPreserveDeletes(boolean).- Specified by:
preserveDeletesin interfaceDBOptionsInterface<Options>- Returns:
- true if deletes are preserved, false otherwise.
-
setTwoWriteQueues
public Options setTwoWriteQueues(boolean twoWriteQueues)
Description copied from interface:DBOptionsInterfaceIf enabled it uses two queues for writes, one for the ones with disable_memtable and one for the ones that also write to memtable. This allows the memtable writes not to lag behind other writes. It can be used to optimize MySQL 2PC in which only the commits, which are serial, write to memtable. DEFAULT: false- Specified by:
setTwoWriteQueuesin interfaceDBOptionsInterface<Options>- Parameters:
twoWriteQueues- true to enable two write queues, false otherwise.- Returns:
- the reference to the current options.
-
twoWriteQueues
public boolean twoWriteQueues()
Description copied from interface:DBOptionsInterfaceReturns true if two write queues are enabled.- Specified by:
twoWriteQueuesin interfaceDBOptionsInterface<Options>- Returns:
- true if two write queues are enabled, false otherwise.
-
setManualWalFlush
public Options setManualWalFlush(boolean manualWalFlush)
Description copied from interface:DBOptionsInterfaceIf true WAL is not flushed automatically after each write. Instead it relies on manual invocation of FlushWAL to write the WAL buffer to its file. DEFAULT: false- Specified by:
setManualWalFlushin interfaceDBOptionsInterface<Options>- Parameters:
manualWalFlush- true to set disable automatic WAL flushing, false otherwise.- Returns:
- the reference to the current options.
-
manualWalFlush
public boolean manualWalFlush()
Description copied from interface:DBOptionsInterfaceReturns true if automatic WAL flushing is disabled. SeeDBOptionsInterface.setManualWalFlush(boolean).- Specified by:
manualWalFlushin interfaceDBOptionsInterface<Options>- Returns:
- true if automatic WAL flushing is disabled, false otherwise.
-
memTableConfig
public MemTableConfig memTableConfig()
Description copied from interface:ColumnFamilyOptionsInterfaceGet the config for mem-table.- Specified by:
memTableConfigin interfaceColumnFamilyOptionsInterface<Options>- Returns:
- the mem-table config.
-
setMemTableConfig
public Options setMemTableConfig(MemTableConfig config)
Description copied from interface:ColumnFamilyOptionsInterfaceSet the config for mem-table.- Specified by:
setMemTableConfigin interfaceColumnFamilyOptionsInterface<Options>- Parameters:
config- the mem-table config.- Returns:
- the instance of the current object.
-
setRateLimiter
public Options setRateLimiter(RateLimiter rateLimiter)
Description copied from interface:DBOptionsInterfaceUse to control write rate of flush and compaction. Flush has higher priority than compaction. Rate limiting is disabled if nullptr. Default: nullptr- Specified by:
setRateLimiterin interfaceDBOptionsInterface<Options>- Parameters:
rateLimiter-RateLimiterinstance.- Returns:
- the instance of the current object.
-
setSstFileManager
public Options setSstFileManager(SstFileManager sstFileManager)
Description copied from interface:DBOptionsInterfaceUse 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).- Specified by:
setSstFileManagerin interfaceDBOptionsInterface<Options>- Parameters:
sstFileManager- The SST File Manager for the db.- Returns:
- the instance of the current object.
-
setLogger
public Options setLogger(Logger logger)
Description copied from interface:DBOptionsInterfaceAny internal progress/error information generated by the db will be written to the Logger if it is non-nullptr, or to a file stored in the same directory as the DB contents if info_log is nullptr.
Default: nullptr
- Specified by:
setLoggerin interfaceDBOptionsInterface<Options>- Parameters:
logger-Loggerinstance.- Returns:
- the instance of the current object.
-
setInfoLogLevel
public Options setInfoLogLevel(InfoLogLevel infoLogLevel)
Description copied from interface:DBOptionsInterfaceSets the RocksDB log level. Default level is INFO
- Specified by:
setInfoLogLevelin interfaceDBOptionsInterface<Options>- Parameters:
infoLogLevel- log level to set.- Returns:
- the instance of the current object.
-
infoLogLevel
public InfoLogLevel infoLogLevel()
Description copied from interface:DBOptionsInterfaceReturns currently set log level.
- Specified by:
infoLogLevelin interfaceDBOptionsInterface<Options>- Returns:
InfoLogLevelinstance.
-
memTableFactoryName
public java.lang.String memTableFactoryName()
Description copied from interface:ColumnFamilyOptionsInterfaceReturns the name of the current mem table representation. Memtable format can be set using setTableFormatConfig.- Specified by:
memTableFactoryNamein interfaceColumnFamilyOptionsInterface<Options>- Returns:
- the name of the currently-used memtable factory.
- See Also:
ColumnFamilyOptionsInterface.setTableFormatConfig(org.rocksdb.TableFormatConfig)
-
tableFormatConfig
public TableFormatConfig tableFormatConfig()
Description copied from interface:ColumnFamilyOptionsInterfaceGet the config for table format.- Specified by:
tableFormatConfigin interfaceColumnFamilyOptionsInterface<Options>- Returns:
- the table format config.
-
setTableFormatConfig
public Options setTableFormatConfig(TableFormatConfig config)
Description copied from interface:ColumnFamilyOptionsInterfaceSet the config for table format.- Specified by:
setTableFormatConfigin interfaceColumnFamilyOptionsInterface<Options>- Parameters:
config- the table format config.- Returns:
- the reference of the current options.
-
tableFactoryName
public java.lang.String tableFactoryName()
- Specified by:
tableFactoryNamein interfaceColumnFamilyOptionsInterface<Options>- Returns:
- the name of the currently used table factory.
-
setCfPaths
public Options setCfPaths(java.util.Collection<DbPath> cfPaths)
Description copied from interface:ColumnFamilyOptionsInterfaceA list of paths where SST files for this column family can be put into, with its target size. Similar to db_paths, newer data is placed into paths specified earlier in the vector while older data gradually moves to paths specified later in the vector. Note that, if a path is supplied to multiple column families, it would have files and total size from all the column families combined. User should provision for the total size(from all the column families) in such cases. If left empty, db_paths will be used. Default: empty- Specified by:
setCfPathsin interfaceColumnFamilyOptionsInterface<Options>- Parameters:
cfPaths- collection of paths for SST files.- Returns:
- the reference of the current options.
-
cfPaths
public java.util.List<DbPath> cfPaths()
- Specified by:
cfPathsin interfaceColumnFamilyOptionsInterface<Options>- Returns:
- collection of paths for SST files.
-
useFixedLengthPrefixExtractor
public Options useFixedLengthPrefixExtractor(int n)
Description copied from interface:ColumnFamilyOptionsInterfaceThis prefix-extractor uses the first n bytes of a key as its prefix. In some hash-based memtable representation such as HashLinkedList and HashSkipList, prefixes are used to partition the keys into several buckets. Prefix extractor is used to specify how to extract the prefix given a key.- Specified by:
useFixedLengthPrefixExtractorin interfaceColumnFamilyOptionsInterface<Options>- Parameters:
n- use the first n bytes of a key as its prefix.- Returns:
- the reference to the current option.
-
useCappedPrefixExtractor
public Options useCappedPrefixExtractor(int n)
Description copied from interface:ColumnFamilyOptionsInterfaceSame as fixed length prefix extractor, except that when slice is shorter than the fixed length, it will use the full key.- Specified by:
useCappedPrefixExtractorin interfaceColumnFamilyOptionsInterface<Options>- Parameters:
n- use the first n bytes of a key as its prefix.- Returns:
- the reference to the current option.
-
compressionType
public CompressionType compressionType()
Description copied from interface:MutableColumnFamilyOptionsInterfaceCompress blocks using the specified compression algorithm. This parameter can be changed dynamically. Default: SNAPPY_COMPRESSION, which gives lightweight but fast compression.- Specified by:
compressionTypein interfaceMutableColumnFamilyOptionsInterface<Options>- Returns:
- Compression type.
-
setCompressionPerLevel
public Options setCompressionPerLevel(java.util.List<CompressionType> compressionLevels)
Description copied from interface:AdvancedColumnFamilyOptionsInterfaceDifferent levels can have different compression policies. There are cases where most lower levels would like to use quick compression algorithms while the higher levels (which have more data) use compression algorithms that have better compression but could be slower. This array, if non-empty, should have an entry for each level of the database; these override the value specified in the previous field 'compression'.
NOTICEIf
level_compaction_dynamic_level_bytes=true,compression_per_level[0]still determinesL0, but other elements of the array are based on base level (the levelL0files are merged to), and may not match the level users see from info log for metadata.If
ExampleL0files are merged tolevel - n, then, fori>0,compression_per_level[i]determines compaction type for leveln+i-1.For example, if we have 5 levels, and we determine to merge
L0data toL4(which meansL1..L3will be empty), then the new files go toL4uses compression typecompression_per_level[1].If now
L0is merged toL2. Data goes toL2will be compressed according tocompression_per_level[1],L3usingcompression_per_level[2]andL4usingcompression_per_level[3]. Compaction for each level can change when data grows.Default: empty
- Specified by:
setCompressionPerLevelin interfaceAdvancedColumnFamilyOptionsInterface<Options>- Parameters:
compressionLevels- list ofCompressionTypeinstances.- Returns:
- the reference to the current options.
-
compressionPerLevel
public java.util.List<CompressionType> compressionPerLevel()
Description copied from interface:AdvancedColumnFamilyOptionsInterfaceReturn the currently set
CompressionTypeper instances.See:
AdvancedColumnFamilyOptionsInterface.setCompressionPerLevel(java.util.List)- Specified by:
compressionPerLevelin interfaceAdvancedColumnFamilyOptionsInterface<Options>- Returns:
- list of
CompressionTypeinstances.
-
setCompressionType
public Options setCompressionType(CompressionType compressionType)
Description copied from interface:MutableColumnFamilyOptionsInterfaceCompress blocks using the specified compression algorithm. This parameter can be changed dynamically. Default: SNAPPY_COMPRESSION, which gives lightweight but fast compression.- Specified by:
setCompressionTypein interfaceMutableColumnFamilyOptionsInterface<Options>- Parameters:
compressionType- Compression Type.- Returns:
- the reference to the current option.
-
setBottommostCompressionType
public Options setBottommostCompressionType(CompressionType bottommostCompressionType)
Description copied from interface:ColumnFamilyOptionsInterfaceCompression algorithm that will be used for the bottommost level that contain files. If level-compaction is used, this option will only affect levels after base level. Default:CompressionType.DISABLE_COMPRESSION_OPTION- Specified by:
setBottommostCompressionTypein interfaceColumnFamilyOptionsInterface<Options>- Parameters:
bottommostCompressionType- The compression type to use for the bottommost level- Returns:
- the reference of the current options.
-
bottommostCompressionType
public CompressionType bottommostCompressionType()
Description copied from interface:ColumnFamilyOptionsInterfaceCompression algorithm that will be used for the bottommost level that contain files. If level-compaction is used, this option will only affect levels after base level. Default:CompressionType.DISABLE_COMPRESSION_OPTION- Specified by:
bottommostCompressionTypein interfaceColumnFamilyOptionsInterface<Options>- Returns:
- The compression type used for the bottommost level
-
setBottommostCompressionOptions
public Options setBottommostCompressionOptions(CompressionOptions bottommostCompressionOptions)
Description copied from interface:ColumnFamilyOptionsInterfaceSet the options for compression algorithms used byColumnFamilyOptionsInterface.bottommostCompressionType()if it is enabled. To enable it, please see the definition ofCompressionOptions.- Specified by:
setBottommostCompressionOptionsin interfaceColumnFamilyOptionsInterface<Options>- Parameters:
bottommostCompressionOptions- the bottom most compression options.- Returns:
- the reference of the current options.
-
bottommostCompressionOptions
public CompressionOptions bottommostCompressionOptions()
Description copied from interface:ColumnFamilyOptionsInterfaceGet the bottom most compression options. SeeColumnFamilyOptionsInterface.setBottommostCompressionOptions(CompressionOptions).- Specified by:
bottommostCompressionOptionsin interfaceColumnFamilyOptionsInterface<Options>- Returns:
- the bottom most compression options.
-
setCompressionOptions
public Options setCompressionOptions(CompressionOptions compressionOptions)
Description copied from interface:ColumnFamilyOptionsInterfaceSet the different options for compression algorithms- Specified by:
setCompressionOptionsin interfaceColumnFamilyOptionsInterface<Options>- Parameters:
compressionOptions- The compression options- Returns:
- the reference of the current options.
-
compressionOptions
public CompressionOptions compressionOptions()
Description copied from interface:ColumnFamilyOptionsInterfaceGet the different options for compression algorithms- Specified by:
compressionOptionsin interfaceColumnFamilyOptionsInterface<Options>- Returns:
- The compression options
-
compactionStyle
public CompactionStyle compactionStyle()
Description copied from interface:AdvancedColumnFamilyOptionsInterfaceCompaction style for DB.- Specified by:
compactionStylein interfaceAdvancedColumnFamilyOptionsInterface<Options>- Returns:
- Compaction style.
-
setCompactionStyle
public Options setCompactionStyle(CompactionStyle compactionStyle)
Description copied from interface:AdvancedColumnFamilyOptionsInterfaceSet compaction style for DB. Default: LEVEL.- Specified by:
setCompactionStylein interfaceAdvancedColumnFamilyOptionsInterface<Options>- Parameters:
compactionStyle- Compaction style.- Returns:
- the reference to the current options.
-
numLevels
public int numLevels()
Description copied from interface:AdvancedColumnFamilyOptionsInterfaceIf level-styled compaction is used, then this number determines the total number of levels.- Specified by:
numLevelsin interfaceAdvancedColumnFamilyOptionsInterface<Options>- Returns:
- the number of levels.
-
setNumLevels
public Options setNumLevels(int numLevels)
Description copied from interface:AdvancedColumnFamilyOptionsInterfaceSet the number of levels for this database If level-styled compaction is used, then this number determines the total number of levels.- Specified by:
setNumLevelsin interfaceAdvancedColumnFamilyOptionsInterface<Options>- Parameters:
numLevels- the number of levels.- Returns:
- the reference to the current options.
-
levelZeroFileNumCompactionTrigger
public int levelZeroFileNumCompactionTrigger()
Description copied from interface:ColumnFamilyOptionsInterfaceThe number of files in level 0 to trigger compaction from level-0 to level-1. A value < 0 means that level-0 compaction will not be triggered by number of files at all. Default: 4- Specified by:
levelZeroFileNumCompactionTriggerin interfaceColumnFamilyOptionsInterface<Options>- Returns:
- the number of files in level 0 to trigger compaction.
-
setLevelZeroFileNumCompactionTrigger
public Options setLevelZeroFileNumCompactionTrigger(int numFiles)
Description copied from interface:ColumnFamilyOptionsInterfaceNumber of files to trigger level-0 compaction. A value < 0 means that level-0 compaction will not be triggered by number of files at all. Default: 4- Specified by:
setLevelZeroFileNumCompactionTriggerin interfaceColumnFamilyOptionsInterface<Options>- Parameters:
numFiles- the number of files in level-0 to trigger compaction.- Returns:
- the reference to the current option.
-
levelZeroSlowdownWritesTrigger
public int levelZeroSlowdownWritesTrigger()
Description copied from interface:ColumnFamilyOptionsInterfaceSoft limit on the number of level-0 files. We start slowing down writes at this point. A value < 0 means that no writing slow down will be triggered by number of files in level-0.- Specified by:
levelZeroSlowdownWritesTriggerin interfaceColumnFamilyOptionsInterface<Options>- Returns:
- the soft limit on the number of level-0 files.
-
setLevelZeroSlowdownWritesTrigger
public Options setLevelZeroSlowdownWritesTrigger(int numFiles)
Description copied from interface:ColumnFamilyOptionsInterfaceSoft limit on number of level-0 files. We start slowing down writes at this point. A value < 0 means that no writing slow down will be triggered by number of files in level-0.- Specified by:
setLevelZeroSlowdownWritesTriggerin interfaceColumnFamilyOptionsInterface<Options>- Parameters:
numFiles- soft limit on number of level-0 files.- Returns:
- the reference to the current option.
-
levelZeroStopWritesTrigger
public int levelZeroStopWritesTrigger()
Description copied from interface:ColumnFamilyOptionsInterfaceMaximum number of level-0 files. We stop writes at this point.- Specified by:
levelZeroStopWritesTriggerin interfaceColumnFamilyOptionsInterface<Options>- Returns:
- the hard limit of the number of level-0 file.
-
setLevelZeroStopWritesTrigger
public Options setLevelZeroStopWritesTrigger(int numFiles)
Description copied from interface:ColumnFamilyOptionsInterfaceMaximum number of level-0 files. We stop writes at this point.- Specified by:
setLevelZeroStopWritesTriggerin interfaceColumnFamilyOptionsInterface<Options>- Parameters:
numFiles- the hard limit of the number of level-0 files.- Returns:
- the reference to the current option.
-
targetFileSizeBase
public long targetFileSizeBase()
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceThe target file size for compaction. This targetFileSizeBase determines a level-1 file size. Target file size for level L can be calculated by targetFileSizeBase * (targetFileSizeMultiplier ^ (L-1)) For example, if targetFileSizeBase is 2MB and target_file_size_multiplier is 10, then each file on level-1 will be 2MB, and each file on level 2 will be 20MB, and each file on level-3 will be 200MB. by default targetFileSizeBase is 64MB.- Specified by:
targetFileSizeBasein interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Returns:
- the target size of a level-0 file.
- See Also:
AdvancedMutableColumnFamilyOptionsInterface.targetFileSizeMultiplier()
-
setTargetFileSizeBase
public Options setTargetFileSizeBase(long targetFileSizeBase)
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceThe target file size for compaction. This targetFileSizeBase determines a level-1 file size. Target file size for level L can be calculated by targetFileSizeBase * (targetFileSizeMultiplier ^ (L-1)) For example, if targetFileSizeBase is 2MB and target_file_size_multiplier is 10, then each file on level-1 will be 2MB, and each file on level 2 will be 20MB, and each file on level-3 will be 200MB. by default targetFileSizeBase is 64MB.- Specified by:
setTargetFileSizeBasein interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Parameters:
targetFileSizeBase- the target size of a level-0 file.- Returns:
- the reference to the current options.
- See Also:
AdvancedMutableColumnFamilyOptionsInterface.setTargetFileSizeMultiplier(int)
-
targetFileSizeMultiplier
public int targetFileSizeMultiplier()
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfacetargetFileSizeMultiplier defines the size ratio between a level-(L+1) file and level-L file. By default targetFileSizeMultiplier is 1, meaning files in different levels have the same target.- Specified by:
targetFileSizeMultiplierin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Returns:
- the size ratio between a level-(L+1) file and level-L file.
-
setTargetFileSizeMultiplier
public Options setTargetFileSizeMultiplier(int multiplier)
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfacetargetFileSizeMultiplier defines the size ratio between a level-L file and level-(L+1) file. By default target_file_size_multiplier is 1, meaning files in different levels have the same target.- Specified by:
setTargetFileSizeMultiplierin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Parameters:
multiplier- the size ratio between a level-(L+1) file and level-L file.- Returns:
- the reference to the current options.
-
setMaxBytesForLevelBase
public Options setMaxBytesForLevelBase(long maxBytesForLevelBase)
Description copied from interface:MutableColumnFamilyOptionsInterfaceThe upper-bound of the total size of level-1 files in bytes. Maximum number of bytes for level L can be calculated as (maxBytesForLevelBase) * (maxBytesForLevelMultiplier ^ (L-1)) For example, if maxBytesForLevelBase is 20MB, and if max_bytes_for_level_multiplier is 10, total data size for level-1 will be 200MB, total file size for level-2 will be 2GB, and total file size for level-3 will be 20GB. by default 'maxBytesForLevelBase' is 256MB.- Specified by:
setMaxBytesForLevelBasein interfaceMutableColumnFamilyOptionsInterface<Options>- Parameters:
maxBytesForLevelBase- maximum bytes for level base.- Returns:
- the reference to the current option.
See
AdvancedMutableColumnFamilyOptionsInterface.setMaxBytesForLevelMultiplier(double)
-
maxBytesForLevelBase
public long maxBytesForLevelBase()
Description copied from interface:MutableColumnFamilyOptionsInterfaceThe upper-bound of the total size of level-1 files in bytes. Maximum number of bytes for level L can be calculated as (maxBytesForLevelBase) * (maxBytesForLevelMultiplier ^ (L-1)) For example, if maxBytesForLevelBase is 20MB, and if max_bytes_for_level_multiplier is 10, total data size for level-1 will be 200MB, total file size for level-2 will be 2GB, and total file size for level-3 will be 20GB. by default 'maxBytesForLevelBase' is 256MB.- Specified by:
maxBytesForLevelBasein interfaceMutableColumnFamilyOptionsInterface<Options>- Returns:
- the upper-bound of the total size of level-1 files
in bytes.
See
AdvancedMutableColumnFamilyOptionsInterface.maxBytesForLevelMultiplier()
-
setLevelCompactionDynamicLevelBytes
public Options setLevelCompactionDynamicLevelBytes(boolean enableLevelCompactionDynamicLevelBytes)
Description copied from interface:AdvancedColumnFamilyOptionsInterfaceIf
true, RocksDB will pick target size of each level dynamically. We will pick a base level b >= 1. L0 will be directly merged into level b, instead of always into level 1. Level 1 to b-1 need to be empty. We try to pick b and its target size so that- target size is in the range of (max_bytes_for_level_base / max_bytes_for_level_multiplier, max_bytes_for_level_base]
- target size of the last level (level num_levels-1) equals to extra size of the level.
At the same time max_bytes_for_level_multiplier and max_bytes_for_level_multiplier_additional are still satisfied.
With this option on, from an empty DB, we make last level the base level, which means merging L0 data into the last level, until it exceeds max_bytes_for_level_base. And then we make the second last level to be base level, to start to merge L0 data to second last level, with its target size to be
1/max_bytes_for_level_multiplierof the last levels extra size. After the data accumulates more so that we need to move the base level to the third last one, and so on.Example
For example, assume
max_bytes_for_level_multiplier=10,num_levels=6, andmax_bytes_for_level_base=10MB.Target sizes of level 1 to 5 starts with:
[- - - - 10MB]with base level is level. Target sizes of level 1 to 4 are not applicable because they will not be used. Until the size of Level 5 grows to more than 10MB, say 11MB, we make base target to level 4 and now the targets looks like:
[- - - 1.1MB 11MB]While data are accumulated, size targets are tuned based on actual data of level 5. When level 5 has 50MB of data, the target is like:
[- - - 5MB 50MB]Until level 5's actual size is more than 100MB, say 101MB. Now if we keep level 4 to be the base level, its target size needs to be 10.1MB, which doesn't satisfy the target size range. So now we make level 3 the target size and the target sizes of the levels look like:
[- - 1.01MB 10.1MB 101MB]In the same way, while level 5 further grows, all levels' targets grow, like
[- - 5MB 50MB 500MB]Until level 5 exceeds 1000MB and becomes 1001MB, we make level 2 the base level and make levels' target sizes like this:
[- 1.001MB 10.01MB 100.1MB 1001MB]and go on...
By doing it, we give
max_bytes_for_level_multipliera priority againstmax_bytes_for_level_base, for a more predictable LSM tree shape. It is useful to limit worse case space amplification.max_bytes_for_level_multiplier_additionalis ignored with this flag on.Turning this feature on or off for an existing DB can cause unexpected LSM tree structure so it's not recommended.
Caution: this option is experimental
Default: false
- Specified by:
setLevelCompactionDynamicLevelBytesin interfaceAdvancedColumnFamilyOptionsInterface<Options>- Parameters:
enableLevelCompactionDynamicLevelBytes- boolean value indicating ifLevelCompactionDynamicLevelBytesshall be enabled.- Returns:
- the reference to the current options.
-
levelCompactionDynamicLevelBytes
public boolean levelCompactionDynamicLevelBytes()
Description copied from interface:AdvancedColumnFamilyOptionsInterfaceReturn if
LevelCompactionDynamicLevelBytesis enabled.For further information see
AdvancedColumnFamilyOptionsInterface.setLevelCompactionDynamicLevelBytes(boolean)- Specified by:
levelCompactionDynamicLevelBytesin interfaceAdvancedColumnFamilyOptionsInterface<Options>- Returns:
- boolean value indicating if
levelCompactionDynamicLevelBytesis enabled.
-
maxBytesForLevelMultiplier
public double maxBytesForLevelMultiplier()
Description copied from interface:ColumnFamilyOptionsInterfaceThe ratio between the total size of level-(L+1) files and the total size of level-L files for all L. DEFAULT: 10- Specified by:
maxBytesForLevelMultiplierin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Specified by:
maxBytesForLevelMultiplierin interfaceColumnFamilyOptionsInterface<Options>- Returns:
- the ratio between the total size of level-(L+1) files and the total size of level-L files for all L.
-
setMaxBytesForLevelMultiplier
public Options setMaxBytesForLevelMultiplier(double multiplier)
Description copied from interface:ColumnFamilyOptionsInterfaceThe ratio between the total size of level-(L+1) files and the total size of level-L files for all L. DEFAULT: 10- Specified by:
setMaxBytesForLevelMultiplierin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Specified by:
setMaxBytesForLevelMultiplierin interfaceColumnFamilyOptionsInterface<Options>- Parameters:
multiplier- the ratio between the total size of level-(L+1) files and the total size of level-L files for all L.- Returns:
- the reference to the current option.
-
maxCompactionBytes
public long maxCompactionBytes()
Description copied from interface:AdvancedColumnFamilyOptionsInterfaceControl maximum size of each compaction (not guaranteed)- Specified by:
maxCompactionBytesin interfaceAdvancedColumnFamilyOptionsInterface<Options>- Specified by:
maxCompactionBytesin interfaceMutableColumnFamilyOptionsInterface<Options>- Returns:
- compaction size threshold
- See Also:
MutableColumnFamilyOptionsInterface.setMaxCompactionBytes(long)
-
setMaxCompactionBytes
public Options setMaxCompactionBytes(long maxCompactionBytes)
Description copied from interface:AdvancedColumnFamilyOptionsInterfaceMaximum size of each compaction (not guarantee)- Specified by:
setMaxCompactionBytesin interfaceAdvancedColumnFamilyOptionsInterface<Options>- Specified by:
setMaxCompactionBytesin interfaceMutableColumnFamilyOptionsInterface<Options>- Parameters:
maxCompactionBytes- the compaction size limit- Returns:
- the reference to the current options.
- See Also:
MutableColumnFamilyOptionsInterface.maxCompactionBytes()
-
arenaBlockSize
public long arenaBlockSize()
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceThe size of one block in arena memory allocation. If ≤ 0, a proper value is automatically calculated (usually 1/10 of writer_buffer_size). There are two additional restriction of the specified size: (1) size should be in the range of [4096, 2 << 30] and (2) be the multiple of the CPU word (which helps with the memory alignment). We'll automatically check and adjust the size number to make sure it conforms to the restrictions. Default: 0- Specified by:
arenaBlockSizein interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Returns:
- the size of an arena block
-
setArenaBlockSize
public Options setArenaBlockSize(long arenaBlockSize)
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceThe size of one block in arena memory allocation. If ≤ 0, a proper value is automatically calculated (usually 1/10 of writer_buffer_size). There are two additional restriction of the specified size: (1) size should be in the range of [4096, 2 << 30] and (2) be the multiple of the CPU word (which helps with the memory alignment). We'll automatically check and adjust the size number to make sure it conforms to the restrictions. Default: 0- Specified by:
setArenaBlockSizein interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Parameters:
arenaBlockSize- the size of an arena block- Returns:
- the reference to the current options.
-
disableAutoCompactions
public boolean disableAutoCompactions()
Description copied from interface:MutableColumnFamilyOptionsInterfaceDisable automatic compactions. Manual compactions can still be issued on this column family- Specified by:
disableAutoCompactionsin interfaceMutableColumnFamilyOptionsInterface<Options>- Returns:
- true if auto-compactions are disabled.
-
setDisableAutoCompactions
public Options setDisableAutoCompactions(boolean disableAutoCompactions)
Description copied from interface:MutableColumnFamilyOptionsInterfaceDisable automatic compactions. Manual compactions can still be issued on this column family- Specified by:
setDisableAutoCompactionsin interfaceMutableColumnFamilyOptionsInterface<Options>- Parameters:
disableAutoCompactions- true if auto-compactions are disabled.- Returns:
- the reference to the current option.
-
maxSequentialSkipInIterations
public long maxSequentialSkipInIterations()
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceAn iteration->Next() sequentially skips over keys with the same user-key unless this option is set. This number specifies the number of keys (with the same userkey) that will be sequentially skipped before a reseek is issued. Default: 8- Specified by:
maxSequentialSkipInIterationsin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Returns:
- the number of keys could be skipped in a iteration.
-
setMaxSequentialSkipInIterations
public Options setMaxSequentialSkipInIterations(long maxSequentialSkipInIterations)
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceAn iteration->Next() sequentially skips over keys with the same user-key unless this option is set. This number specifies the number of keys (with the same userkey) that will be sequentially skipped before a reseek is issued. Default: 8- Specified by:
setMaxSequentialSkipInIterationsin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Parameters:
maxSequentialSkipInIterations- the number of keys could be skipped in a iteration.- Returns:
- the reference to the current options.
-
inplaceUpdateSupport
public boolean inplaceUpdateSupport()
Description copied from interface:AdvancedColumnFamilyOptionsInterfaceAllows thread-safe inplace updates. If inplace_callback function is not set, Put(key, new_value) will update inplace the existing_value iff * key exists in current memtable * new sizeof(new_value) ≤ sizeof(existing_value) * existing_value for that key is a put i.e. kTypeValue If inplace_callback function is set, check doc for inplace_callback. Default: false.- Specified by:
inplaceUpdateSupportin interfaceAdvancedColumnFamilyOptionsInterface<Options>- Returns:
- true if thread-safe inplace updates are allowed.
-
setInplaceUpdateSupport
public Options setInplaceUpdateSupport(boolean inplaceUpdateSupport)
Description copied from interface:AdvancedColumnFamilyOptionsInterfaceAllows thread-safe inplace updates. If inplace_callback function is not set, Put(key, new_value) will update inplace the existing_value iff * key exists in current memtable * new sizeof(new_value) ≤ sizeof(existing_value) * existing_value for that key is a put i.e. kTypeValue If inplace_callback function is set, check doc for inplace_callback. Default: false.- Specified by:
setInplaceUpdateSupportin interfaceAdvancedColumnFamilyOptionsInterface<Options>- Parameters:
inplaceUpdateSupport- true if thread-safe inplace updates are allowed.- Returns:
- the reference to the current options.
-
inplaceUpdateNumLocks
public long inplaceUpdateNumLocks()
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceNumber of locks used for inplace update Default: 10000, if inplace_update_support = true, else 0.- Specified by:
inplaceUpdateNumLocksin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Returns:
- the number of locks used for inplace update.
-
setInplaceUpdateNumLocks
public Options setInplaceUpdateNumLocks(long inplaceUpdateNumLocks)
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceNumber of locks used for inplace update Default: 10000, if inplace_update_support = true, else 0.- Specified by:
setInplaceUpdateNumLocksin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Parameters:
inplaceUpdateNumLocks- the number of locks used for inplace updates.- Returns:
- the reference to the current options.
-
memtablePrefixBloomSizeRatio
public double memtablePrefixBloomSizeRatio()
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceif prefix_extractor is set and memtable_prefix_bloom_size_ratio is not 0, create prefix bloom for memtable with the size of write_buffer_size * memtable_prefix_bloom_size_ratio. If it is larger than 0.25, it is santinized to 0.25. Default: 0 (disable)- Specified by:
memtablePrefixBloomSizeRatioin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Returns:
- the ratio
-
setMemtablePrefixBloomSizeRatio
public Options setMemtablePrefixBloomSizeRatio(double memtablePrefixBloomSizeRatio)
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceif prefix_extractor is set and memtable_prefix_bloom_size_ratio is not 0, create prefix bloom for memtable with the size of write_buffer_size * memtable_prefix_bloom_size_ratio. If it is larger than 0.25, it is santinized to 0.25. Default: 0 (disable)- Specified by:
setMemtablePrefixBloomSizeRatioin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Parameters:
memtablePrefixBloomSizeRatio- The ratio- Returns:
- the reference to the current options.
-
bloomLocality
public int bloomLocality()
Description copied from interface:AdvancedColumnFamilyOptionsInterfaceControl locality of bloom filter probes to improve cache miss rate. This option only applies to memtable prefix bloom and plaintable prefix bloom. It essentially limits the max number of cache lines each bloom filter check can touch. This optimization is turned off when set to 0. The number should never be greater than number of probes. This option can boost performance for in-memory workload but should use with care since it can cause higher false positive rate. Default: 0- Specified by:
bloomLocalityin interfaceAdvancedColumnFamilyOptionsInterface<Options>- Returns:
- the level of locality of bloom-filter probes.
- See Also:
AdvancedColumnFamilyOptionsInterface.setBloomLocality(int)
-
setBloomLocality
public Options setBloomLocality(int bloomLocality)
Description copied from interface:AdvancedColumnFamilyOptionsInterfaceControl locality of bloom filter probes to improve cache miss rate. This option only applies to memtable prefix bloom and plaintable prefix bloom. It essentially limits the max number of cache lines each bloom filter check can touch. This optimization is turned off when set to 0. The number should never be greater than number of probes. This option can boost performance for in-memory workload but should use with care since it can cause higher false positive rate. Default: 0- Specified by:
setBloomLocalityin interfaceAdvancedColumnFamilyOptionsInterface<Options>- Parameters:
bloomLocality- the level of locality of bloom-filter probes.- Returns:
- the reference to the current options.
-
maxSuccessiveMerges
public long maxSuccessiveMerges()
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceMaximum number of successive merge operations on a key in the memtable. When a merge operation is added to the memtable and the maximum number of successive merges is reached, the value of the key will be calculated and inserted into the memtable instead of the merge operation. This will ensure that there are never more than max_successive_merges merge operations in the memtable. Default: 0 (disabled)- Specified by:
maxSuccessiveMergesin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Returns:
- the maximum number of successive merges.
-
setMaxSuccessiveMerges
public Options setMaxSuccessiveMerges(long maxSuccessiveMerges)
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceMaximum number of successive merge operations on a key in the memtable. When a merge operation is added to the memtable and the maximum number of successive merges is reached, the value of the key will be calculated and inserted into the memtable instead of the merge operation. This will ensure that there are never more than max_successive_merges merge operations in the memtable. Default: 0 (disabled)- Specified by:
setMaxSuccessiveMergesin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Parameters:
maxSuccessiveMerges- the maximum number of successive merges.- Returns:
- the reference to the current options.
-
minWriteBufferNumberToMerge
public int minWriteBufferNumberToMerge()
Description copied from interface:AdvancedColumnFamilyOptionsInterfaceThe minimum number of write buffers that will be merged together before writing to storage. If set to 1, then all write buffers are flushed to L0 as individual files and this increases read amplification because a get request has to check in all of these files. Also, an in-memory merge may result in writing lesser data to storage if there are duplicate records in each of these individual write buffers. Default: 1- Specified by:
minWriteBufferNumberToMergein interfaceAdvancedColumnFamilyOptionsInterface<Options>- Returns:
- the minimum number of write buffers that will be merged together.
-
setMinWriteBufferNumberToMerge
public Options setMinWriteBufferNumberToMerge(int minWriteBufferNumberToMerge)
Description copied from interface:AdvancedColumnFamilyOptionsInterfaceThe minimum number of write buffers that will be merged together before writing to storage. If set to 1, then all write buffers are flushed to L0 as individual files and this increases read amplification because a get request has to check in all of these files. Also, an in-memory merge may result in writing lesser data to storage if there are duplicate records in each of these individual write buffers. Default: 1- Specified by:
setMinWriteBufferNumberToMergein interfaceAdvancedColumnFamilyOptionsInterface<Options>- Parameters:
minWriteBufferNumberToMerge- the minimum number of write buffers that will be merged together.- Returns:
- the reference to the current options.
-
setOptimizeFiltersForHits
public Options setOptimizeFiltersForHits(boolean optimizeFiltersForHits)
Description copied from interface:AdvancedColumnFamilyOptionsInterfaceThis flag specifies that the implementation should optimize the filters mainly for cases where keys are found rather than also optimize for keys missed. This would be used in cases where the application knows that there are very few misses or the performance in the case of misses is not important.
For now, this flag allows us to not store filters for the last level i.e the largest level which contains data of the LSM store. For keys which are hits, the filters in this level are not useful because we will search for the data anyway.
NOTE: the filters in other levels are still useful even for key hit because they tell us whether to look in that level or go to the higher level.
Default: false
- Specified by:
setOptimizeFiltersForHitsin interfaceAdvancedColumnFamilyOptionsInterface<Options>- Parameters:
optimizeFiltersForHits- boolean value indicating if this flag is set.- Returns:
- the reference to the current options.
-
optimizeFiltersForHits
public boolean optimizeFiltersForHits()
Description copied from interface:AdvancedColumnFamilyOptionsInterfaceReturns the current state of the
optimize_filters_for_hitssetting.- Specified by:
optimizeFiltersForHitsin interfaceAdvancedColumnFamilyOptionsInterface<Options>- Returns:
- boolean value indicating if the flag
optimize_filters_for_hitswas set.
-
setMemtableHugePageSize
public Options setMemtableHugePageSize(long memtableHugePageSize)
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfacePage size for huge page TLB for bloom in memtable. If ≤ 0, not allocate from huge page TLB but from malloc. Need to reserve huge pages for it to be allocated. For example: sysctl -w vm.nr_hugepages=20 See linux doc Documentation/vm/hugetlbpage.txt- Specified by:
setMemtableHugePageSizein interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Parameters:
memtableHugePageSize- The page size of the huge page tlb- Returns:
- the reference to the current options.
-
memtableHugePageSize
public long memtableHugePageSize()
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfacePage size for huge page TLB for bloom in memtable. If ≤ 0, not allocate from huge page TLB but from malloc. Need to reserve huge pages for it to be allocated. For example: sysctl -w vm.nr_hugepages=20 See linux doc Documentation/vm/hugetlbpage.txt- Specified by:
memtableHugePageSizein interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Returns:
- The page size of the huge page tlb
-
setSoftPendingCompactionBytesLimit
public Options setSoftPendingCompactionBytesLimit(long softPendingCompactionBytesLimit)
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceAll writes will be slowed down to at least delayed_write_rate if estimated bytes needed to be compaction exceed this threshold. Default: 64GB- Specified by:
setSoftPendingCompactionBytesLimitin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Parameters:
softPendingCompactionBytesLimit- The soft limit to impose on compaction- Returns:
- the reference to the current options.
-
softPendingCompactionBytesLimit
public long softPendingCompactionBytesLimit()
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceAll writes will be slowed down to at least delayed_write_rate if estimated bytes needed to be compaction exceed this threshold. Default: 64GB- Specified by:
softPendingCompactionBytesLimitin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Returns:
- The soft limit to impose on compaction
-
setHardPendingCompactionBytesLimit
public Options setHardPendingCompactionBytesLimit(long hardPendingCompactionBytesLimit)
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceAll writes are stopped if estimated bytes needed to be compaction exceed this threshold. Default: 256GB- Specified by:
setHardPendingCompactionBytesLimitin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Parameters:
hardPendingCompactionBytesLimit- The hard limit to impose on compaction- Returns:
- the reference to the current options.
-
hardPendingCompactionBytesLimit
public long hardPendingCompactionBytesLimit()
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceAll writes are stopped if estimated bytes needed to be compaction exceed this threshold. Default: 256GB- Specified by:
hardPendingCompactionBytesLimitin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Returns:
- The hard limit to impose on compaction
-
setLevel0FileNumCompactionTrigger
public Options setLevel0FileNumCompactionTrigger(int level0FileNumCompactionTrigger)
Description copied from interface:MutableColumnFamilyOptionsInterfaceNumber of files to trigger level-0 compaction. A value < 0 means that level-0 compaction will not be triggered by number of files at all. Default: 4- Specified by:
setLevel0FileNumCompactionTriggerin interfaceMutableColumnFamilyOptionsInterface<Options>- Parameters:
level0FileNumCompactionTrigger- The number of files to trigger level-0 compaction- Returns:
- the reference to the current option.
-
level0FileNumCompactionTrigger
public int level0FileNumCompactionTrigger()
Description copied from interface:MutableColumnFamilyOptionsInterfaceNumber of files to trigger level-0 compaction. A value < 0 means that level-0 compaction will not be triggered by number of files at all. Default: 4- Specified by:
level0FileNumCompactionTriggerin interfaceMutableColumnFamilyOptionsInterface<Options>- Returns:
- The number of files to trigger
-
setLevel0SlowdownWritesTrigger
public Options setLevel0SlowdownWritesTrigger(int level0SlowdownWritesTrigger)
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceSoft limit on number of level-0 files. We start slowing down writes at this point. A value < 0 means that no writing slow down will be triggered by number of files in level-0.- Specified by:
setLevel0SlowdownWritesTriggerin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Parameters:
level0SlowdownWritesTrigger- The soft limit on the number of level-0 files- Returns:
- the reference to the current options.
-
level0SlowdownWritesTrigger
public int level0SlowdownWritesTrigger()
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceSoft limit on number of level-0 files. We start slowing down writes at this point. A value < 0 means that no writing slow down will be triggered by number of files in level-0.- Specified by:
level0SlowdownWritesTriggerin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Returns:
- The soft limit on the number of level-0 files
-
setLevel0StopWritesTrigger
public Options setLevel0StopWritesTrigger(int level0StopWritesTrigger)
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceMaximum number of level-0 files. We stop writes at this point.- Specified by:
setLevel0StopWritesTriggerin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Parameters:
level0StopWritesTrigger- The maximum number of level-0 files- Returns:
- the reference to the current options.
-
level0StopWritesTrigger
public int level0StopWritesTrigger()
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceMaximum number of level-0 files. We stop writes at this point.- Specified by:
level0StopWritesTriggerin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Returns:
- The maximum number of level-0 files
-
setMaxBytesForLevelMultiplierAdditional
public Options setMaxBytesForLevelMultiplierAdditional(int[] maxBytesForLevelMultiplierAdditional)
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceDifferent max-size multipliers for different levels. These are multiplied by max_bytes_for_level_multiplier to arrive at the max-size of each level. Default: 1- Specified by:
setMaxBytesForLevelMultiplierAdditionalin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Parameters:
maxBytesForLevelMultiplierAdditional- The max-size multipliers for each level- Returns:
- the reference to the current options.
-
maxBytesForLevelMultiplierAdditional
public int[] maxBytesForLevelMultiplierAdditional()
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceDifferent max-size multipliers for different levels. These are multiplied by max_bytes_for_level_multiplier to arrive at the max-size of each level. Default: 1- Specified by:
maxBytesForLevelMultiplierAdditionalin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Returns:
- The max-size multipliers for each level
-
setParanoidFileChecks
public Options setParanoidFileChecks(boolean paranoidFileChecks)
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceAfter writing every SST file, reopen it and read all the keys. Default: false- Specified by:
setParanoidFileChecksin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Parameters:
paranoidFileChecks- true to enable paranoid file checks- Returns:
- the reference to the current options.
-
paranoidFileChecks
public boolean paranoidFileChecks()
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceAfter writing every SST file, reopen it and read all the keys. Default: false- Specified by:
paranoidFileChecksin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Returns:
- true if paranoid file checks are enabled
-
setMaxWriteBufferNumberToMaintain
public Options setMaxWriteBufferNumberToMaintain(int maxWriteBufferNumberToMaintain)
Description copied from interface:AdvancedColumnFamilyOptionsInterfaceThe total maximum number of write buffers to maintain in memory including copies of buffers that have already been flushed. UnlikeAdvancedMutableColumnFamilyOptionsInterface.maxWriteBufferNumber(), this parameter does not affect flushing. This controls the minimum amount of write history that will be available in memory for conflict checking when Transactions are used. When using an OptimisticTransactionDB: If this value is too low, some transactions may fail at commit time due to not being able to determine whether there were any write conflicts. When using a TransactionDB: If Transaction::SetSnapshot is used, TransactionDB will read either in-memory write buffers or SST files to do write-conflict checking. Increasing this value can reduce the number of reads to SST files done for conflict detection. Setting this value to 0 will cause write buffers to be freed immediately after they are flushed. If this value is set to -1,AdvancedMutableColumnFamilyOptionsInterface.maxWriteBufferNumber()will be used. Default: If using a TransactionDB/OptimisticTransactionDB, the default value will be set to the value ofAdvancedMutableColumnFamilyOptionsInterface.maxWriteBufferNumber()if it is not explicitly set by the user. Otherwise, the default is 0.- Specified by:
setMaxWriteBufferNumberToMaintainin interfaceAdvancedColumnFamilyOptionsInterface<Options>- Parameters:
maxWriteBufferNumberToMaintain- The maximum number of write buffers to maintain- Returns:
- the reference to the current options.
-
maxWriteBufferNumberToMaintain
public int maxWriteBufferNumberToMaintain()
Description copied from interface:AdvancedColumnFamilyOptionsInterfaceThe total maximum number of write buffers to maintain in memory including copies of buffers that have already been flushed.- Specified by:
maxWriteBufferNumberToMaintainin interfaceAdvancedColumnFamilyOptionsInterface<Options>- Returns:
- maxWriteBufferNumberToMaintain The maximum number of write buffers to maintain
-
setCompactionPriority
public Options setCompactionPriority(CompactionPriority compactionPriority)
Description copied from interface:AdvancedColumnFamilyOptionsInterfaceIf levelAdvancedColumnFamilyOptionsInterface.compactionStyle()==CompactionStyle.LEVEL, for each level, which files are prioritized to be picked to compact. Default:CompactionPriority.ByCompensatedSize- Specified by:
setCompactionPriorityin interfaceAdvancedColumnFamilyOptionsInterface<Options>- Parameters:
compactionPriority- The compaction priority- Returns:
- the reference to the current options.
-
compactionPriority
public CompactionPriority compactionPriority()
Description copied from interface:AdvancedColumnFamilyOptionsInterfaceGet the Compaction priority if level compaction is used for all levels- Specified by:
compactionPriorityin interfaceAdvancedColumnFamilyOptionsInterface<Options>- Returns:
- The compaction priority
-
setReportBgIoStats
public Options setReportBgIoStats(boolean reportBgIoStats)
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceMeasure IO stats in compactions and flushes, if true. Default: false- Specified by:
setReportBgIoStatsin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Parameters:
reportBgIoStats- true to enable reporting- Returns:
- the reference to the current options.
-
reportBgIoStats
public boolean reportBgIoStats()
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceDetermine whether IO stats in compactions and flushes are being measured- Specified by:
reportBgIoStatsin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Returns:
- true if reporting is enabled
-
setTtl
public Options setTtl(long ttl)
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceNon-bottom-level files older than TTL will go through the compaction process. This needsMutableDBOptionsInterface.maxOpenFiles()to be set to -1. Enabled only for level compaction for now. Default: 0 (disabled) Dynamically changeable throughRocksDB.setOptions(ColumnFamilyHandle, MutableColumnFamilyOptions).- Specified by:
setTtlin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Parameters:
ttl- the time-to-live.- Returns:
- the reference to the current options.
-
ttl
public long ttl()
Description copied from interface:AdvancedMutableColumnFamilyOptionsInterfaceGet the TTL for Non-bottom-level files that will go through the compaction process. SeeAdvancedMutableColumnFamilyOptionsInterface.setTtl(long).- Specified by:
ttlin interfaceAdvancedMutableColumnFamilyOptionsInterface<Options>- Returns:
- the time-to-live.
-
setCompactionOptionsUniversal
public Options setCompactionOptionsUniversal(CompactionOptionsUniversal compactionOptionsUniversal)
Description copied from interface:AdvancedColumnFamilyOptionsInterfaceSet the options needed to support Universal Style compactions- Specified by:
setCompactionOptionsUniversalin interfaceAdvancedColumnFamilyOptionsInterface<Options>- Parameters:
compactionOptionsUniversal- The Universal Style compaction options- Returns:
- the reference to the current options.
-
compactionOptionsUniversal
public CompactionOptionsUniversal compactionOptionsUniversal()
Description copied from interface:AdvancedColumnFamilyOptionsInterfaceThe options needed to support Universal Style compactions- Specified by:
compactionOptionsUniversalin interfaceAdvancedColumnFamilyOptionsInterface<Options>- Returns:
- The Universal Style compaction options
-
setCompactionOptionsFIFO
public Options setCompactionOptionsFIFO(CompactionOptionsFIFO compactionOptionsFIFO)
Description copied from interface:AdvancedColumnFamilyOptionsInterfaceThe options for FIFO compaction style- Specified by:
setCompactionOptionsFIFOin interfaceAdvancedColumnFamilyOptionsInterface<Options>- Parameters:
compactionOptionsFIFO- The FIFO compaction options- Returns:
- the reference to the current options.
-
compactionOptionsFIFO
public CompactionOptionsFIFO compactionOptionsFIFO()
Description copied from interface:AdvancedColumnFamilyOptionsInterfaceThe options for FIFO compaction style- Specified by:
compactionOptionsFIFOin interfaceAdvancedColumnFamilyOptionsInterface<Options>- Returns:
- The FIFO compaction options
-
setForceConsistencyChecks
public Options setForceConsistencyChecks(boolean forceConsistencyChecks)
Description copied from interface:AdvancedColumnFamilyOptionsInterfaceIn debug mode, RocksDB run consistency checks on the LSM every time the LSM change (Flush, Compaction, AddFile). These checks are disabled in release mode, use this option to enable them in release mode as well. Default: false- Specified by:
setForceConsistencyChecksin interfaceAdvancedColumnFamilyOptionsInterface<Options>- Parameters:
forceConsistencyChecks- true to force consistency checks- Returns:
- the reference to the current options.
-
forceConsistencyChecks
public boolean forceConsistencyChecks()
Description copied from interface:AdvancedColumnFamilyOptionsInterfaceIn debug mode, RocksDB run consistency checks on the LSM every time the LSM change (Flush, Compaction, AddFile). These checks are disabled in release mode.- Specified by:
forceConsistencyChecksin interfaceAdvancedColumnFamilyOptionsInterface<Options>- Returns:
- true if consistency checks are enforced
-
setAtomicFlush
public Options setAtomicFlush(boolean atomicFlush)
Description copied from interface:DBOptionsInterfaceIf true, RocksDB supports flushing multiple column families and committing their results atomically to MANIFEST. Note that it is not necessary to set atomic_flush to true if WAL is always enabled since WAL allows the database to be restored to the last persistent state in WAL. This option is useful when there are column families with writes NOT protected by WAL. For manual flush, application has to specify which column families to flush atomically inRocksDB.flush(FlushOptions, List). For auto-triggered flush, RocksDB atomically flushes ALL column families. Currently, any WAL-enabled writes after atomic flush may be replayed independently if the process crashes later and tries to recover.- Specified by:
setAtomicFlushin interfaceDBOptionsInterface<Options>- Parameters:
atomicFlush- true to enable atomic flush of multiple column families.- Returns:
- the reference to the current options.
-
atomicFlush
public boolean atomicFlush()
Description copied from interface:DBOptionsInterfaceDetermine if atomic flush of multiple column families is enabled. SeeDBOptionsInterface.setAtomicFlush(boolean).- Specified by:
atomicFlushin interfaceDBOptionsInterface<Options>- Returns:
- true if atomic flush is enabled.
-
setAvoidUnnecessaryBlockingIO
public Options setAvoidUnnecessaryBlockingIO(boolean avoidUnnecessaryBlockingIO)
Description copied from interface:DBOptionsInterfaceIf true, working thread may avoid doing unnecessary and long-latency operation (such as deleting obsolete files directly or deleting memtable) and will instead schedule a background job to do it. Use it if you're latency-sensitive. If set to true, takes precedence overReadOptions.setBackgroundPurgeOnIteratorCleanup(boolean).- Specified by:
setAvoidUnnecessaryBlockingIOin interfaceDBOptionsInterface<Options>- Parameters:
avoidUnnecessaryBlockingIO- If true, working thread may avoid doing unnecessary operation.- Returns:
- the reference to the current options.
-
avoidUnnecessaryBlockingIO
public boolean avoidUnnecessaryBlockingIO()
Description copied from interface:DBOptionsInterfaceIf true, working thread may avoid doing unnecessary and long-latency operation (such as deleting obsolete files directly or deleting memtable) and will instead schedule a background job to do it. Use it if you're latency-sensitive. If set to true, takes precedence overReadOptions.setBackgroundPurgeOnIteratorCleanup(boolean).- Specified by:
avoidUnnecessaryBlockingIOin interfaceDBOptionsInterface<Options>- Returns:
- true, if working thread may avoid doing unnecessary operation.
-
setPersistStatsToDisk
public Options setPersistStatsToDisk(boolean persistStatsToDisk)
Description copied from interface:DBOptionsInterfaceIf true, automatically persist stats to a hidden column family (column family name: ___rocksdb_stats_history___) every stats_persist_period_sec seconds; otherwise, write to an in-memory struct. User can query through `GetStatsHistory` API. If user attempts to create a column family with the same name on a DB which have previously set persist_stats_to_disk to true, the column family creation will fail, but the hidden column family will survive, as well as the previously persisted statistics. When peristing stats to disk, the stat name will be limited at 100 bytes. Default: false- Specified by:
setPersistStatsToDiskin interfaceDBOptionsInterface<Options>- Parameters:
persistStatsToDisk- true if stats should be persisted to hidden column family.- Returns:
- the instance of the current object.
-
persistStatsToDisk
public boolean persistStatsToDisk()
Description copied from interface:DBOptionsInterfaceIf true, automatically persist stats to a hidden column family (column family name: ___rocksdb_stats_history___) every stats_persist_period_sec seconds; otherwise, write to an in-memory struct. User can query through `GetStatsHistory` API. If user attempts to create a column family with the same name on a DB which have previously set persist_stats_to_disk to true, the column family creation will fail, but the hidden column family will survive, as well as the previously persisted statistics. When peristing stats to disk, the stat name will be limited at 100 bytes. Default: false- Specified by:
persistStatsToDiskin interfaceDBOptionsInterface<Options>- Returns:
- true if stats should be persisted to hidden column family.
-
setWriteDbidToManifest
public Options setWriteDbidToManifest(boolean writeDbidToManifest)
Description copied from interface:DBOptionsInterfaceHistorically DB ID has always been stored in Identity File in DB folder. If this flag is true, the DB ID is written to Manifest file in addition to the Identity file. By doing this 2 problems are solved 1. We don't checksum the Identity file where as Manifest file is. 2. Since the source of truth for DB is Manifest file DB ID will sit with the source of truth. Previously the Identity file could be copied independent of Manifest and that can result in wrong DB ID. We recommend setting this flag to true. Default: false- Specified by:
setWriteDbidToManifestin interfaceDBOptionsInterface<Options>- Parameters:
writeDbidToManifest- if true, then DB ID will be written to Manifest file.- Returns:
- the instance of the current object.
-
writeDbidToManifest
public boolean writeDbidToManifest()
Description copied from interface:DBOptionsInterfaceHistorically DB ID has always been stored in Identity File in DB folder. If this flag is true, the DB ID is written to Manifest file in addition to the Identity file. By doing this 2 problems are solved 1. We don't checksum the Identity file where as Manifest file is. 2. Since the source of truth for DB is Manifest file DB ID will sit with the source of truth. Previously the Identity file could be copied independent of Manifest and that can result in wrong DB ID. We recommend setting this flag to true. Default: false- Specified by:
writeDbidToManifestin interfaceDBOptionsInterface<Options>- Returns:
- true, if DB ID will be written to Manifest file.
-
setLogReadaheadSize
public Options setLogReadaheadSize(long logReadaheadSize)
Description copied from interface:DBOptionsInterfaceThe number of bytes to prefetch when reading the log. This is mostly useful for reading a remotely located log, as it can save the number of round-trips. If 0, then the prefetching is disabled. Default: 0- Specified by:
setLogReadaheadSizein interfaceDBOptionsInterface<Options>- Parameters:
logReadaheadSize- the number of bytes to prefetch when reading the log.- Returns:
- the instance of the current object.
-
logReadaheadSize
public long logReadaheadSize()
Description copied from interface:DBOptionsInterfaceThe number of bytes to prefetch when reading the log. This is mostly useful for reading a remotely located log, as it can save the number of round-trips. If 0, then the prefetching is disabled. Default: 0- Specified by:
logReadaheadSizein interfaceDBOptionsInterface<Options>- Returns:
- the number of bytes to prefetch when reading the log.
-
setBestEffortsRecovery
public Options setBestEffortsRecovery(boolean bestEffortsRecovery)
Description copied from interface:DBOptionsInterfaceBy default, RocksDB recovery fails if any table file referenced in MANIFEST are missing after scanning the MANIFEST. Best-efforts recovery is another recovery mode that tries to restore the database to the most recent point in time without missing file. Currently not compatible with atomic flush. Furthermore, WAL files will not be used for recovery if best_efforts_recovery is true. Default: false- Specified by:
setBestEffortsRecoveryin interfaceDBOptionsInterface<Options>- Parameters:
bestEffortsRecovery- if true, RocksDB will use best-efforts mode when recovering.- Returns:
- the instance of the current object.
-
bestEffortsRecovery
public boolean bestEffortsRecovery()
Description copied from interface:DBOptionsInterfaceBy default, RocksDB recovery fails if any table file referenced in MANIFEST are missing after scanning the MANIFEST. Best-efforts recovery is another recovery mode that tries to restore the database to the most recent point in time without missing file. Currently not compatible with atomic flush. Furthermore, WAL files will not be used for recovery if best_efforts_recovery is true. Default: false- Specified by:
bestEffortsRecoveryin interfaceDBOptionsInterface<Options>- Returns:
- true, if RocksDB uses best-efforts mode when recovering.
-
setMaxBgErrorResumeCount
public Options setMaxBgErrorResumeCount(int maxBgerrorResumeCount)
Description copied from interface:DBOptionsInterfaceIt defines how many times db resume is called by a separate thread when background retryable IO Error happens. When background retryable IO Error happens, SetBGError is called to deal with the error. If the error can be auto-recovered (e.g., retryable IO Error during Flush or WAL write), then db resume is called in background to recover from the error. If this value is 0 or negative, db resume will not be called. Default: INT_MAX- Specified by:
setMaxBgErrorResumeCountin interfaceDBOptionsInterface<Options>- Parameters:
maxBgerrorResumeCount- maximum number of times db resume should be called when IO Error happens.- Returns:
- the instance of the current object.
-
maxBgerrorResumeCount
public int maxBgerrorResumeCount()
Description copied from interface:DBOptionsInterfaceIt defines how many times db resume is called by a separate thread when background retryable IO Error happens. When background retryable IO Error happens, SetBGError is called to deal with the error. If the error can be auto-recovered (e.g., retryable IO Error during Flush or WAL write), then db resume is called in background to recover from the error. If this value is 0 or negative, db resume will not be called. Default: INT_MAX- Specified by:
maxBgerrorResumeCountin interfaceDBOptionsInterface<Options>- Returns:
- maximum number of times db resume should be called when IO Error happens.
-
setBgerrorResumeRetryInterval
public Options setBgerrorResumeRetryInterval(long bgerrorResumeRetryInterval)
Description copied from interface:DBOptionsInterfaceIf max_bgerror_resume_count is ≥ 2, db resume is called multiple times. This option decides how long to wait to retry the next resume if the previous resume fails and satisfy redo resume conditions. Default: 1000000 (microseconds).- Specified by:
setBgerrorResumeRetryIntervalin interfaceDBOptionsInterface<Options>- Parameters:
bgerrorResumeRetryInterval- how many microseconds to wait between DB resume attempts.- Returns:
- the instance of the current object.
-
bgerrorResumeRetryInterval
public long bgerrorResumeRetryInterval()
Description copied from interface:DBOptionsInterfaceIf max_bgerror_resume_count is ≥ 2, db resume is called multiple times. This option decides how long to wait to retry the next resume if the previous resume fails and satisfy redo resume conditions. Default: 1000000 (microseconds).- Specified by:
bgerrorResumeRetryIntervalin interfaceDBOptionsInterface<Options>- Returns:
- the instance of the current object.
-
setSstPartitionerFactory
public Options setSstPartitionerFactory(SstPartitionerFactory sstPartitionerFactory)
Description copied from interface:ColumnFamilyOptionsInterfaceIf non-nullptr, use the specified factory for a function to determine the partitioning of sst files. This helps compaction to split the files on interesting boundaries (key prefixes) to make propagation of sst files less write amplifying (covering the whole key space). Default: nullptr- Specified by:
setSstPartitionerFactoryin interfaceColumnFamilyOptionsInterface<Options>- Parameters:
sstPartitionerFactory- The factory reference- Returns:
- the reference of the current options.
-
sstPartitionerFactory
public SstPartitionerFactory sstPartitionerFactory()
Description copied from interface:ColumnFamilyOptionsInterfaceGet SST partitioner factory- Specified by:
sstPartitionerFactoryin interfaceColumnFamilyOptionsInterface<Options>- Returns:
- SST partitioner factory
-
setCompactionThreadLimiter
public Options setCompactionThreadLimiter(ConcurrentTaskLimiter compactionThreadLimiter)
Description copied from interface:ColumnFamilyOptionsInterfaceCompaction concurrent thread limiter for the column family. If non-nullptr, use given concurrent thread limiter to control the max outstanding compaction tasks. Limiter can be shared with multiple column families across db instances.- Specified by:
setCompactionThreadLimiterin interfaceColumnFamilyOptionsInterface<Options>- Parameters:
compactionThreadLimiter- The compaction thread limiter.- Returns:
- the reference of the current options.
-
compactionThreadLimiter
public ConcurrentTaskLimiter compactionThreadLimiter()
Description copied from interface:ColumnFamilyOptionsInterfaceGet compaction thread limiter- Specified by:
compactionThreadLimiterin interfaceColumnFamilyOptionsInterface<Options>- Returns:
- Compaction thread limiter
-
disposeInternal
protected final void disposeInternal(long handle)
- Specified by:
disposeInternalin classRocksObject
-
-