MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder

java.lang.Object
- org.rocksdb.MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder

All Implemented Interfaces:: MutableColumnFamilyOptionsInterface

Enclosing class:: MutableColumnFamilyOptions

public static class MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder
extends java.lang.Object
implements MutableColumnFamilyOptionsInterface

Constructor Summary

Constructors
Constructor and Description

MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder()

Constructors
Constructor and Description
`MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder()`

Method Summary

Methods
Modifier and Type	Method and Description
`long`	`arenaBlockSize()` The size of one block in arena memory allocation.
`MutableColumnFamilyOptions`	`build()`
`boolean`	`disableAutoCompactions()` Disable automatic compactions.
`MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder`	`fromString(java.lang.String keyStr, java.lang.String valueStr)`
`long`	`hardPendingCompactionBytesLimit()` All writes are stopped if estimated bytes needed to be compaction exceed this threshold.
`double`	`hardRateLimit()` Puts are delayed 1ms at a time when any level has a compaction score that exceeds hard_rate_limit.
`long`	`inplaceUpdateNumLocks()` Number of locks used for inplace update Default: 10000, if inplace_update_support = true, else 0.
`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.
`MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder`	`setArenaBlockSize(long arenaBlockSize)` The size of one block in arena memory allocation.
`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`	`setHardRateLimit(double hardRateLimit)` Puts are delayed 1ms at a time when any level has a compaction score that exceeds hard_rate_limit.
`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`	`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`	`setSoftRateLimit(double softRateLimit)` Puts are delayed 0-1 ms when any level has a compaction score that exceeds soft_rate_limit.
`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`	`setVerifyChecksumsInCompaction(boolean verifyChecksumsInCompaction)` If true, compaction will verify checksum on every read that happens as part of compaction Default: true
`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.
`double`	`softRateLimit()` Puts are delayed 0-1 ms when any level has a compaction score that exceeds soft_rate_limit.
`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.
`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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder()
```
- Method Detail
  - build
```
public MutableColumnFamilyOptions build()
```
  - fromString
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder fromString(java.lang.String keyStr,
                                                                      java.lang.String valueStr)
                                                                        throws java.lang.IllegalArgumentException
```
    Throws:
    
    java.lang.IllegalArgumentException
  - 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: 4MB
    
    Specified by:
    
    setWriteBufferSize in interface MutableColumnFamilyOptionsInterface
    
    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
    
    Returns:
    size of write buffer.
    See Also:
    MutableColumnFamilyOptionsInterface.setWriteBufferSize(long)
  - setArenaBlockSize
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder setArenaBlockSize(long arenaBlockSize)
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    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 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 MutableColumnFamilyOptionsInterface
    
    Parameters:
    arenaBlockSize - the size of an arena block
    
    Returns:
    the reference to the current option.
  - arenaBlockSize
```
public long arenaBlockSize()
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    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 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 MutableColumnFamilyOptionsInterface
    
    Returns:
    the size of an arena block
  - setMemtablePrefixBloomSizeRatio
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder setMemtablePrefixBloomSizeRatio(double memtablePrefixBloomSizeRatio)
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    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 MutableColumnFamilyOptionsInterface
    
    Parameters:
    memtablePrefixBloomSizeRatio - The ratio
    
    Returns:
    the reference to the current option.
  - memtablePrefixBloomSizeRatio
```
public double memtablePrefixBloomSizeRatio()
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    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 MutableColumnFamilyOptionsInterface
    
    Returns:
    the ratio
  - setMemtableHugePageSize
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder setMemtableHugePageSize(long memtableHugePageSize)
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    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 MutableColumnFamilyOptionsInterface
    
    Parameters:
    memtableHugePageSize - The page size of the huge page tlb
    
    Returns:
    the reference to the current option.
  - memtableHugePageSize
```
public long memtableHugePageSize()
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    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 MutableColumnFamilyOptionsInterface
    
    Returns:
    The page size of the huge page tlb
  - setMaxSuccessiveMerges
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder setMaxSuccessiveMerges(long maxSuccessiveMerges)
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    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 MutableColumnFamilyOptionsInterface
    
    Parameters:
    maxSuccessiveMerges - the maximum number of successive merges.
    
    Returns:
    the reference to the current option.
  - maxSuccessiveMerges
```
public long maxSuccessiveMerges()
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    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 MutableColumnFamilyOptionsInterface
    
    Returns:
    the maximum number of successive merges.
  - setMaxWriteBufferNumber
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder setMaxWriteBufferNumber(int maxWriteBufferNumber)
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    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 MutableColumnFamilyOptionsInterface
    
    Parameters:
    maxWriteBufferNumber - maximum number of write buffers.
    
    Returns:
    the instance of the current Object.
  - maxWriteBufferNumber
```
public int maxWriteBufferNumber()
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    Returns maximum number of write buffers.
    
    Specified by:
    
    maxWriteBufferNumber in interface MutableColumnFamilyOptionsInterface
    
    Returns:
    maximum number of write buffers.
    See Also:
    MutableColumnFamilyOptionsInterface.setMaxWriteBufferNumber(int)
  - setInplaceUpdateNumLocks
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder setInplaceUpdateNumLocks(long inplaceUpdateNumLocks)
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    Number of locks used for inplace update Default: 10000, if inplace_update_support = true, else 0.
    
    Specified by:
    
    setInplaceUpdateNumLocks in interface MutableColumnFamilyOptionsInterface
    
    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: MutableColumnFamilyOptionsInterface
    
    Number of locks used for inplace update Default: 10000, if inplace_update_support = true, else 0.
    
    Specified by:
    
    inplaceUpdateNumLocks in interface MutableColumnFamilyOptionsInterface
    
    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
    
    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
    
    Returns:
    true if auto-compactions are disabled.
  - setSoftRateLimit
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder setSoftRateLimit(double softRateLimit)
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    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 MutableColumnFamilyOptionsInterface
    
    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: MutableColumnFamilyOptionsInterface
    
    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 MutableColumnFamilyOptionsInterface
    
    Returns:
    soft-rate-limit for put delay.
  - setSoftPendingCompactionBytesLimit
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder setSoftPendingCompactionBytesLimit(long softPendingCompactionBytesLimit)
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    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 MutableColumnFamilyOptionsInterface
    
    Parameters:
    softPendingCompactionBytesLimit - The soft limit to impose on compaction
    
    Returns:
    the reference to the current option.
  - softPendingCompactionBytesLimit
```
public long softPendingCompactionBytesLimit()
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    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 MutableColumnFamilyOptionsInterface
    
    Returns:
    The soft limit to impose on compaction
  - setHardRateLimit
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder setHardRateLimit(double hardRateLimit)
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    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 MutableColumnFamilyOptionsInterface
    
    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: MutableColumnFamilyOptionsInterface
    
    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 MutableColumnFamilyOptionsInterface
    
    Returns:
    the hard-rate-limit of a compaction score for put delay.
  - setHardPendingCompactionBytesLimit
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder setHardPendingCompactionBytesLimit(long hardPendingCompactionBytesLimit)
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    All writes are stopped if estimated bytes needed to be compaction exceed this threshold. Default: 256GB
    
    Specified by:
    
    setHardPendingCompactionBytesLimit in interface MutableColumnFamilyOptionsInterface
    
    Parameters:
    hardPendingCompactionBytesLimit - The hard limit to impose on compaction
    
    Returns:
    the reference to the current option.
  - hardPendingCompactionBytesLimit
```
public long hardPendingCompactionBytesLimit()
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    All writes are stopped if estimated bytes needed to be compaction exceed this threshold. Default: 256GB
    
    Specified by:
    
    hardPendingCompactionBytesLimit in interface MutableColumnFamilyOptionsInterface
    
    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
    
    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
    
    Returns:
    The number of files to trigger
  - setLevel0SlowdownWritesTrigger
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder setLevel0SlowdownWritesTrigger(int level0SlowdownWritesTrigger)
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    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 MutableColumnFamilyOptionsInterface
    
    Parameters:
    level0SlowdownWritesTrigger - The soft limit on the number of level-0 files
    
    Returns:
    the reference to the current option.
  - level0SlowdownWritesTrigger
```
public int level0SlowdownWritesTrigger()
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    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 MutableColumnFamilyOptionsInterface
    
    Returns:
    The soft limit on the number of level-0 files
  - setLevel0StopWritesTrigger
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder setLevel0StopWritesTrigger(int level0StopWritesTrigger)
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    Maximum number of level-0 files. We stop writes at this point.
    
    Specified by:
    
    setLevel0StopWritesTrigger in interface MutableColumnFamilyOptionsInterface
    
    Parameters:
    level0StopWritesTrigger - The maximum number of level-0 files
    
    Returns:
    the reference to the current option.
  - level0StopWritesTrigger
```
public int level0StopWritesTrigger()
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    Maximum number of level-0 files. We stop writes at this point.
    
    Specified by:
    
    level0StopWritesTrigger in interface MutableColumnFamilyOptionsInterface
    
    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
    
    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
    
    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: MutableColumnFamilyOptionsInterface
    
    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 MutableColumnFamilyOptionsInterface
    
    Parameters:
    targetFileSizeBase - the target size of a level-0 file.
    
    Returns:
    the reference to the current option.
    See Also:
    MutableColumnFamilyOptionsInterface.setTargetFileSizeMultiplier(int)
  - targetFileSizeBase
```
public long targetFileSizeBase()
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    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 MutableColumnFamilyOptionsInterface
    
    Returns:
    the target size of a level-0 file.
    See Also:
    MutableColumnFamilyOptionsInterface.targetFileSizeMultiplier()
  - setTargetFileSizeMultiplier
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder setTargetFileSizeMultiplier(int targetFileSizeMultiplier)
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    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 MutableColumnFamilyOptionsInterface
    
    Parameters:
    targetFileSizeMultiplier - 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: MutableColumnFamilyOptionsInterface
    
    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 MutableColumnFamilyOptionsInterface
    
    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 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 MutableColumnFamilyOptionsInterface
    
    Parameters:
    maxBytesForLevelBase - maximum bytes for level base.
    
    Returns:
    the reference to the current option.
    See Also:
    MutableColumnFamilyOptionsInterface.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 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 MutableColumnFamilyOptionsInterface
    
    Returns:
    the upper-bound of the total size of level-1 files in bytes.
    See Also:
    MutableColumnFamilyOptionsInterface.maxBytesForLevelMultiplier()
  - setMaxBytesForLevelMultiplier
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder setMaxBytesForLevelMultiplier(double maxBytesForLevelMultiplier)
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    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 MutableColumnFamilyOptionsInterface
    
    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 option.
    See Also:
    MutableColumnFamilyOptionsInterface.setMaxBytesForLevelBase(long)
  - maxBytesForLevelMultiplier
```
public double maxBytesForLevelMultiplier()
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    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 MutableColumnFamilyOptionsInterface
    
    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:
    MutableColumnFamilyOptionsInterface.maxBytesForLevelBase()
  - setMaxBytesForLevelMultiplierAdditional
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder setMaxBytesForLevelMultiplierAdditional(int[] maxBytesForLevelMultiplierAdditional)
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    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 MutableColumnFamilyOptionsInterface
    
    Parameters:
    maxBytesForLevelMultiplierAdditional - The max-size multipliers for each level
    
    Returns:
    the reference to the current option.
  - maxBytesForLevelMultiplierAdditional
```
public int[] maxBytesForLevelMultiplierAdditional()
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    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 MutableColumnFamilyOptionsInterface
    
    Returns:
    The max-size multipliers for each level
  - setVerifyChecksumsInCompaction
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder setVerifyChecksumsInCompaction(boolean verifyChecksumsInCompaction)
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    If true, compaction will verify checksum on every read that happens as part of compaction Default: true
    
    Specified by:
    
    setVerifyChecksumsInCompaction in interface MutableColumnFamilyOptionsInterface
    
    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: MutableColumnFamilyOptionsInterface
    
    If true, compaction will verify checksum on every read that happens as part of compaction Default: true
    
    Specified by:
    
    verifyChecksumsInCompaction in interface MutableColumnFamilyOptionsInterface
    
    Returns:
    true if compaction verifies checksum on every read.
  - setMaxSequentialSkipInIterations
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder setMaxSequentialSkipInIterations(long maxSequentialSkipInIterations)
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    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 MutableColumnFamilyOptionsInterface
    
    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: MutableColumnFamilyOptionsInterface
    
    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 MutableColumnFamilyOptionsInterface
    
    Returns:
    the number of keys could be skipped in a iteration.
  - setParanoidFileChecks
```
public MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder setParanoidFileChecks(boolean paranoidFileChecks)
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    After writing every SST file, reopen it and read all the keys. Default: false
    
    Specified by:
    
    setParanoidFileChecks in interface MutableColumnFamilyOptionsInterface
    
    Parameters:
    paranoidFileChecks - true to enable paranoid file checks
    
    Returns:
    the reference to the current option.
  - paranoidFileChecks
```
public boolean paranoidFileChecks()
```
    Description copied from interface: MutableColumnFamilyOptionsInterface
    
    After writing every SST file, reopen it and read all the keys. Default: false
    
    Specified by:
    
    paranoidFileChecks in interface MutableColumnFamilyOptionsInterface
    
    Returns:
    true if paranoid file checks are enabled

Class MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder

Method Detail

build

fromString

setWriteBufferSize

writeBufferSize

setArenaBlockSize

arenaBlockSize

setMemtablePrefixBloomSizeRatio

memtablePrefixBloomSizeRatio

setMemtableHugePageSize

memtableHugePageSize

setMaxSuccessiveMerges

maxSuccessiveMerges

setMaxWriteBufferNumber

maxWriteBufferNumber

setInplaceUpdateNumLocks

inplaceUpdateNumLocks

setDisableAutoCompactions

disableAutoCompactions

setSoftRateLimit

softRateLimit

setSoftPendingCompactionBytesLimit

softPendingCompactionBytesLimit

setHardRateLimit

hardRateLimit

setHardPendingCompactionBytesLimit

hardPendingCompactionBytesLimit

setLevel0FileNumCompactionTrigger

level0FileNumCompactionTrigger

setLevel0SlowdownWritesTrigger

level0SlowdownWritesTrigger

setLevel0StopWritesTrigger

level0StopWritesTrigger

setMaxCompactionBytes

maxCompactionBytes

setTargetFileSizeBase

targetFileSizeBase

setTargetFileSizeMultiplier

targetFileSizeMultiplier

setMaxBytesForLevelBase

maxBytesForLevelBase

setMaxBytesForLevelMultiplier

maxBytesForLevelMultiplier

setMaxBytesForLevelMultiplierAdditional

maxBytesForLevelMultiplierAdditional

setVerifyChecksumsInCompaction

verifyChecksumsInCompaction

setMaxSequentialSkipInIterations

maxSequentialSkipInIterations

setParanoidFileChecks

paranoidFileChecks