org.apache.flink.contrib.streaming.state.restore

Class AbstractRocksDBRestoreOperation<K>

java.lang.Object

org.apache.flink.contrib.streaming.state.restore.AbstractRocksDBRestoreOperation<K>

Type Parameters:

K - The data type that the serializer serializes.

All Implemented Interfaces:

AutoCloseable, RocksDBRestoreOperation, RestoreOperation<RocksDBRestoreResult>

Direct Known Subclasses:

RocksDBFullRestoreOperation, RocksDBIncrementalRestoreOperation, RocksDBNoneRestoreOperation

public abstract class AbstractRocksDBRestoreOperation<K>
extends Object
implements RocksDBRestoreOperation, AutoCloseable

Base implementation of RocksDB restore operation.

Field Summary

Fields

Modifier and Type	Field and Description
protected CloseableRegistry	cancelStreamRegistry
protected List<org.rocksdb.ColumnFamilyDescriptor>	columnFamilyDescriptors
protected List<org.rocksdb.ColumnFamilyHandle>	columnFamilyHandles
protected java.util.function.Function<String,org.rocksdb.ColumnFamilyOptions>	columnFamilyOptionsFactory
protected org.rocksdb.RocksDB	db
protected org.rocksdb.DBOptions	dbOptions
protected String	dbPath
protected org.rocksdb.ColumnFamilyHandle	defaultColumnFamilyHandle
protected File	instanceBasePath
protected File	instanceRocksDBPath
protected boolean	isKeySerializerCompatibilityChecked
protected int	keyGroupPrefixBytes
protected KeyGroupRange	keyGroupRange
protected StateSerializerProvider<K>	keySerializerProvider
protected Map<String,RocksDBKeyedStateBackend.RocksDbKvStateInfo>	kvStateInformation
protected MetricGroup	metricGroup
protected RocksDBNativeMetricMonitor	nativeMetricMonitor
protected RocksDBNativeMetricOptions	nativeMetricOptions
protected int	numberOfTransferringThreads
protected Collection<KeyedStateHandle>	restoreStateHandles
protected RocksDbTtlCompactFiltersManager	ttlCompactFiltersManager
protected ClassLoader	userCodeClassLoader

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

AbstractRocksDBRestoreOperation(KeyGroupRange keyGroupRange, int keyGroupPrefixBytes, int numberOfTransferringThreads, CloseableRegistry cancelStreamRegistry, ClassLoader userCodeClassLoader, Map<String,RocksDBKeyedStateBackend.RocksDbKvStateInfo> kvStateInformation, StateSerializerProvider<K> keySerializerProvider, File instanceBasePath, File instanceRocksDBPath, org.rocksdb.DBOptions dbOptions, java.util.function.Function<String,org.rocksdb.ColumnFamilyOptions> columnFamilyOptionsFactory, RocksDBNativeMetricOptions nativeMetricOptions, MetricGroup metricGroup, Collection<KeyedStateHandle> stateHandles, RocksDbTtlCompactFiltersManager ttlCompactFiltersManager)

Method Summary

Modifier and Type	Method and Description
void	close() Necessary clean up iff restore operation failed.
org.rocksdb.RocksDB	getDb()
abstract RocksDBRestoreResult	restore() Restores state that was previously snapshot-ed from the provided state handles.

Methods inherited from class java.lang.Object

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

Field Detail

keyGroupRange

protected final KeyGroupRange keyGroupRange

keyGroupPrefixBytes

protected final int keyGroupPrefixBytes

numberOfTransferringThreads

protected final int numberOfTransferringThreads

cancelStreamRegistry

protected final CloseableRegistry cancelStreamRegistry

userCodeClassLoader

protected final ClassLoader userCodeClassLoader

columnFamilyOptionsFactory

protected final java.util.function.Function<String,org.rocksdb.ColumnFamilyOptions> columnFamilyOptionsFactory

dbOptions

protected final org.rocksdb.DBOptions dbOptions

kvStateInformation

protected final Map<String,RocksDBKeyedStateBackend.RocksDbKvStateInfo> kvStateInformation

instanceBasePath

protected final File instanceBasePath

instanceRocksDBPath

protected final File instanceRocksDBPath

dbPath

protected final String dbPath

columnFamilyHandles

protected List<org.rocksdb.ColumnFamilyHandle> columnFamilyHandles

columnFamilyDescriptors

protected List<org.rocksdb.ColumnFamilyDescriptor> columnFamilyDescriptors

keySerializerProvider

protected final StateSerializerProvider<K> keySerializerProvider

nativeMetricOptions

protected final RocksDBNativeMetricOptions nativeMetricOptions

metricGroup

protected final MetricGroup metricGroup

restoreStateHandles

protected final Collection<KeyedStateHandle> restoreStateHandles

ttlCompactFiltersManager

protected final RocksDbTtlCompactFiltersManager ttlCompactFiltersManager

db

protected org.rocksdb.RocksDB db

defaultColumnFamilyHandle

protected org.rocksdb.ColumnFamilyHandle defaultColumnFamilyHandle

nativeMetricMonitor

protected RocksDBNativeMetricMonitor nativeMetricMonitor

isKeySerializerCompatibilityChecked

protected boolean isKeySerializerCompatibilityChecked

Constructor Detail

AbstractRocksDBRestoreOperation

protected AbstractRocksDBRestoreOperation(KeyGroupRange keyGroupRange,
                                          int keyGroupPrefixBytes,
                                          int numberOfTransferringThreads,
                                          CloseableRegistry cancelStreamRegistry,
                                          ClassLoader userCodeClassLoader,
                                          Map<String,RocksDBKeyedStateBackend.RocksDbKvStateInfo> kvStateInformation,
                                          StateSerializerProvider<K> keySerializerProvider,
                                          File instanceBasePath,
                                          File instanceRocksDBPath,
                                          org.rocksdb.DBOptions dbOptions,
                                          java.util.function.Function<String,org.rocksdb.ColumnFamilyOptions> columnFamilyOptionsFactory,
                                          RocksDBNativeMetricOptions nativeMetricOptions,
                                          MetricGroup metricGroup,
                                          @Nonnull
                                          Collection<KeyedStateHandle> stateHandles,
                                          @Nonnull
                                          RocksDbTtlCompactFiltersManager ttlCompactFiltersManager)

Method Detail

getDb

public org.rocksdb.RocksDB getDb()

close

public void close()

Necessary clean up iff restore operation failed.

Specified by:

close in interface AutoCloseable

restore

public abstract RocksDBRestoreResult restore()
                                      throws Exception

Description copied from interface: RocksDBRestoreOperation

Restores state that was previously snapshot-ed from the provided state handles.

Specified by:

restore in interface RocksDBRestoreOperation

Specified by:

restore in interface RestoreOperation<RocksDBRestoreResult>

Throws:

Exception