public class ColumnFamilyOptions extends RocksObject implements ColumnFamilyOptionsInterface, MutableColumnFamilyOptionsInterface
RocksDB (i.e., RocksDB.open()).
If AbstractNativeReference.dispose() function is not called, then it will be GC'd
automatically and native resources will be released as part of the process.nativeHandle_DEFAULT_COMPACTION_MEMTABLE_MEMORY_BUDGET| Constructor and Description |
|---|
ColumnFamilyOptions()
Construct ColumnFamilyOptions.
|
| Modifier and Type | Method and Description |
|---|---|
long |
arenaBlockSize()
The size of one block in arena memory allocation.
|
int |
bloomLocality()
Control locality of bloom filter probes to improve cache miss rate.
|
CompactionStyle |
compactionStyle()
Compaction style for DB.
|
java.util.List<CompressionType> |
compressionPerLevel()
Return the currently set
CompressionType
per instances. |
CompressionType |
compressionType()
Compress blocks using the specified compression algorithm.
|
boolean |
disableAutoCompactions()
Disable automatic compactions.
|
protected void |
disposeInternal(long handle) |
static ColumnFamilyOptions |
getColumnFamilyOptionsFromProps(java.util.Properties properties)
Method to get a options instance by using pre-configured
property values.
|
long |
hardPendingCompactionBytesLimit()
All writes are stopped if estimated bytes needed to be compaction exceed
this threshold.
|
double |
hardRateLimit()
Puts are delayed 1ms at a time when any level has a compaction score that
exceeds hard_rate_limit.
|
long |
inplaceUpdateNumLocks()
Number of locks used for inplace update
Default: 10000, if inplace_update_support = true, else 0.
|
boolean |
inplaceUpdateSupport()
Allows thread-safe inplace updates.
|
int |
level0FileNumCompactionTrigger()
Number of files to trigger level-0 compaction.
|
int |
level0SlowdownWritesTrigger()
Soft limit on number of level-0 files.
|
int |
level0StopWritesTrigger()
Maximum number of level-0 files.
|
boolean |
levelCompactionDynamicLevelBytes()
Return if
LevelCompactionDynamicLevelBytes is enabled. |
int |
levelZeroFileNumCompactionTrigger()
The number of files in level 0 to trigger compaction from level-0 to
level-1.
|
int |
levelZeroSlowdownWritesTrigger()
Soft limit on the number of level-0 files.
|
int |
levelZeroStopWritesTrigger()
Maximum number of level-0 files.
|
long |
maxBytesForLevelBase()
The upper-bound of the total size of level-1 files in bytes.
|
double |
maxBytesForLevelMultiplier()
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.
|
long |
maxCompactionBytes()
Control maximum size of each compaction (not guaranteed)
|
int |
maxMemCompactionLevel()
This does nothing anymore.
|
long |
maxSequentialSkipInIterations()
An iteration->Next() sequentially skips over keys with the same
user-key unless this option is set.
|
long |
maxSuccessiveMerges()
Maximum number of successive merge operations on a key in the memtable.
|
long |
maxTableFilesSizeFIFO()
FIFO compaction option.
|
int |
maxWriteBufferNumber()
Returns maximum number of write buffers.
|
java.lang.String |
memTableFactoryName()
Returns the name of the current mem table representation.
|
long |
memtableHugePageSize()
Page size for huge page TLB for bloom in memtable.
|
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.
|
int |
minPartialMergeOperands()
The number of partial merge operands to accumulate before partial
merge will be performed.
|
int |
minWriteBufferNumberToMerge()
The minimum number of write buffers that will be merged together
before writing to storage.
|
int |
numLevels()
If level-styled compaction is used, then this number determines
the total number of levels.
|
boolean |
optimizeFiltersForHits()
Returns the current state of the
optimize_filters_for_hits
setting. |
ColumnFamilyOptions |
optimizeForPointLookup(long blockCacheSizeMb)
Use this if you don't need to keep the data sorted, i.e.
|
ColumnFamilyOptions |
optimizeLevelStyleCompaction()
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.
|
ColumnFamilyOptions |
optimizeLevelStyleCompaction(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.
|
ColumnFamilyOptions |
optimizeUniversalStyleCompaction()
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.
|
ColumnFamilyOptions |
optimizeUniversalStyleCompaction(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.
|
boolean |
paranoidFileChecks()
After writing every SST file, reopen it and read all the keys.
|
boolean |
purgeRedundantKvsWhileFlush()
Purge duplicate/deleted keys when a memtable is flushed to storage.
|
int |
rateLimitDelayMaxMilliseconds()
The maximum time interval a put will be stalled when hard_rate_limit
is enforced.
|
ColumnFamilyOptions |
setArenaBlockSize(long arenaBlockSize)
The size of one block in arena memory allocation.
|
ColumnFamilyOptions |
setBloomLocality(int bloomLocality)
Control locality of bloom filter probes to improve cache miss rate.
|
ColumnFamilyOptions |
setCompactionFilter(AbstractCompactionFilter<? extends AbstractSlice<?>> compactionFilter) |
ColumnFamilyOptions |
setCompactionStyle(CompactionStyle compactionStyle)
Set compaction style for DB.
|
ColumnFamilyOptions |
setComparator(AbstractComparator<? extends AbstractSlice<?>> comparator)
Use the specified comparator for key ordering.
|
ColumnFamilyOptions |
setComparator(BuiltinComparator builtinComparator)
Set
BuiltinComparator to be used with RocksDB. |
ColumnFamilyOptions |
setCompressionPerLevel(java.util.List<CompressionType> compressionLevels)
Different levels can have different compression
policies.
|
ColumnFamilyOptions |
setCompressionType(CompressionType compressionType)
Compress blocks using the specified compression algorithm.
|
ColumnFamilyOptions |
setDisableAutoCompactions(boolean disableAutoCompactions)
Disable automatic compactions.
|
ColumnFamilyOptions |
setHardPendingCompactionBytesLimit(long hardPendingCompactionBytesLimit)
All writes are stopped if estimated bytes needed to be compaction exceed
this threshold.
|
ColumnFamilyOptions |
setHardRateLimit(double hardRateLimit)
Puts are delayed 1ms at a time when any level has a compaction score that
exceeds hard_rate_limit.
|
ColumnFamilyOptions |
setInplaceUpdateNumLocks(long inplaceUpdateNumLocks)
Number of locks used for inplace update
Default: 10000, if inplace_update_support = true, else 0.
|
ColumnFamilyOptions |
setInplaceUpdateSupport(boolean inplaceUpdateSupport)
Allows thread-safe inplace updates.
|
ColumnFamilyOptions |
setLevel0FileNumCompactionTrigger(int level0FileNumCompactionTrigger)
Number of files to trigger level-0 compaction.
|
ColumnFamilyOptions |
setLevel0SlowdownWritesTrigger(int level0SlowdownWritesTrigger)
Soft limit on number of level-0 files.
|
ColumnFamilyOptions |
setLevel0StopWritesTrigger(int level0StopWritesTrigger)
Maximum number of level-0 files.
|
ColumnFamilyOptions |
setLevelCompactionDynamicLevelBytes(boolean enableLevelCompactionDynamicLevelBytes)
If
true, RocksDB will pick target size of each level
dynamically. |
ColumnFamilyOptions |
setLevelZeroFileNumCompactionTrigger(int numFiles)
Number of files to trigger level-0 compaction.
|
ColumnFamilyOptions |
setLevelZeroSlowdownWritesTrigger(int numFiles)
Soft limit on number of level-0 files.
|
ColumnFamilyOptions |
setLevelZeroStopWritesTrigger(int numFiles)
Maximum number of level-0 files.
|
ColumnFamilyOptions |
setMaxBytesForLevelBase(long maxBytesForLevelBase)
The upper-bound of the total size of level-1 files in bytes.
|
ColumnFamilyOptions |
setMaxBytesForLevelMultiplier(double multiplier)
The ratio between the total size of level-(L+1) files and the total
size of level-L files for all L.
|
ColumnFamilyOptions |
setMaxBytesForLevelMultiplierAdditional(int[] maxBytesForLevelMultiplierAdditional)
Different max-size multipliers for different levels.
|
ColumnFamilyOptions |
setMaxCompactionBytes(long maxCompactionBytes)
Maximum size of each compaction (not guarantee)
|
ColumnFamilyOptions |
setMaxMemCompactionLevel(int maxMemCompactionLevel)
This does nothing anymore.
|
ColumnFamilyOptions |
setMaxSequentialSkipInIterations(long maxSequentialSkipInIterations)
An iteration->Next() sequentially skips over keys with the same
user-key unless this option is set.
|
ColumnFamilyOptions |
setMaxSuccessiveMerges(long maxSuccessiveMerges)
Maximum number of successive merge operations on a key in the memtable.
|
ColumnFamilyOptions |
setMaxTableFilesSizeFIFO(long maxTableFilesSize)
FIFO compaction option.
|
ColumnFamilyOptions |
setMaxWriteBufferNumber(int maxWriteBufferNumber)
The maximum number of write buffers that are built up in memory.
|
ColumnFamilyOptions |
setMemTableConfig(MemTableConfig config)
Set the config for mem-table.
|
ColumnFamilyOptions |
setMemtableHugePageSize(long memtableHugePageSize)
Page size for huge page TLB for bloom in memtable.
|
ColumnFamilyOptions |
setMemtablePrefixBloomSizeRatio(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.
|
ColumnFamilyOptions |
setMergeOperator(MergeOperator mergeOperator)
Set the merge operator to be used for merging two different key/value
pairs that share the same key.
|
ColumnFamilyOptions |
setMergeOperatorName(java.lang.String name)
Set the merge operator to be used for merging two merge operands
of the same key.
|
ColumnFamilyOptions |
setMinPartialMergeOperands(int minPartialMergeOperands)
The number of partial merge operands to accumulate before partial
merge will be performed.
|
ColumnFamilyOptions |
setMinWriteBufferNumberToMerge(int minWriteBufferNumberToMerge)
The minimum number of write buffers that will be merged together
before writing to storage.
|
ColumnFamilyOptions |
setNumLevels(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.
|
ColumnFamilyOptions |
setOptimizeFiltersForHits(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.
|
ColumnFamilyOptions |
setParanoidFileChecks(boolean paranoidFileChecks)
After writing every SST file, reopen it and read all the keys.
|
ColumnFamilyOptions |
setPurgeRedundantKvsWhileFlush(boolean purgeRedundantKvsWhileFlush)
Purge duplicate/deleted keys when a memtable is flushed to storage.
|
ColumnFamilyOptions |
setRateLimitDelayMaxMilliseconds(int rateLimitDelayMaxMilliseconds)
The maximum time interval a put will be stalled when hard_rate_limit
is enforced.
|
ColumnFamilyOptions |
setSoftPendingCompactionBytesLimit(long softPendingCompactionBytesLimit)
All writes will be slowed down to at least delayed_write_rate if estimated
bytes needed to be compaction exceed this threshold.
|
ColumnFamilyOptions |
setSoftRateLimit(double softRateLimit)
Puts are delayed 0-1 ms when any level has a compaction score that exceeds
soft_rate_limit.
|
ColumnFamilyOptions |
setTableFormatConfig(TableFormatConfig config)
Set the config for table format.
|
ColumnFamilyOptions |
setTargetFileSizeBase(long targetFileSizeBase)
The target file size for compaction.
|
ColumnFamilyOptions |
setTargetFileSizeMultiplier(int multiplier)
targetFileSizeMultiplier defines the size ratio between a
level-L file and level-(L+1) file.
|
ColumnFamilyOptions |
setVerifyChecksumsInCompaction(boolean verifyChecksumsInCompaction)
If true, compaction will verify checksum on every read that happens
as part of compaction
Default: true
|
ColumnFamilyOptions |
setWriteBufferSize(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.
|
long |
softPendingCompactionBytesLimit()
All writes will be slowed down to at least delayed_write_rate if estimated
bytes needed to be compaction exceed this threshold.
|
double |
softRateLimit()
Puts are delayed 0-1 ms when any level has a compaction score that exceeds
soft_rate_limit.
|
java.lang.String |
tableFactoryName() |
long |
targetFileSizeBase()
The target file size for compaction.
|
int |
targetFileSizeMultiplier()
targetFileSizeMultiplier defines the size ratio between a
level-(L+1) file and level-L file.
|
ColumnFamilyOptions |
useCappedPrefixExtractor(int n)
Same as fixed length prefix extractor, except that when slice is
shorter than the fixed length, it will use the full key.
|
ColumnFamilyOptions |
useFixedLengthPrefixExtractor(int n)
This prefix-extractor uses the first n bytes of a key as its prefix.
|
boolean |
verifyChecksumsInCompaction()
If true, compaction will verify checksum on every read that happens
as part of compaction
Default: true
|
long |
writeBufferSize()
Return size of write buffer size.
|
disposeInternalclose, disOwnNativeHandle, isOwningHandledispose, finalizepublic ColumnFamilyOptions()
rocksdb::DBOptions in the c++ side.public static ColumnFamilyOptions getColumnFamilyOptionsFromProps(java.util.Properties properties)
Method to get a options instance by using pre-configured property values. If one or many values are undefined in the context of RocksDB the method will return a null value.
Note: Property keys can be derived from
getter methods within the options class. Example: the method
writeBufferSize() has a property key:
write_buffer_size.
properties - Properties instance.instance
or null.java.lang.IllegalArgumentException - if null or empty
Properties instance is passed to the method call.public ColumnFamilyOptions optimizeForPointLookup(long blockCacheSizeMb)
ColumnFamilyOptionsInterfaceoptimizeForPointLookup in interface ColumnFamilyOptionsInterfaceblockCacheSizeMb - Block cache size in MBpublic ColumnFamilyOptions optimizeLevelStyleCompaction()
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
optimizeLevelStyleCompaction in interface ColumnFamilyOptionsInterfacepublic ColumnFamilyOptions optimizeLevelStyleCompaction(long memtableMemoryBudget)
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
optimizeLevelStyleCompaction in interface ColumnFamilyOptionsInterfacememtableMemoryBudget - memory budget in bytespublic ColumnFamilyOptions optimizeUniversalStyleCompaction()
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
optimizeUniversalStyleCompaction in interface ColumnFamilyOptionsInterfacepublic ColumnFamilyOptions optimizeUniversalStyleCompaction(long memtableMemoryBudget)
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
optimizeUniversalStyleCompaction in interface ColumnFamilyOptionsInterfacememtableMemoryBudget - memory budget in bytespublic ColumnFamilyOptions setComparator(BuiltinComparator builtinComparator)
ColumnFamilyOptionsInterfaceBuiltinComparator to be used with RocksDB.
Note: Comparator can be set once upon database creation.
Default: BytewiseComparator.setComparator in interface ColumnFamilyOptionsInterfacebuiltinComparator - a BuiltinComparator type.public ColumnFamilyOptions setComparator(AbstractComparator<? extends AbstractSlice<?>> comparator)
ColumnFamilyOptionsInterfacesetComparator in interface ColumnFamilyOptionsInterfacecomparator - java instance.public ColumnFamilyOptions setMergeOperatorName(java.lang.String name)
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.
setMergeOperatorName in interface ColumnFamilyOptionsInterfacename - 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".public ColumnFamilyOptions setMergeOperator(MergeOperator mergeOperator)
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.
setMergeOperator in interface ColumnFamilyOptionsInterfacemergeOperator - MergeOperator instance.public ColumnFamilyOptions setCompactionFilter(AbstractCompactionFilter<? extends AbstractSlice<?>> compactionFilter)
public ColumnFamilyOptions setWriteBufferSize(long writeBufferSize)
MutableColumnFamilyOptionsInterfacemax_write_buffer_number write 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: 4MBsetWriteBufferSize in interface MutableColumnFamilyOptionsInterfacewriteBufferSize - the size of write buffer.public long writeBufferSize()
MutableColumnFamilyOptionsInterfacewriteBufferSize in interface MutableColumnFamilyOptionsInterfaceMutableColumnFamilyOptionsInterface.setWriteBufferSize(long)public ColumnFamilyOptions setMaxWriteBufferNumber(int maxWriteBufferNumber)
MutableColumnFamilyOptionsInterfacesetMaxWriteBufferNumber in interface MutableColumnFamilyOptionsInterfacemaxWriteBufferNumber - maximum number of write buffers.public int maxWriteBufferNumber()
MutableColumnFamilyOptionsInterfacemaxWriteBufferNumber in interface MutableColumnFamilyOptionsInterfaceMutableColumnFamilyOptionsInterface.setMaxWriteBufferNumber(int)public ColumnFamilyOptions setMinWriteBufferNumberToMerge(int minWriteBufferNumberToMerge)
ColumnFamilyOptionsInterfacesetMinWriteBufferNumberToMerge in interface ColumnFamilyOptionsInterfaceminWriteBufferNumberToMerge - the minimum number of write buffers
that will be merged together.public int minWriteBufferNumberToMerge()
ColumnFamilyOptionsInterfaceminWriteBufferNumberToMerge in interface ColumnFamilyOptionsInterfacepublic ColumnFamilyOptions useFixedLengthPrefixExtractor(int n)
ColumnFamilyOptionsInterfaceuseFixedLengthPrefixExtractor in interface ColumnFamilyOptionsInterfacen - use the first n bytes of a key as its prefix.public ColumnFamilyOptions useCappedPrefixExtractor(int n)
ColumnFamilyOptionsInterfaceuseCappedPrefixExtractor in interface ColumnFamilyOptionsInterfacen - use the first n bytes of a key as its prefix.public ColumnFamilyOptions setCompressionType(CompressionType compressionType)
ColumnFamilyOptionsInterfacesetCompressionType in interface ColumnFamilyOptionsInterfacecompressionType - Compression Type.public CompressionType compressionType()
ColumnFamilyOptionsInterfacecompressionType in interface ColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setCompressionPerLevel(java.util.List<CompressionType> compressionLevels)
ColumnFamilyOptionsInterfaceDifferent 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 determines L0,
but other elements of the array are based on base level
(the level L0 files are merged to), and may not
match the level users see from info log for metadata.
If L0 files are merged to level - n,
then, for i>0, compression_per_level[i]
determines compaction type for level n+i-1.
For example, if we have 5 levels, and we determine to
merge L0 data to L4 (which means L1..L3
will be empty), then the new files go to L4 uses
compression type compression_per_level[1].
If now L0 is merged to L2. Data goes to
L2 will be compressed according to
compression_per_level[1], L3 using
compression_per_level[2]and L4 using
compression_per_level[3]. Compaction for each
level can change when data grows.
Default: empty
setCompressionPerLevel in interface ColumnFamilyOptionsInterfacecompressionLevels - list of
CompressionType instances.public java.util.List<CompressionType> compressionPerLevel()
ColumnFamilyOptionsInterfaceReturn the currently set CompressionType
per instances.
See: ColumnFamilyOptionsInterface.setCompressionPerLevel(java.util.List)
compressionPerLevel in interface ColumnFamilyOptionsInterfaceCompressionType
instances.public ColumnFamilyOptions setNumLevels(int numLevels)
ColumnFamilyOptionsInterfacesetNumLevels in interface ColumnFamilyOptionsInterfacenumLevels - the number of levels.public int numLevels()
ColumnFamilyOptionsInterfacenumLevels in interface ColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setLevelZeroFileNumCompactionTrigger(int numFiles)
ColumnFamilyOptionsInterfacesetLevelZeroFileNumCompactionTrigger in interface ColumnFamilyOptionsInterfacenumFiles - the number of files in level-0 to trigger compaction.public int levelZeroFileNumCompactionTrigger()
ColumnFamilyOptionsInterfacelevelZeroFileNumCompactionTrigger in interface ColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setLevelZeroSlowdownWritesTrigger(int numFiles)
ColumnFamilyOptionsInterfacesetLevelZeroSlowdownWritesTrigger in interface ColumnFamilyOptionsInterfacenumFiles - soft limit on number of level-0 files.public int levelZeroSlowdownWritesTrigger()
ColumnFamilyOptionsInterfacelevelZeroSlowdownWritesTrigger in interface ColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setLevelZeroStopWritesTrigger(int numFiles)
ColumnFamilyOptionsInterfacesetLevelZeroStopWritesTrigger in interface ColumnFamilyOptionsInterfacenumFiles - the hard limit of the number of level-0 files.public int levelZeroStopWritesTrigger()
ColumnFamilyOptionsInterfacelevelZeroStopWritesTrigger in interface ColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setMaxMemCompactionLevel(int maxMemCompactionLevel)
ColumnFamilyOptionsInterfacesetMaxMemCompactionLevel in interface ColumnFamilyOptionsInterfacemaxMemCompactionLevel - Unused.public int maxMemCompactionLevel()
ColumnFamilyOptionsInterfacemaxMemCompactionLevel in interface ColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setTargetFileSizeBase(long targetFileSizeBase)
MutableColumnFamilyOptionsInterfacesetTargetFileSizeBase in interface MutableColumnFamilyOptionsInterfacetargetFileSizeBase - the target size of a level-0 file.MutableColumnFamilyOptionsInterface.setTargetFileSizeMultiplier(int)public long targetFileSizeBase()
MutableColumnFamilyOptionsInterfacetargetFileSizeBase in interface MutableColumnFamilyOptionsInterfaceMutableColumnFamilyOptionsInterface.targetFileSizeMultiplier()public ColumnFamilyOptions setTargetFileSizeMultiplier(int multiplier)
MutableColumnFamilyOptionsInterfacesetTargetFileSizeMultiplier in interface MutableColumnFamilyOptionsInterfacemultiplier - the size ratio between a level-(L+1) file
and level-L file.public int targetFileSizeMultiplier()
MutableColumnFamilyOptionsInterfacetargetFileSizeMultiplier in interface MutableColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setMaxBytesForLevelBase(long maxBytesForLevelBase)
MutableColumnFamilyOptionsInterfacesetMaxBytesForLevelBase in interface MutableColumnFamilyOptionsInterfacemaxBytesForLevelBase - maximum bytes for level base.MutableColumnFamilyOptionsInterface.setMaxBytesForLevelMultiplier(double)public long maxBytesForLevelBase()
MutableColumnFamilyOptionsInterfacemaxBytesForLevelBase in interface MutableColumnFamilyOptionsInterfaceMutableColumnFamilyOptionsInterface.maxBytesForLevelMultiplier()public ColumnFamilyOptions setLevelCompactionDynamicLevelBytes(boolean enableLevelCompactionDynamicLevelBytes)
ColumnFamilyOptionsInterfaceIf 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
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_multiplier of 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.
For example, assume max_bytes_for_level_multiplier=10,
num_levels=6, and max_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_multiplier a priority
against max_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_additional is 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
setLevelCompactionDynamicLevelBytes in interface ColumnFamilyOptionsInterfaceenableLevelCompactionDynamicLevelBytes - boolean value indicating
if LevelCompactionDynamicLevelBytes shall be enabled.public boolean levelCompactionDynamicLevelBytes()
ColumnFamilyOptionsInterfaceReturn if LevelCompactionDynamicLevelBytes is enabled.
For further information see
ColumnFamilyOptionsInterface.setLevelCompactionDynamicLevelBytes(boolean)
levelCompactionDynamicLevelBytes in interface ColumnFamilyOptionsInterfacelevelCompactionDynamicLevelBytes is enabled.public ColumnFamilyOptions setMaxBytesForLevelMultiplier(double multiplier)
ColumnFamilyOptionsInterfacesetMaxBytesForLevelMultiplier in interface ColumnFamilyOptionsInterfacesetMaxBytesForLevelMultiplier in interface MutableColumnFamilyOptionsInterfacemultiplier - the ratio between the total size of level-(L+1)
files and the total size of level-L files for all L.MutableColumnFamilyOptionsInterface.setMaxBytesForLevelBase(long)public double maxBytesForLevelMultiplier()
ColumnFamilyOptionsInterfacemaxBytesForLevelMultiplier in interface ColumnFamilyOptionsInterfacemaxBytesForLevelMultiplier in interface MutableColumnFamilyOptionsInterfaceMutableColumnFamilyOptionsInterface.maxBytesForLevelBase()public ColumnFamilyOptions setMaxCompactionBytes(long maxCompactionBytes)
ColumnFamilyOptionsInterfacesetMaxCompactionBytes in interface ColumnFamilyOptionsInterfacesetMaxCompactionBytes in interface MutableColumnFamilyOptionsInterfacemaxCompactionBytes - the compaction size limitMutableColumnFamilyOptionsInterface.maxCompactionBytes()public long maxCompactionBytes()
ColumnFamilyOptionsInterfacemaxCompactionBytes in interface ColumnFamilyOptionsInterfacemaxCompactionBytes in interface MutableColumnFamilyOptionsInterfaceMutableColumnFamilyOptionsInterface.setMaxCompactionBytes(long)public ColumnFamilyOptions setSoftRateLimit(double softRateLimit)
ColumnFamilyOptionsInterfacesetSoftRateLimit in interface ColumnFamilyOptionsInterfacesetSoftRateLimit in interface MutableColumnFamilyOptionsInterfacesoftRateLimit - the soft-rate-limit of a compaction score
for put delay.public double softRateLimit()
ColumnFamilyOptionsInterfacesoftRateLimit in interface ColumnFamilyOptionsInterfacesoftRateLimit in interface MutableColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setHardRateLimit(double hardRateLimit)
ColumnFamilyOptionsInterfacesetHardRateLimit in interface ColumnFamilyOptionsInterfacesetHardRateLimit in interface MutableColumnFamilyOptionsInterfacehardRateLimit - the hard-rate-limit of a compaction score for put
delay.public double hardRateLimit()
ColumnFamilyOptionsInterfacehardRateLimit in interface ColumnFamilyOptionsInterfacehardRateLimit in interface MutableColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setRateLimitDelayMaxMilliseconds(int rateLimitDelayMaxMilliseconds)
ColumnFamilyOptionsInterfacesetRateLimitDelayMaxMilliseconds in interface ColumnFamilyOptionsInterfacerateLimitDelayMaxMilliseconds - the maximum time interval a put
will be stalled.public int rateLimitDelayMaxMilliseconds()
ColumnFamilyOptionsInterfacerateLimitDelayMaxMilliseconds in interface ColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setArenaBlockSize(long arenaBlockSize)
MutableColumnFamilyOptionsInterfacesetArenaBlockSize in interface MutableColumnFamilyOptionsInterfacearenaBlockSize - the size of an arena blockpublic long arenaBlockSize()
MutableColumnFamilyOptionsInterfacearenaBlockSize in interface MutableColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setDisableAutoCompactions(boolean disableAutoCompactions)
MutableColumnFamilyOptionsInterfacesetDisableAutoCompactions in interface MutableColumnFamilyOptionsInterfacedisableAutoCompactions - true if auto-compactions are disabled.public boolean disableAutoCompactions()
MutableColumnFamilyOptionsInterfacedisableAutoCompactions in interface MutableColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setPurgeRedundantKvsWhileFlush(boolean purgeRedundantKvsWhileFlush)
ColumnFamilyOptionsInterfacesetPurgeRedundantKvsWhileFlush in interface ColumnFamilyOptionsInterfacepurgeRedundantKvsWhileFlush - true if purging keys is disabled.public boolean purgeRedundantKvsWhileFlush()
ColumnFamilyOptionsInterfacepurgeRedundantKvsWhileFlush in interface ColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setCompactionStyle(CompactionStyle compactionStyle)
ColumnFamilyOptionsInterfacesetCompactionStyle in interface ColumnFamilyOptionsInterfacecompactionStyle - Compaction style.public CompactionStyle compactionStyle()
ColumnFamilyOptionsInterfacecompactionStyle in interface ColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setMaxTableFilesSizeFIFO(long maxTableFilesSize)
ColumnFamilyOptionsInterfacesetMaxTableFilesSizeFIFO in interface ColumnFamilyOptionsInterfacemaxTableFilesSize - the size limit of the total sum of table files.public long maxTableFilesSizeFIFO()
ColumnFamilyOptionsInterfacemaxTableFilesSizeFIFO in interface ColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setVerifyChecksumsInCompaction(boolean verifyChecksumsInCompaction)
MutableColumnFamilyOptionsInterfacesetVerifyChecksumsInCompaction in interface MutableColumnFamilyOptionsInterfaceverifyChecksumsInCompaction - true if compaction verifies
checksum on every read.public boolean verifyChecksumsInCompaction()
MutableColumnFamilyOptionsInterfaceverifyChecksumsInCompaction in interface MutableColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setMaxSequentialSkipInIterations(long maxSequentialSkipInIterations)
MutableColumnFamilyOptionsInterfacesetMaxSequentialSkipInIterations in interface MutableColumnFamilyOptionsInterfacemaxSequentialSkipInIterations - the number of keys could
be skipped in a iteration.public long maxSequentialSkipInIterations()
MutableColumnFamilyOptionsInterfacemaxSequentialSkipInIterations in interface MutableColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setMemTableConfig(MemTableConfig config)
ColumnFamilyOptionsInterfacesetMemTableConfig in interface ColumnFamilyOptionsInterfaceconfig - the mem-table config.public java.lang.String memTableFactoryName()
ColumnFamilyOptionsInterfacememTableFactoryName in interface ColumnFamilyOptionsInterfaceColumnFamilyOptionsInterface.setTableFormatConfig(org.rocksdb.TableFormatConfig)public ColumnFamilyOptions setTableFormatConfig(TableFormatConfig config)
ColumnFamilyOptionsInterfacesetTableFormatConfig in interface ColumnFamilyOptionsInterfaceconfig - the table format config.public java.lang.String tableFactoryName()
tableFactoryName in interface ColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setInplaceUpdateSupport(boolean inplaceUpdateSupport)
ColumnFamilyOptionsInterfacesetInplaceUpdateSupport in interface ColumnFamilyOptionsInterfaceinplaceUpdateSupport - true if thread-safe inplace updates
are allowed.public boolean inplaceUpdateSupport()
ColumnFamilyOptionsInterfaceinplaceUpdateSupport in interface ColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setInplaceUpdateNumLocks(long inplaceUpdateNumLocks)
MutableColumnFamilyOptionsInterfacesetInplaceUpdateNumLocks in interface MutableColumnFamilyOptionsInterfaceinplaceUpdateNumLocks - the number of locks used for
inplace updates.public long inplaceUpdateNumLocks()
MutableColumnFamilyOptionsInterfaceinplaceUpdateNumLocks in interface MutableColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setMemtablePrefixBloomSizeRatio(double memtablePrefixBloomSizeRatio)
MutableColumnFamilyOptionsInterfacesetMemtablePrefixBloomSizeRatio in interface MutableColumnFamilyOptionsInterfacememtablePrefixBloomSizeRatio - The ratiopublic double memtablePrefixBloomSizeRatio()
MutableColumnFamilyOptionsInterfacememtablePrefixBloomSizeRatio in interface MutableColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setBloomLocality(int bloomLocality)
ColumnFamilyOptionsInterfacesetBloomLocality in interface ColumnFamilyOptionsInterfacebloomLocality - the level of locality of bloom-filter probes.public int bloomLocality()
ColumnFamilyOptionsInterfacebloomLocality in interface ColumnFamilyOptionsInterfaceColumnFamilyOptionsInterface.setBloomLocality(int)public ColumnFamilyOptions setMaxSuccessiveMerges(long maxSuccessiveMerges)
MutableColumnFamilyOptionsInterfacesetMaxSuccessiveMerges in interface MutableColumnFamilyOptionsInterfacemaxSuccessiveMerges - the maximum number of successive merges.public long maxSuccessiveMerges()
MutableColumnFamilyOptionsInterfacemaxSuccessiveMerges in interface MutableColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setMinPartialMergeOperands(int minPartialMergeOperands)
ColumnFamilyOptionsInterfacesetMinPartialMergeOperands in interface ColumnFamilyOptionsInterfaceminPartialMergeOperands - min partial merge operandspublic int minPartialMergeOperands()
ColumnFamilyOptionsInterfaceminPartialMergeOperands in interface ColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setOptimizeFiltersForHits(boolean optimizeFiltersForHits)
ColumnFamilyOptionsInterfaceThis 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
setOptimizeFiltersForHits in interface ColumnFamilyOptionsInterfaceoptimizeFiltersForHits - boolean value indicating if this flag is set.public boolean optimizeFiltersForHits()
ColumnFamilyOptionsInterfaceReturns the current state of the optimize_filters_for_hits
setting.
optimizeFiltersForHits in interface ColumnFamilyOptionsInterfaceoptimize_filters_for_hits was set.public ColumnFamilyOptions setMemtableHugePageSize(long memtableHugePageSize)
MutableColumnFamilyOptionsInterfacesetMemtableHugePageSize in interface MutableColumnFamilyOptionsInterfacememtableHugePageSize - The page size of the huge
page tlbpublic long memtableHugePageSize()
MutableColumnFamilyOptionsInterfacememtableHugePageSize in interface MutableColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setSoftPendingCompactionBytesLimit(long softPendingCompactionBytesLimit)
MutableColumnFamilyOptionsInterfacesetSoftPendingCompactionBytesLimit in interface MutableColumnFamilyOptionsInterfacesoftPendingCompactionBytesLimit - The soft limit to impose on
compactionpublic long softPendingCompactionBytesLimit()
MutableColumnFamilyOptionsInterfacesoftPendingCompactionBytesLimit in interface MutableColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setHardPendingCompactionBytesLimit(long hardPendingCompactionBytesLimit)
MutableColumnFamilyOptionsInterfacesetHardPendingCompactionBytesLimit in interface MutableColumnFamilyOptionsInterfacehardPendingCompactionBytesLimit - The hard limit to impose on
compactionpublic long hardPendingCompactionBytesLimit()
MutableColumnFamilyOptionsInterfacehardPendingCompactionBytesLimit in interface MutableColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setLevel0FileNumCompactionTrigger(int level0FileNumCompactionTrigger)
MutableColumnFamilyOptionsInterfacesetLevel0FileNumCompactionTrigger in interface MutableColumnFamilyOptionsInterfacelevel0FileNumCompactionTrigger - The number of files to trigger
level-0 compactionpublic int level0FileNumCompactionTrigger()
MutableColumnFamilyOptionsInterfacelevel0FileNumCompactionTrigger in interface MutableColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setLevel0SlowdownWritesTrigger(int level0SlowdownWritesTrigger)
MutableColumnFamilyOptionsInterfacesetLevel0SlowdownWritesTrigger in interface MutableColumnFamilyOptionsInterfacelevel0SlowdownWritesTrigger - The soft limit on the number of
level-0 filespublic int level0SlowdownWritesTrigger()
MutableColumnFamilyOptionsInterfacelevel0SlowdownWritesTrigger in interface MutableColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setLevel0StopWritesTrigger(int level0StopWritesTrigger)
MutableColumnFamilyOptionsInterfacesetLevel0StopWritesTrigger in interface MutableColumnFamilyOptionsInterfacelevel0StopWritesTrigger - The maximum number of level-0 filespublic int level0StopWritesTrigger()
MutableColumnFamilyOptionsInterfacelevel0StopWritesTrigger in interface MutableColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setMaxBytesForLevelMultiplierAdditional(int[] maxBytesForLevelMultiplierAdditional)
MutableColumnFamilyOptionsInterfacesetMaxBytesForLevelMultiplierAdditional in interface MutableColumnFamilyOptionsInterfacemaxBytesForLevelMultiplierAdditional - The max-size multipliers
for each levelpublic int[] maxBytesForLevelMultiplierAdditional()
MutableColumnFamilyOptionsInterfacemaxBytesForLevelMultiplierAdditional in interface MutableColumnFamilyOptionsInterfacepublic ColumnFamilyOptions setParanoidFileChecks(boolean paranoidFileChecks)
MutableColumnFamilyOptionsInterfacesetParanoidFileChecks in interface MutableColumnFamilyOptionsInterfaceparanoidFileChecks - true to enable paranoid file checkspublic boolean paranoidFileChecks()
MutableColumnFamilyOptionsInterfaceparanoidFileChecks in interface MutableColumnFamilyOptionsInterfaceprotected final void disposeInternal(long handle)
disposeInternal in class RocksObject