org.apache.flink.contrib.streaming.state

Class RocksDBResourceContainer

java.lang.Object

org.apache.flink.contrib.streaming.state.RocksDBResourceContainer

All Implemented Interfaces:

AutoCloseable

public final class RocksDBResourceContainer
extends Object
implements AutoCloseable

The container for RocksDB resources, including predefined options, option factory and shared resource among instances.

This should be the only entrance for EmbeddedRocksDBStateBackend to get RocksDB options, and should be properly (and necessarily) closed to prevent resource leak.

Constructor Summary

Constructors

Constructor and Description
RocksDBResourceContainer()
RocksDBResourceContainer(PredefinedOptions predefinedOptions, RocksDBOptionsFactory optionsFactory)
RocksDBResourceContainer(PredefinedOptions predefinedOptions, RocksDBOptionsFactory optionsFactory, OpaqueMemoryResource<org.apache.flink.contrib.streaming.state.RocksDBSharedResources> sharedResources)
RocksDBResourceContainer(ReadableConfig configuration, PredefinedOptions predefinedOptions, RocksDBOptionsFactory optionsFactory, OpaqueMemoryResource<org.apache.flink.contrib.streaming.state.RocksDBSharedResources> sharedResources, File instanceBasePath, boolean enableStatistics)

Method Summary

Modifier and Type	Method and Description
void	close()
org.rocksdb.ColumnFamilyOptions	getColumnOptions() Gets the RocksDB ColumnFamilyOptions to be used for all RocksDB instances.
org.rocksdb.DBOptions	getDbOptions() Gets the RocksDB DBOptions to be used for RocksDB instances.
org.rocksdb.ReadOptions	getReadOptions() Gets the RocksDB ReadOptions to be used for read operations.
Long	getWriteBufferManagerCapacity() Gets write buffer manager capacity.
org.rocksdb.WriteOptions	getWriteOptions() Gets the RocksDB WriteOptions to be used for write operations.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RocksDBResourceContainer

@VisibleForTesting
public RocksDBResourceContainer()

RocksDBResourceContainer

@VisibleForTesting
public RocksDBResourceContainer(PredefinedOptions predefinedOptions,
                                                   @Nullable
                                                   RocksDBOptionsFactory optionsFactory)

RocksDBResourceContainer

@VisibleForTesting
public RocksDBResourceContainer(PredefinedOptions predefinedOptions,
                                                   @Nullable
                                                   RocksDBOptionsFactory optionsFactory,
                                                   @Nullable
                                                   OpaqueMemoryResource<org.apache.flink.contrib.streaming.state.RocksDBSharedResources> sharedResources)

RocksDBResourceContainer

public RocksDBResourceContainer(ReadableConfig configuration,
                                PredefinedOptions predefinedOptions,
                                @Nullable
                                RocksDBOptionsFactory optionsFactory,
                                @Nullable
                                OpaqueMemoryResource<org.apache.flink.contrib.streaming.state.RocksDBSharedResources> sharedResources,
                                @Nullable
                                File instanceBasePath,
                                boolean enableStatistics)

Method Detail

getDbOptions

public org.rocksdb.DBOptions getDbOptions()

Gets the RocksDB DBOptions to be used for RocksDB instances.

getWriteBufferManagerCapacity

public Long getWriteBufferManagerCapacity()

Gets write buffer manager capacity.

Returns:

the capacity of the write buffer manager, or null if write buffer manager is not enabled.

getColumnOptions

public org.rocksdb.ColumnFamilyOptions getColumnOptions()

Gets the RocksDB ColumnFamilyOptions to be used for all RocksDB instances.

getWriteOptions

public org.rocksdb.WriteOptions getWriteOptions()

Gets the RocksDB WriteOptions to be used for write operations.

getReadOptions

public org.rocksdb.ReadOptions getReadOptions()

Gets the RocksDB ReadOptions to be used for read operations.

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception