org.apache.flink.contrib.streaming.state.snapshot

Class RocksDBSnapshotStrategyBase<K,R extends org.apache.flink.runtime.state.SnapshotResources>

java.lang.Object

org.apache.flink.contrib.streaming.state.snapshot.RocksDBSnapshotStrategyBase<K,R>

Type Parameters:

K - type of the backend keys.

All Implemented Interfaces:

AutoCloseable, org.apache.flink.api.common.state.CheckpointListener, org.apache.flink.runtime.state.SnapshotStrategy<org.apache.flink.runtime.state.KeyedStateHandle,R>

Direct Known Subclasses:

RocksFullSnapshotStrategy, RocksIncrementalSnapshotStrategy

public abstract class RocksDBSnapshotStrategyBase<K,R extends org.apache.flink.runtime.state.SnapshotResources>
extends Object
implements org.apache.flink.api.common.state.CheckpointListener, org.apache.flink.runtime.state.SnapshotStrategy<org.apache.flink.runtime.state.KeyedStateHandle,R>, AutoCloseable

Abstract base class for SnapshotStrategy implementations for RocksDB state backend.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.runtime.state.SnapshotStrategy

org.apache.flink.runtime.state.SnapshotStrategy.SnapshotResultSupplier<S extends org.apache.flink.runtime.state.StateObject>

Field Summary

Fields

Modifier and Type	Field and Description
protected org.rocksdb.RocksDB	db RocksDB instance from the backend.
protected int	keyGroupPrefixBytes Number of bytes in the key-group prefix.
protected org.apache.flink.runtime.state.KeyGroupRange	keyGroupRange The key-group range for the task.
protected org.apache.flink.api.common.typeutils.TypeSerializer<K>	keySerializer The key serializer of the backend.
protected LinkedHashMap<String,RocksDBKeyedStateBackend.RocksDbKvStateInfo>	kvStateInformation Key/Value state meta info from the backend.
protected org.apache.flink.runtime.state.LocalRecoveryConfig	localRecoveryConfig The configuration for local recovery.
protected org.apache.flink.util.ResourceGuard	rocksDBResourceGuard Resource guard for the RocksDB instance.

Constructor Summary

Constructors

Constructor and Description

RocksDBSnapshotStrategyBase(String description, org.rocksdb.RocksDB db, org.apache.flink.util.ResourceGuard rocksDBResourceGuard, org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, LinkedHashMap<String,RocksDBKeyedStateBackend.RocksDbKvStateInfo> kvStateInformation, org.apache.flink.runtime.state.KeyGroupRange keyGroupRange, int keyGroupPrefixBytes, org.apache.flink.runtime.state.LocalRecoveryConfig localRecoveryConfig)

Method Summary

Modifier and Type	Method and Description
abstract void	close()
String	getDescription()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.api.common.state.CheckpointListener

notifyCheckpointAborted, notifyCheckpointComplete

Methods inherited from interface org.apache.flink.runtime.state.SnapshotStrategy

asyncSnapshot, syncPrepareResources

Field Detail

db

@Nonnull
protected org.rocksdb.RocksDB db

RocksDB instance from the backend.

rocksDBResourceGuard

@Nonnull
protected final org.apache.flink.util.ResourceGuard rocksDBResourceGuard

Resource guard for the RocksDB instance.

keySerializer

@Nonnull
protected final org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer

The key serializer of the backend.

kvStateInformation

@Nonnull
protected final LinkedHashMap<String,RocksDBKeyedStateBackend.RocksDbKvStateInfo> kvStateInformation

Key/Value state meta info from the backend.

keyGroupRange

@Nonnull
protected final org.apache.flink.runtime.state.KeyGroupRange keyGroupRange

The key-group range for the task.

keyGroupPrefixBytes

@Nonnegative
protected final int keyGroupPrefixBytes

Number of bytes in the key-group prefix.

localRecoveryConfig

@Nonnull
protected final org.apache.flink.runtime.state.LocalRecoveryConfig localRecoveryConfig

The configuration for local recovery.

Constructor Detail

RocksDBSnapshotStrategyBase

public RocksDBSnapshotStrategyBase(@Nonnull
                                   String description,
                                   @Nonnull
                                   org.rocksdb.RocksDB db,
                                   @Nonnull
                                   org.apache.flink.util.ResourceGuard rocksDBResourceGuard,
                                   @Nonnull
                                   org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer,
                                   @Nonnull
                                   LinkedHashMap<String,RocksDBKeyedStateBackend.RocksDbKvStateInfo> kvStateInformation,
                                   @Nonnull
                                   org.apache.flink.runtime.state.KeyGroupRange keyGroupRange,
                                   @Nonnegative
                                   int keyGroupPrefixBytes,
                                   @Nonnull
                                   org.apache.flink.runtime.state.LocalRecoveryConfig localRecoveryConfig)

Method Detail

getDescription

@Nonnull
public String getDescription()

close

public abstract void close()

Specified by:

close in interface AutoCloseable