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

Class RocksIncrementalSnapshotStrategy<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.RocksIncrementalSnapshotStrategy<K>

Type Parameters:

K - type of the backend keys.

All Implemented Interfaces:

CheckpointListener, SnapshotStrategy<SnapshotResult<KeyedStateHandle>>

public class RocksIncrementalSnapshotStrategy<K>
extends RocksDBSnapshotStrategyBase<K>

Snapshot strategy for RocksDBKeyedStateBackend that is based on RocksDB's native checkpoints and creates incremental snapshots.

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

RocksIncrementalSnapshotStrategy(org.rocksdb.RocksDB db, ResourceGuard rocksDBResourceGuard, TypeSerializer<K> keySerializer, LinkedHashMap<String,RocksDBKeyedStateBackend.RocksDbKvStateInfo> kvStateInformation, KeyGroupRange keyGroupRange, int keyGroupPrefixBytes, LocalRecoveryConfig localRecoveryConfig, CloseableRegistry cancelStreamRegistry, File instanceBasePath, UUID backendUID, SortedMap<Long,Set<StateHandleID>> materializedSstFiles, long lastCompletedCheckpointId, int numberOfTransferingThreads)

Method Summary

Modifier and Type	Method and Description
protected RunnableFuture<SnapshotResult<KeyedStateHandle>>	doSnapshot(long checkpointId, long checkpointTimestamp, CheckpointStreamFactory checkpointStreamFactory, CheckpointOptions checkpointOptions) This method implements the concrete snapshot logic for a non-empty state.
void	notifyCheckpointComplete(long completedCheckpointId) 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

RocksIncrementalSnapshotStrategy

public RocksIncrementalSnapshotStrategy(@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
                                        File instanceBasePath,
                                        @Nonnull
                                        UUID backendUID,
                                        @Nonnull
                                        SortedMap<Long,Set<StateHandleID>> materializedSstFiles,
                                        long lastCompletedCheckpointId,
                                        int numberOfTransferingThreads)

Method Detail

doSnapshot

@Nonnull
protected RunnableFuture<SnapshotResult<KeyedStateHandle>> doSnapshot(long checkpointId,
                                                                               long checkpointTimestamp,
                                                                               @Nonnull
                                                                               CheckpointStreamFactory checkpointStreamFactory,
                                                                               @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 completedCheckpointId)

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:

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