org.apache.flink.runtime.state

类 StateBackendLoader

java.lang.Object

org.apache.flink.runtime.state.StateBackendLoader

public class StateBackendLoader
extends Object

This class contains utility methods to load state backends from configurations.

字段概要

字段

限定符和类型	字段和说明
static String	FS_STATE_BACKEND_NAME 已过时。
static String	HASHMAP_STATE_BACKEND_NAME The shortcut configuration name of the HashMap state backend.
static String	MEMORY_STATE_BACKEND_NAME 已过时。
static String	ROCKSDB_STATE_BACKEND_NAME The shortcut configuration name for the RocksDB State Backend.

方法概要

限定符和类型	方法和说明
static StateBackend	fromApplicationOrConfigOrDefault(StateBackend fromApplication, org.apache.flink.util.TernaryBoolean isChangelogStateBackendEnableFromApplication, org.apache.flink.configuration.Configuration config, ClassLoader classLoader, org.slf4j.Logger logger) This is the state backend loader that loads a DelegatingStateBackend wrapping the state backend loaded from loadFromApplicationOrConfigOrDefaultInternal(org.apache.flink.runtime.state.StateBackend, org.apache.flink.configuration.Configuration, java.lang.ClassLoader, org.slf4j.Logger) when delegation is enabled.
static StateBackend	loadStateBackendFromConfig(org.apache.flink.configuration.ReadableConfig config, ClassLoader classLoader, org.slf4j.Logger logger) Loads the unwrapped state backend from the configuration, from the parameter 'state.backend', as defined in StateBackendOptions.STATE_BACKEND.
static boolean	stateBackendFromApplicationOrConfigOrDefaultUseManagedMemory(org.apache.flink.configuration.Configuration config, Optional<Boolean> stateBackendFromApplicationUsesManagedMemory, ClassLoader classLoader) Checks whether state backend uses managed memory, without having to deserialize or load the state backend.

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

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

字段详细资料

HASHMAP_STATE_BACKEND_NAME

public static final String HASHMAP_STATE_BACKEND_NAME

The shortcut configuration name of the HashMap state backend.

另请参阅:

常量字段值

MEMORY_STATE_BACKEND_NAME

@Deprecated
public static final String MEMORY_STATE_BACKEND_NAME

已过时。

The shortcut configuration name for the MemoryState backend that checkpoints to the JobManager.

另请参阅:

常量字段值

FS_STATE_BACKEND_NAME

@Deprecated
public static final String FS_STATE_BACKEND_NAME

已过时。

The shortcut configuration name for the FileSystem State backend.

另请参阅:

常量字段值

ROCKSDB_STATE_BACKEND_NAME

public static final String ROCKSDB_STATE_BACKEND_NAME

The shortcut configuration name for the RocksDB State Backend.

另请参阅:

常量字段值

方法详细资料

loadStateBackendFromConfig

public static StateBackend loadStateBackendFromConfig(org.apache.flink.configuration.ReadableConfig config,
                                                      ClassLoader classLoader,
                                                      @Nullable
                                                      org.slf4j.Logger logger)
                                               throws org.apache.flink.configuration.IllegalConfigurationException,
                                                      org.apache.flink.util.DynamicCodeLoadingException,
                                                      IOException

Loads the unwrapped state backend from the configuration, from the parameter 'state.backend', as defined in StateBackendOptions.STATE_BACKEND.

The state backends can be specified either via their shortcut name, or via the class name of a StateBackendFactory. If a StateBackendFactory class name is specified, the factory is instantiated (via its zero-argument constructor) and its StateBackendFactory.createFromConfig(ReadableConfig, ClassLoader) method is called.

Recognized shortcut names are '', '' '' (Deprecated), and '' (Deprecated).

参数:

config - The configuration to load the state backend from

classLoader - The class loader that should be used to load the state backend

logger - Optionally, a logger to log actions to (may be null)

返回:

The instantiated state backend.

抛出:

org.apache.flink.util.DynamicCodeLoadingException - Thrown if a state backend factory is configured and the factory class was not found or the factory could not be instantiated

org.apache.flink.configuration.IllegalConfigurationException - May be thrown by the StateBackendFactory when creating / configuring the state backend in the factory

IOException - May be thrown by the StateBackendFactory when instantiating the state backend

fromApplicationOrConfigOrDefault

public static StateBackend fromApplicationOrConfigOrDefault(@Nullable
                                                            StateBackend fromApplication,
                                                            org.apache.flink.util.TernaryBoolean isChangelogStateBackendEnableFromApplication,
                                                            org.apache.flink.configuration.Configuration config,
                                                            ClassLoader classLoader,
                                                            @Nullable
                                                            org.slf4j.Logger logger)
                                                     throws org.apache.flink.configuration.IllegalConfigurationException,
                                                            org.apache.flink.util.DynamicCodeLoadingException,
                                                            IOException

This is the state backend loader that loads a DelegatingStateBackend wrapping the state backend loaded from loadFromApplicationOrConfigOrDefaultInternal(org.apache.flink.runtime.state.StateBackend, org.apache.flink.configuration.Configuration, java.lang.ClassLoader, org.slf4j.Logger) when delegation is enabled. If delegation is not enabled, the underlying wrapped state backend is returned instead.

参数:

fromApplication - StateBackend defined from application

isChangelogStateBackendEnableFromApplication - whether to enable the ChangelogStateBackend from application

config - The configuration to load the state backend from

classLoader - The class loader that should be used to load the state backend

logger - Optionally, a logger to log actions to (may be null)

返回:

The instantiated state backend.

抛出:

org.apache.flink.util.DynamicCodeLoadingException - Thrown if a state backend (factory) is configured and the (factory) class was not found or could not be instantiated

org.apache.flink.configuration.IllegalConfigurationException - May be thrown by the StateBackendFactory when creating / configuring the state backend in the factory

IOException - May be thrown by the StateBackendFactory when instantiating the state backend

stateBackendFromApplicationOrConfigOrDefaultUseManagedMemory

public static boolean stateBackendFromApplicationOrConfigOrDefaultUseManagedMemory(org.apache.flink.configuration.Configuration config,
                                                                                   Optional<Boolean> stateBackendFromApplicationUsesManagedMemory,
                                                                                   ClassLoader classLoader)

Checks whether state backend uses managed memory, without having to deserialize or load the state backend.

参数:

config - Cluster configuration.

stateBackendFromApplicationUsesManagedMemory - Whether the application-defined backend uses Flink's managed memory. Empty if application has not defined a backend.

classLoader - User code classloader.

返回:

Whether the state backend uses managed memory.