org.apache.flink.state.changelog

类 ChangelogKeyedStateBackend<K>

java.lang.Object

org.apache.flink.state.changelog.ChangelogKeyedStateBackend<K>

类型参数:

K - The key by which state is keyed.

所有已实现的接口:

Closeable, AutoCloseable, org.apache.flink.api.common.state.CheckpointListener, org.apache.flink.runtime.state.CheckpointableKeyedStateBackend<K>, org.apache.flink.runtime.state.KeyedStateBackend<K>, org.apache.flink.runtime.state.KeyedStateFactory, org.apache.flink.runtime.state.PriorityQueueSetFactory, org.apache.flink.runtime.state.Snapshotable<org.apache.flink.runtime.state.SnapshotResult<org.apache.flink.runtime.state.KeyedStateHandle>>, org.apache.flink.runtime.state.TestableKeyedStateBackend<K>, org.apache.flink.util.Disposable

@Internal
public class ChangelogKeyedStateBackend<K>
extends Object
implements org.apache.flink.runtime.state.CheckpointableKeyedStateBackend<K>, org.apache.flink.api.common.state.CheckpointListener, org.apache.flink.runtime.state.TestableKeyedStateBackend<K>

A KeyedStateBackend that keeps state on the underlying delegated keyed state backend as well as on the state change log.

嵌套类概要

从接口继承的嵌套类/接口 org.apache.flink.runtime.state.KeyedStateBackend

org.apache.flink.runtime.state.KeyedStateBackend.KeySelectionListener<K>

构造器概要

构造器

构造器和说明

ChangelogKeyedStateBackend(org.apache.flink.runtime.state.AbstractKeyedStateBackend<K> keyedStateBackend, org.apache.flink.api.common.ExecutionConfig executionConfig, org.apache.flink.runtime.state.ttl.TtlTimeProvider ttlTimeProvider, org.apache.flink.runtime.state.changelog.StateChangelogWriter<org.apache.flink.runtime.state.changelog.ChangelogStateHandle> stateChangelogWriter, Collection<org.apache.flink.runtime.state.changelog.ChangelogStateBackendHandle> initialState, org.apache.flink.api.common.operators.MailboxExecutor mainMailboxExecutor, ExecutorService asyncOperationsThreadPool)

方法概要

限定符和类型	方法和说明
<N,S extends org.apache.flink.api.common.state.State,T> void	applyToAllKeys(N namespace, org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer, org.apache.flink.api.common.state.StateDescriptor<S,T> stateDescriptor, org.apache.flink.runtime.state.KeyedStateFunction<K,S> function)
void	close()
<T extends org.apache.flink.runtime.state.heap.HeapPriorityQueueElement & org.apache.flink.runtime.state.PriorityComparable<? super T> & org.apache.flink.runtime.state.Keyed<?>> org.apache.flink.runtime.state.KeyGroupedInternalPriorityQueue<T>	create(String stateName, org.apache.flink.api.common.typeutils.TypeSerializer<T> byteOrderedElementSerializer)
<N,SV,SEV,S extends org.apache.flink.api.common.state.State,IS extends S> IS	createInternalState(org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer, org.apache.flink.api.common.state.StateDescriptor<S,SV> stateDesc, org.apache.flink.runtime.state.StateSnapshotTransformer.StateSnapshotTransformFactory<SEV> snapshotTransformFactory)
boolean	deregisterKeySelectionListener(org.apache.flink.runtime.state.KeyedStateBackend.KeySelectionListener<K> listener)
void	dispose()
K	getCurrentKey()
org.apache.flink.runtime.state.KeyedStateBackend<K>	getDelegatedKeyedStateBackend(boolean recursive)
ChangelogState	getExistingStateForRecovery(String name, org.apache.flink.runtime.state.metainfo.StateMetaInfoSnapshot.BackendStateType type)
org.apache.flink.runtime.state.KeyGroupRange	getKeyGroupRange()
<N> java.util.stream.Stream<K>	getKeys(String state, N namespace)
<N> java.util.stream.Stream<org.apache.flink.api.java.tuple.Tuple2<K,N>>	getKeysAndNamespaces(String state)
org.apache.flink.api.common.typeutils.TypeSerializer<K>	getKeySerializer()
<N,S extends org.apache.flink.api.common.state.State,T> S	getOrCreateKeyedState(org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer, org.apache.flink.api.common.state.StateDescriptor<S,T> stateDescriptor)
<N,S extends org.apache.flink.api.common.state.State> S	getPartitionedState(N namespace, org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer, org.apache.flink.api.common.state.StateDescriptor<S,?> stateDescriptor)
boolean	isStateImmutableInStateBackend(org.apache.flink.runtime.checkpoint.CheckpointType checkpointOptions)
void	notifyCheckpointAborted(long checkpointId)
void	notifyCheckpointComplete(long checkpointId)
int	numKeyValueStateEntries()
void	registerKeySelectionListener(org.apache.flink.runtime.state.KeyedStateBackend.KeySelectionListener<K> listener)
org.apache.flink.runtime.state.SavepointResources<K>	savepoint()
void	setCurrentKey(K newKey)
RunnableFuture<org.apache.flink.runtime.state.SnapshotResult<org.apache.flink.runtime.state.KeyedStateHandle>>	snapshot(long checkpointId, long timestamp, org.apache.flink.runtime.state.CheckpointStreamFactory streamFactory, org.apache.flink.runtime.checkpoint.CheckpointOptions checkpointOptions)

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.apache.flink.runtime.state.KeyedStateFactory

createInternalState

构造器详细资料

ChangelogKeyedStateBackend

public ChangelogKeyedStateBackend(org.apache.flink.runtime.state.AbstractKeyedStateBackend<K> keyedStateBackend,
                                  org.apache.flink.api.common.ExecutionConfig executionConfig,
                                  org.apache.flink.runtime.state.ttl.TtlTimeProvider ttlTimeProvider,
                                  org.apache.flink.runtime.state.changelog.StateChangelogWriter<org.apache.flink.runtime.state.changelog.ChangelogStateHandle> stateChangelogWriter,
                                  Collection<org.apache.flink.runtime.state.changelog.ChangelogStateBackendHandle> initialState,
                                  org.apache.flink.api.common.operators.MailboxExecutor mainMailboxExecutor,
                                  ExecutorService asyncOperationsThreadPool)

方法详细资料

getKeyGroupRange

public org.apache.flink.runtime.state.KeyGroupRange getKeyGroupRange()

指定者:

getKeyGroupRange 在接口中 org.apache.flink.runtime.state.CheckpointableKeyedStateBackend<K>

close

public void close()
           throws IOException

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

抛出:

IOException

setCurrentKey

public void setCurrentKey(K newKey)

指定者:

setCurrentKey 在接口中 org.apache.flink.runtime.state.KeyedStateBackend<K>

getCurrentKey

public K getCurrentKey()

指定者:

getCurrentKey 在接口中 org.apache.flink.runtime.state.KeyedStateBackend<K>

getKeySerializer

public org.apache.flink.api.common.typeutils.TypeSerializer<K> getKeySerializer()

指定者:

getKeySerializer 在接口中 org.apache.flink.runtime.state.KeyedStateBackend<K>

getKeys

public <N> java.util.stream.Stream<K> getKeys(String state,
                                              N namespace)

指定者:

getKeys 在接口中 org.apache.flink.runtime.state.KeyedStateBackend<K>

getKeysAndNamespaces

public <N> java.util.stream.Stream<org.apache.flink.api.java.tuple.Tuple2<K,N>> getKeysAndNamespaces(String state)

指定者:

getKeysAndNamespaces 在接口中 org.apache.flink.runtime.state.KeyedStateBackend<K>

dispose

public void dispose()

指定者:

dispose 在接口中 org.apache.flink.runtime.state.KeyedStateBackend<K>

指定者:

dispose 在接口中 org.apache.flink.util.Disposable

registerKeySelectionListener

public void registerKeySelectionListener(org.apache.flink.runtime.state.KeyedStateBackend.KeySelectionListener<K> listener)

指定者:

registerKeySelectionListener 在接口中 org.apache.flink.runtime.state.KeyedStateBackend<K>

deregisterKeySelectionListener

public boolean deregisterKeySelectionListener(org.apache.flink.runtime.state.KeyedStateBackend.KeySelectionListener<K> listener)

指定者:

deregisterKeySelectionListener 在接口中 org.apache.flink.runtime.state.KeyedStateBackend<K>

applyToAllKeys

public <N,S extends org.apache.flink.api.common.state.State,T> void applyToAllKeys(N namespace,
                                                                                   org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer,
                                                                                   org.apache.flink.api.common.state.StateDescriptor<S,T> stateDescriptor,
                                                                                   org.apache.flink.runtime.state.KeyedStateFunction<K,S> function)
                                                                            throws Exception

指定者:

applyToAllKeys 在接口中 org.apache.flink.runtime.state.KeyedStateBackend<K>

抛出:

Exception

getPartitionedState

public <N,S extends org.apache.flink.api.common.state.State> S getPartitionedState(N namespace,
                                                                                   org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer,
                                                                                   org.apache.flink.api.common.state.StateDescriptor<S,?> stateDescriptor)
                                                                            throws Exception

指定者:

getPartitionedState 在接口中 org.apache.flink.runtime.state.KeyedStateBackend<K>

抛出:

Exception

snapshot

@Nonnull
public RunnableFuture<org.apache.flink.runtime.state.SnapshotResult<org.apache.flink.runtime.state.KeyedStateHandle>> snapshot(long checkpointId,
                                                                                                                                        long timestamp,
                                                                                                                                        @Nonnull
                                                                                                                                        org.apache.flink.runtime.state.CheckpointStreamFactory streamFactory,
                                                                                                                                        @Nonnull
                                                                                                                                        org.apache.flink.runtime.checkpoint.CheckpointOptions checkpointOptions)
                                                                                                                                 throws Exception

指定者:

snapshot 在接口中 org.apache.flink.runtime.state.Snapshotable<org.apache.flink.runtime.state.SnapshotResult<org.apache.flink.runtime.state.KeyedStateHandle>>

抛出:

Exception

create

@Nonnull
public <T extends org.apache.flink.runtime.state.heap.HeapPriorityQueueElement & org.apache.flink.runtime.state.PriorityComparable<? super T> & org.apache.flink.runtime.state.Keyed<?>> org.apache.flink.runtime.state.KeyGroupedInternalPriorityQueue<T> create(@Nonnull
                                                                                                                                                                                                                                                                           String stateName,
                                                                                                                                                                                                                                                                           @Nonnull
                                                                                                                                                                                                                                                                           org.apache.flink.api.common.typeutils.TypeSerializer<T> byteOrderedElementSerializer)

指定者:

create 在接口中 org.apache.flink.runtime.state.PriorityQueueSetFactory

numKeyValueStateEntries

@VisibleForTesting
public int numKeyValueStateEntries()

指定者:

numKeyValueStateEntries 在接口中 org.apache.flink.runtime.state.TestableKeyedStateBackend<K>

isStateImmutableInStateBackend

public boolean isStateImmutableInStateBackend(org.apache.flink.runtime.checkpoint.CheckpointType checkpointOptions)

指定者:

isStateImmutableInStateBackend 在接口中 org.apache.flink.runtime.state.KeyedStateBackend<K>

savepoint

@Nonnull
public org.apache.flink.runtime.state.SavepointResources<K> savepoint()
                                                                        throws Exception

指定者:

savepoint 在接口中 org.apache.flink.runtime.state.CheckpointableKeyedStateBackend<K>

抛出:

Exception

notifyCheckpointComplete

public void notifyCheckpointComplete(long checkpointId)
                              throws Exception

指定者:

notifyCheckpointComplete 在接口中 org.apache.flink.api.common.state.CheckpointListener

抛出:

Exception

notifyCheckpointAborted

public void notifyCheckpointAborted(long checkpointId)
                             throws Exception

指定者:

notifyCheckpointAborted 在接口中 org.apache.flink.api.common.state.CheckpointListener

抛出:

Exception

getOrCreateKeyedState

public <N,S extends org.apache.flink.api.common.state.State,T> S getOrCreateKeyedState(org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer,
                                                                                       org.apache.flink.api.common.state.StateDescriptor<S,T> stateDescriptor)
                                                                                throws Exception

指定者:

getOrCreateKeyedState 在接口中 org.apache.flink.runtime.state.KeyedStateBackend<K>

抛出:

Exception

createInternalState

@Nonnull
public <N,SV,SEV,S extends org.apache.flink.api.common.state.State,IS extends S> IS createInternalState(@Nonnull
                                                                                                                 org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer,
                                                                                                                 @Nonnull
                                                                                                                 org.apache.flink.api.common.state.StateDescriptor<S,SV> stateDesc,
                                                                                                                 @Nonnull
                                                                                                                 org.apache.flink.runtime.state.StateSnapshotTransformer.StateSnapshotTransformFactory<SEV> snapshotTransformFactory)
                                                                                                          throws Exception

指定者:

createInternalState 在接口中 org.apache.flink.runtime.state.KeyedStateFactory

抛出:

Exception

getDelegatedKeyedStateBackend

public org.apache.flink.runtime.state.KeyedStateBackend<K> getDelegatedKeyedStateBackend(boolean recursive)

指定者:

getDelegatedKeyedStateBackend 在接口中 org.apache.flink.runtime.state.TestableKeyedStateBackend<K>

getExistingStateForRecovery

public ChangelogState getExistingStateForRecovery(String name,
                                                  org.apache.flink.runtime.state.metainfo.StateMetaInfoSnapshot.BackendStateType type)
                                           throws NoSuchElementException,
                                                  UnsupportedOperationException

参数:

name - state name

type - state type (the only supported type currently are: key value, priority queue)

返回:

an existing state, i.e. the one that was already created. The returned state will not apply TTL to the passed values, regardless of the TTL settings. This prevents double applying of TTL (recovered values are TTL values if TTL was enabled). The state will, however, use TTL serializer if TTL is enabled. WARN: only valid during the recovery.

抛出:

NoSuchElementException - if the state wasn't created

UnsupportedOperationException - if state type is not supported