Package org.apache.flink.configuration

Class CheckpointingOptions

  • public class CheckpointingOptions
extends Object
    A collection of all configuration options that relate to checkpoints and savepoints.

    • Field Detail

      • STATE_BACKEND

        @Deprecated
public static final ConfigOption<String> STATE_BACKEND
        Deprecated.
        Use StateBackendOptions.STATE_BACKEND.
        The checkpoint storage used to store operator state locally within the cluster during execution.

        The implementation 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 'hashmap' and 'rocksdb'.

      • CHECKPOINT_STORAGE

        public static final ConfigOption<String> CHECKPOINT_STORAGE
        The checkpoint storage used to checkpoint state for recovery.

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

        Recognized shortcut names are 'jobmanager' and 'filesystem'.

      • MAX_RETAINED_CHECKPOINTS

        public static final ConfigOption<Integer> MAX_RETAINED_CHECKPOINTS
        The maximum number of completed checkpoints to retain.

      • INCREMENTAL_CHECKPOINTS

        public static final ConfigOption<Boolean> INCREMENTAL_CHECKPOINTS
        Option whether the state backend should create incremental checkpoints, if possible. For an incremental checkpoint, only a diff from the previous checkpoint is stored, rather than the complete checkpoint state.

        Once enabled, the state size shown in web UI or fetched from rest API only represents the delta checkpoint size instead of full checkpoint size.

        Some state backends may not support incremental checkpoints and ignore this option.

      • LOCAL_RECOVERY

        public static final ConfigOption<Boolean> LOCAL_RECOVERY
        This option configures local recovery for this state backend. By default, local recovery is deactivated.

        Local recovery currently only covers keyed state backends (including both the EmbeddedRocksDBStateBackend and the HashMapStateBackend).

      • LOCAL_RECOVERY_TASK_MANAGER_STATE_ROOT_DIRS

        public static final ConfigOption<String> LOCAL_RECOVERY_TASK_MANAGER_STATE_ROOT_DIRS
        The config parameter defining the root directories for storing file-based state for local recovery.

        Local recovery currently only covers keyed state backends. Currently, MemoryStateBackend does not support local recovery and ignore this option.

      • SAVEPOINT_DIRECTORY

        public static final ConfigOption<String> SAVEPOINT_DIRECTORY
        The default directory for savepoints. Used by the state backends that write savepoints to file systems (HashMapStateBackend, EmbeddedRocksDBStateBackend).

      • CHECKPOINTS_DIRECTORY

        public static final ConfigOption<String> CHECKPOINTS_DIRECTORY
        The default directory used for storing the data files and meta data of checkpoints in a Flink supported filesystem. The storage path must be accessible from all participating processes/nodes(i.e. all TaskManagers and JobManagers).

      • CREATE_CHECKPOINT_SUB_DIR

        public static final ConfigOption<Boolean> CREATE_CHECKPOINT_SUB_DIR
        Whether to create sub-directories named by job id to store the data files and meta data of checkpoints. The default value is true to enable user could run several jobs with the same checkpoint directory at the same time. If this value is set to false, pay attention not to run several jobs with the same directory simultaneously.

      • FS_SMALL_FILE_THRESHOLD

        public static final ConfigOption<MemorySize> FS_SMALL_FILE_THRESHOLD
        The minimum size of state data files. All state chunks smaller than that are stored inline in the root checkpoint metadata file.

      • FS_WRITE_BUFFER_SIZE

        public static final ConfigOption<Integer> FS_WRITE_BUFFER_SIZE
        The default size of the write buffer for the checkpoint streams that write to file systems.

    • Constructor Detail

      • CheckpointingOptions

        public CheckpointingOptions()