org.apache.flink.contrib.streaming.state

Interface OptionsFactory

All Superinterfaces:

Serializable

public interface OptionsFactory
extends 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 OptionsFactory(){

		public DBOptions createDBOptions(DBOptions currentOptions) {
			return  currentOptions.setMaxOpenFiles(1024);
		}

		public ColumnFamilyOptions createColumnOptions(ColumnFamilyOptions currentOptions) {
			return currentOptions.setCompactionStyle(CompactionStyle.LEVEL);
		}
 });
 

Method Summary

Modifier and Type	Method and Description
org.rocksdb.ColumnFamilyOptions	createColumnOptions(org.rocksdb.ColumnFamilyOptions currentOptions) This method should set the additional options on top of the current options object.
org.rocksdb.DBOptions	createDBOptions(org.rocksdb.DBOptions currentOptions) This method should set the additional options on top of the current options object.

Method Detail

createDBOptions

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

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.

Returns:

The options object on which the additional options are set.

createColumnOptions

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

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.

Returns:

The options object on which the additional options are set.