org.apache.flink.contrib.streaming.state

Class RocksDBListState<K,N,V>

java.lang.Object

org.apache.flink.contrib.streaming.state.AbstractRocksDBState<K,N,List<V>,org.apache.flink.api.common.state.ListState<V>>

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

Type Parameters:

K - The type of the key.

N - The type of the namespace.

V - The type of the values in the list state.

All Implemented Interfaces:

org.apache.flink.api.common.state.AppendingState<V,Iterable<V>>, org.apache.flink.api.common.state.ListState<V>, org.apache.flink.api.common.state.MergingState<V,Iterable<V>>, org.apache.flink.api.common.state.State, org.apache.flink.runtime.state.internal.InternalAppendingState<K,N,V,List<V>,Iterable<V>>, org.apache.flink.runtime.state.internal.InternalKvState<K,N,List<V>>, org.apache.flink.runtime.state.internal.InternalListState<K,N,V>, org.apache.flink.runtime.state.internal.InternalMergingState<K,N,V,List<V>,Iterable<V>>

public class RocksDBListState<K,N,V>
extends AbstractRocksDBState<K,N,List<V>,org.apache.flink.api.common.state.ListState<V>>
implements org.apache.flink.runtime.state.internal.InternalListState<K,N,V>

ListState implementation that stores state in RocksDB.

RocksDBStateBackend must ensure that we set the StringAppendOperator on the column family that we use for our state since we use the merge() call.

Field Summary

Fields inherited from class org.apache.flink.contrib.streaming.state.AbstractRocksDBState

backend, columnFamily, defaultValue, keySerializationDataOutputView, keySerializationStream, writeOptions

Constructor Summary

Constructors

Constructor and Description
RocksDBListState(org.rocksdb.ColumnFamilyHandle columnFamily, org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer, org.apache.flink.api.common.typeutils.TypeSerializer<List<V>> valueSerializer, List<V> defaultValue, org.apache.flink.api.common.typeutils.TypeSerializer<V> elementSerializer, RocksDBKeyedStateBackend<K> backend) Creates a new RocksDBListState.

Method Summary

Modifier and Type	Method and Description
void	add(V value)
void	addAll(List<V> values)
Iterable<V>	get()
org.apache.flink.api.common.typeutils.TypeSerializer<K>	getKeySerializer()
org.apache.flink.api.common.typeutils.TypeSerializer<N>	getNamespaceSerializer()
org.apache.flink.api.common.typeutils.TypeSerializer<List<V>>	getValueSerializer()
void	mergeNamespaces(N target, Collection<N> sources)
void	update(List<V> values)

Methods inherited from class org.apache.flink.contrib.streaming.state.AbstractRocksDBState

clear, getDefaultValue, getSerializedValue, setCurrentNamespace, writeCurrentKeyWithGroupAndNamespace, writeKeyWithGroupAndNamespace, writeKeyWithGroupAndNamespace

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

getSerializedValue, setCurrentNamespace

Methods inherited from interface org.apache.flink.api.common.state.State

clear

Constructor Detail

RocksDBListState

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

Creates a new RocksDBListState.

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.

elementSerializer - The serializer for elements of the list state.

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

Method Detail

getKeySerializer

public org.apache.flink.api.common.typeutils.TypeSerializer<K> getKeySerializer()

Specified by:

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

getNamespaceSerializer

public org.apache.flink.api.common.typeutils.TypeSerializer<N> getNamespaceSerializer()

Specified by:

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

getValueSerializer

public org.apache.flink.api.common.typeutils.TypeSerializer<List<V>> getValueSerializer()

Specified by:

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

get

public Iterable<V> get()

Specified by:

get in interface org.apache.flink.api.common.state.AppendingState<V,Iterable<V>>

add

public void add(V value)
         throws IOException

Specified by:

add in interface org.apache.flink.api.common.state.AppendingState<V,Iterable<V>>

Throws:

IOException

mergeNamespaces

public void mergeNamespaces(N target,
                            Collection<N> sources)
                     throws Exception

Specified by:

mergeNamespaces in interface org.apache.flink.runtime.state.internal.InternalMergingState<K,N,V,List<V>,Iterable<V>>

Throws:

Exception

update

public void update(List<V> values)
            throws Exception

Specified by:

update in interface org.apache.flink.api.common.state.ListState<V>

Specified by:

update in interface org.apache.flink.runtime.state.internal.InternalListState<K,N,V>

Throws:

Exception

addAll

public void addAll(List<V> values)
            throws Exception

Specified by:

addAll in interface org.apache.flink.api.common.state.ListState<V>

Specified by:

addAll in interface org.apache.flink.runtime.state.internal.InternalListState<K,N,V>

Throws:

Exception