org.apache.flink.contrib.streaming.state

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

java.lang.Object

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

Type Parameters:

K - The type of the key.

N - The type of the namespace.

V - The type of values kept internally in state.

S - The type of State.

All Implemented Interfaces:

org.apache.flink.api.common.state.State, org.apache.flink.runtime.state.internal.InternalKvState<K,N,V>

Direct Known Subclasses:

RocksDBAggregatingState, RocksDBFoldingState, RocksDBListState, RocksDBMapState, RocksDBReducingState, RocksDBValueState

public abstract class AbstractRocksDBState<K,N,V,S extends org.apache.flink.api.common.state.State>
extends Object
implements org.apache.flink.runtime.state.internal.InternalKvState<K,N,V>, 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 RocksDBKeyedStateBackend<K>	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.
protected V	defaultValue
protected org.apache.flink.core.memory.DataOutputView	keySerializationDataOutputView
protected org.apache.flink.core.memory.ByteArrayOutputStreamWithPos	keySerializationStream
protected org.rocksdb.WriteOptions	writeOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	clear()
protected V	getDefaultValue()
byte[]	getSerializedValue(byte[] serializedKeyAndNamespace, org.apache.flink.api.common.typeutils.TypeSerializer<K> safeKeySerializer, org.apache.flink.api.common.typeutils.TypeSerializer<N> safeNamespaceSerializer, org.apache.flink.api.common.typeutils.TypeSerializer<V> safeValueSerializer)
void	setCurrentNamespace(N namespace)
protected void	writeCurrentKeyWithGroupAndNamespace()
protected void	writeKeyWithGroupAndNamespace(int keyGroup, K key, N namespace, org.apache.flink.core.memory.ByteArrayOutputStreamWithPos keySerializationStream, org.apache.flink.core.memory.DataOutputView keySerializationDataOutputView)
protected void	writeKeyWithGroupAndNamespace(int keyGroup, K key, org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, N namespace, org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer, org.apache.flink.core.memory.ByteArrayOutputStreamWithPos keySerializationStream, org.apache.flink.core.memory.DataOutputView keySerializationDataOutputView)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.runtime.state.internal.InternalKvState

getKeySerializer, getNamespaceSerializer, getValueSerializer

Field Detail

backend

protected RocksDBKeyedStateBackend<K> 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.

defaultValue

protected final V defaultValue

writeOptions

protected final org.rocksdb.WriteOptions writeOptions

keySerializationStream

protected final org.apache.flink.core.memory.ByteArrayOutputStreamWithPos keySerializationStream

keySerializationDataOutputView

protected final org.apache.flink.core.memory.DataOutputView keySerializationDataOutputView

Constructor Detail

AbstractRocksDBState

protected AbstractRocksDBState(org.rocksdb.ColumnFamilyHandle columnFamily,
                               org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer,
                               org.apache.flink.api.common.typeutils.TypeSerializer<V> valueSerializer,
                               V defaultValue,
                               RocksDBKeyedStateBackend<K> backend)

Creates a new RocksDB backed state.

Parameters:

columnFamily - The RocksDB column family that this state is associated to.

namespaceSerializer - The serializer for the namespace.

valueSerializer - The serializer for the state.

defaultValue - The default value for the state.

backend - The backend for which this state is bind to.

Method Detail

clear

public void clear()

Specified by:

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

setCurrentNamespace

public void setCurrentNamespace(N namespace)

Specified by:

setCurrentNamespace in interface org.apache.flink.runtime.state.internal.InternalKvState<K,N,V>

getSerializedValue

public byte[] getSerializedValue(byte[] serializedKeyAndNamespace,
                                 org.apache.flink.api.common.typeutils.TypeSerializer<K> safeKeySerializer,
                                 org.apache.flink.api.common.typeutils.TypeSerializer<N> safeNamespaceSerializer,
                                 org.apache.flink.api.common.typeutils.TypeSerializer<V> safeValueSerializer)
                          throws Exception

Specified by:

getSerializedValue in interface org.apache.flink.runtime.state.internal.InternalKvState<K,N,V>

Throws:

Exception

writeCurrentKeyWithGroupAndNamespace

protected void writeCurrentKeyWithGroupAndNamespace()
                                             throws IOException

Throws:

IOException

writeKeyWithGroupAndNamespace

protected void writeKeyWithGroupAndNamespace(int keyGroup,
                                             K key,
                                             N namespace,
                                             org.apache.flink.core.memory.ByteArrayOutputStreamWithPos keySerializationStream,
                                             org.apache.flink.core.memory.DataOutputView keySerializationDataOutputView)
                                      throws IOException

Throws:

IOException

writeKeyWithGroupAndNamespace

protected void writeKeyWithGroupAndNamespace(int keyGroup,
                                             K key,
                                             org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer,
                                             N namespace,
                                             org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer,
                                             org.apache.flink.core.memory.ByteArrayOutputStreamWithPos keySerializationStream,
                                             org.apache.flink.core.memory.DataOutputView keySerializationDataOutputView)
                                      throws IOException

Throws:

IOException

getDefaultValue

protected V getDefaultValue()