Package org.apache.flink.runtime.state.changelog

Class ChangelogStateBackendLocalHandle

java.lang.Object

org.apache.flink.runtime.state.changelog.ChangelogStateBackendLocalHandle

All Implemented Interfaces:

Serializable, ChangelogStateBackendHandle, CheckpointBoundKeyedStateHandle, CompositeStateHandle, KeyedStateHandle, StateObject

public class ChangelogStateBackendLocalHandle
extends Object
implements ChangelogStateBackendHandle

State handle for local copies of ChangelogStateHandleStreamImpl. Consists of a remoteHandle that maintains the mapping of local handle and remote handle, like sharedStateHandleIDs in IncrementalLocalKeyedStateHandle.

See Also:

Serialized Form

Nested Class Summary

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

ChangelogStateBackendHandle.ChangelogStateBackendHandleImpl

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

StateObject.StateObjectLocation, StateObject.StateObjectSizeStatsCollector

Constructor Summary

Constructors

Constructor	Description
ChangelogStateBackendLocalHandle(List<KeyedStateHandle> localMaterialized, List<ChangelogStateHandle> localNonMaterialized, ChangelogStateBackendHandle.ChangelogStateBackendHandleImpl remoteHandle)

Method Summary

Modifier and Type	Method	Description
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.
long	getCheckpointId()	Returns the ID of the checkpoint for which the handle was created or used.
KeyedStateHandle	getIntersection(KeyGroupRange keyGroupRange)	Returns a state over a range that is the intersection between this handle's key-group range and the provided key-group range.
KeyGroupRange	getKeyGroupRange()	Returns the range of the key groups contained in the state.
long	getMaterializationID()
List<KeyedStateHandle>	getMaterializedStateHandles()
List<ChangelogStateHandle>	getNonMaterializedStateHandles()
List<KeyedStateHandle>	getRemoteMaterializedStateHandles()
List<ChangelogStateHandle>	getRemoteNonMaterializedStateHandles()
StateHandleID	getStateHandleId()	Returns a unique state handle id to distinguish with other keyed state handles.
long	getStateSize()	Returns the size of the state in bytes.
ChangelogStateBackendHandle	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.

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.runtime.state.StateObject

collectSizeStats

Constructor Detail

ChangelogStateBackendLocalHandle

public ChangelogStateBackendLocalHandle(List<KeyedStateHandle> localMaterialized,
                                        List<ChangelogStateHandle> localNonMaterialized,
                                        ChangelogStateBackendHandle.ChangelogStateBackendHandleImpl remoteHandle)

Method Detail

getMaterializedStateHandles

public List<KeyedStateHandle> getMaterializedStateHandles()

Specified by:

getMaterializedStateHandles in interface ChangelogStateBackendHandle

getNonMaterializedStateHandles

public List<ChangelogStateHandle> getNonMaterializedStateHandles()

Specified by:

getNonMaterializedStateHandles in interface ChangelogStateBackendHandle

getMaterializationID

public long getMaterializationID()

Specified by:

getMaterializationID in interface ChangelogStateBackendHandle

rebound

public ChangelogStateBackendHandle rebound(long checkpointId)

Description copied from interface: CheckpointBoundKeyedStateHandle

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

Specified by:

rebound in interface ChangelogStateBackendHandle

Specified by:

rebound in interface CheckpointBoundKeyedStateHandle

Parameters:

checkpointId - rebounded checkpoint id.

getRemoteMaterializedStateHandles

public List<KeyedStateHandle> getRemoteMaterializedStateHandles()

getRemoteNonMaterializedStateHandles

public List<ChangelogStateHandle> getRemoteNonMaterializedStateHandles()

getCheckpointId

public long getCheckpointId()

Description copied from interface: CheckpointBoundKeyedStateHandle

Returns the ID of the checkpoint for which the handle was created or used.

Specified by:

getCheckpointId in interface CheckpointBoundKeyedStateHandle

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.

Specified by:

registerSharedStates in interface CompositeStateHandle

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().

Specified by:

getCheckpointedSize in interface CompositeStateHandle

Returns:

The persisted data size during checkpoint execution in bytes.

getKeyGroupRange

public KeyGroupRange getKeyGroupRange()

Description copied from interface: KeyedStateHandle

Returns the range of the key groups contained in the state.

Specified by:

getKeyGroupRange in interface KeyedStateHandle

getIntersection

@Nullable
public KeyedStateHandle getIntersection(KeyGroupRange keyGroupRange)

Description copied from interface: KeyedStateHandle

Returns a state over a range that is the intersection between this handle's key-group range and the provided key-group range.

Specified by:

getIntersection in interface KeyedStateHandle

Parameters:

keyGroupRange - The key group range to intersect with, will return null if the intersection of this handle's key-group and the provided key-group is empty.

getStateHandleId

public StateHandleID getStateHandleId()

Description copied from interface: KeyedStateHandle

Returns a unique state handle id to distinguish with other keyed state handles.

If this state handle would be used as materialized part of ChangelogStateBackendHandle, it should persist this state handle id when serializing of checkpoint and deserialize it back to ensure the state handle id is constant.

Specified by:

getStateHandleId in interface KeyedStateHandle

Returns:

A unique state handle 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.

Specified by:

discardState in interface StateObject

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.

Specified by:

getStateSize in interface StateObject

Returns:

Size of the state in bytes.