org.apache.flink.contrib.streaming.state

Interface RocksDBOptionsFactory

All Superinterfaces:

OptionsFactory, Serializable

All Known Subinterfaces:

ConfigurableRocksDBOptionsFactory

All Known Implementing Classes:

DefaultConfigurableOptionsFactory

public interface RocksDBOptionsFactory
extends OptionsFactory, Serializable

A factory for DBOptions and ColumnFamilyOptions to be passed to the RocksDBStateBackend. Options have to be created lazily by this factory, because the Options class is not serializable and holds pointers to native code.

A typical pattern to use this OptionsFactory is as follows:

 rocksDbBackend.setOptions(new RocksDBOptionsFactory() {

		public DBOptions createDBOptions(DBOptions currentOptions, Collection<AutoCloseable> handlesToClose) {
			return currentOptions.setMaxOpenFiles(1024);
		}

		public ColumnFamilyOptions createColumnOptions(ColumnFamilyOptions currentOptions, Collection<AutoCloseable> handlesToClose) {
			BloomFilter bloomFilter = new BloomFilter();
 			handlesToClose.add(bloomFilter);

 			return currentOptions
 					.setTableFormatConfig(
 							new BlockBasedTableConfig().setFilter(bloomFilter));
		}
 });
 

Method Summary

Modifier and Type	Method and Description
default org.rocksdb.ColumnFamilyOptions	createColumnOptions(org.rocksdb.ColumnFamilyOptions currentOptions) Do not override these methods, they are only to maintain interface compatibility with prior versions.
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.
default org.rocksdb.DBOptions	createDBOptions(org.rocksdb.DBOptions currentOptions) Do not override these methods, they are only to maintain interface compatibility with prior versions.
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.
default RocksDBNativeMetricOptions	createNativeMetricsOptions(RocksDBNativeMetricOptions nativeMetricOptions) This method should enable certain RocksDB metrics to be forwarded to Flink's metrics reporter.

Method Detail

createDBOptions

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. 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.

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

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. 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.

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.

createNativeMetricsOptions

default RocksDBNativeMetricOptions createNativeMetricsOptions(RocksDBNativeMetricOptions nativeMetricOptions)

This method should enable certain RocksDB metrics to be forwarded to Flink's metrics reporter.

Enabling these monitoring options may degrade RockDB performance and should be set with care.

Specified by:

createNativeMetricsOptions in interface OptionsFactory

Parameters:

nativeMetricOptions - The options object with the pre-defined options.

Returns:

The options object on which the additional options are set.

createDBOptions

default org.rocksdb.DBOptions createDBOptions(org.rocksdb.DBOptions currentOptions)

Do not override these methods, they are only to maintain interface compatibility with prior versions. They will be removed in one of the next versions.

Specified by:

createDBOptions in interface OptionsFactory

Parameters:

currentOptions - The options object with the pre-defined options.

Returns:

The options object on which the additional options are set.

createColumnOptions

default org.rocksdb.ColumnFamilyOptions createColumnOptions(org.rocksdb.ColumnFamilyOptions currentOptions)

Do not override these methods, they are only to maintain interface compatibility with prior versions. They will be removed in one of the next versions.

Specified by:

createColumnOptions in interface OptionsFactory

Parameters:

currentOptions - The options object with the pre-defined options.

Returns:

The options object on which the additional options are set.