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,V>,V>

java.lang.Object

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

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<N>

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,V>,V>
extends Object
implements org.apache.flink.runtime.state.KvState<N>, 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 org.apache.flink.core.memory.DataOutputView	keySerializationDataOutputView
protected org.apache.flink.core.memory.ByteArrayOutputStreamWithPos	keySerializationStream
protected SD	stateDesc State descriptor from which to create this state instance

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	clear()
byte[]	getSerializedValue(byte[] serializedKeyAndNamespace)
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)

Methods inherited from class java.lang.Object

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

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

stateDesc

protected final SD extends org.apache.flink.api.common.state.StateDescriptor<S,V> stateDesc

State descriptor from which to create this state instance

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,
                    SD stateDesc,
                    RocksDBKeyedStateBackend<K> 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

setCurrentNamespace

public void setCurrentNamespace(N namespace)

Specified by:

setCurrentNamespace in interface org.apache.flink.runtime.state.KvState<N>

getSerializedValue

public byte[] getSerializedValue(byte[] serializedKeyAndNamespace)
                          throws Exception

Specified by:

getSerializedValue in interface org.apache.flink.runtime.state.KvState<N>

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