org.apache.flink.contrib.streaming.state

Class RocksDBMapState<K,N,UK,UV>

java.lang.Object

org.apache.flink.contrib.streaming.state.AbstractRocksDBState<K,N,Map<UK,UV>,MapState<UK,UV>>

org.apache.flink.contrib.streaming.state.RocksDBMapState<K,N,UK,UV>

Type Parameters:

K - The type of the key.

N - The type of the namespace.

UK - The type of the keys in the map state.

UV - The type of the values in the map state.

All Implemented Interfaces:

MapState<UK,UV>, State, InternalKvState<K,N,Map<UK,UV>>, InternalMapState<K,N,UK,UV>

public class RocksDBMapState<K,N,UK,UV>
extends AbstractRocksDBState<K,N,Map<UK,UV>,MapState<UK,UV>>
implements InternalMapState<K,N,UK,UV>

MapState 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
RocksDBMapState(org.rocksdb.ColumnFamilyHandle columnFamily, TypeSerializer<N> namespaceSerializer, TypeSerializer<Map<UK,UV>> valueSerializer, Map<UK,UV> defaultValue, RocksDBKeyedStateBackend<K> backend) Creates a new RocksDBMapState.

Method Summary

Modifier and Type	Method and Description
void	clear() Removes the value mapped under the current key.
boolean	contains(UK userKey) Returns whether there exists the given mapping.
Iterable<Map.Entry<UK,UV>>	entries() Returns all the mappings in the state.
UV	get(UK userKey) Returns the current value associated with the given key.
TypeSerializer<K>	getKeySerializer() Returns the TypeSerializer for the type of key this state is associated to.
TypeSerializer<N>	getNamespaceSerializer() Returns the TypeSerializer for the type of namespace this state is associated to.
byte[]	getSerializedValue(byte[] serializedKeyAndNamespace, TypeSerializer<K> safeKeySerializer, TypeSerializer<N> safeNamespaceSerializer, TypeSerializer<Map<UK,UV>> safeValueSerializer) Returns the serialized value for the given key and namespace.
TypeSerializer<Map<UK,UV>>	getValueSerializer() Returns the TypeSerializer for the type of value this state holds.
Iterator<Map.Entry<UK,UV>>	iterator() Iterates over all the mappings in the state.
Iterable<UK>	keys() Returns all the keys in the state.
void	put(UK userKey, UV userValue) Associates a new value with the given key.
void	putAll(Map<UK,UV> map) Copies all of the mappings from the given map into the state.
void	remove(UK userKey) Deletes the mapping of the given key.
Iterable<UV>	values() Returns all the values in the state.

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

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

setCurrentNamespace

Constructor Detail

RocksDBMapState

public RocksDBMapState(org.rocksdb.ColumnFamilyHandle columnFamily,
                       TypeSerializer<N> namespaceSerializer,
                       TypeSerializer<Map<UK,UV>> valueSerializer,
                       Map<UK,UV> defaultValue,
                       RocksDBKeyedStateBackend<K> backend)

Creates a new RocksDBMapState.

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

getKeySerializer

public TypeSerializer<K> getKeySerializer()

Description copied from interface: InternalKvState

Returns the TypeSerializer for the type of key this state is associated to.

Specified by:

getKeySerializer in interface InternalKvState<K,N,Map<UK,UV>>

getNamespaceSerializer

public TypeSerializer<N> getNamespaceSerializer()

Description copied from interface: InternalKvState

Returns the TypeSerializer for the type of namespace this state is associated to.

Specified by:

getNamespaceSerializer in interface InternalKvState<K,N,Map<UK,UV>>

getValueSerializer

public TypeSerializer<Map<UK,UV>> getValueSerializer()

Description copied from interface: InternalKvState

Returns the TypeSerializer for the type of value this state holds.

Specified by:

getValueSerializer in interface InternalKvState<K,N,Map<UK,UV>>

get

public UV get(UK userKey)
       throws IOException,
              org.rocksdb.RocksDBException

Description copied from interface: MapState

Returns the current value associated with the given key.

Specified by:

get in interface MapState<UK,UV>

Parameters:

userKey - The key of the mapping

Returns:

The value of the mapping with the given key

Throws:

IOException

org.rocksdb.RocksDBException

put

public void put(UK userKey,
                UV userValue)
         throws IOException,
                org.rocksdb.RocksDBException

Description copied from interface: MapState

Associates a new value with the given key.

Specified by:

put in interface MapState<UK,UV>

Parameters:

userKey - The key of the mapping

userValue - The new value of the mapping

Throws:

IOException

org.rocksdb.RocksDBException

putAll

public void putAll(Map<UK,UV> map)
            throws IOException,
                   org.rocksdb.RocksDBException

Description copied from interface: MapState

Copies all of the mappings from the given map into the state.

Specified by:

putAll in interface MapState<UK,UV>

Parameters:

map - The mappings to be stored in this state

Throws:

IOException

org.rocksdb.RocksDBException

remove

public void remove(UK userKey)
            throws IOException,
                   org.rocksdb.RocksDBException

Description copied from interface: MapState

Deletes the mapping of the given key.

Specified by:

remove in interface MapState<UK,UV>

Parameters:

userKey - The key of the mapping

Throws:

IOException

org.rocksdb.RocksDBException

contains

public boolean contains(UK userKey)
                 throws IOException,
                        org.rocksdb.RocksDBException

Description copied from interface: MapState

Returns whether there exists the given mapping.

Specified by:

contains in interface MapState<UK,UV>

Parameters:

userKey - The key of the mapping

Returns:

True if there exists a mapping whose key equals to the given key

Throws:

IOException

org.rocksdb.RocksDBException

entries

public Iterable<Map.Entry<UK,UV>> entries()
                                   throws IOException,
                                          org.rocksdb.RocksDBException

Description copied from interface: MapState

Returns all the mappings in the state.

Specified by:

entries in interface MapState<UK,UV>

Returns:

An iterable view of all the key-value pairs in the state.

Throws:

IOException

org.rocksdb.RocksDBException

keys

public Iterable<UK> keys()
                  throws IOException,
                         org.rocksdb.RocksDBException

Description copied from interface: MapState

Returns all the keys in the state.

Specified by:

keys in interface MapState<UK,UV>

Returns:

An iterable view of all the keys in the state.

Throws:

IOException

org.rocksdb.RocksDBException

values

public Iterable<UV> values()
                    throws IOException,
                           org.rocksdb.RocksDBException

Description copied from interface: MapState

Returns all the values in the state.

Specified by:

values in interface MapState<UK,UV>

Returns:

An iterable view of all the values in the state.

Throws:

IOException

org.rocksdb.RocksDBException

iterator

public Iterator<Map.Entry<UK,UV>> iterator()
                                    throws IOException,
                                           org.rocksdb.RocksDBException

Description copied from interface: MapState

Iterates over all the mappings in the state.

Specified by:

iterator in interface MapState<UK,UV>

Returns:

An iterator over all the mappings in the state

Throws:

IOException

org.rocksdb.RocksDBException

clear

public void clear()

Description copied from interface: State

Removes the value mapped under the current key.

Specified by:

clear in interface State

Overrides:

clear in class AbstractRocksDBState<K,N,Map<UK,UV>,MapState<UK,UV>>

getSerializedValue

public byte[] getSerializedValue(byte[] serializedKeyAndNamespace,
                                 TypeSerializer<K> safeKeySerializer,
                                 TypeSerializer<N> safeNamespaceSerializer,
                                 TypeSerializer<Map<UK,UV>> safeValueSerializer)
                          throws Exception

Description copied from interface: InternalKvState

Returns the serialized value for the given key and namespace.

If no value is associated with key and namespace, null is returned.

TO IMPLEMENTERS: This method is called by multiple threads. Anything stateful (e.g. serializers) should be either duplicated or protected from undesired consequences of concurrent invocations.

Specified by:

getSerializedValue in interface InternalKvState<K,N,Map<UK,UV>>

Overrides:

getSerializedValue in class AbstractRocksDBState<K,N,Map<UK,UV>,MapState<UK,UV>>

Parameters:

serializedKeyAndNamespace - Serialized key and namespace

safeKeySerializer - A key serializer which is safe to be used even in multi-threaded context

safeNamespaceSerializer - A namespace serializer which is safe to be used even in multi-threaded context

safeValueSerializer - A value serializer which is safe to be used even in multi-threaded context

Returns:

Serialized value or null if no value is associated with the key and namespace.

Throws:

Exception - Exceptions during serialization are forwarded