MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder (schwefel 6.15.5.1 API)

java.lang.Object
- org.rocksdb.AbstractMutableOptions.AbstractMutableOptionsBuilder<MutableColumnFamilyOptions,MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder,org.rocksdb.MutableColumnFamilyOptions.MutableColumnFamilyOptionKey>
- - org.rocksdb.MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder

All Implemented Interfaces:: AdvancedMutableColumnFamilyOptionsInterface<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>, MutableColumnFamilyOptionsInterface<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>

Enclosing class:: MutableColumnFamilyOptions

public static class MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder
extends AbstractMutableOptions.AbstractMutableOptionsBuilder<MutableColumnFamilyOptions,MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder,org.rocksdb.MutableColumnFamilyOptions.MutableColumnFamilyOptionKey>
implements MutableColumnFamilyOptionsInterface<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Map<String,org.rocksdb.MutableColumnFamilyOptions.MutableColumnFamilyOptionKey>`	`allKeys()` Get all of the possible keys
`long`	`arenaBlockSize()` The size of one block in arena memory allocation.
`protected MutableColumnFamilyOptions`	`build(String[] keys, String[] values)` Construct a sub-class instance of `AbstractMutableOptions`.
`CompressionType`	`compressionType()` Compress blocks using the specified compression algorithm.
`boolean`	`disableAutoCompactions()` Disable automatic compactions.
`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.
`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.
`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()` We try to limit number of bytes in one compaction to be lower than this threshold.
`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.
`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.
`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
`protected MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder`	`self()`
`MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder`	`setArenaBlockSize(long arenaBlockSize)` The size of one block in arena memory allocation.
`MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder`	`setCompressionType(CompressionType compressionType)` Compress blocks using the specified compression algorithm.
`MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder`	`setDisableAutoCompactions(boolean disableAutoCompactions)` Disable automatic compactions.
`MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder`	`setHardPendingCompactionBytesLimit(long hardPendingCompactionBytesLimit)` All writes are stopped if estimated bytes needed to be compaction exceed this threshold.
`MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder`	`setInplaceUpdateNumLocks(long inplaceUpdateNumLocks)` Number of locks used for inplace update Default: 10000, if inplace_update_support = true, else 0.
`MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder`	`setLevel0FileNumCompactionTrigger(int level0FileNumCompactionTrigger)` Number of files to trigger level-0 compaction.
`MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder`	`setLevel0SlowdownWritesTrigger(int level0SlowdownWritesTrigger)` Soft limit on number of level-0 files.
`MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder`	`setLevel0StopWritesTrigger(int level0StopWritesTrigger)` Maximum number of level-0 files.
`MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder`	`setMaxBytesForLevelBase(long maxBytesForLevelBase)` The upper-bound of the total size of level-1 files in bytes.
`MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder`	`setMaxBytesForLevelMultiplier(double maxBytesForLevelMultiplier)` The ratio between the total size of level-(L+1) files and the total size of level-L files for all L.
`MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder`	`setMaxBytesForLevelMultiplierAdditional(int[] maxBytesForLevelMultiplierAdditional)` Different max-size multipliers for different levels.
`MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder`	`setMaxCompactionBytes(long maxCompactionBytes)` We try to limit number of bytes in one compaction to be lower than this threshold.
`MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder`	`setMaxSequentialSkipInIterations(long maxSequentialSkipInIterations)` An iteration->Next() sequentially skips over keys with the same user-key unless this option is set.
`MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder`	`setMaxSuccessiveMerges(long maxSuccessiveMerges)` Maximum number of successive merge operations on a key in the memtable.
`MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder`	`setMaxWriteBufferNumber(int maxWriteBufferNumber)` The maximum number of write buffers that are built up in memory.
`MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder`	`setMemtableHugePageSize(long memtableHugePageSize)` Page size for huge page TLB for bloom in memtable.
`MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder`	`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.
`MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder`	`setParanoidFileChecks(boolean paranoidFileChecks)` After writing every SST file, reopen it and read all the keys.
`MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder`	`setReportBgIoStats(boolean reportBgIoStats)` Measure IO stats in compactions and flushes, if true.
`MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder`	`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.
`MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder`	`setTargetFileSizeBase(long targetFileSizeBase)` The target file size for compaction.
`MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder`	`setTargetFileSizeMultiplier(int targetFileSizeMultiplier)` targetFileSizeMultiplier defines the size ratio between a level-L file and level-(L+1) file.
`MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder`	`setTtl(long ttl)` Non-bottom-level files older than TTL will go through the compaction process.
`MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder`	`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.
`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.
`long`	`writeBufferSize()` Return size of write buffer size.

Methods inherited from class org.rocksdb.AbstractMutableOptions.AbstractMutableOptionsBuilder
build, fromString, getBoolean, getDouble, getEnum, getInt, getIntArray, getLong, setBoolean, setDouble, setEnum, setInt, setIntArray, setLong

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

- Method Detail
  - self
```
protected MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder self()
```
    Specified by:
    
    self in class AbstractMutableOptions.AbstractMutableOptionsBuilder<MutableColumnFamilyOptions,MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder,org.rocksdb.MutableColumnFamilyOptions.MutableColumnFamilyOptionKey>
  - allKeys
```
protected Map<String,org.rocksdb.MutableColumnFamilyOptions.MutableColumnFamilyOptionKey> allKeys()
```
    Description copied from class: AbstractMutableOptions.AbstractMutableOptionsBuilder
    
    Get all of the possible keys
    
    Specified by:
    
    allKeys in class AbstractMutableOptions.AbstractMutableOptionsBuilder<MutableColumnFamilyOptions,MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder,org.rocksdb.MutableColumnFamilyOptions.MutableColumnFamilyOptionKey>
    
    Returns:
    
    A map of all keys, indexed by name.
  - build
```
protected MutableColumnFamilyOptions build(String[] keys,
                                           String[] values)
```
    Description copied from class: AbstractMutableOptions.AbstractMutableOptionsBuilder
    
    Construct a sub-class instance of AbstractMutableOptions.
    
    Specified by:
    
    build in class AbstractMutableOptions.AbstractMutableOptionsBuilder<MutableColumnFamilyOptions,MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder,org.rocksdb.MutableColumnFamilyOptions.MutableColumnFamilyOptionKey>
    
    Parameters:
    
    keys - the keys
    
    values - the values
    
    Returns:
    
    an instance of the options.
  - setWriteBufferSize
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder 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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    Returns:
    
    size of write buffer.
    
    See Also:
    
    MutableColumnFamilyOptionsInterface.setWriteBufferSize(long)
  - setArenaBlockSize
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder 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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    Returns:
    
    the size of an arena block
  - setMemtablePrefixBloomSizeRatio
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder 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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    Returns:
    
    the ratio
  - setMemtableHugePageSize
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder 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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    Returns:
    
    The page size of the huge page tlb
  - setMaxSuccessiveMerges
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder 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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    Returns:
    
    the maximum number of successive merges.
  - setMaxWriteBufferNumber
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder 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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    Returns:
    
    maximum number of write buffers.
    
    See Also:
    
    AdvancedMutableColumnFamilyOptionsInterface.setMaxWriteBufferNumber(int)
  - setInplaceUpdateNumLocks
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder 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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    Returns:
    
    the number of locks used for inplace update.
  - setDisableAutoCompactions
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder 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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    Returns:
    
    true if auto-compactions are disabled.
  - setSoftPendingCompactionBytesLimit
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder 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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    Returns:
    
    The soft limit to impose on compaction
  - setHardPendingCompactionBytesLimit
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder 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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    Returns:
    
    The hard limit to impose on compaction
  - setLevel0FileNumCompactionTrigger
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder 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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    Returns:
    
    The number of files to trigger
  - setLevel0SlowdownWritesTrigger
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder 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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    Returns:
    
    The soft limit on the number of level-0 files
  - setLevel0StopWritesTrigger
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder 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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    Returns:
    
    The maximum number of level-0 files
  - setMaxCompactionBytes
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder setMaxCompactionBytes(long maxCompactionBytes)
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    We try to limit number of bytes in one compaction to be lower than this threshold. But it's not guaranteed. Value 0 will be sanitized.
    
    Specified by:
    
    setMaxCompactionBytes in interface MutableColumnFamilyOptionsInterface<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    Parameters:
    
    maxCompactionBytes - max bytes in a compaction
    
    Returns:
    
    the reference to the current option.
    
    See Also:
    
    MutableColumnFamilyOptionsInterface.maxCompactionBytes()
  - maxCompactionBytes
```
public long maxCompactionBytes()
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    We try to limit number of bytes in one compaction to be lower than this threshold. But it's not guaranteed. Value 0 will be sanitized.
    
    Specified by:
    
    maxCompactionBytes in interface MutableColumnFamilyOptionsInterface<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    Returns:
    
    the maximum number of bytes in for a compaction.
    
    See Also:
    
    MutableColumnFamilyOptionsInterface.setMaxCompactionBytes(long)
  - setTargetFileSizeBase
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder 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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    Returns:
    
    the target size of a level-0 file.
    
    See Also:
    
    AdvancedMutableColumnFamilyOptionsInterface.targetFileSizeMultiplier()
  - setTargetFileSizeMultiplier
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder setTargetFileSizeMultiplier(int targetFileSizeMultiplier)
```
    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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    Parameters:
    
    targetFileSizeMultiplier - 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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    Returns:
    
    the size ratio between a level-(L+1) file and level-L file.
  - setMaxBytesForLevelBase
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder 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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    Returns:
    
    the upper-bound of the total size of level-1 files in bytes. See AdvancedMutableColumnFamilyOptionsInterface.maxBytesForLevelMultiplier()
  - setMaxBytesForLevelMultiplier
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder setMaxBytesForLevelMultiplier(double maxBytesForLevelMultiplier)
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    Parameters:
    
    maxBytesForLevelMultiplier - 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 options. See MutableColumnFamilyOptionsInterface.setMaxBytesForLevelBase(long)
  - maxBytesForLevelMultiplier
```
public double maxBytesForLevelMultiplier()
```
    Description copied from interface: AdvancedMutableColumnFamilyOptionsInterface
    
    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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    Returns:
    
    the ratio between the total size of level-(L+1) files and the total size of level-L files for all L. See MutableColumnFamilyOptionsInterface.maxBytesForLevelBase()
  - setMaxBytesForLevelMultiplierAdditional
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder 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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    Returns:
    
    The max-size multipliers for each level
  - setMaxSequentialSkipInIterations
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder 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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    Returns:
    
    the number of keys could be skipped in a iteration.
  - setParanoidFileChecks
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder 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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    Returns:
    
    true if paranoid file checks are enabled
  - setCompressionType
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder 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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    Returns:
    
    Compression type.
  - setReportBgIoStats
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder 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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    Returns:
    
    true if reporting is enabled
  - setTtl
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder 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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    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<MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder>
    
    Returns:
    
    the time-to-live.

Class MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder

Method Summary

Methods inherited from class org.rocksdb.AbstractMutableOptions.AbstractMutableOptionsBuilder

Methods inherited from class java.lang.Object

Method Detail

self

allKeys

build

setWriteBufferSize

writeBufferSize

setArenaBlockSize

arenaBlockSize

setMemtablePrefixBloomSizeRatio

memtablePrefixBloomSizeRatio

setMemtableHugePageSize

memtableHugePageSize

setMaxSuccessiveMerges

maxSuccessiveMerges

setMaxWriteBufferNumber

maxWriteBufferNumber

setInplaceUpdateNumLocks

inplaceUpdateNumLocks

setDisableAutoCompactions

disableAutoCompactions

setSoftPendingCompactionBytesLimit

softPendingCompactionBytesLimit

setHardPendingCompactionBytesLimit

hardPendingCompactionBytesLimit

setLevel0FileNumCompactionTrigger

level0FileNumCompactionTrigger

setLevel0SlowdownWritesTrigger

level0SlowdownWritesTrigger

setLevel0StopWritesTrigger

level0StopWritesTrigger

setMaxCompactionBytes

maxCompactionBytes

setTargetFileSizeBase

targetFileSizeBase

setTargetFileSizeMultiplier

targetFileSizeMultiplier

setMaxBytesForLevelBase

maxBytesForLevelBase

setMaxBytesForLevelMultiplier

maxBytesForLevelMultiplier

setMaxBytesForLevelMultiplierAdditional

maxBytesForLevelMultiplierAdditional

setMaxSequentialSkipInIterations

maxSequentialSkipInIterations

setParanoidFileChecks

paranoidFileChecks

setCompressionType

compressionType

setReportBgIoStats

reportBgIoStats

setTtl

ttl