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

Class RocksFullSnapshotStrategy<K>

java.lang.Object

org.apache.flink.runtime.state.AbstractSnapshotStrategy<KeyedStateHandle>

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

org.apache.flink.contrib.streaming.state.snapshot.RocksFullSnapshotStrategy<K>

Type Parameters:

K - type of the backend keys.

All Implemented Interfaces:

CheckpointListener, SnapshotStrategy<SnapshotResult<KeyedStateHandle>>

public class RocksFullSnapshotStrategy<K>
extends RocksDBSnapshotStrategyBase<K>

Snapshot strategy to create full snapshots of RocksDBKeyedStateBackend. Iterates and writes all states from a RocksDB snapshot of the column families.

Field Summary

Fields inherited from class org.apache.flink.contrib.streaming.state.snapshot.RocksDBSnapshotStrategyBase

cancelStreamRegistry, db, keyGroupPrefixBytes, keyGroupRange, keySerializer, kvStateInformation, localRecoveryConfig, rocksDBResourceGuard

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

description

Constructor Summary

Constructors

Constructor and Description
RocksFullSnapshotStrategy(org.rocksdb.RocksDB db, ResourceGuard rocksDBResourceGuard, TypeSerializer<K> keySerializer, LinkedHashMap<String,RocksDBKeyedStateBackend.RocksDbKvStateInfo> kvStateInformation, KeyGroupRange keyGroupRange, int keyGroupPrefixBytes, LocalRecoveryConfig localRecoveryConfig, CloseableRegistry cancelStreamRegistry, StreamCompressionDecorator keyGroupCompressionDecorator)

Method Summary

Modifier and Type	Method and Description
RunnableFuture<SnapshotResult<KeyedStateHandle>>	doSnapshot(long checkpointId, long timestamp, CheckpointStreamFactory primaryStreamFactory, CheckpointOptions checkpointOptions) This method implements the concrete snapshot logic for a non-empty state.
void	notifyCheckpointAborted(long checkpointId) This method is called as a notification once a distributed checkpoint has been aborted.
void	notifyCheckpointComplete(long checkpointId) This method is called as a notification once a distributed checkpoint has been completed.

Methods inherited from class org.apache.flink.contrib.streaming.state.snapshot.RocksDBSnapshotStrategyBase

snapshot

Methods inherited from class org.apache.flink.runtime.state.AbstractSnapshotStrategy

logAsyncCompleted, logSyncCompleted, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RocksFullSnapshotStrategy

public RocksFullSnapshotStrategy(@Nonnull
                                 org.rocksdb.RocksDB db,
                                 @Nonnull
                                 ResourceGuard rocksDBResourceGuard,
                                 @Nonnull
                                 TypeSerializer<K> keySerializer,
                                 @Nonnull
                                 LinkedHashMap<String,RocksDBKeyedStateBackend.RocksDbKvStateInfo> kvStateInformation,
                                 @Nonnull
                                 KeyGroupRange keyGroupRange,
                                 @Nonnegative
                                 int keyGroupPrefixBytes,
                                 @Nonnull
                                 LocalRecoveryConfig localRecoveryConfig,
                                 @Nonnull
                                 CloseableRegistry cancelStreamRegistry,
                                 @Nonnull
                                 StreamCompressionDecorator keyGroupCompressionDecorator)

Method Detail

doSnapshot

@Nonnull
public RunnableFuture<SnapshotResult<KeyedStateHandle>> doSnapshot(long checkpointId,
                                                                            long timestamp,
                                                                            @Nonnull
                                                                            CheckpointStreamFactory primaryStreamFactory,
                                                                            @Nonnull
                                                                            CheckpointOptions checkpointOptions)
                                                                     throws Exception

Description copied from class: RocksDBSnapshotStrategyBase

This method implements the concrete snapshot logic for a non-empty state.

Specified by:

doSnapshot in class RocksDBSnapshotStrategyBase<K>

Throws:

Exception

notifyCheckpointComplete

public void notifyCheckpointComplete(long checkpointId)

Description copied from interface: CheckpointListener

This method is called as a notification once a distributed checkpoint has been completed.

Note that any exception during this method will not cause the checkpoint to fail any more.

Parameters:

checkpointId - The ID of the checkpoint that has been completed.

notifyCheckpointAborted

public void notifyCheckpointAborted(long checkpointId)

Description copied from interface: CheckpointListener

This method is called as a notification once a distributed checkpoint has been aborted.

Parameters:

checkpointId - The ID of the checkpoint that has been aborted.