ColumnFamilyOptions

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

All Implemented Interfaces:

ColumnFamilyOptionsInterface
```
public class ColumnFamilyOptions
extends RocksObject
implements ColumnFamilyOptionsInterface
```
ColumnFamilyOptions to control the behavior of a database. It will be used during the creation of a RocksDB (i.e., RocksDB.open()). If RocksObject.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 interface org.rocksdb.ColumnFamilyOptionsInterface
  DEFAULT_COMPACTION_MEMTABLE_MEMORY_BUDGET

Constructor Summary

Constructors
Constructor and Description

ColumnFamilyOptions()
Construct ColumnFamilyOptions.

Constructors
Constructor and Description
`ColumnFamilyOptions()` Construct ColumnFamilyOptions.

Method Summary

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.
`CompactionStyle`	`compactionStyle()` Compaction style for DB.
`java.util.List<CompressionType>`	`compressionPerLevel()` Return the currently set `CompressionType` per instances.
`CompressionType`	`compressionType()` Compress blocks using the specified compression algorithm.
`boolean`	`disableAutoCompactions()` Disable automatic compactions.
`protected void`	`disposeInternal()` Release the memory allocated for the current instance in the c++ side.
`int`	`expandedCompactionFactor()` Maximum number of bytes in all compacted files.
`boolean`	`filterDeletes()` Use KeyMayExist API to filter deletes when this is true.
`static ColumnFamilyOptions`	`getColumnFamilyOptionsFromProps(java.util.Properties properties)` Method to get a options instance by using pre-configured property values.
`double`	`hardRateLimit()` Puts are delayed 1ms at a time when any level has a compaction score that exceeds hard_rate_limit.
`long`	`inplaceUpdateNumLocks()` Number of locks used for inplace update Default: 10000, if inplace_update_support = true, else 0.
`boolean`	`inplaceUpdateSupport()` Allows thread-safe inplace updates.
`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.
`int`	`maxBytesForLevelMultiplier()` The ratio between the total size of level-(L+1) files and the total size of level-L files for all L.
`int`	`maxGrandparentOverlapFactor()` Control maximum bytes of overlaps in grandparent (i.e., level+2) before we stop building a single file in a level->level+1 compaction.
`int`	`maxMemCompactionLevel()` The highest level to which a new compacted memtable is pushed if it does not create overlap.
`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.
`int`	`maxWriteBufferNumber()` Returns maximum number of write buffers.
`java.lang.String`	`memTableFactoryName()` Returns the name of the current mem table representation.
`int`	`memtablePrefixBloomBits()` Returns the number of bits used in the prefix bloom filter.
`int`	`memtablePrefixBloomProbes()` The number of hash probes per key used in the mem-table.
`int`	`minPartialMergeOperands()` The number of partial merge operands to accumulate before partial merge will be performed.
`int`	`minWriteBufferNumberToMerge()` The minimum number of write buffers that will be merged together before writing to storage.
`int`	`numLevels()` If level-styled compaction is used, then this number determines the total number of levels.
`boolean`	`optimizeFiltersForHits()` Returns the current state of the `optimize_filters_for_hits` setting.
`ColumnFamilyOptions`	`optimizeForPointLookup(long blockCacheSizeMb)` Use this if you don't need to keep the data sorted, i.e.
`ColumnFamilyOptions`	`optimizeLevelStyleCompaction()` Default values for some parameters in ColumnFamilyOptions are not optimized for heavy workloads and big datasets, which means you might observe write stalls under some conditions.
`ColumnFamilyOptions`	`optimizeLevelStyleCompaction(long memtableMemoryBudget)` Default values for some parameters in ColumnFamilyOptions are not optimized for heavy workloads and big datasets, which means you might observe write stalls under some conditions.
`ColumnFamilyOptions`	`optimizeUniversalStyleCompaction()` Default values for some parameters in ColumnFamilyOptions are not optimized for heavy workloads and big datasets, which means you might observe write stalls under some conditions.
`ColumnFamilyOptions`	`optimizeUniversalStyleCompaction(long memtableMemoryBudget)` Default values for some parameters in ColumnFamilyOptions are not optimized for heavy workloads and big datasets, which means you might observe write stalls under some conditions.
`boolean`	`purgeRedundantKvsWhileFlush()` Purge duplicate/deleted keys when a memtable is flushed to storage.
`int`	`rateLimitDelayMaxMilliseconds()` The maximum time interval a put will be stalled when hard_rate_limit is enforced.
`ColumnFamilyOptions`	`setArenaBlockSize(long arenaBlockSize)` The size of one block in arena memory allocation.
`ColumnFamilyOptions`	`setBloomLocality(int bloomLocality)` Control locality of bloom filter probes to improve cache miss rate.
`ColumnFamilyOptions`	`setCompactionStyle(CompactionStyle compactionStyle)` Set compaction style for DB.
`ColumnFamilyOptions`	`setComparator(AbstractComparator<? extends org.rocksdb.AbstractSlice<?>> comparator)` Use the specified comparator for key ordering.
`ColumnFamilyOptions`	`setComparator(BuiltinComparator builtinComparator)` Set `BuiltinComparator` to be used with RocksDB.
`ColumnFamilyOptions`	`setCompressionPerLevel(java.util.List<CompressionType> compressionLevels)` Different levels can have different compression policies.
`ColumnFamilyOptions`	`setCompressionType(CompressionType compressionType)` Compress blocks using the specified compression algorithm.
`ColumnFamilyOptions`	`setDisableAutoCompactions(boolean disableAutoCompactions)` Disable automatic compactions.
`ColumnFamilyOptions`	`setExpandedCompactionFactor(int expandedCompactionFactor)` Maximum number of bytes in all compacted files.
`ColumnFamilyOptions`	`setFilterDeletes(boolean filterDeletes)` Use KeyMayExist API to filter deletes when this is true.
`ColumnFamilyOptions`	`setHardRateLimit(double hardRateLimit)` Puts are delayed 1ms at a time when any level has a compaction score that exceeds hard_rate_limit.
`ColumnFamilyOptions`	`setInplaceUpdateNumLocks(long inplaceUpdateNumLocks)` Number of locks used for inplace update Default: 10000, if inplace_update_support = true, else 0.
`ColumnFamilyOptions`	`setInplaceUpdateSupport(boolean inplaceUpdateSupport)` Allows thread-safe inplace updates.
`ColumnFamilyOptions`	`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(int multiplier)` The ratio between the total size of level-(L+1) files and the total size of level-L files for all L.
`ColumnFamilyOptions`	`setMaxGrandparentOverlapFactor(int maxGrandparentOverlapFactor)` Control maximum bytes of overlaps in grandparent (i.e., level+2) before we stop building a single file in a level->level+1 compaction.
`ColumnFamilyOptions`	`setMaxMemCompactionLevel(int maxMemCompactionLevel)` The highest level to which a new compacted memtable is pushed if it does not create overlap.
`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`	`setMaxWriteBufferNumber(int maxWriteBufferNumber)` The maximum number of write buffers that are built up in memory.
`ColumnFamilyOptions`	`setMemTableConfig(MemTableConfig config)` Set the config for mem-table.
`ColumnFamilyOptions`	`setMemtablePrefixBloomBits(int memtablePrefixBloomBits)` Sets the number of bits used in the prefix bloom filter.
`ColumnFamilyOptions`	`setMemtablePrefixBloomProbes(int memtablePrefixBloomProbes)` The number of hash probes per key used in the mem-table.
`ColumnFamilyOptions`	`setMergeOperator(MergeOperator mergeOperator)` Set the merge operator to be used for merging two different key/value pairs that share the same key.
`ColumnFamilyOptions`	`setMergeOperatorName(java.lang.String name)` Set the merge operator to be used for merging two merge operands of the same key.
`ColumnFamilyOptions`	`setMinPartialMergeOperands(int minPartialMergeOperands)` The number of partial merge operands to accumulate before partial merge will be performed.
`ColumnFamilyOptions`	`setMinWriteBufferNumberToMerge(int minWriteBufferNumberToMerge)` The minimum number of write buffers that will be merged together before writing to storage.
`ColumnFamilyOptions`	`setNumLevels(int numLevels)` Set the number of levels for this database If level-styled compaction is used, then this number determines the total number of levels.
`ColumnFamilyOptions`	`setOptimizeFiltersForHits(boolean optimizeFiltersForHits)` This flag specifies that the implementation should optimize the filters mainly for cases where keys are found rather than also optimize for keys missed.
`ColumnFamilyOptions`	`setPurgeRedundantKvsWhileFlush(boolean purgeRedundantKvsWhileFlush)` Purge duplicate/deleted keys when a memtable is flushed to storage.
`ColumnFamilyOptions`	`setRateLimitDelayMaxMilliseconds(int rateLimitDelayMaxMilliseconds)` The maximum time interval a put will be stalled when hard_rate_limit is enforced.
`ColumnFamilyOptions`	`setSoftRateLimit(double softRateLimit)` Puts are delayed 0-1 ms when any level has a compaction score that exceeds soft_rate_limit.
`ColumnFamilyOptions`	`setSourceCompactionFactor(int sourceCompactionFactor)` Maximum number of bytes in all source files to be compacted in a single compaction run.
`ColumnFamilyOptions`	`setTableFormatConfig(TableFormatConfig config)` Set the config for table format.
`ColumnFamilyOptions`	`setTargetFileSizeBase(long targetFileSizeBase)` The target file size for compaction.
`ColumnFamilyOptions`	`setTargetFileSizeMultiplier(int multiplier)` targetFileSizeMultiplier defines the size ratio between a level-L file and level-(L+1) file.
`ColumnFamilyOptions`	`setVerifyChecksumsInCompaction(boolean verifyChecksumsInCompaction)` If true, compaction will verify checksum on every read that happens as part of compaction Default: true
`ColumnFamilyOptions`	`setWriteBufferSize(long writeBufferSize)` Amount of data to build up in memory (backed by an unsorted log on disk) before converting to a sorted on-disk file.
`double`	`softRateLimit()` Puts are delayed 0-1 ms when any level has a compaction score that exceeds soft_rate_limit.
`int`	`sourceCompactionFactor()` Maximum number of bytes in all source files to be compacted in a single compaction run.
`java.lang.String`	`tableFactoryName()`
`long`	`targetFileSizeBase()` The target file size for compaction.
`int`	`targetFileSizeMultiplier()` targetFileSizeMultiplier defines the size ratio between a level-(L+1) file and level-L file.
`ColumnFamilyOptions`	`useFixedLengthPrefixExtractor(int n)` This prefix-extractor uses the first n bytes of a key as its prefix.
`boolean`	`verifyChecksumsInCompaction()` If true, compaction will verify checksum on every read that happens as part of compaction Default: true
`long`	`writeBufferSize()` Return size of write buffer size.

Methods inherited from class org.rocksdb.RocksObject
disOwnNativeHandle, dispose, finalize, isInitialized, isOwningNativeHandle

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::DBOptions in the c++ side.
- Method Detail
  - getColumnFamilyOptionsFromProps
```
public static ColumnFamilyOptions getColumnFamilyOptionsFromProps(java.util.Properties properties)
```
    Method to get a options instance by using pre-configured property values. If one or many values are undefined in the context of RocksDB the method will return a null value.
    
    Note: Property keys can be derived from getter methods within the options class. Example: the method writeBufferSize() has a property key: write_buffer_size.
    
    Parameters:
    properties - Properties instance.
    
    Returns:
    instance or null.
    
    Throws:
    
    java.lang.IllegalArgumentException - if null or empty Properties instance is passed to the method call.
  - 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
    
    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
    
    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
    
    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
    
    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
    
    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
    
    Parameters:
    builtinComparator - a BuiltinComparator type.
    
    Returns:
    the instance of the current Object.
  - setComparator
```
public ColumnFamilyOptions setComparator(AbstractComparator<? extends org.rocksdb.AbstractSlice<?>> 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
    
    Parameters:
    comparator - java instance.
    
    Returns:
    the instance of the current Object.
  - setMergeOperatorName
```
public ColumnFamilyOptions setMergeOperatorName(java.lang.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
    
    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
    
    Parameters:
    mergeOperator - MergeOperator instance.
    
    Returns:
    the instance of the current Object.
  - setWriteBufferSize
```
public ColumnFamilyOptions setWriteBufferSize(long writeBufferSize)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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: 4MB
    
    Specified by:
    
    setWriteBufferSize in interface ColumnFamilyOptionsInterface
    
    Parameters:
    writeBufferSize - the size of write buffer.
    
    Returns:
    the instance of the current Object.
  - writeBufferSize
```
public long writeBufferSize()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Return size of write buffer size.
    
    Specified by:
    
    writeBufferSize in interface ColumnFamilyOptionsInterface
    
    Returns:
    size of write buffer.
    See Also:
    ColumnFamilyOptionsInterface.setWriteBufferSize(long)
  - setMaxWriteBufferNumber
```
public ColumnFamilyOptions setMaxWriteBufferNumber(int maxWriteBufferNumber)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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 ColumnFamilyOptionsInterface
    
    Parameters:
    maxWriteBufferNumber - maximum number of write buffers.
    
    Returns:
    the instance of the current Object.
  - maxWriteBufferNumber
```
public int maxWriteBufferNumber()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Returns maximum number of write buffers.
    
    Specified by:
    
    maxWriteBufferNumber in interface ColumnFamilyOptionsInterface
    
    Returns:
    maximum number of write buffers.
    See Also:
    ColumnFamilyOptionsInterface.setMaxWriteBufferNumber(int)
  - setMinWriteBufferNumberToMerge
```
public ColumnFamilyOptions setMinWriteBufferNumberToMerge(int minWriteBufferNumberToMerge)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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 ColumnFamilyOptionsInterface
    
    Parameters:
    minWriteBufferNumberToMerge - the minimum number of write buffers that will be merged together.
    
    Returns:
    the reference to the current option.
  - minWriteBufferNumberToMerge
```
public int minWriteBufferNumberToMerge()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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 ColumnFamilyOptionsInterface
    
    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
    
    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: ColumnFamilyOptionsInterface
    
    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 ColumnFamilyOptionsInterface
    
    Parameters:
    compressionType - Compression Type.
    
    Returns:
    the reference to the current option.
  - compressionType
```
public CompressionType compressionType()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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 ColumnFamilyOptionsInterface
    
    Returns:
    Compression type.
  - setCompressionPerLevel
```
public ColumnFamilyOptions setCompressionPerLevel(java.util.List<CompressionType> compressionLevels)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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 ColumnFamilyOptionsInterface
    
    Parameters:
    compressionLevels - list of CompressionType instances.
    
    Returns:
    the reference to the current option.
  - compressionPerLevel
```
public java.util.List<CompressionType> compressionPerLevel()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Return the currently set CompressionType per instances.
    
    See: ColumnFamilyOptionsInterface.setCompressionPerLevel(java.util.List)
    
    Specified by:
    
    compressionPerLevel in interface ColumnFamilyOptionsInterface
    
    Returns:
    list of CompressionType instances.
  - setNumLevels
```
public ColumnFamilyOptions setNumLevels(int numLevels)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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 ColumnFamilyOptionsInterface
    
    Parameters:
    numLevels - the number of levels.
    
    Returns:
    the reference to the current option.
  - numLevels
```
public int numLevels()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    If level-styled compaction is used, then this number determines the total number of levels.
    
    Specified by:
    
    numLevels in interface ColumnFamilyOptionsInterface
    
    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
    
    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
    
    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
    
    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
    
    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
    
    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
    
    Returns:
    the hard limit of the number of level-0 file.
  - setMaxMemCompactionLevel
```
public ColumnFamilyOptions setMaxMemCompactionLevel(int maxMemCompactionLevel)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    The highest level to which a new compacted memtable is pushed if it does not create overlap. We try to push to level 2 to avoid the relatively expensive level 0≥1 compactions and to avoid some expensive manifest file operations. We do not push all the way to the largest level since that can generate a lot of wasted disk space if the same key space is being repeatedly overwritten.
    
    Specified by:
    
    setMaxMemCompactionLevel in interface ColumnFamilyOptionsInterface
    
    Parameters:
    maxMemCompactionLevel - the highest level to which a new compacted mem-table will be pushed.
    
    Returns:
    the reference to the current option.
  - maxMemCompactionLevel
```
public int maxMemCompactionLevel()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    The highest level to which a new compacted memtable is pushed if it does not create overlap. We try to push to level 2 to avoid the relatively expensive level 0≥1 compactions and to avoid some expensive manifest file operations. We do not push all the way to the largest level since that can generate a lot of wasted disk space if the same key space is being repeatedly overwritten.
    
    Specified by:
    
    maxMemCompactionLevel in interface ColumnFamilyOptionsInterface
    
    Returns:
    the highest level where a new compacted memtable will be pushed.
  - setTargetFileSizeBase
```
public ColumnFamilyOptions setTargetFileSizeBase(long targetFileSizeBase)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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 2MB.
    
    Specified by:
    
    setTargetFileSizeBase in interface ColumnFamilyOptionsInterface
    
    Parameters:
    targetFileSizeBase - the target size of a level-0 file.
    
    Returns:
    the reference to the current option.
    See Also:
    ColumnFamilyOptionsInterface.setTargetFileSizeMultiplier(int)
  - targetFileSizeBase
```
public long targetFileSizeBase()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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 2MB.
    
    Specified by:
    
    targetFileSizeBase in interface ColumnFamilyOptionsInterface
    
    Returns:
    the target size of a level-0 file.
    See Also:
    ColumnFamilyOptionsInterface.targetFileSizeMultiplier()
  - setTargetFileSizeMultiplier
```
public ColumnFamilyOptions setTargetFileSizeMultiplier(int multiplier)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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 ColumnFamilyOptionsInterface
    
    Parameters:
    multiplier - the size ratio between a level-(L+1) file and level-L file.
    
    Returns:
    the reference to the current option.
  - targetFileSizeMultiplier
```
public int targetFileSizeMultiplier()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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 ColumnFamilyOptionsInterface
    
    Returns:
    the size ratio between a level-(L+1) file and level-L file.
  - setMaxBytesForLevelBase
```
public ColumnFamilyOptions setMaxBytesForLevelBase(long maxBytesForLevelBase)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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 20MB, total file size for level-2 will be 200MB, and total file size for level-3 will be 2GB. by default 'maxBytesForLevelBase' is 10MB.
    
    Specified by:
    
    setMaxBytesForLevelBase in interface ColumnFamilyOptionsInterface
    
    Parameters:
    maxBytesForLevelBase - maximum bytes for level base.
    
    Returns:
    the reference to the current option.
    See Also:
    ColumnFamilyOptionsInterface.setMaxBytesForLevelMultiplier(int)
  - maxBytesForLevelBase
```
public long maxBytesForLevelBase()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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 20MB, total file size for level-2 will be 200MB, and total file size for level-3 will be 2GB. by default 'maxBytesForLevelBase' is 10MB.
    
    Specified by:
    
    maxBytesForLevelBase in interface ColumnFamilyOptionsInterface
    
    Returns:
    the upper-bound of the total size of level-1 files in bytes.
    See Also:
    ColumnFamilyOptionsInterface.maxBytesForLevelMultiplier()
  - setLevelCompactionDynamicLevelBytes
```
public ColumnFamilyOptions setLevelCompactionDynamicLevelBytes(boolean enableLevelCompactionDynamicLevelBytes)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    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 ColumnFamilyOptionsInterface
    
    Parameters:
    enableLevelCompactionDynamicLevelBytes - boolean value indicating if LevelCompactionDynamicLevelBytes shall be enabled.
    
    Returns:
    the reference to the current option.
  - levelCompactionDynamicLevelBytes
```
public boolean levelCompactionDynamicLevelBytes()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Return if LevelCompactionDynamicLevelBytes is enabled.
    
    For further information see ColumnFamilyOptionsInterface.setLevelCompactionDynamicLevelBytes(boolean)
    
    Specified by:
    
    levelCompactionDynamicLevelBytes in interface ColumnFamilyOptionsInterface
    
    Returns:
    boolean value indicating if levelCompactionDynamicLevelBytes is enabled.
  - setMaxBytesForLevelMultiplier
```
public ColumnFamilyOptions setMaxBytesForLevelMultiplier(int 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 ColumnFamilyOptionsInterface
    
    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.
    See Also:
    ColumnFamilyOptionsInterface.setMaxBytesForLevelBase(long)
  - maxBytesForLevelMultiplier
```
public int 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 ColumnFamilyOptionsInterface
    
    Returns:
    the ratio between the total size of level-(L+1) files and the total size of level-L files for all L.
    See Also:
    ColumnFamilyOptionsInterface.maxBytesForLevelBase()
  - setExpandedCompactionFactor
```
public ColumnFamilyOptions setExpandedCompactionFactor(int expandedCompactionFactor)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Maximum number of bytes in all compacted files. We avoid expanding the lower level file set of a compaction if it would make the total compaction cover more than (expanded_compaction_factor * targetFileSizeLevel()) many bytes.
    
    Specified by:
    
    setExpandedCompactionFactor in interface ColumnFamilyOptionsInterface
    
    Parameters:
    expandedCompactionFactor - the maximum number of bytes in all compacted files.
    
    Returns:
    the reference to the current option.
    See Also:
    ColumnFamilyOptionsInterface.setSourceCompactionFactor(int)
  - expandedCompactionFactor
```
public int expandedCompactionFactor()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Maximum number of bytes in all compacted files. We avoid expanding the lower level file set of a compaction if it would make the total compaction cover more than (expanded_compaction_factor * targetFileSizeLevel()) many bytes.
    
    Specified by:
    
    expandedCompactionFactor in interface ColumnFamilyOptionsInterface
    
    Returns:
    the maximum number of bytes in all compacted files.
    See Also:
    ColumnFamilyOptionsInterface.sourceCompactionFactor()
  - setSourceCompactionFactor
```
public ColumnFamilyOptions setSourceCompactionFactor(int sourceCompactionFactor)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Maximum number of bytes in all source files to be compacted in a single compaction run. We avoid picking too many files in the source level so that we do not exceed the total source bytes for compaction to exceed (source_compaction_factor * targetFileSizeLevel()) many bytes. Default:1, i.e. pick maxfilesize amount of data as the source of a compaction.
    
    Specified by:
    
    setSourceCompactionFactor in interface ColumnFamilyOptionsInterface
    
    Parameters:
    sourceCompactionFactor - the maximum number of bytes in all source files to be compacted in a single compaction run.
    
    Returns:
    the reference to the current option.
    See Also:
    ColumnFamilyOptionsInterface.setExpandedCompactionFactor(int)
  - sourceCompactionFactor
```
public int sourceCompactionFactor()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Maximum number of bytes in all source files to be compacted in a single compaction run. We avoid picking too many files in the source level so that we do not exceed the total source bytes for compaction to exceed (source_compaction_factor * targetFileSizeLevel()) many bytes. Default:1, i.e. pick maxfilesize amount of data as the source of a compaction.
    
    Specified by:
    
    sourceCompactionFactor in interface ColumnFamilyOptionsInterface
    
    Returns:
    the maximum number of bytes in all source files to be compactedo.
    See Also:
    ColumnFamilyOptionsInterface.expandedCompactionFactor()
  - setMaxGrandparentOverlapFactor
```
public ColumnFamilyOptions setMaxGrandparentOverlapFactor(int maxGrandparentOverlapFactor)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Control maximum bytes of overlaps in grandparent (i.e., level+2) before we stop building a single file in a level->level+1 compaction.
    
    Specified by:
    
    setMaxGrandparentOverlapFactor in interface ColumnFamilyOptionsInterface
    
    Parameters:
    maxGrandparentOverlapFactor - maximum bytes of overlaps in "grandparent" level.
    
    Returns:
    the reference to the current option.
  - maxGrandparentOverlapFactor
```
public int maxGrandparentOverlapFactor()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Control maximum bytes of overlaps in grandparent (i.e., level+2) before we stop building a single file in a level->level+1 compaction.
    
    Specified by:
    
    maxGrandparentOverlapFactor in interface ColumnFamilyOptionsInterface
    
    Returns:
    maximum bytes of overlaps in "grandparent" level.
  - setSoftRateLimit
```
public ColumnFamilyOptions setSoftRateLimit(double softRateLimit)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Puts are delayed 0-1 ms when any level has a compaction score that exceeds soft_rate_limit. This is ignored when == 0.0. CONSTRAINT: soft_rate_limit ≤ hard_rate_limit. If this constraint does not hold, RocksDB will set soft_rate_limit = hard_rate_limit Default: 0 (disabled)
    
    Specified by:
    
    setSoftRateLimit in interface ColumnFamilyOptionsInterface
    
    Parameters:
    softRateLimit - the soft-rate-limit of a compaction score for put delay.
    
    Returns:
    the reference to the current option.
  - softRateLimit
```
public double softRateLimit()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Puts are delayed 0-1 ms when any level has a compaction score that exceeds soft_rate_limit. This is ignored when == 0.0. CONSTRAINT: soft_rate_limit ≤ hard_rate_limit. If this constraint does not hold, RocksDB will set soft_rate_limit = hard_rate_limit Default: 0 (disabled)
    
    Specified by:
    
    softRateLimit in interface ColumnFamilyOptionsInterface
    
    Returns:
    soft-rate-limit for put delay.
  - setHardRateLimit
```
public ColumnFamilyOptions setHardRateLimit(double hardRateLimit)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Puts are delayed 1ms at a time when any level has a compaction score that exceeds hard_rate_limit. This is ignored when ≤ 1.0. Default: 0 (disabled)
    
    Specified by:
    
    setHardRateLimit in interface ColumnFamilyOptionsInterface
    
    Parameters:
    hardRateLimit - the hard-rate-limit of a compaction score for put delay.
    
    Returns:
    the reference to the current option.
  - hardRateLimit
```
public double hardRateLimit()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Puts are delayed 1ms at a time when any level has a compaction score that exceeds hard_rate_limit. This is ignored when ≤ 1.0. Default: 0 (disabled)
    
    Specified by:
    
    hardRateLimit in interface ColumnFamilyOptionsInterface
    
    Returns:
    the hard-rate-limit of a compaction score for put delay.
  - setRateLimitDelayMaxMilliseconds
```
public ColumnFamilyOptions setRateLimitDelayMaxMilliseconds(int rateLimitDelayMaxMilliseconds)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    The maximum time interval a put will be stalled when hard_rate_limit is enforced. If 0, then there is no limit. Default: 1000
    
    Specified by:
    
    setRateLimitDelayMaxMilliseconds in interface ColumnFamilyOptionsInterface
    
    Parameters:
    rateLimitDelayMaxMilliseconds - the maximum time interval a put will be stalled.
    
    Returns:
    the reference to the current option.
  - rateLimitDelayMaxMilliseconds
```
public int rateLimitDelayMaxMilliseconds()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    The maximum time interval a put will be stalled when hard_rate_limit is enforced. If 0, then there is no limit. Default: 1000
    
    Specified by:
    
    rateLimitDelayMaxMilliseconds in interface ColumnFamilyOptionsInterface
    
    Returns:
    the maximum time interval a put will be stalled when hard_rate_limit is enforced.
  - setArenaBlockSize
```
public ColumnFamilyOptions setArenaBlockSize(long arenaBlockSize)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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 additonal restriction of the 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 ColumnFamilyOptionsInterface
    
    Parameters:
    arenaBlockSize - the size of an arena block
    
    Returns:
    the reference to the current option.
  - arenaBlockSize
```
public long arenaBlockSize()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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 additonal restriction of the 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 ColumnFamilyOptionsInterface
    
    Returns:
    the size of an arena block
  - setDisableAutoCompactions
```
public ColumnFamilyOptions setDisableAutoCompactions(boolean disableAutoCompactions)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Disable automatic compactions. Manual compactions can still be issued on this column family
    
    Specified by:
    
    setDisableAutoCompactions in interface ColumnFamilyOptionsInterface
    
    Parameters:
    disableAutoCompactions - true if auto-compactions are disabled.
    
    Returns:
    the reference to the current option.
  - disableAutoCompactions
```
public boolean disableAutoCompactions()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Disable automatic compactions. Manual compactions can still be issued on this column family
    
    Specified by:
    
    disableAutoCompactions in interface ColumnFamilyOptionsInterface
    
    Returns:
    true if auto-compactions are disabled.
  - setPurgeRedundantKvsWhileFlush
```
public ColumnFamilyOptions setPurgeRedundantKvsWhileFlush(boolean purgeRedundantKvsWhileFlush)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Purge duplicate/deleted keys when a memtable is flushed to storage. Default: true
    
    Specified by:
    
    setPurgeRedundantKvsWhileFlush in interface ColumnFamilyOptionsInterface
    
    Parameters:
    purgeRedundantKvsWhileFlush - true if purging keys is disabled.
    
    Returns:
    the reference to the current option.
  - purgeRedundantKvsWhileFlush
```
public boolean purgeRedundantKvsWhileFlush()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Purge duplicate/deleted keys when a memtable is flushed to storage. Default: true
    
    Specified by:
    
    purgeRedundantKvsWhileFlush in interface ColumnFamilyOptionsInterface
    
    Returns:
    true if purging keys is disabled.
  - setCompactionStyle
```
public ColumnFamilyOptions setCompactionStyle(CompactionStyle compactionStyle)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Set compaction style for DB. Default: LEVEL.
    
    Specified by:
    
    setCompactionStyle in interface ColumnFamilyOptionsInterface
    
    Parameters:
    compactionStyle - Compaction style.
    
    Returns:
    the reference to the current option.
  - compactionStyle
```
public CompactionStyle compactionStyle()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Compaction style for DB.
    
    Specified by:
    
    compactionStyle in interface ColumnFamilyOptionsInterface
    
    Returns:
    Compaction style.
  - setVerifyChecksumsInCompaction
```
public ColumnFamilyOptions setVerifyChecksumsInCompaction(boolean verifyChecksumsInCompaction)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    If true, compaction will verify checksum on every read that happens as part of compaction Default: true
    
    Specified by:
    
    setVerifyChecksumsInCompaction in interface ColumnFamilyOptionsInterface
    
    Parameters:
    verifyChecksumsInCompaction - true if compaction verifies checksum on every read.
    
    Returns:
    the reference to the current option.
  - verifyChecksumsInCompaction
```
public boolean verifyChecksumsInCompaction()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    If true, compaction will verify checksum on every read that happens as part of compaction Default: true
    
    Specified by:
    
    verifyChecksumsInCompaction in interface ColumnFamilyOptionsInterface
    
    Returns:
    true if compaction verifies checksum on every read.
  - setFilterDeletes
```
public ColumnFamilyOptions setFilterDeletes(boolean filterDeletes)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Use KeyMayExist API to filter deletes when this is true. If KeyMayExist returns false, i.e. the key definitely does not exist, then the delete is a noop. KeyMayExist only incurs in-memory look up. This optimization avoids writing the delete to storage when appropriate. Default: false
    
    Specified by:
    
    setFilterDeletes in interface ColumnFamilyOptionsInterface
    
    Parameters:
    filterDeletes - true if filter-deletes behavior is on.
    
    Returns:
    the reference to the current option.
  - filterDeletes
```
public boolean filterDeletes()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Use KeyMayExist API to filter deletes when this is true. If KeyMayExist returns false, i.e. the key definitely does not exist, then the delete is a noop. KeyMayExist only incurs in-memory look up. This optimization avoids writing the delete to storage when appropriate. Default: false
    
    Specified by:
    
    filterDeletes in interface ColumnFamilyOptionsInterface
    
    Returns:
    true if filter-deletes behavior is on.
  - setMaxSequentialSkipInIterations
```
public ColumnFamilyOptions setMaxSequentialSkipInIterations(long maxSequentialSkipInIterations)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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 ColumnFamilyOptionsInterface
    
    Parameters:
    maxSequentialSkipInIterations - the number of keys could be skipped in a iteration.
    
    Returns:
    the reference to the current option.
  - maxSequentialSkipInIterations
```
public long maxSequentialSkipInIterations()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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 ColumnFamilyOptionsInterface
    
    Returns:
    the number of keys could be skipped in a iteration.
  - setMemTableConfig
```
public ColumnFamilyOptions setMemTableConfig(MemTableConfig config)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Set the config for mem-table.
    
    Specified by:
    
    setMemTableConfig in interface ColumnFamilyOptionsInterface
    
    Parameters:
    config - the mem-table config.
    
    Returns:
    the instance of the current Object.
  - memTableFactoryName
```
public java.lang.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
    
    Returns:
    the name of the currently-used memtable factory.
    See Also:
    ColumnFamilyOptionsInterface.setTableFormatConfig(org.rocksdb.TableFormatConfig)
  - setTableFormatConfig
```
public ColumnFamilyOptions setTableFormatConfig(TableFormatConfig config)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Set the config for table format.
    
    Specified by:
    
    setTableFormatConfig in interface ColumnFamilyOptionsInterface
    
    Parameters:
    config - the table format config.
    
    Returns:
    the reference of the current Options.
  - tableFactoryName
```
public java.lang.String tableFactoryName()
```
    Specified by:
    
    tableFactoryName in interface ColumnFamilyOptionsInterface
    
    Returns:
    the name of the currently used table factory.
  - setInplaceUpdateSupport
```
public ColumnFamilyOptions setInplaceUpdateSupport(boolean inplaceUpdateSupport)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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 ColumnFamilyOptionsInterface
    
    Parameters:
    inplaceUpdateSupport - true if thread-safe inplace updates are allowed.
    
    Returns:
    the reference to the current option.
  - inplaceUpdateSupport
```
public boolean inplaceUpdateSupport()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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 ColumnFamilyOptionsInterface
    
    Returns:
    true if thread-safe inplace updates are allowed.
  - setInplaceUpdateNumLocks
```
public ColumnFamilyOptions setInplaceUpdateNumLocks(long inplaceUpdateNumLocks)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Number of locks used for inplace update Default: 10000, if inplace_update_support = true, else 0.
    
    Specified by:
    
    setInplaceUpdateNumLocks in interface ColumnFamilyOptionsInterface
    
    Parameters:
    inplaceUpdateNumLocks - the number of locks used for inplace updates.
    
    Returns:
    the reference to the current option.
  - inplaceUpdateNumLocks
```
public long inplaceUpdateNumLocks()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Number of locks used for inplace update Default: 10000, if inplace_update_support = true, else 0.
    
    Specified by:
    
    inplaceUpdateNumLocks in interface ColumnFamilyOptionsInterface
    
    Returns:
    the number of locks used for inplace update.
  - setMemtablePrefixBloomBits
```
public ColumnFamilyOptions setMemtablePrefixBloomBits(int memtablePrefixBloomBits)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Sets the number of bits used in the prefix bloom filter. This value will be used only when a prefix-extractor is specified.
    
    Specified by:
    
    setMemtablePrefixBloomBits in interface ColumnFamilyOptionsInterface
    
    Parameters:
    memtablePrefixBloomBits - the number of bits used in the prefix bloom filter.
    
    Returns:
    the reference to the current option.
  - memtablePrefixBloomBits
```
public int memtablePrefixBloomBits()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Returns the number of bits used in the prefix bloom filter. This value will be used only when a prefix-extractor is specified.
    
    Specified by:
    
    memtablePrefixBloomBits in interface ColumnFamilyOptionsInterface
    
    Returns:
    the number of bloom-bits.
    See Also:
    ColumnFamilyOptionsInterface.useFixedLengthPrefixExtractor(int)
  - setMemtablePrefixBloomProbes
```
public ColumnFamilyOptions setMemtablePrefixBloomProbes(int memtablePrefixBloomProbes)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    The number of hash probes per key used in the mem-table.
    
    Specified by:
    
    setMemtablePrefixBloomProbes in interface ColumnFamilyOptionsInterface
    
    Parameters:
    memtablePrefixBloomProbes - the number of hash probes per key.
    
    Returns:
    the reference to the current option.
  - memtablePrefixBloomProbes
```
public int memtablePrefixBloomProbes()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    The number of hash probes per key used in the mem-table.
    
    Specified by:
    
    memtablePrefixBloomProbes in interface ColumnFamilyOptionsInterface
    
    Returns:
    the number of hash probes per key.
  - setBloomLocality
```
public ColumnFamilyOptions setBloomLocality(int bloomLocality)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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 ColumnFamilyOptionsInterface
    
    Parameters:
    bloomLocality - the level of locality of bloom-filter probes.
    
    Returns:
    the reference to the current option.
  - bloomLocality
```
public int bloomLocality()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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 ColumnFamilyOptionsInterface
    
    Returns:
    the level of locality of bloom-filter probes.
    See Also:
    ColumnFamilyOptionsInterface.setMemtablePrefixBloomProbes(int)
  - setMaxSuccessiveMerges
```
public ColumnFamilyOptions setMaxSuccessiveMerges(long maxSuccessiveMerges)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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 ColumnFamilyOptionsInterface
    
    Parameters:
    maxSuccessiveMerges - the maximum number of successive merges.
    
    Returns:
    the reference to the current option.
  - maxSuccessiveMerges
```
public long maxSuccessiveMerges()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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 ColumnFamilyOptionsInterface
    
    Returns:
    the maximum number of successive merges.
  - setMinPartialMergeOperands
```
public ColumnFamilyOptions setMinPartialMergeOperands(int minPartialMergeOperands)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    The number of partial merge operands to accumulate before partial merge will be performed. Partial merge will not be called if the list of values to merge is less than min_partial_merge_operands. If min_partial_merge_operands < 2, then it will be treated as 2. Default: 2
    
    Specified by:
    
    setMinPartialMergeOperands in interface ColumnFamilyOptionsInterface
    
    Parameters:
    minPartialMergeOperands - min partial merge operands
    
    Returns:
    the reference to the current option.
  - minPartialMergeOperands
```
public int minPartialMergeOperands()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    The number of partial merge operands to accumulate before partial merge will be performed. Partial merge will not be called if the list of values to merge is less than min_partial_merge_operands. If min_partial_merge_operands < 2, then it will be treated as 2. Default: 2
    
    Specified by:
    
    minPartialMergeOperands in interface ColumnFamilyOptionsInterface
    
    Returns:
    min partial merge operands
  - setOptimizeFiltersForHits
```
public ColumnFamilyOptions setOptimizeFiltersForHits(boolean optimizeFiltersForHits)
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    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 ColumnFamilyOptionsInterface
    
    Parameters:
    optimizeFiltersForHits - boolean value indicating if this flag is set.
    
    Returns:
    the reference to the current option.
  - optimizeFiltersForHits
```
public boolean optimizeFiltersForHits()
```
    Description copied from interface: ColumnFamilyOptionsInterface
    
    Returns the current state of the optimize_filters_for_hits setting.
    
    Specified by:
    
    optimizeFiltersForHits in interface ColumnFamilyOptionsInterface
    
    Returns:
    boolean value indicating if the flag optimize_filters_for_hits was set.
  - disposeInternal
```
protected void disposeInternal()
```
    Release the memory allocated for the current instance in the c++ side.
    
    Specified by:
    
    disposeInternal in class RocksObject

Class ColumnFamilyOptions

Field Summary

Fields inherited from class org.rocksdb.RocksObject

Fields inherited from interface org.rocksdb.ColumnFamilyOptionsInterface

Constructor Summary

Method Summary

Methods inherited from class org.rocksdb.RocksObject

Methods inherited from class java.lang.Object

Constructor Detail

ColumnFamilyOptions

Method Detail

getColumnFamilyOptionsFromProps

optimizeForPointLookup

optimizeLevelStyleCompaction

optimizeLevelStyleCompaction

optimizeUniversalStyleCompaction

optimizeUniversalStyleCompaction

setComparator

setComparator

setMergeOperatorName

setMergeOperator

setWriteBufferSize

writeBufferSize

setMaxWriteBufferNumber

maxWriteBufferNumber

setMinWriteBufferNumberToMerge

minWriteBufferNumberToMerge

useFixedLengthPrefixExtractor

setCompressionType

compressionType

setCompressionPerLevel

compressionPerLevel

setNumLevels

numLevels

setLevelZeroFileNumCompactionTrigger

levelZeroFileNumCompactionTrigger

setLevelZeroSlowdownWritesTrigger

levelZeroSlowdownWritesTrigger

setLevelZeroStopWritesTrigger

levelZeroStopWritesTrigger

setMaxMemCompactionLevel

maxMemCompactionLevel

setTargetFileSizeBase

targetFileSizeBase

setTargetFileSizeMultiplier

targetFileSizeMultiplier

setMaxBytesForLevelBase

maxBytesForLevelBase

setLevelCompactionDynamicLevelBytes

Example

levelCompactionDynamicLevelBytes

setMaxBytesForLevelMultiplier

maxBytesForLevelMultiplier

setExpandedCompactionFactor

expandedCompactionFactor

setSourceCompactionFactor

sourceCompactionFactor

setMaxGrandparentOverlapFactor

maxGrandparentOverlapFactor

setSoftRateLimit

softRateLimit

setHardRateLimit

hardRateLimit

setRateLimitDelayMaxMilliseconds

rateLimitDelayMaxMilliseconds

setArenaBlockSize

arenaBlockSize

setDisableAutoCompactions

disableAutoCompactions

setPurgeRedundantKvsWhileFlush

purgeRedundantKvsWhileFlush

setCompactionStyle

compactionStyle

setVerifyChecksumsInCompaction

verifyChecksumsInCompaction

setFilterDeletes

filterDeletes

setMaxSequentialSkipInIterations

maxSequentialSkipInIterations

setMemTableConfig