ColumnFamilyOptions (schwefel 6.15.5.1 API)

java.lang.Object
- org.rocksdb.AbstractNativeReference
- - org.rocksdb.AbstractImmutableNativeReference
  - - org.rocksdb.RocksObject
    - - org.rocksdb.ColumnFamilyOptions

All Implemented Interfaces:

AutoCloseable, AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>, AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>, ColumnFamilyOptionsInterface<ColumnFamilyOptions>, MutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
```
public class ColumnFamilyOptions
extends RocksObject
implements ColumnFamilyOptionsInterface<ColumnFamilyOptions>, MutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
```
ColumnFamilyOptions to control the behavior of a database. It will be used during the creation of a 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.

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

Constructor Summary

Constructors
Constructor and Description
`ColumnFamilyOptions()` Construct ColumnFamilyOptions.
`ColumnFamilyOptions(ColumnFamilyOptions other)` Copy constructor for ColumnFamilyOptions.
`ColumnFamilyOptions(Options options)` Constructor from Options

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.
`CompressionOptions`	`bottommostCompressionOptions()` Get the bottom most compression options.
`CompressionType`	`bottommostCompressionType()` Compression algorithm that will be used for the bottommost level that contain files.
`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.
`CompactionOptionsFIFO`	`compactionOptionsFIFO()` The options for FIFO compaction style
`CompactionOptionsUniversal`	`compactionOptionsUniversal()` The options needed to support Universal Style compactions
`CompactionPriority`	`compactionPriority()` Get the Compaction priority if level compaction is used for all levels
`CompactionStyle`	`compactionStyle()` Compaction style for DB.
`ConcurrentTaskLimiter`	`compactionThreadLimiter()` Get compaction thread limiter
`CompressionOptions`	`compressionOptions()` Get the different options for compression algorithms
`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)`
`boolean`	`forceConsistencyChecks()` In debug mode, RocksDB run consistency checks on the LSM every time the LSM change (Flush, Compaction, AddFile).
`static ColumnFamilyOptions`	`getColumnFamilyOptionsFromProps(ConfigOptions cfgOpts, Properties properties)` Method to get a options instance by using pre-configured property values.
`static ColumnFamilyOptions`	`getColumnFamilyOptionsFromProps(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.
`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)
`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.
`int`	`maxWriteBufferNumberToMaintain()` The total maximum number of write buffers to maintain in memory including copies of buffers that have already been flushed.
`MemTableConfig`	`memTableConfig()` Get the config for mem-table.
`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`	`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.
`ColumnFamilyOptions`	`oldDefaults(int majorVersion, int minorVersion)` The function recovers options to a previous version.
`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. you'll never use an iterator, only Put() and Get() API calls
`ColumnFamilyOptions`	`optimizeForSmallDb()` Use this if your DB is very small (like under 1GB) and you don't want to spend lots of memory for memtables.
`ColumnFamilyOptions`	`optimizeForSmallDb(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.
`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`	`reportBgIoStats()` Determine whether IO stats in compactions and flushes are being measured
`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`	`setBottommostCompressionOptions(CompressionOptions bottommostCompressionOptions)` Set the options for compression algorithms used by `ColumnFamilyOptionsInterface.bottommostCompressionType()` if it is enabled.
`ColumnFamilyOptions`	`setBottommostCompressionType(CompressionType bottommostCompressionType)` Compression algorithm that will be used for the bottommost level that contain files.
`ColumnFamilyOptions`	`setCfPaths(Collection<DbPath> cfPaths)` A list of paths where SST files for this column family can be put into, with its target size.
`ColumnFamilyOptions`	`setCompactionFilter(AbstractCompactionFilter<? extends AbstractSlice<?>> compactionFilter)` A single CompactionFilter instance to call into during compaction.
`ColumnFamilyOptions`	`setCompactionFilterFactory(AbstractCompactionFilterFactory<? extends AbstractCompactionFilter<?>> compactionFilterFactory)` This is a factory that provides `AbstractCompactionFilter` objects which allow an application to modify/delete a key-value during background compaction.
`ColumnFamilyOptions`	`setCompactionOptionsFIFO(CompactionOptionsFIFO compactionOptionsFIFO)` The options for FIFO compaction style
`ColumnFamilyOptions`	`setCompactionOptionsUniversal(CompactionOptionsUniversal compactionOptionsUniversal)` Set the options needed to support Universal Style compactions
`ColumnFamilyOptions`	`setCompactionPriority(CompactionPriority compactionPriority)` If level `AdvancedColumnFamilyOptionsInterface.compactionStyle()` == `CompactionStyle.LEVEL`, for each level, which files are prioritized to be picked to compact.
`ColumnFamilyOptions`	`setCompactionStyle(CompactionStyle compactionStyle)` Set compaction style for DB.
`ColumnFamilyOptions`	`setCompactionThreadLimiter(ConcurrentTaskLimiter compactionThreadLimiter)` Compaction concurrent thread limiter for the column family.
`ColumnFamilyOptions`	`setComparator(AbstractComparator comparator)` Use the specified comparator for key ordering.
`ColumnFamilyOptions`	`setComparator(BuiltinComparator builtinComparator)` Set `BuiltinComparator` to be used with RocksDB.
`ColumnFamilyOptions`	`setCompressionOptions(CompressionOptions compressionOptions)` Set the different options for compression algorithms
`ColumnFamilyOptions`	`setCompressionPerLevel(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`	`setForceConsistencyChecks(boolean forceConsistencyChecks)` In debug mode, RocksDB run consistency checks on the LSM every time the LSM change (Flush, Compaction, AddFile).
`ColumnFamilyOptions`	`setHardPendingCompactionBytesLimit(long hardPendingCompactionBytesLimit)` All writes are stopped if estimated bytes needed to be compaction exceed this threshold.
`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`	`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`	`setMaxWriteBufferNumberToMaintain(int maxWriteBufferNumberToMaintain)` The total maximum number of write buffers to maintain in memory including copies of buffers that have already been flushed.
`ColumnFamilyOptions`	`setMemTableConfig(MemTableConfig memTableConfig)` 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(String name)` Set the merge operator to be used for merging two merge operands of the same key.
`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`	`setReportBgIoStats(boolean reportBgIoStats)` Measure IO stats in compactions and flushes, if true.
`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`	`setSstPartitionerFactory(SstPartitionerFactory sstPartitionerFactory)` If non-nullptr, use the specified factory for a function to determine the partitioning of sst files.
`ColumnFamilyOptions`	`setTableFormatConfig(TableFormatConfig tableFormatConfig)` 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`	`setTtl(long ttl)` Non-bottom-level files older than TTL will go through the compaction process.
`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.
`SstPartitionerFactory`	`sstPartitionerFactory()` Get SST partitioner factory
`String`	`tableFactoryName()`
`TableFormatConfig`	`tableFormatConfig()` Get the config for table format.
`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.
`long`	`ttl()` Get the TTL for Non-bottom-level files that will go through the compaction process.
`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.
`long`	`writeBufferSize()` Return size of write buffer size.

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

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ColumnFamilyOptions
```
public ColumnFamilyOptions()
```
    Construct ColumnFamilyOptions. This constructor will create (by allocating a block of memory) an rocksdb::ColumnFamilyOptions in the c++ side.
  - ColumnFamilyOptions
```
public ColumnFamilyOptions(ColumnFamilyOptions other)
```
    Copy constructor for ColumnFamilyOptions. NOTE: This does a shallow copy, which means comparator, merge_operator, compaction_filter, compaction_filter_factory and other pointers will be cloned!
    
    Parameters:
    
    other - The ColumnFamilyOptions to copy.
  - ColumnFamilyOptions
```
public ColumnFamilyOptions(Options options)
```
    Constructor from Options
    
    Parameters:
    
    options - The options.
- Method Detail
  - getColumnFamilyOptionsFromProps
```
public static ColumnFamilyOptions getColumnFamilyOptionsFromProps(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.
    
    Parameters:
    
    properties - Properties instance.
    
    Returns:
    
    instance or null.
    
    Throws:
    
    IllegalArgumentException - if null or empty Properties instance is passed to the method call.
  - getColumnFamilyOptionsFromProps
```
public static ColumnFamilyOptions getColumnFamilyOptionsFromProps(ConfigOptions cfgOpts,
                                                                  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.
    
    Parameters:
    
    cfgOpts - ConfigOptions controlling how the properties are parsed.
    
    properties - Properties instance.
    
    Returns:
    
    instance or null.
    
    Throws:
    
    IllegalArgumentException - if null or empty Properties instance is passed to the method call.
  - oldDefaults
```
public ColumnFamilyOptions oldDefaults(int majorVersion,
                                       int minorVersion)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    The function recovers options to a previous version. Only 4.6 or later versions are supported.
    
    Specified by:
    
    oldDefaults in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    majorVersion - the major version
    
    minorVersion - the minor version
    
    Returns:
    
    the instance of the current object.
  - optimizeForSmallDb
```
public ColumnFamilyOptions optimizeForSmallDb()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Use this if your DB is very small (like under 1GB) and you don't want to spend lots of memory for memtables.
    
    Specified by:
    
    optimizeForSmallDb in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    the instance of the current object.
  - optimizeForSmallDb
```
public ColumnFamilyOptions optimizeForSmallDb(Cache cache)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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. An optional cache object is passed in to be used as the block cache
    
    Specified by:
    
    optimizeForSmallDb in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    cache - optional cache object to be used as the block cache
    
    Returns:
    
    the instance of the current object.
  - optimizeForPointLookup
```
public ColumnFamilyOptions optimizeForPointLookup(long blockCacheSizeMb)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Use 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:
    
    optimizeForPointLookup in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    blockCacheSizeMb - Block cache size in MB
    
    Returns:
    
    the instance of the current object.
  - optimizeLevelStyleCompaction
```
public ColumnFamilyOptions optimizeLevelStyleCompaction()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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. 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:
    
    optimizeLevelStyleCompaction in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    the instance of the current object.
  - optimizeLevelStyleCompaction
```
public ColumnFamilyOptions optimizeLevelStyleCompaction(long memtableMemoryBudget)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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. 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:
    
    optimizeLevelStyleCompaction in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    memtableMemoryBudget - memory budget in bytes
    
    Returns:
    
    the instance of the current object.
  - optimizeUniversalStyleCompaction
```
public ColumnFamilyOptions optimizeUniversalStyleCompaction()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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. 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:
    
    optimizeUniversalStyleCompaction in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    the instance of the current object.
  - optimizeUniversalStyleCompaction
```
public ColumnFamilyOptions optimizeUniversalStyleCompaction(long memtableMemoryBudget)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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. 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:
    
    optimizeUniversalStyleCompaction in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    memtableMemoryBudget - memory budget in bytes
    
    Returns:
    
    the instance of the current object.
  - setComparator
```
public ColumnFamilyOptions setComparator(BuiltinComparator builtinComparator)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Set BuiltinComparator to be used with RocksDB. Note: Comparator can be set once upon database creation. Default: BytewiseComparator.
    
    Specified by:
    
    setComparator in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    builtinComparator - a BuiltinComparator type.
    
    Returns:
    
    the instance of the current object.
  - setComparator
```
public ColumnFamilyOptions setComparator(AbstractComparator comparator)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Use 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:
    
    setComparator in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    comparator - java instance.
    
    Returns:
    
    the instance of the current object.
  - setMergeOperatorName
```
public ColumnFamilyOptions setMergeOperatorName(String name)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Set 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:
    
    setMergeOperatorName in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    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 ColumnFamilyOptions setMergeOperator(MergeOperator mergeOperator)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Set 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:
    
    setMergeOperator in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    mergeOperator - MergeOperator instance.
    
    Returns:
    
    the instance of the current object.
  - setCompactionFilter
```
public ColumnFamilyOptions setCompactionFilter(AbstractCompactionFilter<? extends AbstractSlice<?>> compactionFilter)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    A 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 call ColumnFamilyOptionsInterface.setCompactionFilterFactory(AbstractCompactionFilterFactory) instead. The client should specify only set one of the two. ColumnFamilyOptionsInterface.setCompactionFilter(AbstractCompactionFilter) takes precedence over ColumnFamilyOptionsInterface.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:
    
    setCompactionFilter in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    compactionFilter - AbstractCompactionFilter instance.
    
    Returns:
    
    the instance of the current object.
  - compactionFilter
```
public AbstractCompactionFilter<? extends AbstractSlice<?>> compactionFilter()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Accessor for the CompactionFilter instance in use.
    
    Specified by:
    
    compactionFilter in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    Reference to the CompactionFilter, or null if one hasn't been set.
  - setCompactionFilterFactory
```
public ColumnFamilyOptions setCompactionFilterFactory(AbstractCompactionFilterFactory<? extends AbstractCompactionFilter<?>> compactionFilterFactory)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    This is a factory that provides AbstractCompactionFilter objects 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:
    
    setCompactionFilterFactory in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    compactionFilterFactory - AbstractCompactionFilterFactory instance.
    
    Returns:
    
    the instance of the current object.
  - compactionFilterFactory
```
public AbstractCompactionFilterFactory<? extends AbstractCompactionFilter<?>> compactionFilterFactory()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Accessor for the CompactionFilterFactory instance in use.
    
    Specified by:
    
    compactionFilterFactory in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    Reference to the CompactionFilterFactory, or null if one hasn't been set.
  - setWriteBufferSize
```
public ColumnFamilyOptions setWriteBufferSize(long writeBufferSize)
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    Amount 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 to max_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: 64MB
    
    Specified by:
    
    setWriteBufferSize in interface MutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    writeBufferSize - the size of write buffer.
    
    Returns:
    
    the instance of the current object.
  - writeBufferSize
```
public long writeBufferSize()
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    Return size of write buffer size.
    
    Specified by:
    
    writeBufferSize in interface MutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    size of write buffer.
    
    See Also:
    
    MutableColumnFamilyOptionsInterface.setWriteBufferSize(long)
  - setMaxWriteBufferNumber
```
public ColumnFamilyOptions setMaxWriteBufferNumber(int maxWriteBufferNumber)
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    The 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:
    
    setMaxWriteBufferNumber in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    maxWriteBufferNumber - maximum number of write buffers.
    
    Returns:
    
    the instance of the current options.
  - maxWriteBufferNumber
```
public int maxWriteBufferNumber()
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    Returns maximum number of write buffers.
    
    Specified by:
    
    maxWriteBufferNumber in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    maximum number of write buffers.
    
    See Also:
    
    AdvancedMutableColumnFamilyOptionsInterface.setMaxWriteBufferNumber(int)
  - setMinWriteBufferNumberToMerge
```
public ColumnFamilyOptions setMinWriteBufferNumberToMerge(int minWriteBufferNumberToMerge)
```
    Description copied from interface: AdvancedColumnFamilyOptionsInterface
    
    The 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:
    
    setMinWriteBufferNumberToMerge in interface AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    minWriteBufferNumberToMerge - the minimum number of write buffers that will be merged together.
    
    Returns:
    
    the reference to the current options.
  - minWriteBufferNumberToMerge
```
public int minWriteBufferNumberToMerge()
```
    Description copied from interface: AdvancedColumnFamilyOptionsInterface
    
    The 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:
    
    minWriteBufferNumberToMerge in interface AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    the minimum number of write buffers that will be merged together.
  - useFixedLengthPrefixExtractor
```
public ColumnFamilyOptions useFixedLengthPrefixExtractor(int n)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    This 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:
    
    useFixedLengthPrefixExtractor in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    n - use the first n bytes of a key as its prefix.
    
    Returns:
    
    the reference to the current option.
  - useCappedPrefixExtractor
```
public ColumnFamilyOptions useCappedPrefixExtractor(int n)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Same as fixed length prefix extractor, except that when slice is shorter than the fixed length, it will use the full key.
    
    Specified by:
    
    useCappedPrefixExtractor in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    n - use the first n bytes of a key as its prefix.
    
    Returns:
    
    the reference to the current option.
  - setCompressionType
```
public ColumnFamilyOptions setCompressionType(CompressionType compressionType)
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    Compress blocks using the specified compression algorithm. This parameter can be changed dynamically. Default: SNAPPY_COMPRESSION, which gives lightweight but fast compression.
    
    Specified by:
    
    setCompressionType in interface MutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    compressionType - Compression Type.
    
    Returns:
    
    the reference to the current option.
  - compressionType
```
public CompressionType compressionType()
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    Compress blocks using the specified compression algorithm. This parameter can be changed dynamically. Default: SNAPPY_COMPRESSION, which gives lightweight but fast compression.
    
    Specified by:
    
    compressionType in interface MutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    Compression type.
  - setCompressionPerLevel
```
public ColumnFamilyOptions setCompressionPerLevel(List<CompressionType> compressionLevels)
```
    Description copied from interface: AdvancedColumnFamilyOptionsInterface
    
    Different 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'.
    NOTICE
    If 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.
    Example
    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
    
    Specified by:
    
    setCompressionPerLevel in interface AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    compressionLevels - list of CompressionType instances.
    
    Returns:
    
    the reference to the current options.
  - compressionPerLevel
```
public List<CompressionType> compressionPerLevel()
```
    Description copied from interface: AdvancedColumnFamilyOptionsInterface
    
    Return the currently set CompressionType per instances.
    
    See: AdvancedColumnFamilyOptionsInterface.setCompressionPerLevel(java.util.List)
    
    Specified by:
    
    compressionPerLevel in interface AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    list of CompressionType instances.
  - setBottommostCompressionType
```
public ColumnFamilyOptions setBottommostCompressionType(CompressionType bottommostCompressionType)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Compression 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:
    
    setBottommostCompressionType in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    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: ColumnFamilyOptionsInterface
    
    Compression 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:
    
    bottommostCompressionType in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    The compression type used for the bottommost level
  - setBottommostCompressionOptions
```
public ColumnFamilyOptions setBottommostCompressionOptions(CompressionOptions bottommostCompressionOptions)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Set the options for compression algorithms used by ColumnFamilyOptionsInterface.bottommostCompressionType() if it is enabled. To enable it, please see the definition of CompressionOptions.
    
    Specified by:
    
    setBottommostCompressionOptions in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    bottommostCompressionOptions - the bottom most compression options.
    
    Returns:
    
    the reference of the current options.
  - bottommostCompressionOptions
```
public CompressionOptions bottommostCompressionOptions()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Get the bottom most compression options. See ColumnFamilyOptionsInterface.setBottommostCompressionOptions(CompressionOptions).
    
    Specified by:
    
    bottommostCompressionOptions in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    the bottom most compression options.
  - setCompressionOptions
```
public ColumnFamilyOptions setCompressionOptions(CompressionOptions compressionOptions)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Set the different options for compression algorithms
    
    Specified by:
    
    setCompressionOptions in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    compressionOptions - The compression options
    
    Returns:
    
    the reference of the current options.
  - compressionOptions
```
public CompressionOptions compressionOptions()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Get the different options for compression algorithms
    
    Specified by:
    
    compressionOptions in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    The compression options
  - setNumLevels
```
public ColumnFamilyOptions setNumLevels(int numLevels)
```
    Description copied from interface: AdvancedColumnFamilyOptionsInterface
    
    Set the number of levels for this database If level-styled compaction is used, then this number determines the total number of levels.
    
    Specified by:
    
    setNumLevels in interface AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    numLevels - the number of levels.
    
    Returns:
    
    the reference to the current options.
  - numLevels
```
public int numLevels()
```
    Description copied from interface: AdvancedColumnFamilyOptionsInterface
    
    If level-styled compaction is used, then this number determines the total number of levels.
    
    Specified by:
    
    numLevels in interface AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    the number of levels.
  - setLevelZeroFileNumCompactionTrigger
```
public ColumnFamilyOptions setLevelZeroFileNumCompactionTrigger(int numFiles)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Number 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:
    
    setLevelZeroFileNumCompactionTrigger in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    numFiles - the number of files in level-0 to trigger compaction.
    
    Returns:
    
    the reference to the current option.
  - levelZeroFileNumCompactionTrigger
```
public int levelZeroFileNumCompactionTrigger()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    The 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:
    
    levelZeroFileNumCompactionTrigger in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    the number of files in level 0 to trigger compaction.
  - setLevelZeroSlowdownWritesTrigger
```
public ColumnFamilyOptions setLevelZeroSlowdownWritesTrigger(int numFiles)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Soft 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:
    
    setLevelZeroSlowdownWritesTrigger in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    numFiles - soft limit on number of level-0 files.
    
    Returns:
    
    the reference to the current option.
  - levelZeroSlowdownWritesTrigger
```
public int levelZeroSlowdownWritesTrigger()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Soft 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:
    
    levelZeroSlowdownWritesTrigger in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    the soft limit on the number of level-0 files.
  - setLevelZeroStopWritesTrigger
```
public ColumnFamilyOptions setLevelZeroStopWritesTrigger(int numFiles)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Maximum number of level-0 files. We stop writes at this point.
    
    Specified by:
    
    setLevelZeroStopWritesTrigger in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    numFiles - the hard limit of the number of level-0 files.
    
    Returns:
    
    the reference to the current option.
  - levelZeroStopWritesTrigger
```
public int levelZeroStopWritesTrigger()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Maximum number of level-0 files. We stop writes at this point.
    
    Specified by:
    
    levelZeroStopWritesTrigger in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    the hard limit of the number of level-0 file.
  - setTargetFileSizeBase
```
public ColumnFamilyOptions setTargetFileSizeBase(long targetFileSizeBase)
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    The 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:
    
    setTargetFileSizeBase in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    targetFileSizeBase - the target size of a level-0 file.
    
    Returns:
    
    the reference to the current options.
    
    See Also:
    
    AdvancedMutableColumnFamilyOptionsInterface.setTargetFileSizeMultiplier(int)
  - targetFileSizeBase
```
public long targetFileSizeBase()
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    The 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:
    
    targetFileSizeBase in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    the target size of a level-0 file.
    
    See Also:
    
    AdvancedMutableColumnFamilyOptionsInterface.targetFileSizeMultiplier()
  - setTargetFileSizeMultiplier
```
public ColumnFamilyOptions setTargetFileSizeMultiplier(int multiplier)
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    targetFileSizeMultiplier 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:
    
    setTargetFileSizeMultiplier in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    multiplier - the size ratio between a level-(L+1) file and level-L file.
    
    Returns:
    
    the reference to the current options.
  - targetFileSizeMultiplier
```
public int targetFileSizeMultiplier()
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    targetFileSizeMultiplier 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:
    
    targetFileSizeMultiplier in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    the size ratio between a level-(L+1) file and level-L file.
  - setMaxBytesForLevelBase
```
public ColumnFamilyOptions setMaxBytesForLevelBase(long maxBytesForLevelBase)
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    The 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:
    
    setMaxBytesForLevelBase in interface MutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    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: MutableColumnFamilyOptionsInterface
    
    The 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:
    
    maxBytesForLevelBase in interface MutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    the upper-bound of the total size of level-1 files in bytes. See AdvancedMutableColumnFamilyOptionsInterface.maxBytesForLevelMultiplier()
  - setLevelCompactionDynamicLevelBytes
```
public ColumnFamilyOptions setLevelCompactionDynamicLevelBytes(boolean enableLevelCompactionDynamicLevelBytes)
```
    Description copied from interface: AdvancedColumnFamilyOptionsInterface
    If 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
    1. target size is in the range of (max_bytes_for_level_base / max_bytes_for_level_multiplier, max_bytes_for_level_base]
    2. 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_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.
    
    Example
    
    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
    Specified by:
    
    setLevelCompactionDynamicLevelBytes in interface AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    enableLevelCompactionDynamicLevelBytes - boolean value indicating if LevelCompactionDynamicLevelBytes shall be enabled.
    
    Returns:
    
    the reference to the current options.
  - levelCompactionDynamicLevelBytes
```
public boolean levelCompactionDynamicLevelBytes()
```
    Description copied from interface: AdvancedColumnFamilyOptionsInterface
    
    Return if LevelCompactionDynamicLevelBytes is enabled.
    
    For further information see AdvancedColumnFamilyOptionsInterface.setLevelCompactionDynamicLevelBytes(boolean)
    
    Specified by:
    
    levelCompactionDynamicLevelBytes in interface AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    boolean value indicating if levelCompactionDynamicLevelBytes is enabled.
  - setMaxBytesForLevelMultiplier
```
public ColumnFamilyOptions setMaxBytesForLevelMultiplier(double multiplier)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    The 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:
    
    setMaxBytesForLevelMultiplier in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Specified by:
    
    setMaxBytesForLevelMultiplier in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    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.
  - maxBytesForLevelMultiplier
```
public double maxBytesForLevelMultiplier()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    The 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:
    
    maxBytesForLevelMultiplier in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Specified by:
    
    maxBytesForLevelMultiplier in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    the ratio between the total size of level-(L+1) files and the total size of level-L files for all L.
  - setMaxCompactionBytes
```
public ColumnFamilyOptions setMaxCompactionBytes(long maxCompactionBytes)
```
    Description copied from interface: AdvancedColumnFamilyOptionsInterface
    
    Maximum size of each compaction (not guarantee)
    
    Specified by:
    
    setMaxCompactionBytes in interface AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Specified by:
    
    setMaxCompactionBytes in interface MutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    maxCompactionBytes - the compaction size limit
    
    Returns:
    
    the reference to the current options.
    
    See Also:
    
    MutableColumnFamilyOptionsInterface.maxCompactionBytes()
  - maxCompactionBytes
```
public long maxCompactionBytes()
```
    Description copied from interface: AdvancedColumnFamilyOptionsInterface
    
    Control maximum size of each compaction (not guaranteed)
    
    Specified by:
    
    maxCompactionBytes in interface AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Specified by:
    
    maxCompactionBytes in interface MutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    compaction size threshold
    
    See Also:
    
    MutableColumnFamilyOptionsInterface.setMaxCompactionBytes(long)
  - setArenaBlockSize
```
public ColumnFamilyOptions setArenaBlockSize(long arenaBlockSize)
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    The 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:
    
    setArenaBlockSize in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    arenaBlockSize - the size of an arena block
    
    Returns:
    
    the reference to the current options.
  - arenaBlockSize
```
public long arenaBlockSize()
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    The 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:
    
    arenaBlockSize in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    the size of an arena block
  - setDisableAutoCompactions
```
public ColumnFamilyOptions setDisableAutoCompactions(boolean disableAutoCompactions)
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    Disable automatic compactions. Manual compactions can still be issued on this column family
    
    Specified by:
    
    setDisableAutoCompactions in interface MutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    disableAutoCompactions - true if auto-compactions are disabled.
    
    Returns:
    
    the reference to the current option.
  - disableAutoCompactions
```
public boolean disableAutoCompactions()
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    Disable automatic compactions. Manual compactions can still be issued on this column family
    
    Specified by:
    
    disableAutoCompactions in interface MutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    true if auto-compactions are disabled.
  - setCompactionStyle
```
public ColumnFamilyOptions setCompactionStyle(CompactionStyle compactionStyle)
```
    Description copied from interface: AdvancedColumnFamilyOptionsInterface
    
    Set compaction style for DB. Default: LEVEL.
    
    Specified by:
    
    setCompactionStyle in interface AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    compactionStyle - Compaction style.
    
    Returns:
    
    the reference to the current options.
  - compactionStyle
```
public CompactionStyle compactionStyle()
```
    Description copied from interface: AdvancedColumnFamilyOptionsInterface
    
    Compaction style for DB.
    
    Specified by:
    
    compactionStyle in interface AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    Compaction style.
  - setMaxTableFilesSizeFIFO
```
public ColumnFamilyOptions setMaxTableFilesSizeFIFO(long maxTableFilesSize)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    FIFO 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:
    
    setMaxTableFilesSizeFIFO in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    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: ColumnFamilyOptionsInterface
    
    FIFO 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:
    
    maxTableFilesSizeFIFO in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    the size limit of the total sum of table files.
  - setMaxSequentialSkipInIterations
```
public ColumnFamilyOptions setMaxSequentialSkipInIterations(long maxSequentialSkipInIterations)
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    An 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:
    
    setMaxSequentialSkipInIterations in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    maxSequentialSkipInIterations - the number of keys could be skipped in a iteration.
    
    Returns:
    
    the reference to the current options.
  - maxSequentialSkipInIterations
```
public long maxSequentialSkipInIterations()
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    An 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:
    
    maxSequentialSkipInIterations in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    the number of keys could be skipped in a iteration.
  - memTableConfig
```
public MemTableConfig memTableConfig()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Get the config for mem-table.
    
    Specified by:
    
    memTableConfig in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    the mem-table config.
  - setMemTableConfig
```
public ColumnFamilyOptions setMemTableConfig(MemTableConfig memTableConfig)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Set the config for mem-table.
    
    Specified by:
    
    setMemTableConfig in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    memTableConfig - the mem-table config.
    
    Returns:
    
    the instance of the current object.
  - memTableFactoryName
```
public String memTableFactoryName()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Returns the name of the current mem table representation. Memtable format can be set using setTableFormatConfig.
    
    Specified by:
    
    memTableFactoryName in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    the name of the currently-used memtable factory.
    
    See Also:
    
    ColumnFamilyOptionsInterface.setTableFormatConfig(org.rocksdb.TableFormatConfig)
  - tableFormatConfig
```
public TableFormatConfig tableFormatConfig()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Get the config for table format.
    
    Specified by:
    
    tableFormatConfig in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    the table format config.
  - setTableFormatConfig
```
public ColumnFamilyOptions setTableFormatConfig(TableFormatConfig tableFormatConfig)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Set the config for table format.
    
    Specified by:
    
    setTableFormatConfig in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    tableFormatConfig - the table format config.
    
    Returns:
    
    the reference of the current options.
  - tableFactoryName
```
public String tableFactoryName()
```
    Specified by:
    
    tableFactoryName in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    the name of the currently used table factory.
  - setCfPaths
```
public ColumnFamilyOptions setCfPaths(Collection<DbPath> cfPaths)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    A 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:
    
    setCfPaths in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    cfPaths - collection of paths for SST files.
    
    Returns:
    
    the reference of the current options.
  - cfPaths
```
public List<DbPath> cfPaths()
```
    Specified by:
    
    cfPaths in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    collection of paths for SST files.
  - setInplaceUpdateSupport
```
public ColumnFamilyOptions setInplaceUpdateSupport(boolean inplaceUpdateSupport)
```
    Description copied from interface: AdvancedColumnFamilyOptionsInterface
    
    Allows 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:
    
    setInplaceUpdateSupport in interface AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    inplaceUpdateSupport - true if thread-safe inplace updates are allowed.
    
    Returns:
    
    the reference to the current options.
  - inplaceUpdateSupport
```
public boolean inplaceUpdateSupport()
```
    Description copied from interface: AdvancedColumnFamilyOptionsInterface
    
    Allows 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:
    
    inplaceUpdateSupport in interface AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    true if thread-safe inplace updates are allowed.
  - setInplaceUpdateNumLocks
```
public ColumnFamilyOptions setInplaceUpdateNumLocks(long inplaceUpdateNumLocks)
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    Number of locks used for inplace update Default: 10000, if inplace_update_support = true, else 0.
    
    Specified by:
    
    setInplaceUpdateNumLocks in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    inplaceUpdateNumLocks - the number of locks used for inplace updates.
    
    Returns:
    
    the reference to the current options.
  - inplaceUpdateNumLocks
```
public long inplaceUpdateNumLocks()
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    Number of locks used for inplace update Default: 10000, if inplace_update_support = true, else 0.
    
    Specified by:
    
    inplaceUpdateNumLocks in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    the number of locks used for inplace update.
  - setMemtablePrefixBloomSizeRatio
```
public ColumnFamilyOptions setMemtablePrefixBloomSizeRatio(double memtablePrefixBloomSizeRatio)
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    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. If it is larger than 0.25, it is santinized to 0.25. Default: 0 (disable)
    
    Specified by:
    
    setMemtablePrefixBloomSizeRatio in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    memtablePrefixBloomSizeRatio - The ratio
    
    Returns:
    
    the reference to the current options.
  - memtablePrefixBloomSizeRatio
```
public double memtablePrefixBloomSizeRatio()
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    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. If it is larger than 0.25, it is santinized to 0.25. Default: 0 (disable)
    
    Specified by:
    
    memtablePrefixBloomSizeRatio in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    the ratio
  - setBloomLocality
```
public ColumnFamilyOptions setBloomLocality(int bloomLocality)
```
    Description copied from interface: AdvancedColumnFamilyOptionsInterface
    
    Control 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:
    
    setBloomLocality in interface AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    bloomLocality - the level of locality of bloom-filter probes.
    
    Returns:
    
    the reference to the current options.
  - bloomLocality
```
public int bloomLocality()
```
    Description copied from interface: AdvancedColumnFamilyOptionsInterface
    
    Control 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:
    
    bloomLocality in interface AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    the level of locality of bloom-filter probes.
    
    See Also:
    
    AdvancedColumnFamilyOptionsInterface.setBloomLocality(int)
  - setMaxSuccessiveMerges
```
public ColumnFamilyOptions setMaxSuccessiveMerges(long maxSuccessiveMerges)
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    Maximum 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:
    
    setMaxSuccessiveMerges in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    maxSuccessiveMerges - the maximum number of successive merges.
    
    Returns:
    
    the reference to the current options.
  - maxSuccessiveMerges
```
public long maxSuccessiveMerges()
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    Maximum 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:
    
    maxSuccessiveMerges in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    the maximum number of successive merges.
  - setOptimizeFiltersForHits
```
public ColumnFamilyOptions setOptimizeFiltersForHits(boolean optimizeFiltersForHits)
```
    Description copied from interface: AdvancedColumnFamilyOptionsInterface
    
    This 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:
    
    setOptimizeFiltersForHits in interface AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    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: AdvancedColumnFamilyOptionsInterface
    
    Returns the current state of the optimize_filters_for_hits setting.
    
    Specified by:
    
    optimizeFiltersForHits in interface AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    boolean value indicating if the flag optimize_filters_for_hits was set.
  - setMemtableHugePageSize
```
public ColumnFamilyOptions setMemtableHugePageSize(long memtableHugePageSize)
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    Page 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:
    
    setMemtableHugePageSize in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    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: AdvancedMutableColumnFamilyOptionsInterface
    
    Page 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:
    
    memtableHugePageSize in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    The page size of the huge page tlb
  - setSoftPendingCompactionBytesLimit
```
public ColumnFamilyOptions setSoftPendingCompactionBytesLimit(long softPendingCompactionBytesLimit)
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    All 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:
    
    setSoftPendingCompactionBytesLimit in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    softPendingCompactionBytesLimit - The soft limit to impose on compaction
    
    Returns:
    
    the reference to the current options.
  - softPendingCompactionBytesLimit
```
public long softPendingCompactionBytesLimit()
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    All 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:
    
    softPendingCompactionBytesLimit in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    The soft limit to impose on compaction
  - setHardPendingCompactionBytesLimit
```
public ColumnFamilyOptions setHardPendingCompactionBytesLimit(long hardPendingCompactionBytesLimit)
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    All writes are stopped if estimated bytes needed to be compaction exceed this threshold. Default: 256GB
    
    Specified by:
    
    setHardPendingCompactionBytesLimit in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    hardPendingCompactionBytesLimit - The hard limit to impose on compaction
    
    Returns:
    
    the reference to the current options.
  - hardPendingCompactionBytesLimit
```
public long hardPendingCompactionBytesLimit()
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    All writes are stopped if estimated bytes needed to be compaction exceed this threshold. Default: 256GB
    
    Specified by:
    
    hardPendingCompactionBytesLimit in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    The hard limit to impose on compaction
  - setLevel0FileNumCompactionTrigger
```
public ColumnFamilyOptions setLevel0FileNumCompactionTrigger(int level0FileNumCompactionTrigger)
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    Number 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:
    
    setLevel0FileNumCompactionTrigger in interface MutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    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: MutableColumnFamilyOptionsInterface
    
    Number 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:
    
    level0FileNumCompactionTrigger in interface MutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    The number of files to trigger
  - setLevel0SlowdownWritesTrigger
```
public ColumnFamilyOptions setLevel0SlowdownWritesTrigger(int level0SlowdownWritesTrigger)
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    Soft 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:
    
    setLevel0SlowdownWritesTrigger in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    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: AdvancedMutableColumnFamilyOptionsInterface
    
    Soft 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:
    
    level0SlowdownWritesTrigger in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    The soft limit on the number of level-0 files
  - setLevel0StopWritesTrigger
```
public ColumnFamilyOptions setLevel0StopWritesTrigger(int level0StopWritesTrigger)
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    Maximum number of level-0 files. We stop writes at this point.
    
    Specified by:
    
    setLevel0StopWritesTrigger in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    level0StopWritesTrigger - The maximum number of level-0 files
    
    Returns:
    
    the reference to the current options.
  - level0StopWritesTrigger
```
public int level0StopWritesTrigger()
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    Maximum number of level-0 files. We stop writes at this point.
    
    Specified by:
    
    level0StopWritesTrigger in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    The maximum number of level-0 files
  - setMaxBytesForLevelMultiplierAdditional
```
public ColumnFamilyOptions setMaxBytesForLevelMultiplierAdditional(int[] maxBytesForLevelMultiplierAdditional)
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    Different 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:
    
    setMaxBytesForLevelMultiplierAdditional in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    maxBytesForLevelMultiplierAdditional - The max-size multipliers for each level
    
    Returns:
    
    the reference to the current options.
  - maxBytesForLevelMultiplierAdditional
```
public int[] maxBytesForLevelMultiplierAdditional()
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    Different 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:
    
    maxBytesForLevelMultiplierAdditional in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    The max-size multipliers for each level
  - setParanoidFileChecks
```
public ColumnFamilyOptions setParanoidFileChecks(boolean paranoidFileChecks)
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    After writing every SST file, reopen it and read all the keys. Default: false
    
    Specified by:
    
    setParanoidFileChecks in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    paranoidFileChecks - true to enable paranoid file checks
    
    Returns:
    
    the reference to the current options.
  - paranoidFileChecks
```
public boolean paranoidFileChecks()
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    After writing every SST file, reopen it and read all the keys. Default: false
    
    Specified by:
    
    paranoidFileChecks in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    true if paranoid file checks are enabled
  - setMaxWriteBufferNumberToMaintain
```
public ColumnFamilyOptions setMaxWriteBufferNumberToMaintain(int maxWriteBufferNumberToMaintain)
```
    Description copied from interface: AdvancedColumnFamilyOptionsInterface
    
    The total maximum number of write buffers to maintain in memory including copies of buffers that have already been flushed. Unlike AdvancedMutableColumnFamilyOptionsInterface.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 of AdvancedMutableColumnFamilyOptionsInterface.maxWriteBufferNumber() if it is not explicitly set by the user. Otherwise, the default is 0.
    
    Specified by:
    
    setMaxWriteBufferNumberToMaintain in interface AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    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: AdvancedColumnFamilyOptionsInterface
    
    The total maximum number of write buffers to maintain in memory including copies of buffers that have already been flushed.
    
    Specified by:
    
    maxWriteBufferNumberToMaintain in interface AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    maxWriteBufferNumberToMaintain The maximum number of write buffers to maintain
  - setCompactionPriority
```
public ColumnFamilyOptions setCompactionPriority(CompactionPriority compactionPriority)
```
    Description copied from interface: AdvancedColumnFamilyOptionsInterface
    
    If level AdvancedColumnFamilyOptionsInterface.compactionStyle() == CompactionStyle.LEVEL, for each level, which files are prioritized to be picked to compact. Default: CompactionPriority.ByCompensatedSize
    
    Specified by:
    
    setCompactionPriority in interface AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    compactionPriority - The compaction priority
    
    Returns:
    
    the reference to the current options.
  - compactionPriority
```
public CompactionPriority compactionPriority()
```
    Description copied from interface: AdvancedColumnFamilyOptionsInterface
    
    Get the Compaction priority if level compaction is used for all levels
    
    Specified by:
    
    compactionPriority in interface AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    The compaction priority
  - setReportBgIoStats
```
public ColumnFamilyOptions setReportBgIoStats(boolean reportBgIoStats)
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    Measure IO stats in compactions and flushes, if true. Default: false
    
    Specified by:
    
    setReportBgIoStats in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    reportBgIoStats - true to enable reporting
    
    Returns:
    
    the reference to the current options.
  - reportBgIoStats
```
public boolean reportBgIoStats()
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    Determine whether IO stats in compactions and flushes are being measured
    
    Specified by:
    
    reportBgIoStats in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    true if reporting is enabled
  - setTtl
```
public ColumnFamilyOptions setTtl(long ttl)
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    Non-bottom-level files older than TTL will go through the compaction process. This needs MutableDBOptionsInterface.maxOpenFiles() to be set to -1. Enabled only for level compaction for now. Default: 0 (disabled) Dynamically changeable through RocksDB.setOptions(ColumnFamilyHandle, MutableColumnFamilyOptions).
    
    Specified by:
    
    setTtl in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    ttl - the time-to-live.
    
    Returns:
    
    the reference to the current options.
  - ttl
```
public long ttl()
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    Get the TTL for Non-bottom-level files that will go through the compaction process. See AdvancedMutableColumnFamilyOptionsInterface.setTtl(long).
    
    Specified by:
    
    ttl in interface AdvancedMutableColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    the time-to-live.
  - setCompactionOptionsUniversal
```
public ColumnFamilyOptions setCompactionOptionsUniversal(CompactionOptionsUniversal compactionOptionsUniversal)
```
    Description copied from interface: AdvancedColumnFamilyOptionsInterface
    
    Set the options needed to support Universal Style compactions
    
    Specified by:
    
    setCompactionOptionsUniversal in interface AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    compactionOptionsUniversal - The Universal Style compaction options
    
    Returns:
    
    the reference to the current options.
  - compactionOptionsUniversal
```
public CompactionOptionsUniversal compactionOptionsUniversal()
```
    Description copied from interface: AdvancedColumnFamilyOptionsInterface
    
    The options needed to support Universal Style compactions
    
    Specified by:
    
    compactionOptionsUniversal in interface AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    The Universal Style compaction options
  - setCompactionOptionsFIFO
```
public ColumnFamilyOptions setCompactionOptionsFIFO(CompactionOptionsFIFO compactionOptionsFIFO)
```
    Description copied from interface: AdvancedColumnFamilyOptionsInterface
    
    The options for FIFO compaction style
    
    Specified by:
    
    setCompactionOptionsFIFO in interface AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    compactionOptionsFIFO - The FIFO compaction options
    
    Returns:
    
    the reference to the current options.
  - compactionOptionsFIFO
```
public CompactionOptionsFIFO compactionOptionsFIFO()
```
    Description copied from interface: AdvancedColumnFamilyOptionsInterface
    
    The options for FIFO compaction style
    
    Specified by:
    
    compactionOptionsFIFO in interface AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    The FIFO compaction options
  - setForceConsistencyChecks
```
public ColumnFamilyOptions setForceConsistencyChecks(boolean forceConsistencyChecks)
```
    Description copied from interface: AdvancedColumnFamilyOptionsInterface
    
    In 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:
    
    setForceConsistencyChecks in interface AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    forceConsistencyChecks - true to force consistency checks
    
    Returns:
    
    the reference to the current options.
  - forceConsistencyChecks
```
public boolean forceConsistencyChecks()
```
    Description copied from interface: AdvancedColumnFamilyOptionsInterface
    
    In 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:
    
    forceConsistencyChecks in interface AdvancedColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    true if consistency checks are enforced
  - setSstPartitionerFactory
```
public ColumnFamilyOptions setSstPartitionerFactory(SstPartitionerFactory sstPartitionerFactory)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    If 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:
    
    setSstPartitionerFactory in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    sstPartitionerFactory - The factory reference
    
    Returns:
    
    the reference of the current options.
  - setCompactionThreadLimiter
```
public ColumnFamilyOptions setCompactionThreadLimiter(ConcurrentTaskLimiter compactionThreadLimiter)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Compaction 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:
    
    setCompactionThreadLimiter in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Parameters:
    
    compactionThreadLimiter - The compaction thread limiter.
    
    Returns:
    
    the reference of the current options.
  - compactionThreadLimiter
```
public ConcurrentTaskLimiter compactionThreadLimiter()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Get compaction thread limiter
    
    Specified by:
    
    compactionThreadLimiter in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    Compaction thread limiter
  - sstPartitionerFactory
```
public SstPartitionerFactory sstPartitionerFactory()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Get SST partitioner factory
    
    Specified by:
    
    sstPartitionerFactory in interface ColumnFamilyOptionsInterface<ColumnFamilyOptions>
    
    Returns:
    
    SST partitioner factory
  - disposeInternal
```
protected final void disposeInternal(long handle)
```
    Specified by:
    
    disposeInternal in class RocksObject

Class ColumnFamilyOptions

Field Summary

Fields inherited from class org.rocksdb.RocksObject

Fields inherited from class org.rocksdb.AbstractImmutableNativeReference

Fields inherited from interface org.rocksdb.ColumnFamilyOptionsInterface

Constructor Summary

Method Summary

Methods inherited from class org.rocksdb.RocksObject

Methods inherited from class org.rocksdb.AbstractImmutableNativeReference

Methods inherited from class org.rocksdb.AbstractNativeReference

Methods inherited from class java.lang.Object

Constructor Detail

ColumnFamilyOptions

ColumnFamilyOptions

ColumnFamilyOptions

Method Detail

getColumnFamilyOptionsFromProps

getColumnFamilyOptionsFromProps

oldDefaults

optimizeForSmallDb

optimizeForSmallDb

optimizeForPointLookup

optimizeLevelStyleCompaction

optimizeLevelStyleCompaction

optimizeUniversalStyleCompaction

optimizeUniversalStyleCompaction

setComparator

setComparator

setMergeOperatorName

setMergeOperator

setCompactionFilter

compactionFilter

setCompactionFilterFactory

compactionFilterFactory

setWriteBufferSize

writeBufferSize

setMaxWriteBufferNumber

maxWriteBufferNumber

setMinWriteBufferNumberToMerge

minWriteBufferNumberToMerge

useFixedLengthPrefixExtractor

useCappedPrefixExtractor

setCompressionType

compressionType

setCompressionPerLevel

compressionPerLevel

setBottommostCompressionType

bottommostCompressionType

setBottommostCompressionOptions

bottommostCompressionOptions

setCompressionOptions

compressionOptions

setNumLevels

numLevels

setLevelZeroFileNumCompactionTrigger

levelZeroFileNumCompactionTrigger

setLevelZeroSlowdownWritesTrigger

levelZeroSlowdownWritesTrigger

setLevelZeroStopWritesTrigger

levelZeroStopWritesTrigger

setTargetFileSizeBase

targetFileSizeBase

setTargetFileSizeMultiplier

targetFileSizeMultiplier

setMaxBytesForLevelBase

maxBytesForLevelBase

setLevelCompactionDynamicLevelBytes

levelCompactionDynamicLevelBytes

setMaxBytesForLevelMultiplier

maxBytesForLevelMultiplier

setMaxCompactionBytes

maxCompactionBytes

setArenaBlockSize

arenaBlockSize

setDisableAutoCompactions

disableAutoCompactions

setCompactionStyle

compactionStyle

setMaxTableFilesSizeFIFO

maxTableFilesSizeFIFO