org.apache.flink.contrib.streaming.state

Class AbstractRocksDBState<K,N,S extends org.apache.flink.api.common.state.State,SD extends org.apache.flink.api.common.state.StateDescriptor<S,?>>

java.lang.Object

org.apache.flink.contrib.streaming.state.AbstractRocksDBState<K,N,S,SD>

Type Parameters:

K - The type of the key.

N - The type of the namespace.

S - The type of State.

SD - The type of StateDescriptor.

All Implemented Interfaces:

org.apache.flink.api.common.state.State, org.apache.flink.runtime.state.KvState<K,N,S,SD,RocksDBStateBackend>

Direct Known Subclasses:

RocksDBFoldingState, RocksDBListState, RocksDBReducingState, RocksDBValueState

public abstract class AbstractRocksDBState<K,N,S extends org.apache.flink.api.common.state.State,SD extends org.apache.flink.api.common.state.StateDescriptor<S,?>>
extends Object
implements org.apache.flink.runtime.state.KvState<K,N,S,SD,RocksDBStateBackend>, org.apache.flink.api.common.state.State

Base class for State implementations that store state in a RocksDB database.

State is not stored in this class but in the RocksDB instance that the RocksDBStateBackend manages and checkpoints.

Field Summary

Fields

Modifier and Type	Field and Description
protected RocksDBStateBackend	backend Backend that holds the actual RocksDB instance where we store state
protected org.rocksdb.ColumnFamilyHandle	columnFamily The column family of this particular instance of state

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRocksDBState(org.rocksdb.ColumnFamilyHandle columnFamily, org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer, RocksDBStateBackend backend) Creates a new RocksDB backed state.

Method Summary

Modifier and Type	Method and Description
void	clear()
void	dispose()
void	setCurrentKey(K key)
void	setCurrentNamespace(N namespace)
org.apache.flink.runtime.state.KvStateSnapshot<K,N,S,SD,RocksDBStateBackend>	snapshot(long checkpointId, long timestamp)
protected void	writeKeyAndNamespace(org.apache.flink.core.memory.DataOutputView out)

Methods inherited from class java.lang.Object

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

Field Detail

backend

protected RocksDBStateBackend backend

Backend that holds the actual RocksDB instance where we store state

columnFamily

protected org.rocksdb.ColumnFamilyHandle columnFamily

The column family of this particular instance of state

Constructor Detail

AbstractRocksDBState

protected AbstractRocksDBState(org.rocksdb.ColumnFamilyHandle columnFamily,
                               org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer,
                               RocksDBStateBackend backend)

Creates a new RocksDB backed state.

Parameters:

namespaceSerializer - The serializer for the namespace.

Method Detail

clear

public void clear()

Specified by:

clear in interface org.apache.flink.api.common.state.State

writeKeyAndNamespace

protected void writeKeyAndNamespace(org.apache.flink.core.memory.DataOutputView out)
                             throws IOException

Throws:

IOException

setCurrentNamespace

public void setCurrentNamespace(N namespace)

Specified by:

setCurrentNamespace in interface org.apache.flink.runtime.state.KvState<K,N,S extends org.apache.flink.api.common.state.State,SD extends org.apache.flink.api.common.state.StateDescriptor<S,?>,RocksDBStateBackend>

dispose

public void dispose()

Specified by:

dispose in interface org.apache.flink.runtime.state.KvState<K,N,S extends org.apache.flink.api.common.state.State,SD extends org.apache.flink.api.common.state.StateDescriptor<S,?>,RocksDBStateBackend>

setCurrentKey

public void setCurrentKey(K key)

Specified by:

setCurrentKey in interface org.apache.flink.runtime.state.KvState<K,N,S extends org.apache.flink.api.common.state.State,SD extends org.apache.flink.api.common.state.StateDescriptor<S,?>,RocksDBStateBackend>

snapshot

public org.apache.flink.runtime.state.KvStateSnapshot<K,N,S,SD,RocksDBStateBackend> snapshot(long checkpointId,
                                                                                             long timestamp)
                                                                                      throws Exception

Specified by:

snapshot in interface org.apache.flink.runtime.state.KvState<K,N,S extends org.apache.flink.api.common.state.State,SD extends org.apache.flink.api.common.state.StateDescriptor<S,?>,RocksDBStateBackend>

Throws:

Exception