Package org.apache.flink.state.rocksdb

Class RocksDBKeyedStateBackendBuilder<K>

java.lang.Object

org.apache.flink.runtime.state.AbstractKeyedStateBackendBuilder<K>

org.apache.flink.state.rocksdb.RocksDBKeyedStateBackendBuilder<K>

Type Parameters:

K - The data type that the key serializer serializes.

All Implemented Interfaces:

org.apache.flink.runtime.state.StateBackendBuilder<org.apache.flink.runtime.state.AbstractKeyedStateBackend<K>,org.apache.flink.runtime.state.BackendBuildingException>

public class RocksDBKeyedStateBackendBuilder<K>
extends org.apache.flink.runtime.state.AbstractKeyedStateBackendBuilder<K>

Builder class for RocksDBKeyedStateBackend which handles all necessary initializations and clean ups.

Field Summary

Fields inherited from class org.apache.flink.runtime.state.AbstractKeyedStateBackendBuilder

cancelStreamRegistry, executionConfig, keyGroupCompressionDecorator, keyGroupRange, keySerializerProvider, kvStateRegistry, latencyTrackingStateConfig, logger, numberOfKeyGroups, restoreStateHandles, sizeTrackingStateConfig, ttlTimeProvider, userCodeClassLoader

Constructor Summary

Constructors

Constructor

Description

RocksDBKeyedStateBackendBuilder(String operatorIdentifier, ClassLoader userCodeClassLoader, File instanceBasePath, RocksDBResourceContainer optionsContainer, Function<String,org.rocksdb.ColumnFamilyOptions> columnFamilyOptionsFactory, org.apache.flink.runtime.query.TaskKvStateRegistry kvStateRegistry, org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, int numberOfKeyGroups, org.apache.flink.runtime.state.KeyGroupRange keyGroupRange, org.apache.flink.api.common.ExecutionConfig executionConfig, org.apache.flink.runtime.state.LocalRecoveryConfig localRecoveryConfig, RocksDBPriorityQueueConfig priorityQueueConfig, org.apache.flink.runtime.state.ttl.TtlTimeProvider ttlTimeProvider, org.apache.flink.runtime.state.metrics.LatencyTrackingStateConfig latencyTrackingStateConfig, org.apache.flink.runtime.state.metrics.SizeTrackingStateConfig sizeTrackingStateConfig, org.apache.flink.metrics.MetricGroup metricGroup, org.apache.flink.runtime.state.StateBackend.CustomInitializationMetrics customInitializationMetrics, Collection<org.apache.flink.runtime.state.KeyedStateHandle> stateHandles, org.apache.flink.runtime.state.StreamCompressionDecorator keyGroupCompressionDecorator, org.apache.flink.core.fs.CloseableRegistry cancelStreamRegistry)

Method Summary

Modifier and Type	Method	Description
RocksDBKeyedStateBackend<K>	build()
static File	getInstanceRocksDBPath(File instanceBasePath)
RocksDBKeyedStateBackendBuilder<K>	setAsyncExceptionHandler(org.apache.flink.runtime.taskmanager.AsyncExceptionHandler asyncExceptionHandler)
RocksDBKeyedStateBackendBuilder<K>	setManualCompactionConfig(RocksDBManualCompactionConfig manualCompactionConfig)

Methods inherited from class java.lang.Object

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

Constructor Detail

RocksDBKeyedStateBackendBuilder

public RocksDBKeyedStateBackendBuilder(String operatorIdentifier,
                                       ClassLoader userCodeClassLoader,
                                       File instanceBasePath,
                                       RocksDBResourceContainer optionsContainer,
                                       Function<String,org.rocksdb.ColumnFamilyOptions> columnFamilyOptionsFactory,
                                       org.apache.flink.runtime.query.TaskKvStateRegistry kvStateRegistry,
                                       org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer,
                                       int numberOfKeyGroups,
                                       org.apache.flink.runtime.state.KeyGroupRange keyGroupRange,
                                       org.apache.flink.api.common.ExecutionConfig executionConfig,
                                       org.apache.flink.runtime.state.LocalRecoveryConfig localRecoveryConfig,
                                       RocksDBPriorityQueueConfig priorityQueueConfig,
                                       org.apache.flink.runtime.state.ttl.TtlTimeProvider ttlTimeProvider,
                                       org.apache.flink.runtime.state.metrics.LatencyTrackingStateConfig latencyTrackingStateConfig,
                                       org.apache.flink.runtime.state.metrics.SizeTrackingStateConfig sizeTrackingStateConfig,
                                       org.apache.flink.metrics.MetricGroup metricGroup,
                                       org.apache.flink.runtime.state.StateBackend.CustomInitializationMetrics customInitializationMetrics,
                                       @Nonnull
                                       Collection<org.apache.flink.runtime.state.KeyedStateHandle> stateHandles,
                                       org.apache.flink.runtime.state.StreamCompressionDecorator keyGroupCompressionDecorator,
                                       org.apache.flink.core.fs.CloseableRegistry cancelStreamRegistry)

Method Detail

getInstanceRocksDBPath

public static File getInstanceRocksDBPath(File instanceBasePath)

build

public RocksDBKeyedStateBackend<K> build()
                                  throws org.apache.flink.runtime.state.BackendBuildingException

Throws:

org.apache.flink.runtime.state.BackendBuildingException

setManualCompactionConfig

public RocksDBKeyedStateBackendBuilder<K> setManualCompactionConfig(RocksDBManualCompactionConfig manualCompactionConfig)

setAsyncExceptionHandler

public RocksDBKeyedStateBackendBuilder<K> setAsyncExceptionHandler(org.apache.flink.runtime.taskmanager.AsyncExceptionHandler asyncExceptionHandler)