org.apache.flink.runtime.state

类 AbstractKeyedStateBackend<K>

java.lang.Object

org.apache.flink.runtime.state.AbstractKeyedStateBackend<K>

类型参数:

K - Type of the key by which state is keyed.

所有已实现的接口:

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

直接已知子类:

HeapKeyedStateBackend

public abstract class AbstractKeyedStateBackend<K>
extends Object
implements CheckpointableKeyedStateBackend<K>, org.apache.flink.api.common.state.InternalCheckpointListener, TestableKeyedStateBackend<K>, InternalKeyContext<K>

Base implementation of KeyedStateBackend. The state can be checkpointed to streams using Snapshotable.snapshot(long, long, CheckpointStreamFactory, CheckpointOptions).

嵌套类概要

嵌套类

限定符和类型	类和说明
static interface	AbstractKeyedStateBackend.PartitionStateFactory

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

KeyedStateBackend.KeySelectionListener<K>

字段概要

字段

限定符和类型	字段和说明
protected org.apache.flink.core.fs.CloseableRegistry	cancelStreamRegistry Registry for all opened streams, so they can be closed if the task using this backend is closed.
protected InternalKeyContext<K>	keyContext The key context for this backend.
protected StreamCompressionDecorator	keyGroupCompressionDecorator Decorates the input and output streams to write key-groups compressed.
protected KeyGroupRange	keyGroupRange Range of key-groups for which this backend is responsible.
protected org.apache.flink.api.common.typeutils.TypeSerializer<K>	keySerializer The key serializer.
protected TaskKvStateRegistry	kvStateRegistry KvStateRegistry helper for this task.
protected LatencyTrackingStateConfig	latencyTrackingStateConfig
protected int	numberOfKeyGroups The number of key-groups aka max parallelism.
protected TtlTimeProvider	ttlTimeProvider
protected ClassLoader	userCodeClassLoader

构造器概要

构造器

限定符	构造器和说明
protected	AbstractKeyedStateBackend(AbstractKeyedStateBackend<K> abstractKeyedStateBackend)
	AbstractKeyedStateBackend(TaskKvStateRegistry kvStateRegistry, org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, ClassLoader userCodeClassLoader, org.apache.flink.api.common.ExecutionConfig executionConfig, TtlTimeProvider ttlTimeProvider, LatencyTrackingStateConfig latencyTrackingStateConfig, org.apache.flink.core.fs.CloseableRegistry cancelStreamRegistry, InternalKeyContext<K> keyContext)
	AbstractKeyedStateBackend(TaskKvStateRegistry kvStateRegistry, org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, ClassLoader userCodeClassLoader, org.apache.flink.api.common.ExecutionConfig executionConfig, TtlTimeProvider ttlTimeProvider, LatencyTrackingStateConfig latencyTrackingStateConfig, org.apache.flink.core.fs.CloseableRegistry cancelStreamRegistry, StreamCompressionDecorator keyGroupCompressionDecorator, InternalKeyContext<K> keyContext)

方法概要

限定符和类型	方法和说明
<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, KeyedStateFunction<K,S> function) Applies the provided KeyedStateFunction to the state with the provided StateDescriptor of all the currently active keys.
<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, KeyedStateFunction<K,S> function, AbstractKeyedStateBackend.PartitionStateFactory partitionStateFactory)
void	close()
boolean	deregisterKeySelectionListener(KeyedStateBackend.KeySelectionListener<K> listener) Stop calling listener registered in KeyedStateBackend.registerKeySelectionListener(org.apache.flink.runtime.state.KeyedStateBackend.KeySelectionListener<K>).
void	dispose() Closes the state backend, releasing all internal resources, but does not delete any persistent checkpoint data.
K	getCurrentKey() Used by states to access the current key.
int	getCurrentKeyGroupIndex() Returns the key-group to which the current key belongs.
InternalKeyContext<K>	getKeyContext()
StreamCompressionDecorator	getKeyGroupCompressionDecorator()
KeyGroupRange	getKeyGroupRange() Returns the key groups which this state backend is responsible for.
org.apache.flink.api.common.typeutils.TypeSerializer<K>	getKeySerializer()
LatencyTrackingStateConfig	getLatencyTrackingStateConfig()
int	getNumberOfKeyGroups() Returns the number of key-groups aka max parallelism.
<N,S extends org.apache.flink.api.common.state.State,V> S	getOrCreateKeyedState(org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer, org.apache.flink.api.common.state.StateDescriptor<S,V> stateDescriptor) Creates or retrieves a keyed state backed by this state backend.
<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) TODO: NOTE: This method does a lot of work caching / retrieving states just to update the namespace.
void	notifyCheckpointSubsumed(long checkpointId)
int	numKeyValueStatesByName()
void	publishQueryableStateIfEnabled(org.apache.flink.api.common.state.StateDescriptor<?,?> stateDescriptor, InternalKvState<?,?,?> kvState)
void	registerKeySelectionListener(KeyedStateBackend.KeySelectionListener<K> listener) State backend will call KeyedStateBackend.KeySelectionListener.keySelected(K) when key context is switched if supported.
boolean	requiresLegacySynchronousTimerSnapshots(SnapshotType checkpointType)
void	setCurrentKey(K newKey) Sets the current key that is used for partitioned state.
void	setCurrentKeyGroupIndex(int currentKeyGroupIndex) Set current key group index of the context.

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

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

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

savepoint

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

snapshot

从接口继承的方法 org.apache.flink.api.common.state.CheckpointListener

notifyCheckpointAborted, notifyCheckpointComplete

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

getDelegatedKeyedStateBackend, numKeyValueStateEntries

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

getKeys, getKeysAndNamespaces, isSafeToReuseKVState, isStateImmutableInStateBackend

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

createOrUpdateInternalState, createOrUpdateInternalState, createOrUpdateInternalState

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

create, create

字段详细资料

keySerializer

protected final org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer

The key serializer.

numberOfKeyGroups

protected final int numberOfKeyGroups

The number of key-groups aka max parallelism.

keyGroupRange

protected final KeyGroupRange keyGroupRange

Range of key-groups for which this backend is responsible.

kvStateRegistry

protected final TaskKvStateRegistry kvStateRegistry

KvStateRegistry helper for this task.

cancelStreamRegistry

protected org.apache.flink.core.fs.CloseableRegistry cancelStreamRegistry

Registry for all opened streams, so they can be closed if the task using this backend is closed.

userCodeClassLoader

protected final ClassLoader userCodeClassLoader

ttlTimeProvider

protected final TtlTimeProvider ttlTimeProvider

latencyTrackingStateConfig

protected final LatencyTrackingStateConfig latencyTrackingStateConfig

keyGroupCompressionDecorator

protected final StreamCompressionDecorator keyGroupCompressionDecorator

Decorates the input and output streams to write key-groups compressed.

keyContext

protected final InternalKeyContext<K> keyContext

The key context for this backend.

构造器详细资料

AbstractKeyedStateBackend

public AbstractKeyedStateBackend(TaskKvStateRegistry kvStateRegistry,
                                 org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer,
                                 ClassLoader userCodeClassLoader,
                                 org.apache.flink.api.common.ExecutionConfig executionConfig,
                                 TtlTimeProvider ttlTimeProvider,
                                 LatencyTrackingStateConfig latencyTrackingStateConfig,
                                 org.apache.flink.core.fs.CloseableRegistry cancelStreamRegistry,
                                 InternalKeyContext<K> keyContext)

AbstractKeyedStateBackend

public AbstractKeyedStateBackend(TaskKvStateRegistry kvStateRegistry,
                                 org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer,
                                 ClassLoader userCodeClassLoader,
                                 org.apache.flink.api.common.ExecutionConfig executionConfig,
                                 TtlTimeProvider ttlTimeProvider,
                                 LatencyTrackingStateConfig latencyTrackingStateConfig,
                                 org.apache.flink.core.fs.CloseableRegistry cancelStreamRegistry,
                                 StreamCompressionDecorator keyGroupCompressionDecorator,
                                 InternalKeyContext<K> keyContext)

AbstractKeyedStateBackend

protected AbstractKeyedStateBackend(AbstractKeyedStateBackend<K> abstractKeyedStateBackend)

方法详细资料

notifyCheckpointSubsumed

public void notifyCheckpointSubsumed(long checkpointId)
                              throws Exception

指定者:

notifyCheckpointSubsumed 在接口中 org.apache.flink.api.common.state.InternalCheckpointListener

抛出:

Exception

dispose

public void dispose()

Closes the state backend, releasing all internal resources, but does not delete any persistent checkpoint data.

指定者:

dispose 在接口中 KeyedStateBackend<K>

指定者:

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

setCurrentKey

public void setCurrentKey(K newKey)

从接口复制的说明: KeyedStateBackend

Sets the current key that is used for partitioned state.

指定者:

setCurrentKey 在接口中 InternalKeyContext<K>

指定者:

setCurrentKey 在接口中 KeyedStateBackend<K>

参数:

newKey - The new current key.

另请参阅:

KeyedStateBackend

registerKeySelectionListener

public void registerKeySelectionListener(KeyedStateBackend.KeySelectionListener<K> listener)

从接口复制的说明: KeyedStateBackend

State backend will call KeyedStateBackend.KeySelectionListener.keySelected(K) when key context is switched if supported.

指定者:

registerKeySelectionListener 在接口中 KeyedStateBackend<K>

deregisterKeySelectionListener

public boolean deregisterKeySelectionListener(KeyedStateBackend.KeySelectionListener<K> listener)

从接口复制的说明: KeyedStateBackend

Stop calling listener registered in KeyedStateBackend.registerKeySelectionListener(org.apache.flink.runtime.state.KeyedStateBackend.KeySelectionListener<K>).

指定者:

deregisterKeySelectionListener 在接口中 KeyedStateBackend<K>

返回:

returns true iff listener was registered before.

getKeySerializer

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

指定者:

getKeySerializer 在接口中 KeyedStateBackend<K>

返回:

Serializer of the key.

另请参阅:

KeyedStateBackend

getCurrentKey

public K getCurrentKey()

从接口复制的说明: InternalKeyContext

Used by states to access the current key.

指定者:

getCurrentKey 在接口中 InternalKeyContext<K>

指定者:

getCurrentKey 在接口中 KeyedStateBackend<K>

返回:

Current key.

另请参阅:

KeyedStateBackend

getCurrentKeyGroupIndex

public int getCurrentKeyGroupIndex()

从接口复制的说明: InternalKeyContext

Returns the key-group to which the current key belongs.

指定者:

getCurrentKeyGroupIndex 在接口中 InternalKeyContext<K>

另请参阅:

KeyedStateBackend

getNumberOfKeyGroups

public int getNumberOfKeyGroups()

从接口复制的说明: InternalKeyContext

Returns the number of key-groups aka max parallelism.

指定者:

getNumberOfKeyGroups 在接口中 InternalKeyContext<K>

另请参阅:

KeyedStateBackend

getKeyGroupRange

public KeyGroupRange getKeyGroupRange()

从接口复制的说明: CheckpointableKeyedStateBackend

Returns the key groups which this state backend is responsible for.

指定者:

getKeyGroupRange 在接口中 CheckpointableKeyedStateBackend<K>

指定者:

getKeyGroupRange 在接口中 InternalKeyContext<K>

另请参阅:

KeyedStateBackend

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,
                                                                                   KeyedStateFunction<K,S> function)
                                                                            throws Exception

从接口复制的说明: KeyedStateBackend

Applies the provided KeyedStateFunction to the state with the provided StateDescriptor of all the currently active keys.

指定者:

applyToAllKeys 在接口中 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.

抛出:

Exception

另请参阅:

KeyedStateBackend

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,
                                                                                   KeyedStateFunction<K,S> function,
                                                                                   AbstractKeyedStateBackend.PartitionStateFactory partitionStateFactory)
                                                                            throws Exception

抛出:

Exception

getOrCreateKeyedState

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

从接口复制的说明: KeyedStateBackend

Creates or retrieves a keyed state backed by this state backend.

指定者:

getOrCreateKeyedState 在接口中 KeyedStateBackend<K>

类型参数:

N - The type of the namespace.

S - The type of the state.

参数:

namespaceSerializer - The serializer used for the namespace type of the state

stateDescriptor - The identifier for the state. This contains name and can create a default state value.

返回:

A new key/value state backed by this backend.

抛出:

Exception - Exceptions may occur during initialization of the state and should be forwarded.

另请参阅:

KeyedStateBackend

publishQueryableStateIfEnabled

public void publishQueryableStateIfEnabled(org.apache.flink.api.common.state.StateDescriptor<?,?> stateDescriptor,
                                           InternalKvState<?,?,?> kvState)

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

TODO: 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 在接口中 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.

返回:

A new key/value state backed by this backend.

抛出:

Exception - Exceptions may occur during initialization of the state and should be forwarded.

另请参阅:

KeyedStateBackend

close

public void close()
           throws IOException

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

抛出:

IOException

getLatencyTrackingStateConfig

public LatencyTrackingStateConfig getLatencyTrackingStateConfig()

getKeyGroupCompressionDecorator

@VisibleForTesting
public StreamCompressionDecorator getKeyGroupCompressionDecorator()

numKeyValueStatesByName

@VisibleForTesting
public int numKeyValueStatesByName()

requiresLegacySynchronousTimerSnapshots

public boolean requiresLegacySynchronousTimerSnapshots(SnapshotType checkpointType)

getKeyContext

public InternalKeyContext<K> getKeyContext()

setCurrentKeyGroupIndex

public void setCurrentKeyGroupIndex(int currentKeyGroupIndex)

从接口复制的说明: InternalKeyContext

Set current key group index of the context.

指定者:

setCurrentKeyGroupIndex 在接口中 InternalKeyContext<K>

参数:

currentKeyGroupIndex - the current key group index to set to.