org.apache.flink.runtime.state

Class DefaultOperatorStateBackend

java.lang.Object

org.apache.flink.runtime.state.DefaultOperatorStateBackend

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.flink.api.common.state.OperatorStateStore, OperatorStateBackend, Snapshotable<SnapshotResult<OperatorStateHandle>,Collection<OperatorStateHandle>>, org.apache.flink.util.Disposable

@Internal
public class DefaultOperatorStateBackend
extends Object
implements OperatorStateBackend

Default implementation of OperatorStateStore that provides the ability to make snapshots.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_OPERATOR_STATE_NAME The default namespace for state in cases where no state name is provided

Constructor Summary

Constructors

Constructor and Description
DefaultOperatorStateBackend(ClassLoader userClassLoader, org.apache.flink.api.common.ExecutionConfig executionConfig, boolean asynchronousSnapshots)

Method Summary

Modifier and Type	Method and Description
void	close()
void	dispose()
<K,V> org.apache.flink.api.common.state.BroadcastState<K,V>	getBroadcastState(org.apache.flink.api.common.state.MapStateDescriptor<K,V> stateDescriptor)
org.apache.flink.api.common.ExecutionConfig	getExecutionConfig()
<S> org.apache.flink.api.common.state.ListState<S>	getListState(org.apache.flink.api.common.state.ListStateDescriptor<S> stateDescriptor)
<S> org.apache.flink.api.common.state.ListState<S>	getOperatorState(org.apache.flink.api.common.state.ListStateDescriptor<S> stateDescriptor) Deprecated. This was deprecated as part of a refinement to the function names. Please use getListState(ListStateDescriptor) instead.
Set<String>	getRegisteredBroadcastStateNames()
Set<String>	getRegisteredStateNames()
<T extends Serializable> org.apache.flink.api.common.state.ListState<T>	getSerializableListState(String stateName) Deprecated. Using Java serialization for persisting state is not encouraged. Please use getListState(ListStateDescriptor) instead.
<S> org.apache.flink.api.common.state.ListState<S>	getUnionListState(org.apache.flink.api.common.state.ListStateDescriptor<S> stateDescriptor)
void	restore(Collection<OperatorStateHandle> restoreSnapshots) Restores state that was previously snapshotted from the provided parameters.
RunnableFuture<SnapshotResult<OperatorStateHandle>>	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.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_OPERATOR_STATE_NAME

public static final String DEFAULT_OPERATOR_STATE_NAME

The default namespace for state in cases where no state name is provided

See Also:

Constant Field Values

Constructor Detail

DefaultOperatorStateBackend

public DefaultOperatorStateBackend(ClassLoader userClassLoader,
                                   org.apache.flink.api.common.ExecutionConfig executionConfig,
                                   boolean asynchronousSnapshots)

Method Detail

getExecutionConfig

public org.apache.flink.api.common.ExecutionConfig getExecutionConfig()

getRegisteredStateNames

public Set<String> getRegisteredStateNames()

Specified by:

getRegisteredStateNames in interface org.apache.flink.api.common.state.OperatorStateStore

getRegisteredBroadcastStateNames

public Set<String> getRegisteredBroadcastStateNames()

Specified by:

getRegisteredBroadcastStateNames in interface org.apache.flink.api.common.state.OperatorStateStore

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

dispose

public void dispose()

Specified by:

dispose in interface OperatorStateBackend

Specified by:

dispose in interface org.apache.flink.util.Disposable

getBroadcastState

public <K,V> org.apache.flink.api.common.state.BroadcastState<K,V> getBroadcastState(org.apache.flink.api.common.state.MapStateDescriptor<K,V> stateDescriptor)
                                                                              throws org.apache.flink.util.StateMigrationException

Specified by:

getBroadcastState in interface org.apache.flink.api.common.state.OperatorStateStore

Throws:

org.apache.flink.util.StateMigrationException

getListState

public <S> org.apache.flink.api.common.state.ListState<S> getListState(org.apache.flink.api.common.state.ListStateDescriptor<S> stateDescriptor)
                                                                throws Exception

Specified by:

getListState in interface org.apache.flink.api.common.state.OperatorStateStore

Throws:

Exception

getUnionListState

public <S> org.apache.flink.api.common.state.ListState<S> getUnionListState(org.apache.flink.api.common.state.ListStateDescriptor<S> stateDescriptor)
                                                                     throws Exception

Specified by:

getUnionListState in interface org.apache.flink.api.common.state.OperatorStateStore

Throws:

Exception

getOperatorState

@Deprecated
public <S> org.apache.flink.api.common.state.ListState<S> getOperatorState(org.apache.flink.api.common.state.ListStateDescriptor<S> stateDescriptor)
                                                                                throws Exception

Deprecated. This was deprecated as part of a refinement to the function names. Please use getListState(ListStateDescriptor) instead.

Specified by:

getOperatorState in interface org.apache.flink.api.common.state.OperatorStateStore

Throws:

Exception

getSerializableListState

@Deprecated
public <T extends Serializable> org.apache.flink.api.common.state.ListState<T> getSerializableListState(String stateName)
                                                                                                             throws Exception

Deprecated. Using Java serialization for persisting state is not encouraged. Please use getListState(ListStateDescriptor) instead.

Specified by:

getSerializableListState in interface org.apache.flink.api.common.state.OperatorStateStore

Throws:

Exception

snapshot

public RunnableFuture<SnapshotResult<OperatorStateHandle>> snapshot(long checkpointId,
                                                                    long timestamp,
                                                                    CheckpointStreamFactory streamFactory,
                                                                    CheckpointOptions checkpointOptions)
                                                             throws Exception

Description copied from interface: Snapshotable

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

Specified by:

snapshot in interface Snapshotable<SnapshotResult<OperatorStateHandle>,Collection<OperatorStateHandle>>

Parameters:

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.

Returns:

A runnable future that will yield a StateObject.

Throws:

Exception

restore

public void restore(Collection<OperatorStateHandle> restoreSnapshots)
             throws Exception

Description copied from interface: Snapshotable

Restores state that was previously snapshotted from the provided parameters. Typically the parameters are state handles from which the old state is read.

Specified by:

restore in interface Snapshotable<SnapshotResult<OperatorStateHandle>,Collection<OperatorStateHandle>>

Parameters:

restoreSnapshots - the old state to restore.

Throws:

Exception