org.apache.flink.runtime.state.StateBackend Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.flink.runtime.state;
import org.apache.flink.annotation.PublicEvolving;
import org.apache.flink.api.common.JobID;
import org.apache.flink.api.common.typeutils.TypeSerializer;
import org.apache.flink.core.execution.SavepointFormatType;
import org.apache.flink.core.fs.CloseableRegistry;
import org.apache.flink.metrics.MetricGroup;
import org.apache.flink.runtime.checkpoint.CheckpointOptions;
import org.apache.flink.runtime.checkpoint.CheckpointType;
import org.apache.flink.runtime.execution.Environment;
import org.apache.flink.runtime.jobgraph.RestoreMode;
import org.apache.flink.runtime.query.TaskKvStateRegistry;
import org.apache.flink.runtime.state.ttl.TtlTimeProvider;
import javax.annotation.Nonnull;
import java.util.Collection;
/**
* A State Backend defines how the state of a streaming application is stored locally within
* the cluster. Different State Backends store their state in different fashions, and use different
* data structures to hold the state of a running application.
*
* For example, the {@link org.apache.flink.runtime.state.hashmap.HashMapStateBackend hashmap
* state backend} keeps working state in the memory of the TaskManager. The backend is lightweight
* and without additional dependencies.
*
*
The {@code EmbeddedRocksDBStateBackend} stores working state in an embedded RocksDB and is able to scale working state to many terabytes in
* size, only limited by available disk space across all task managers.
*
*
Raw Bytes Storage and Backends
*
* The {@code StateBackend} creates services for for keyed state and operator
* state.
*
*
The {@link CheckpointableKeyedStateBackend} and {@link OperatorStateBackend} created by this
* state backend define how to hold the working state for keys and operators. They also define how
* to checkpoint that state, frequently using the raw bytes storage (via the {@code
* CheckpointStreamFactory}). However, it is also possible that for example a keyed state backend
* simply implements the bridge to a key/value store, and that it does not need to store anything in
* the raw byte storage upon a checkpoint.
*
*
Serializability
*
* State Backends need to be {@link java.io.Serializable serializable}, because they distributed
* across parallel processes (for distributed execution) together with the streaming application
* code.
*
*
Because of that, {@code StateBackend} implementations (typically subclasses of {@link
* AbstractStateBackend}) are meant to be like factories that create the proper states stores
* that provide access to the persistent storage and hold the keyed- and operator state data
* structures. That way, the State Backend can be very lightweight (contain only configurations)
* which makes it easier to be serializable.
*
*
Thread Safety
*
* State backend implementations have to be thread-safe. Multiple threads may be creating
* keyed-/operator state backends concurrently.
*/
@PublicEvolving
public interface StateBackend extends java.io.Serializable {
/**
* Return the name of this backend, default is simple class name. {@link
* org.apache.flink.runtime.state.delegate.DelegatingStateBackend} may return the simple class
* name of the delegated backend.
*/
default String getName() {
return this.getClass().getSimpleName();
}
/**
* Creates a new {@link CheckpointableKeyedStateBackend} that is responsible for holding
* keyed state and checkpointing it.
*
*
Keyed State is state where each value is bound to a key.
*
* @param env The environment of the task.
* @param jobID The ID of the job that the task belongs to.
* @param operatorIdentifier The identifier text of the operator.
* @param keySerializer The key-serializer for the operator.
* @param numberOfKeyGroups The number of key-groups aka max parallelism.
* @param keyGroupRange Range of key-groups for which the to-be-created backend is responsible.
* @param kvStateRegistry KvStateRegistry helper for this task.
* @param ttlTimeProvider Provider for TTL logic to judge about state expiration.
* @param metricGroup The parent metric group for all state backend metrics.
* @param stateHandles The state handles for restore.
* @param cancelStreamRegistry The registry to which created closeable objects will be
* registered during restore.
* @param The type of the keys by which the state is organized.
* @return The Keyed State Backend for the given job, operator, and key group range.
* @throws Exception This method may forward all exceptions that occur while instantiating the
* backend.
*/
CheckpointableKeyedStateBackend createKeyedStateBackend(
Environment env,
JobID jobID,
String operatorIdentifier,
TypeSerializer keySerializer,
int numberOfKeyGroups,
KeyGroupRange keyGroupRange,
TaskKvStateRegistry kvStateRegistry,
TtlTimeProvider ttlTimeProvider,
MetricGroup metricGroup,
@Nonnull Collection stateHandles,
CloseableRegistry cancelStreamRegistry)
throws Exception;
/**
* Creates a new {@link CheckpointableKeyedStateBackend} with the given managed memory fraction.
* Backends that use managed memory are required to implement this interface.
*/
default CheckpointableKeyedStateBackend createKeyedStateBackend(
Environment env,
JobID jobID,
String operatorIdentifier,
TypeSerializer keySerializer,
int numberOfKeyGroups,
KeyGroupRange keyGroupRange,
TaskKvStateRegistry kvStateRegistry,
TtlTimeProvider ttlTimeProvider,
MetricGroup metricGroup,
@Nonnull Collection stateHandles,
CloseableRegistry cancelStreamRegistry,
double managedMemoryFraction)
throws Exception {
// ignore managed memory fraction by default
return createKeyedStateBackend(
env,
jobID,
operatorIdentifier,
keySerializer,
numberOfKeyGroups,
keyGroupRange,
kvStateRegistry,
ttlTimeProvider,
metricGroup,
stateHandles,
cancelStreamRegistry);
}
/**
* Creates a new {@link OperatorStateBackend} that can be used for storing operator state.
*
* Operator state is state that is associated with parallel operator (or function) instances,
* rather than with keys.
*
* @param env The runtime environment of the executing task.
* @param operatorIdentifier The identifier of the operator whose state should be stored.
* @param stateHandles The state handles for restore.
* @param cancelStreamRegistry The registry to register streams to close if task canceled.
* @return The OperatorStateBackend for operator identified by the job and operator identifier.
* @throws Exception This method may forward all exceptions that occur while instantiating the
* backend.
*/
OperatorStateBackend createOperatorStateBackend(
Environment env,
String operatorIdentifier,
@Nonnull Collection stateHandles,
CloseableRegistry cancelStreamRegistry)
throws Exception;
/** Whether the state backend uses Flink's managed memory. */
default boolean useManagedMemory() {
return false;
}
/**
* Tells if a state backend supports the {@link RestoreMode#NO_CLAIM} mode.
*
* If a state backend supports {@code NO_CLAIM} mode, it should create an independent
* snapshot when it receives {@link CheckpointType#FULL_CHECKPOINT} in {@link
* Snapshotable#snapshot(long, long, CheckpointStreamFactory, CheckpointOptions)}.
*
* @return If the state backend supports {@link RestoreMode#NO_CLAIM} mode.
*/
default boolean supportsNoClaimRestoreMode() {
return false;
}
default boolean supportsSavepointFormat(SavepointFormatType formatType) {
return formatType == SavepointFormatType.CANONICAL;
}
}