MutableDBOptions.MutableDBOptionsBuilder

java.lang.Object
- org.rocksdb.AbstractMutableOptions.AbstractMutableOptionsBuilder<MutableDBOptions,MutableDBOptions.MutableDBOptionsBuilder,org.rocksdb.MutableDBOptions.MutableDBOptionKey>
- - org.rocksdb.MutableDBOptions.MutableDBOptionsBuilder

All Implemented Interfaces:: MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>

Enclosing class:: MutableDBOptions

public static class MutableDBOptions.MutableDBOptionsBuilder
extends AbstractMutableOptions.AbstractMutableOptionsBuilder<MutableDBOptions,MutableDBOptions.MutableDBOptionsBuilder,org.rocksdb.MutableDBOptions.MutableDBOptionKey>
implements MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected java.util.Map<java.lang.String,org.rocksdb.MutableDBOptions.MutableDBOptionKey>`	`allKeys()` Get all the possible keys
`boolean`	`avoidFlushDuringShutdown()` By default RocksDB will flush all memtables on DB close if there are unpersisted data (i.e.
`protected MutableDBOptions`	`build(java.lang.String[] keys, java.lang.String[] values)` Construct a subclass instance of `AbstractMutableOptions`.
`long`	`bytesPerSync()` Allows OS to incrementally sync files to disk while they are being written, asynchronously, in the background.
`long`	`compactionReadaheadSize()` If non-zero, we perform bigger reads when doing compaction.
`long`	`delayedWriteRate()` The limited write rate to DB if `ColumnFamilyOptions.softPendingCompactionBytesLimit()` or `ColumnFamilyOptions.level0SlowdownWritesTrigger()` is triggered, or we are writing to the last mem table allowed and we allow more than 3 mem tables.
`long`	`deleteObsoleteFilesPeriodMicros()` The periodicity when obsolete files get deleted.
`int`	`maxBackgroundCompactions()` Deprecated.
`int`	`maxBackgroundJobs()` Returns the maximum number of concurrent background jobs (both flushes and compactions combined).
`int`	`maxOpenFiles()` Number of open files that can be used by the DB.
`long`	`maxTotalWalSize()` Returns the max total write-ahead log size.
`protected MutableDBOptions.MutableDBOptionsBuilder`	`self()`
`MutableDBOptions.MutableDBOptionsBuilder`	`setAvoidFlushDuringShutdown(boolean avoidFlushDuringShutdown)` By default RocksDB will flush all memtables on DB close if there are unpersisted data (i.e.
`MutableDBOptions.MutableDBOptionsBuilder`	`setBytesPerSync(long bytesPerSync)` Allows OS to incrementally sync files to disk while they are being written, asynchronously, in the background.
`MutableDBOptions.MutableDBOptionsBuilder`	`setCompactionReadaheadSize(long compactionReadaheadSize)` If non-zero, we perform bigger reads when doing compaction.
`MutableDBOptions.MutableDBOptionsBuilder`	`setDelayedWriteRate(long delayedWriteRate)` The limited write rate to DB if `ColumnFamilyOptions.softPendingCompactionBytesLimit()` or `ColumnFamilyOptions.level0SlowdownWritesTrigger()` is triggered, or we are writing to the last mem table allowed and we allow more than 3 mem tables.
`MutableDBOptions.MutableDBOptionsBuilder`	`setDeleteObsoleteFilesPeriodMicros(long micros)` The periodicity when obsolete files get deleted.
`MutableDBOptions.MutableDBOptionsBuilder`	`setMaxBackgroundCompactions(int maxBackgroundCompactions)` Deprecated.
`MutableDBOptions.MutableDBOptionsBuilder`	`setMaxBackgroundJobs(int maxBackgroundJobs)` Specifies the maximum number of concurrent background jobs (both flushes and compactions combined).
`MutableDBOptions.MutableDBOptionsBuilder`	`setMaxOpenFiles(int maxOpenFiles)` Number of open files that can be used by the DB.
`MutableDBOptions.MutableDBOptionsBuilder`	`setMaxTotalWalSize(long maxTotalWalSize)` Set the max total write-ahead log size.
`MutableDBOptions.MutableDBOptionsBuilder`	`setStatsDumpPeriodSec(int statsDumpPeriodSec)` if not zero, dump rocksdb.stats to LOG every stats_dump_period_sec Default: 600 (10 minutes)
`MutableDBOptions.MutableDBOptionsBuilder`	`setStatsHistoryBufferSize(long statsHistoryBufferSize)` If not zero, periodically take stats snapshots and store in memory, the memory size for stats snapshots is capped at `statsHistoryBufferSize` Default: 1MB
`MutableDBOptions.MutableDBOptionsBuilder`	`setStatsPersistPeriodSec(int statsPersistPeriodSec)` If not zero, dump rocksdb.stats to RocksDB every `statsPersistPeriodSec` Default: 600
`MutableDBOptions.MutableDBOptionsBuilder`	`setStrictBytesPerSync(boolean strictBytesPerSync)` When true, guarantees WAL files have at most `MutableDBOptionsInterface.walBytesPerSync()` bytes submitted for writeback at any given time, and SST files have at most `MutableDBOptionsInterface.bytesPerSync()` bytes pending writeback at any given time.
`MutableDBOptions.MutableDBOptionsBuilder`	`setWalBytesPerSync(long walBytesPerSync)` Same as `MutableDBOptionsInterface.setBytesPerSync(long)` , but applies to WAL files
`MutableDBOptions.MutableDBOptionsBuilder`	`setWritableFileMaxBufferSize(long writableFileMaxBufferSize)` This is the maximum buffer size that is used by WritableFileWriter.
`int`	`statsDumpPeriodSec()` If not zero, dump rocksdb.stats to LOG every stats_dump_period_sec Default: 600 (10 minutes)
`long`	`statsHistoryBufferSize()` If not zero, periodically take stats snapshots and store in memory, the memory size for stats snapshots is capped at `statsHistoryBufferSize`
`int`	`statsPersistPeriodSec()` If not zero, dump rocksdb.stats to RocksDB every `statsPersistPeriodSec`
`boolean`	`strictBytesPerSync()` Return the strict byte limit per sync.
`long`	`walBytesPerSync()` Same as `MutableDBOptionsInterface.bytesPerSync()` , but applies to WAL files
`long`	`writableFileMaxBufferSize()` This is the maximum buffer size that is used by WritableFileWriter.

Methods inherited from class org.rocksdb.AbstractMutableOptions.AbstractMutableOptionsBuilder
build, fromParsed, getBoolean, getDouble, getEnum, getInt, getIntArray, getLong, getUnknown, 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 MutableDBOptions.MutableDBOptionsBuilder self()
```
    Specified by:
    
    self in class AbstractMutableOptions.AbstractMutableOptionsBuilder<MutableDBOptions,MutableDBOptions.MutableDBOptionsBuilder,org.rocksdb.MutableDBOptions.MutableDBOptionKey>
  - allKeys
```
protected java.util.Map<java.lang.String,org.rocksdb.MutableDBOptions.MutableDBOptionKey> allKeys()
```
    Description copied from class: AbstractMutableOptions.AbstractMutableOptionsBuilder
    
    Get all the possible keys
    
    Specified by:
    
    allKeys in class AbstractMutableOptions.AbstractMutableOptionsBuilder<MutableDBOptions,MutableDBOptions.MutableDBOptionsBuilder,org.rocksdb.MutableDBOptions.MutableDBOptionKey>
    
    Returns:
    
    A map of all keys, indexed by name.
  - build
```
protected MutableDBOptions build(java.lang.String[] keys,
                                 java.lang.String[] values)
```
    Description copied from class: AbstractMutableOptions.AbstractMutableOptionsBuilder
    
    Construct a subclass instance of AbstractMutableOptions.
    
    Specified by:
    
    build in class AbstractMutableOptions.AbstractMutableOptionsBuilder<MutableDBOptions,MutableDBOptions.MutableDBOptionsBuilder,org.rocksdb.MutableDBOptions.MutableDBOptionKey>
    
    Parameters:
    
    keys - the keys
    
    values - the values
    
    Returns:
    
    an instance of the options.
  - setMaxBackgroundJobs
```
public MutableDBOptions.MutableDBOptionsBuilder setMaxBackgroundJobs(int maxBackgroundJobs)
```
    Description copied from interface: MutableDBOptionsInterface
    
    Specifies the maximum number of concurrent background jobs (both flushes and compactions combined). Default: 2
    
    Specified by:
    
    setMaxBackgroundJobs in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Parameters:
    
    maxBackgroundJobs - number of max concurrent background jobs
    
    Returns:
    
    the instance of the current object.
  - maxBackgroundJobs
```
public int maxBackgroundJobs()
```
    Description copied from interface: MutableDBOptionsInterface
    
    Returns the maximum number of concurrent background jobs (both flushes and compactions combined). Default: 2
    
    Specified by:
    
    maxBackgroundJobs in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Returns:
    
    the maximum number of concurrent background jobs.
  - setMaxBackgroundCompactions
```
@Deprecated
public MutableDBOptions.MutableDBOptionsBuilder setMaxBackgroundCompactions(int maxBackgroundCompactions)
```
    Deprecated.
    
    Description copied from interface: MutableDBOptionsInterface
    
    NOT SUPPORTED ANYMORE: RocksDB automatically decides this based on the value of max_background_jobs. For backwards compatibility we will set `max_background_jobs = max_background_compactions + max_background_flushes` in the case where user sets at least one of `max_background_compactions` or `max_background_flushes` (we replace -1 by 1 in case one option is unset).
    Specifies the maximum number of concurrent background compaction jobs, submitted to the default LOW priority thread pool. If you're increasing this, also consider increasing number of threads in LOW priority thread pool. For more information, see Default: -1
    
    Specified by:
    
    setMaxBackgroundCompactions in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Parameters:
    
    maxBackgroundCompactions - the maximum number of background compaction jobs.
    
    Returns:
    
    the instance of the current object.
    
    See Also:
    
    Env.setBackgroundThreads(int), Env.setBackgroundThreads(int, Priority), DBOptionsInterface.maxBackgroundFlushes()
  - maxBackgroundCompactions
```
@Deprecated
public int maxBackgroundCompactions()
```
    Deprecated.
    
    Description copied from interface: MutableDBOptionsInterface
    
    NOT SUPPORTED ANYMORE: RocksDB automatically decides this based on the value of max_background_jobs. For backwards compatibility we will set `max_background_jobs = max_background_compactions + max_background_flushes` in the case where user sets at least one of `max_background_compactions` or `max_background_flushes` (we replace -1 by 1 in case one option is unset).
    Returns the maximum number of concurrent background compaction jobs, submitted to the default LOW priority thread pool. When increasing this number, we may also want to consider increasing number of threads in LOW priority thread pool. Default: -1
    
    Specified by:
    
    maxBackgroundCompactions in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Returns:
    
    the maximum number of concurrent background compaction jobs.
    
    See Also:
    
    Env.setBackgroundThreads(int), Env.setBackgroundThreads(int, Priority)
  - setAvoidFlushDuringShutdown
```
public MutableDBOptions.MutableDBOptionsBuilder setAvoidFlushDuringShutdown(boolean avoidFlushDuringShutdown)
```
    Description copied from interface: MutableDBOptionsInterface
    
    By default RocksDB will flush all memtables on DB close if there are unpersisted data (i.e. with WAL disabled) The flush can be skip to speedup DB close. Unpersisted data WILL BE LOST.
    DEFAULT: false
    Dynamically changeable through RocksDB.setOptions(ColumnFamilyHandle, MutableColumnFamilyOptions) API.
    
    Specified by:
    
    setAvoidFlushDuringShutdown in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Parameters:
    
    avoidFlushDuringShutdown - true if we should avoid flush during shutdown
    
    Returns:
    
    the reference to the current options.
  - avoidFlushDuringShutdown
```
public boolean avoidFlushDuringShutdown()
```
    Description copied from interface: MutableDBOptionsInterface
    
    By default RocksDB will flush all memtables on DB close if there are unpersisted data (i.e. with WAL disabled) The flush can be skip to speedup DB close. Unpersisted data WILL BE LOST.
    DEFAULT: false
    Dynamically changeable through RocksDB.setOptions(ColumnFamilyHandle, MutableColumnFamilyOptions) API.
    
    Specified by:
    
    avoidFlushDuringShutdown in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Returns:
    
    true if we should avoid flush during shutdown
  - setWritableFileMaxBufferSize
```
public MutableDBOptions.MutableDBOptionsBuilder setWritableFileMaxBufferSize(long writableFileMaxBufferSize)
```
    Description copied from interface: MutableDBOptionsInterface
    
    This is the maximum buffer size that is used by WritableFileWriter. On Windows, we need to maintain an aligned buffer for writes. We allow the buffer to grow until it's size hits the limit.
    Default: 1024 * 1024 (1 MB)
    
    Specified by:
    
    setWritableFileMaxBufferSize in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Parameters:
    
    writableFileMaxBufferSize - the maximum buffer size
    
    Returns:
    
    the reference to the current options.
  - writableFileMaxBufferSize
```
public long writableFileMaxBufferSize()
```
    Description copied from interface: MutableDBOptionsInterface
    
    This is the maximum buffer size that is used by WritableFileWriter. On Windows, we need to maintain an aligned buffer for writes. We allow the buffer to grow until it's size hits the limit.
    Default: 1024 * 1024 (1 MB)
    
    Specified by:
    
    writableFileMaxBufferSize in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Returns:
    
    the maximum buffer size
  - setDelayedWriteRate
```
public MutableDBOptions.MutableDBOptionsBuilder setDelayedWriteRate(long delayedWriteRate)
```
    Description copied from interface: MutableDBOptionsInterface
    
    The limited write rate to DB if ColumnFamilyOptions.softPendingCompactionBytesLimit() or ColumnFamilyOptions.level0SlowdownWritesTrigger() is triggered, or we are writing to the last mem table allowed and we allow more than 3 mem tables. It is calculated using size of user write requests before compression. RocksDB may decide to slow down more if the compaction still gets behind further. If the value is 0, we will infer a value from `rater_limiter` value if it is not empty, or 16MB if `rater_limiter` is empty. Note that if users change the rate in `rate_limiter` after DB is opened, `delayed_write_rate` won't be adjusted.
    Unit: bytes per second.
    Default: 0
    Dynamically changeable through RocksDB.setDBOptions(MutableDBOptions).
    
    Specified by:
    
    setDelayedWriteRate in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Parameters:
    
    delayedWriteRate - the rate in bytes per second
    
    Returns:
    
    the reference to the current options.
  - delayedWriteRate
```
public long delayedWriteRate()
```
    Description copied from interface: MutableDBOptionsInterface
    
    The limited write rate to DB if ColumnFamilyOptions.softPendingCompactionBytesLimit() or ColumnFamilyOptions.level0SlowdownWritesTrigger() is triggered, or we are writing to the last mem table allowed and we allow more than 3 mem tables. It is calculated using size of user write requests before compression. RocksDB may decide to slow down more if the compaction still gets behind further. If the value is 0, we will infer a value from `rater_limiter` value if it is not empty, or 16MB if `rater_limiter` is empty. Note that if users change the rate in `rate_limiter` after DB is opened, `delayed_write_rate` won't be adjusted.
    Unit: bytes per second.
    Default: 0
    Dynamically changeable through RocksDB.setDBOptions(MutableDBOptions).
    
    Specified by:
    
    delayedWriteRate in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Returns:
    
    the rate in bytes per second
  - setMaxTotalWalSize
```
public MutableDBOptions.MutableDBOptionsBuilder setMaxTotalWalSize(long maxTotalWalSize)
```
    Description copied from interface: MutableDBOptionsInterface
    
    Set the max total write-ahead log size. Once write-ahead logs exceed this size, we will start forcing the flush of column families whose memtables are backed by the oldest live WAL file
    
    The oldest WAL files are the ones that are causing all the space amplification.
    For example, with 15 column families, each with write_buffer_size = 128 MB max_write_buffer_number = 6 max_total_wal_size will be calculated to be [15 * 128MB * 6] * 4 = 45GB
    The RocksDB wiki has some discussion about how the WAL interacts with memtables and flushing of column families, at ...
    
    If set to 0 (default), we will dynamically choose the WAL size limit to be [sum of all write_buffer_size * max_write_buffer_number] * 4
    
    This option takes effect only when there are more than one column family as otherwise the wal size is dictated by the write_buffer_size.
    
    Default: 0
    
    Specified by:
    
    setMaxTotalWalSize in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Parameters:
    
    maxTotalWalSize - max total wal size.
    
    Returns:
    
    the instance of the current object.
  - maxTotalWalSize
```
public long maxTotalWalSize()
```
    Description copied from interface: MutableDBOptionsInterface
    
    Returns the max total write-ahead log size. Once write-ahead logs exceed this size, we will start forcing the flush of column families whose memtables are backed by the oldest live WAL file.
    
    The oldest WAL files are the ones that are causing all the space amplification.
    For example, with 15 column families, each with write_buffer_size = 128 MB max_write_buffer_number = 6 max_total_wal_size will be calculated to be [15 * 128MB * 6] * 4 = 45GB
    The RocksDB wiki has some discussion about how the WAL interacts with memtables and flushing of column families, at ...
    
    If set to 0 (default), we will dynamically choose the WAL size limit to be [sum of all write_buffer_size * max_write_buffer_number] * 4
    
    This option takes effect only when there are more than one column family as otherwise the wal size is dictated by the write_buffer_size.
    
    Default: 0
    
    If set to 0 (default), we will dynamically choose the WAL size limit to be [sum of all write_buffer_size * max_write_buffer_number] * 4
    
    Specified by:
    
    maxTotalWalSize in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Returns:
    
    max total wal size
  - setDeleteObsoleteFilesPeriodMicros
```
public MutableDBOptions.MutableDBOptionsBuilder setDeleteObsoleteFilesPeriodMicros(long micros)
```
    Description copied from interface: MutableDBOptionsInterface
    
    The periodicity when obsolete files get deleted. The default value is 6 hours. The files that get out of scope by compaction process will still get automatically delete on every compaction, regardless of this setting
    
    Specified by:
    
    setDeleteObsoleteFilesPeriodMicros in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Parameters:
    
    micros - the time interval in micros
    
    Returns:
    
    the instance of the current object.
  - deleteObsoleteFilesPeriodMicros
```
public long deleteObsoleteFilesPeriodMicros()
```
    Description copied from interface: MutableDBOptionsInterface
    
    The periodicity when obsolete files get deleted. The default value is 6 hours. The files that get out of scope by compaction process will still get automatically delete on every compaction, regardless of this setting
    
    Specified by:
    
    deleteObsoleteFilesPeriodMicros in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Returns:
    
    the time interval in micros when obsolete files will be deleted.
  - setStatsDumpPeriodSec
```
public MutableDBOptions.MutableDBOptionsBuilder setStatsDumpPeriodSec(int statsDumpPeriodSec)
```
    Description copied from interface: MutableDBOptionsInterface
    
    if not zero, dump rocksdb.stats to LOG every stats_dump_period_sec Default: 600 (10 minutes)
    
    Specified by:
    
    setStatsDumpPeriodSec in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Parameters:
    
    statsDumpPeriodSec - time interval in seconds.
    
    Returns:
    
    the instance of the current object.
  - statsDumpPeriodSec
```
public int statsDumpPeriodSec()
```
    Description copied from interface: MutableDBOptionsInterface
    
    If not zero, dump rocksdb.stats to LOG every stats_dump_period_sec Default: 600 (10 minutes)
    
    Specified by:
    
    statsDumpPeriodSec in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Returns:
    
    time interval in seconds.
  - setStatsPersistPeriodSec
```
public MutableDBOptions.MutableDBOptionsBuilder setStatsPersistPeriodSec(int statsPersistPeriodSec)
```
    Description copied from interface: MutableDBOptionsInterface
    
    If not zero, dump rocksdb.stats to RocksDB every statsPersistPeriodSec Default: 600
    
    Specified by:
    
    setStatsPersistPeriodSec in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Parameters:
    
    statsPersistPeriodSec - time interval in seconds.
    
    Returns:
    
    the instance of the current object.
  - statsPersistPeriodSec
```
public int statsPersistPeriodSec()
```
    Description copied from interface: MutableDBOptionsInterface
    
    If not zero, dump rocksdb.stats to RocksDB every statsPersistPeriodSec
    
    Specified by:
    
    statsPersistPeriodSec in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Returns:
    
    time interval in seconds.
  - setStatsHistoryBufferSize
```
public MutableDBOptions.MutableDBOptionsBuilder setStatsHistoryBufferSize(long statsHistoryBufferSize)
```
    Description copied from interface: MutableDBOptionsInterface
    
    If not zero, periodically take stats snapshots and store in memory, the memory size for stats snapshots is capped at statsHistoryBufferSize Default: 1MB
    
    Specified by:
    
    setStatsHistoryBufferSize in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Parameters:
    
    statsHistoryBufferSize - the size of the buffer.
    
    Returns:
    
    the instance of the current object.
  - statsHistoryBufferSize
```
public long statsHistoryBufferSize()
```
    Description copied from interface: MutableDBOptionsInterface
    
    If not zero, periodically take stats snapshots and store in memory, the memory size for stats snapshots is capped at statsHistoryBufferSize
    
    Specified by:
    
    statsHistoryBufferSize in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Returns:
    
    the size of the buffer.
  - setMaxOpenFiles
```
public MutableDBOptions.MutableDBOptionsBuilder setMaxOpenFiles(int maxOpenFiles)
```
    Description copied from interface: MutableDBOptionsInterface
    
    Number of open files that can be used by the DB. You may need to increase this if your database has a large working set. Value -1 means files opened are always kept open. You can estimate number of files based on target_file_size_base and target_file_size_multiplier for level-based compaction. For universal-style compaction, you can usually set it to -1. Default: -1
    
    Specified by:
    
    setMaxOpenFiles in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Parameters:
    
    maxOpenFiles - the maximum number of open files.
    
    Returns:
    
    the instance of the current object.
  - maxOpenFiles
```
public int maxOpenFiles()
```
    Description copied from interface: MutableDBOptionsInterface
    
    Number of open files that can be used by the DB. You may need to increase this if your database has a large working set. Value -1 means files opened are always kept open. You can estimate number of files based on target_file_size_base and target_file_size_multiplier for level-based compaction. For universal-style compaction, you can usually set it to -1. Default: -1
    
    Specified by:
    
    maxOpenFiles in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Returns:
    
    the maximum number of open files.
  - setBytesPerSync
```
public MutableDBOptions.MutableDBOptionsBuilder setBytesPerSync(long bytesPerSync)
```
    Description copied from interface: MutableDBOptionsInterface
    
    Allows OS to incrementally sync files to disk while they are being written, asynchronously, in the background. Issue one request for every bytes_per_sync written. 0 turns it off. Default: 0
    
    Specified by:
    
    setBytesPerSync in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Parameters:
    
    bytesPerSync - size in bytes
    
    Returns:
    
    the instance of the current object.
  - bytesPerSync
```
public long bytesPerSync()
```
    Description copied from interface: MutableDBOptionsInterface
    
    Allows OS to incrementally sync files to disk while they are being written, asynchronously, in the background. Issue one request for every bytes_per_sync written. 0 turns it off. Default: 0
    
    Specified by:
    
    bytesPerSync in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Returns:
    
    size in bytes
  - setWalBytesPerSync
```
public MutableDBOptions.MutableDBOptionsBuilder setWalBytesPerSync(long walBytesPerSync)
```
    Description copied from interface: MutableDBOptionsInterface
    
    Same as MutableDBOptionsInterface.setBytesPerSync(long) , but applies to WAL files
    Default: 0, turned off
    
    Specified by:
    
    setWalBytesPerSync in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Parameters:
    
    walBytesPerSync - size in bytes
    
    Returns:
    
    the instance of the current object.
  - walBytesPerSync
```
public long walBytesPerSync()
```
    Description copied from interface: MutableDBOptionsInterface
    
    Same as MutableDBOptionsInterface.bytesPerSync() , but applies to WAL files
    Default: 0, turned off
    
    Specified by:
    
    walBytesPerSync in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Returns:
    
    size in bytes
  - setStrictBytesPerSync
```
public MutableDBOptions.MutableDBOptionsBuilder setStrictBytesPerSync(boolean strictBytesPerSync)
```
    Description copied from interface: MutableDBOptionsInterface
    
    When true, guarantees WAL files have at most MutableDBOptionsInterface.walBytesPerSync() bytes submitted for writeback at any given time, and SST files have at most MutableDBOptionsInterface.bytesPerSync() bytes pending writeback at any given time. This can be used to handle cases where processing speed exceeds I/O speed during file generation, which can lead to a huge sync when the file is finished, even with MutableDBOptionsInterface.bytesPerSync() / MutableDBOptionsInterface.walBytesPerSync() properly configured.
    - If `sync_file_range` is supported it achieves this by waiting for any prior `sync_file_range`s to finish before proceeding. In this way, processing (compression, etc.) can proceed uninhibited in the gap between `sync_file_range`s, and we block only when I/O falls behind. - Otherwise the `WritableFile::Sync` method is used. Note this mechanism always blocks, thus preventing the interleaving of I/O and processing.
    Note: Enabling this option does not provide any additional persistence guarantees, as it may use `sync_file_range`, which does not write out metadata.
    Default: false
    
    Specified by:
    
    setStrictBytesPerSync in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Parameters:
    
    strictBytesPerSync - the bytes per sync
    
    Returns:
    
    the instance of the current object.
  - strictBytesPerSync
```
public boolean strictBytesPerSync()
```
    Description copied from interface: MutableDBOptionsInterface
    
    Return the strict byte limit per sync.
    See MutableDBOptionsInterface.setStrictBytesPerSync(boolean)
    
    Specified by:
    
    strictBytesPerSync in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Returns:
    
    the limit in bytes.
  - setCompactionReadaheadSize
```
public MutableDBOptions.MutableDBOptionsBuilder setCompactionReadaheadSize(long compactionReadaheadSize)
```
    Description copied from interface: MutableDBOptionsInterface
    
    If non-zero, we perform bigger reads when doing compaction. If you're running RocksDB on spinning disks, you should set this to at least 2MB.
    That way RocksDB's compaction is doing sequential instead of random reads.
    Default: 0
    
    Specified by:
    
    setCompactionReadaheadSize in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Parameters:
    
    compactionReadaheadSize - The compaction read-ahead size
    
    Returns:
    
    the reference to the current options.
  - compactionReadaheadSize
```
public long compactionReadaheadSize()
```
    Description copied from interface: MutableDBOptionsInterface
    
    If non-zero, we perform bigger reads when doing compaction. If you're running RocksDB on spinning disks, you should set this to at least 2MB.
    That way RocksDB's compaction is doing sequential instead of random reads.
    Default: 0
    
    Specified by:
    
    compactionReadaheadSize in interface MutableDBOptionsInterface<MutableDBOptions.MutableDBOptionsBuilder>
    
    Returns:
    
    The compaction read-ahead size

Class MutableDBOptions.MutableDBOptionsBuilder

Method Summary

Methods inherited from class org.rocksdb.AbstractMutableOptions.AbstractMutableOptionsBuilder

Methods inherited from class java.lang.Object

Method Detail

self

allKeys

build

setMaxBackgroundJobs

maxBackgroundJobs

setMaxBackgroundCompactions

maxBackgroundCompactions

setAvoidFlushDuringShutdown

avoidFlushDuringShutdown

setWritableFileMaxBufferSize

writableFileMaxBufferSize

setDelayedWriteRate

delayedWriteRate

setMaxTotalWalSize

maxTotalWalSize

setDeleteObsoleteFilesPeriodMicros

deleteObsoleteFilesPeriodMicros

setStatsDumpPeriodSec

statsDumpPeriodSec

setStatsPersistPeriodSec

statsPersistPeriodSec

setStatsHistoryBufferSize

statsHistoryBufferSize

setMaxOpenFiles

maxOpenFiles

setBytesPerSync

bytesPerSync

setWalBytesPerSync

walBytesPerSync

setStrictBytesPerSync

strictBytesPerSync

setCompactionReadaheadSize

compactionReadaheadSize