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>,org.apache.flink.api.common.state.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:

org.apache.flink.api.common.state.MapState<UK,UV>, org.apache.flink.api.common.state.State, org.apache.flink.runtime.state.internal.InternalKvState<K,N,Map<UK,UV>>, org.apache.flink.runtime.state.internal.InternalMapState<K,N,UK,UV>

public class RocksDBMapState<K,N,UK,UV>
extends AbstractRocksDBState<K,N,Map<UK,UV>,org.apache.flink.api.common.state.MapState<UK,UV>>
implements org.apache.flink.runtime.state.internal.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, org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer, org.apache.flink.api.common.typeutils.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()
boolean	contains(UK userKey)
Iterable<Map.Entry<UK,UV>>	entries()
UV	get(UK userKey)
org.apache.flink.api.common.typeutils.TypeSerializer<K>	getKeySerializer()
org.apache.flink.api.common.typeutils.TypeSerializer<N>	getNamespaceSerializer()
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<Map<UK,UV>> safeValueSerializer)
org.apache.flink.api.common.typeutils.TypeSerializer<Map<UK,UV>>	getValueSerializer()
Iterator<Map.Entry<UK,UV>>	iterator()
Iterable<UK>	keys()
void	put(UK userKey, UV userValue)
void	putAll(Map<UK,UV> map)
void	remove(UK userKey)
Iterable<UV>	values()

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,
                       org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer,
                       org.apache.flink.api.common.typeutils.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 org.apache.flink.api.common.typeutils.TypeSerializer<K> getKeySerializer()

Specified by:

getKeySerializer in interface org.apache.flink.runtime.state.internal.InternalKvState<K,N,Map<UK,UV>>

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,Map<UK,UV>>

getValueSerializer

public org.apache.flink.api.common.typeutils.TypeSerializer<Map<UK,UV>> getValueSerializer()

Specified by:

getValueSerializer in interface org.apache.flink.runtime.state.internal.InternalKvState<K,N,Map<UK,UV>>

get

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

Specified by:

get in interface org.apache.flink.api.common.state.MapState<UK,UV>

Throws:

IOException

org.rocksdb.RocksDBException

put

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

Specified by:

put in interface org.apache.flink.api.common.state.MapState<UK,UV>

Throws:

IOException

org.rocksdb.RocksDBException

putAll

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

Specified by:

putAll in interface org.apache.flink.api.common.state.MapState<UK,UV>

Throws:

IOException

org.rocksdb.RocksDBException

remove

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

Specified by:

remove in interface org.apache.flink.api.common.state.MapState<UK,UV>

Throws:

IOException

org.rocksdb.RocksDBException

contains

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

Specified by:

contains in interface org.apache.flink.api.common.state.MapState<UK,UV>

Throws:

IOException

org.rocksdb.RocksDBException

entries

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

Specified by:

entries in interface org.apache.flink.api.common.state.MapState<UK,UV>

Throws:

IOException

org.rocksdb.RocksDBException

keys

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

Specified by:

keys in interface org.apache.flink.api.common.state.MapState<UK,UV>

Throws:

IOException

org.rocksdb.RocksDBException

values

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

Specified by:

values in interface org.apache.flink.api.common.state.MapState<UK,UV>

Throws:

IOException

org.rocksdb.RocksDBException

iterator

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

Specified by:

iterator in interface org.apache.flink.api.common.state.MapState<UK,UV>

Throws:

IOException

org.rocksdb.RocksDBException

clear

public void clear()

Specified by:

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

Overrides:

clear in class AbstractRocksDBState<K,N,Map<UK,UV>,org.apache.flink.api.common.state.MapState<UK,UV>>

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<Map<UK,UV>> safeValueSerializer)
                          throws Exception

Specified by:

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

Overrides:

getSerializedValue in class AbstractRocksDBState<K,N,Map<UK,UV>,org.apache.flink.api.common.state.MapState<UK,UV>>

Throws:

Exception