Package org.apache.flink.runtime.state

Class IncrementalLocalKeyedStateHandle

java.lang.Object

org.apache.flink.runtime.state.AbstractIncrementalStateHandle

org.apache.flink.runtime.state.IncrementalLocalKeyedStateHandle

All Implemented Interfaces:

Serializable, CheckpointBoundKeyedStateHandle, CompositeStateHandle, IncrementalKeyedStateHandle, KeyedStateHandle, StateObject

public class IncrementalLocalKeyedStateHandle
extends AbstractIncrementalStateHandle

State handle for local copies of IncrementalRemoteKeyedStateHandle. Consists of a DirectoryStateHandle that represents the directory of the native RocksDB snapshot, the key groups, and a stream state handle for Flink's state meta data file.

See Also:

Serialized Form

Nested Class Summary

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

IncrementalKeyedStateHandle.HandleAndLocalPath

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

StateObject.StateObjectLocation, StateObject.StateObjectSizeStatsCollector

Field Summary

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

backendIdentifier, checkpointId, keyGroupRange, metaStateHandle, sharedState, stateHandleId

Constructor Summary

Constructors

Constructor	Description
IncrementalLocalKeyedStateHandle(UUID backendIdentifier, long checkpointId, DirectoryStateHandle directoryStateHandle, KeyGroupRange keyGroupRange, StreamStateHandle metaDataState, List<IncrementalKeyedStateHandle.HandleAndLocalPath> sharedState)

Method Summary

Modifier and Type	Method	Description
void	collectSizeStats(StateObject.StateObjectSizeStatsCollector collector)	Collects statistics about state size and location from the state object.
void	discardState()	Discards the state referred to and solemnly owned by this handle, to free up resources in the persistent storage.
long	getCheckpointedSize()	Returns the persisted data size during checkpoint execution in bytes.
DirectoryStateHandle	getDirectoryStateHandle()
long	getStateSize()	Returns the size of the state in bytes.
CheckpointBoundKeyedStateHandle	rebound(long checkpointId)	Returns a new CheckpointBoundKeyedStateHandle Rebounding checkpoint id to a specific checkpoint id.
void	registerSharedStates(SharedStateRegistry stateRegistry, long checkpointID)	Register both newly created and already referenced shared states in the given SharedStateRegistry.
String	toString()

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

equals, getBackendIdentifier, getCheckpointId, getIntersection, getKeyGroupRange, getMetaDataStateHandle, getSharedStateHandles, getStateHandleId, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IncrementalLocalKeyedStateHandle

public IncrementalLocalKeyedStateHandle(@Nonnull
                                        UUID backendIdentifier,
                                        @Nonnegative
                                        long checkpointId,
                                        @Nonnull
                                        DirectoryStateHandle directoryStateHandle,
                                        @Nonnull
                                        KeyGroupRange keyGroupRange,
                                        @Nonnull
                                        StreamStateHandle metaDataState,
                                        @Nonnull
                                        List<IncrementalKeyedStateHandle.HandleAndLocalPath> sharedState)

Method Detail

rebound

public CheckpointBoundKeyedStateHandle rebound(long checkpointId)

Description copied from interface: CheckpointBoundKeyedStateHandle

Returns a new CheckpointBoundKeyedStateHandle Rebounding checkpoint id to a specific checkpoint id.

Parameters:

checkpointId - rebounded checkpoint id.

discardState

public void discardState()
                  throws Exception

Description copied from interface: StateObject

Discards the state referred to and solemnly owned by this handle, to free up resources in the persistent storage. This method is called when the state represented by this object will not be used anymore.

Throws:

Exception

getStateSize

public long getStateSize()

Description copied from interface: StateObject

Returns the size of the state in bytes. If the size is not known, this method should return 0.

The values produced by this method are only used for informational purposes and for metrics/monitoring. If this method returns wrong values, the checkpoints and recovery will still behave correctly. However, efficiency may be impacted (wrong space pre-allocation) and functionality that depends on metrics (like monitoring) will be impacted.

Note for implementors: This method should not perform any I/O operations while obtaining the state size (hence it does not declare throwing an IOException). Instead, the state size should be stored in the state object, or should be computable from the state stored in this object. The reason is that this method is called frequently by several parts of the checkpointing and issuing I/O requests from this method accumulates a heavy I/O load on the storage system at higher scale.

Returns:

Size of the state in bytes.

collectSizeStats

public void collectSizeStats(StateObject.StateObjectSizeStatsCollector collector)

Description copied from interface: StateObject

Collects statistics about state size and location from the state object.

Parameters:

collector - the statistics collector.

toString

public String toString()

Overrides:

toString in class AbstractIncrementalStateHandle

registerSharedStates

public void registerSharedStates(SharedStateRegistry stateRegistry,
                                 long checkpointID)

Description copied from interface: CompositeStateHandle

Register both newly created and already referenced shared states in the given SharedStateRegistry. This method is called when the checkpoint successfully completes or is recovered from failures.

After this is completed, newly created shared state is considered as published is no longer owned by this handle. This means that it should no longer be deleted as part of calls to StateObject.discardState(). Instead, StateObject.discardState() will trigger an unregistration from the registry.

Parameters:

stateRegistry - The registry where shared states are registered.

getCheckpointedSize

public long getCheckpointedSize()

Description copied from interface: CompositeStateHandle

Returns the persisted data size during checkpoint execution in bytes. If incremental checkpoint is enabled, this value represents the incremental persisted data size, and usually smaller than StateObject.getStateSize(). If the size is unknown, this method would return same result as StateObject.getStateSize().

Returns:

The persisted data size during checkpoint execution in bytes.

getDirectoryStateHandle

@Nonnull
public DirectoryStateHandle getDirectoryStateHandle()