DefaultConfigurableOptionsFactory (Flink : State backends : RocksDB 1.14.3 API)

java.lang.Object
- org.apache.flink.contrib.streaming.state.DefaultConfigurableOptionsFactory

All Implemented Interfaces:

Serializable, ConfigurableRocksDBOptionsFactory, RocksDBOptionsFactory
```
public class DefaultConfigurableOptionsFactory
extends Object
implements ConfigurableRocksDBOptionsFactory
```
An implementation of ConfigurableRocksDBOptionsFactory using options provided by RocksDBConfigurableOptions. It acts as the default options factory within EmbeddedRocksDBStateBackend if the user did not define a RocksDBOptionsFactory.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

DefaultConfigurableOptionsFactory()

Constructors
Constructor and Description
`DefaultConfigurableOptionsFactory()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DefaultConfigurableOptionsFactory`	`configure(org.apache.flink.configuration.ReadableConfig configuration)` Creates a `DefaultConfigurableOptionsFactory` instance from a `ReadableConfig`.
`org.rocksdb.ColumnFamilyOptions`	`createColumnOptions(org.rocksdb.ColumnFamilyOptions currentOptions, Collection<AutoCloseable> handlesToClose)` This method should set the additional options on top of the current options object.
`org.rocksdb.DBOptions`	`createDBOptions(org.rocksdb.DBOptions currentOptions, Collection<AutoCloseable> handlesToClose)` This method should set the additional options on top of the current options object.
`Map<String,String>`	`getConfiguredOptions()`
`DefaultConfigurableOptionsFactory`	`setBlockCacheSize(String blockCacheSize)`
`DefaultConfigurableOptionsFactory`	`setBlockSize(String blockSize)`
`DefaultConfigurableOptionsFactory`	`setBloomFilterBitsPerKey(double bitsPerKey)`
`DefaultConfigurableOptionsFactory`	`setBloomFilterBlockBasedMode(boolean blockBasedMode)`
`DefaultConfigurableOptionsFactory`	`setCompactionStyle(org.rocksdb.CompactionStyle compactionStyle)`
`DefaultConfigurableOptionsFactory`	`setLogDir(String logDir)` The directory for RocksDB's logging files.
`DefaultConfigurableOptionsFactory`	`setLogFileNum(int logFileNum)` The maximum number of files RocksDB should keep for logging.
`DefaultConfigurableOptionsFactory`	`setLogLevel(org.rocksdb.InfoLogLevel logLevel)`
`DefaultConfigurableOptionsFactory`	`setMaxBackgroundThreads(int totalThreadCount)`
`DefaultConfigurableOptionsFactory`	`setMaxLogFileSize(String maxLogFileSize)` The maximum size of RocksDB's file used for logging.
`DefaultConfigurableOptionsFactory`	`setMaxOpenFiles(int maxOpenFiles)`
`DefaultConfigurableOptionsFactory`	`setMaxSizeLevelBase(String maxSizeLevelBase)`
`DefaultConfigurableOptionsFactory`	`setMaxWriteBufferNumber(int writeBufferNumber)`
`DefaultConfigurableOptionsFactory`	`setMetadataBlockSize(String metadataBlockSize)`
`DefaultConfigurableOptionsFactory`	`setMinWriteBufferNumberToMerge(int writeBufferNumber)`
`DefaultConfigurableOptionsFactory`	`setTargetFileSizeBase(String targetFileSizeBase)`
`DefaultConfigurableOptionsFactory`	`setUseBloomFilter(boolean useBloomFilter)`
`DefaultConfigurableOptionsFactory`	`setUseDynamicLevelSize(boolean value)`
`DefaultConfigurableOptionsFactory`	`setWriteBufferSize(String writeBufferSize)`
`String`	`toString()`

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

Methods inherited from interface org.apache.flink.contrib.streaming.state.RocksDBOptionsFactory
createNativeMetricsOptions, createReadOptions, createWriteOptions

- Constructor Detail
  - DefaultConfigurableOptionsFactory
```
public DefaultConfigurableOptionsFactory()
```
- Method Detail
  - createDBOptions
```
public org.rocksdb.DBOptions createDBOptions(org.rocksdb.DBOptions currentOptions,
                                             Collection<AutoCloseable> handlesToClose)
```
    Description copied from interface: RocksDBOptionsFactory
    
    This method should set the additional options on top of the current options object. The current options object may contain pre-defined options based on flags that have been configured on the state backend.
    It is important to set the options on the current object and return the result from the setter methods, otherwise the pre-defined options may get lost.
    
    Specified by:
    
    createDBOptions in interface RocksDBOptionsFactory
    
    Parameters:
    
    currentOptions - The options object with the pre-defined options.
    
    handlesToClose - The collection to register newly created RocksObjects.
    
    Returns:
    
    The options object on which the additional options are set.
  - createColumnOptions
```
public org.rocksdb.ColumnFamilyOptions createColumnOptions(org.rocksdb.ColumnFamilyOptions currentOptions,
                                                           Collection<AutoCloseable> handlesToClose)
```
    Description copied from interface: RocksDBOptionsFactory
    
    This method should set the additional options on top of the current options object. The current options object may contain pre-defined options based on flags that have been configured on the state backend.
    It is important to set the options on the current object and return the result from the setter methods, otherwise the pre-defined options may get lost.
    
    Specified by:
    
    createColumnOptions in interface RocksDBOptionsFactory
    
    Parameters:
    
    currentOptions - The options object with the pre-defined options.
    
    handlesToClose - The collection to register newly created RocksObjects.
    
    Returns:
    
    The options object on which the additional options are set.
  - getConfiguredOptions
```
public Map<String,String> getConfiguredOptions()
```
  - setMaxBackgroundThreads
```
public DefaultConfigurableOptionsFactory setMaxBackgroundThreads(int totalThreadCount)
```
  - setMaxOpenFiles
```
public DefaultConfigurableOptionsFactory setMaxOpenFiles(int maxOpenFiles)
```
  - setLogLevel
```
public DefaultConfigurableOptionsFactory setLogLevel(org.rocksdb.InfoLogLevel logLevel)
```
  - setLogDir
```
public DefaultConfigurableOptionsFactory setLogDir(String logDir)
```
    The directory for RocksDB's logging files.
    
    Parameters:
    
    logDir - If empty, log files will be in the same directory as data files
    If non-empty, this directory will be used and the data directory's absolute path will be used as the prefix of the log file name.
    
    Returns:
    
    this options factory
  - setMaxLogFileSize
```
public DefaultConfigurableOptionsFactory setMaxLogFileSize(String maxLogFileSize)
```
    The maximum size of RocksDB's file used for logging.
    If the log files becomes larger than this, a new file will be created. If 0, all logs will be written to one log file.
    
    Parameters:
    
    maxLogFileSize - max file size limit
    
    Returns:
    
    this options factory
  - setLogFileNum
```
public DefaultConfigurableOptionsFactory setLogFileNum(int logFileNum)
```
    The maximum number of files RocksDB should keep for logging.
    
    Parameters:
    
    logFileNum - number of files to keep
    
    Returns:
    
    this options factory
  - setCompactionStyle
```
public DefaultConfigurableOptionsFactory setCompactionStyle(org.rocksdb.CompactionStyle compactionStyle)
```
  - setUseDynamicLevelSize
```
public DefaultConfigurableOptionsFactory setUseDynamicLevelSize(boolean value)
```
  - setTargetFileSizeBase
```
public DefaultConfigurableOptionsFactory setTargetFileSizeBase(String targetFileSizeBase)
```
  - setMaxSizeLevelBase
```
public DefaultConfigurableOptionsFactory setMaxSizeLevelBase(String maxSizeLevelBase)
```
  - setWriteBufferSize
```
public DefaultConfigurableOptionsFactory setWriteBufferSize(String writeBufferSize)
```
  - setMaxWriteBufferNumber
```
public DefaultConfigurableOptionsFactory setMaxWriteBufferNumber(int writeBufferNumber)
```
  - setMinWriteBufferNumberToMerge
```
public DefaultConfigurableOptionsFactory setMinWriteBufferNumberToMerge(int writeBufferNumber)
```
  - setBlockSize
```
public DefaultConfigurableOptionsFactory setBlockSize(String blockSize)
```
  - setMetadataBlockSize
```
public DefaultConfigurableOptionsFactory setMetadataBlockSize(String metadataBlockSize)
```
  - setBlockCacheSize
```
public DefaultConfigurableOptionsFactory setBlockCacheSize(String blockCacheSize)
```
  - setUseBloomFilter
```
public DefaultConfigurableOptionsFactory setUseBloomFilter(boolean useBloomFilter)
```
  - setBloomFilterBitsPerKey
```
public DefaultConfigurableOptionsFactory setBloomFilterBitsPerKey(double bitsPerKey)
```
  - setBloomFilterBlockBasedMode
```
public DefaultConfigurableOptionsFactory setBloomFilterBlockBasedMode(boolean blockBasedMode)
```
  - configure
```
public DefaultConfigurableOptionsFactory configure(org.apache.flink.configuration.ReadableConfig configuration)
```
    Creates a DefaultConfigurableOptionsFactory instance from a ReadableConfig.
    If no options within RocksDBConfigurableOptions has ever been configured, the created RocksDBOptionsFactory would not override anything defined in PredefinedOptions.
    
    Specified by:
    
    configure in interface ConfigurableRocksDBOptionsFactory
    
    Parameters:
    
    configuration - Configuration to be used for the ConfigurableRocksDBOptionsFactory creation
    
    Returns:
    
    A ConfigurableRocksDBOptionsFactory created from the given configuration
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class DefaultConfigurableOptionsFactory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.flink.contrib.streaming.state.RocksDBOptionsFactory

Constructor Detail

DefaultConfigurableOptionsFactory

Method Detail

createDBOptions

createColumnOptions

getConfiguredOptions

setMaxBackgroundThreads

setMaxOpenFiles

setLogLevel

setLogDir

setMaxLogFileSize

setLogFileNum

setCompactionStyle

setUseDynamicLevelSize

setTargetFileSizeBase

setMaxSizeLevelBase

setWriteBufferSize

setMaxWriteBufferNumber

setMinWriteBufferNumberToMerge

setBlockSize

setMetadataBlockSize

setBlockCacheSize

setUseBloomFilter

setBloomFilterBitsPerKey

setBloomFilterBlockBasedMode

configure

toString