public class BatchExecutionKeyedStateBackend<K> extends Object implements CheckpointableKeyedStateBackend<K>
CheckpointableKeyedStateBackend which keeps values for a single key at a time.
IMPORTANT: Requires the incoming records to be sorted/grouped by the key. Used in a BATCH style execution.
KeyedStateBackend.KeySelectionListener<K>| Constructor and Description |
|---|
BatchExecutionKeyedStateBackend(TypeSerializer<K> keySerializer,
KeyGroupRange keyGroupRange,
ExecutionConfig executionConfig) |
| Modifier and Type | Method and Description |
|---|---|
<N,S extends State,T> |
applyToAllKeys(N namespace,
TypeSerializer<N> namespaceSerializer,
StateDescriptor<S,T> stateDescriptor,
KeyedStateFunction<K,S> function)
Applies the provided
KeyedStateFunction to the state with the provided StateDescriptor of all the currently active keys. |
void |
close() |
<T extends HeapPriorityQueueElement & PriorityComparable<? super T> & Keyed<?>> |
create(String stateName,
TypeSerializer<T> byteOrderedElementSerializer)
Creates a
KeyGroupedInternalPriorityQueue. |
<N,SV,SEV,S extends State,IS extends S> |
createOrUpdateInternalState(TypeSerializer<N> namespaceSerializer,
StateDescriptor<S,SV> stateDesc,
StateSnapshotTransformer.StateSnapshotTransformFactory<SEV> snapshotTransformFactory)
Creates or updates internal state and returns a new
InternalKvState. |
boolean |
deregisterKeySelectionListener(KeyedStateBackend.KeySelectionListener<K> listener)
Stop calling listener registered in
KeyedStateBackend.registerKeySelectionListener(org.apache.flink.runtime.state.KeyedStateBackend.KeySelectionListener<K>). |
void |
dispose()
Disposes the object and releases all resources.
|
K |
getCurrentKey() |
KeyGroupRange |
getKeyGroupRange()
Returns the key groups which this state backend is responsible for.
|
<N> Stream<K> |
getKeys(String state,
N namespace) |
<N> Stream<Tuple2<K,N>> |
getKeysAndNamespaces(String state) |
TypeSerializer<K> |
getKeySerializer() |
<N,S extends State,T> |
getOrCreateKeyedState(TypeSerializer<N> namespaceSerializer,
StateDescriptor<S,T> stateDescriptor)
Creates or retrieves a keyed state backed by this state backend.
|
<N,S extends State> |
getPartitionedState(N namespace,
TypeSerializer<N> namespaceSerializer,
StateDescriptor<S,?> stateDescriptor)
Creates or retrieves a partitioned state backed by this state backend.
|
void |
registerKeySelectionListener(KeyedStateBackend.KeySelectionListener<K> listener)
State backend will call
KeyedStateBackend.KeySelectionListener.keySelected(K) when key context is switched
if supported. |
SavepointResources<K> |
savepoint()
Returns a
SavepointResources that can be used by SavepointSnapshotStrategy to
write out a savepoint in the common/unified format. |
void |
setCurrentKey(K newKey)
Sets the current key that is used for partitioned state.
|
RunnableFuture<SnapshotResult<KeyedStateHandle>> |
snapshot(long checkpointId,
long timestamp,
CheckpointStreamFactory streamFactory,
CheckpointOptions checkpointOptions)
Operation that writes a snapshot into a stream that is provided by the given
CheckpointStreamFactory and returns a @RunnableFuture that gives a state handle to
the snapshot. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitisSafeToReuseKVState, isStateImmutableInStateBackendcreateOrUpdateInternalState, createOrUpdateInternalStatecreatepublic BatchExecutionKeyedStateBackend(TypeSerializer<K> keySerializer, KeyGroupRange keyGroupRange, ExecutionConfig executionConfig)
public void setCurrentKey(K newKey)
KeyedStateBackendsetCurrentKey in interface KeyedStateBackend<K>newKey - The new current key.public K getCurrentKey()
getCurrentKey in interface KeyedStateBackend<K>public TypeSerializer<K> getKeySerializer()
getKeySerializer in interface KeyedStateBackend<K>public <N,S extends State,T> void applyToAllKeys(N namespace, TypeSerializer<N> namespaceSerializer, StateDescriptor<S,T> stateDescriptor, KeyedStateFunction<K,S> function)
KeyedStateBackendKeyedStateFunction to the state with the provided StateDescriptor of all the currently active keys.applyToAllKeys in interface KeyedStateBackend<K>N - The type of the namespace.S - The type of the state.namespace - the namespace of the state.namespaceSerializer - the serializer for the namespace.stateDescriptor - the descriptor of the state to which the function is going to be
applied.function - the function to be applied to the keyed state.public <N> Stream<K> getKeys(String state, N namespace)
getKeys in interface KeyedStateBackend<K>state - State variable for which existing keys will be returned.namespace - Namespace for which existing keys will be returned.public <N> Stream<Tuple2<K,N>> getKeysAndNamespaces(String state)
getKeysAndNamespaces in interface KeyedStateBackend<K>state - State variable for which existing keys will be returned.public <N,S extends State,T> S getOrCreateKeyedState(TypeSerializer<N> namespaceSerializer, StateDescriptor<S,T> stateDescriptor) throws Exception
KeyedStateBackendgetOrCreateKeyedState in interface KeyedStateBackend<K>N - The type of the namespace.S - The type of the state.namespaceSerializer - The serializer used for the namespace type of the statestateDescriptor - The identifier for the state. This contains name and can create a
default state value.Exception - Exceptions may occur during initialization of the state and should be
forwarded.public <N,S extends State> S getPartitionedState(N namespace, TypeSerializer<N> namespaceSerializer, StateDescriptor<S,?> stateDescriptor) throws Exception
KeyedStateBackendTODO: NOTE: This method does a lot of work caching / retrieving states just to update the namespace. This method should be removed for the sake of namespaces being lazily fetched from the keyed state backend, or being set on the state directly.
getPartitionedState in interface KeyedStateBackend<K>N - The type of the namespace.S - The type of the state.stateDescriptor - The identifier for the state. This contains name and can create a
default state value.Exception - Exceptions may occur during initialization of the state and should be
forwarded.public void dispose()
Disposabledispose in interface KeyedStateBackend<K>dispose in interface Disposablepublic void registerKeySelectionListener(KeyedStateBackend.KeySelectionListener<K> listener)
KeyedStateBackendKeyedStateBackend.KeySelectionListener.keySelected(K) when key context is switched
if supported.registerKeySelectionListener in interface KeyedStateBackend<K>public boolean deregisterKeySelectionListener(KeyedStateBackend.KeySelectionListener<K> listener)
KeyedStateBackendKeyedStateBackend.registerKeySelectionListener(org.apache.flink.runtime.state.KeyedStateBackend.KeySelectionListener<K>).deregisterKeySelectionListener in interface KeyedStateBackend<K>@Nonnull public <N,SV,SEV,S extends State,IS extends S> IS createOrUpdateInternalState(@Nonnull TypeSerializer<N> namespaceSerializer, @Nonnull StateDescriptor<S,SV> stateDesc, @Nonnull StateSnapshotTransformer.StateSnapshotTransformFactory<SEV> snapshotTransformFactory) throws Exception
KeyedStateFactoryInternalKvState.createOrUpdateInternalState in interface KeyedStateFactoryN - The type of the namespace.SV - The type of the stored state value.SEV - The type of the stored state value or entry for collection types (list or map).S - The type of the public API state.IS - The type of internal state.namespaceSerializer - TypeSerializer for the state namespace.stateDesc - The StateDescriptor that contains the name of the state.snapshotTransformFactory - factory of state snapshot transformer.Exception@Nonnull public <T extends HeapPriorityQueueElement & PriorityComparable<? super T> & Keyed<?>> KeyGroupedInternalPriorityQueue<T> create(@Nonnull String stateName, @Nonnull TypeSerializer<T> byteOrderedElementSerializer)
PriorityQueueSetFactoryKeyGroupedInternalPriorityQueue.create in interface PriorityQueueSetFactoryT - type of the stored elements.stateName - unique name for associated with this queue.byteOrderedElementSerializer - a serializer that with a format that is lexicographically
ordered in alignment with elementPriorityComparator.public KeyGroupRange getKeyGroupRange()
CheckpointableKeyedStateBackendgetKeyGroupRange in interface CheckpointableKeyedStateBackend<K>public void close()
throws IOException
close in interface Closeableclose in interface AutoCloseableIOException@Nonnull public RunnableFuture<SnapshotResult<KeyedStateHandle>> snapshot(long checkpointId, long timestamp, @Nonnull CheckpointStreamFactory streamFactory, @Nonnull CheckpointOptions checkpointOptions)
SnapshotableCheckpointStreamFactory and returns a @RunnableFuture that gives a state handle to
the snapshot. It is up to the implementation if the operation is performed synchronous or
asynchronous. In the later case, the returned Runnable must be executed first before
obtaining the handle.snapshot in interface Snapshotable<SnapshotResult<KeyedStateHandle>>checkpointId - The ID of the checkpoint.timestamp - The timestamp of the checkpoint.streamFactory - The factory that we can use for writing our state to streams.checkpointOptions - Options for how to perform this checkpoint.StateObject.@Nonnull public SavepointResources<K> savepoint() throws Exception
CheckpointableKeyedStateBackendSavepointResources that can be used by SavepointSnapshotStrategy to
write out a savepoint in the common/unified format.savepoint in interface CheckpointableKeyedStateBackend<K>ExceptionCopyright © 2014–2024 The Apache Software Foundation. All rights reserved.