io.ray.streaming.state.backend

Class AbstractKeyStateBackend

java.lang.Object

io.ray.streaming.state.backend.AbstractKeyStateBackend

All Implemented Interfaces:

StateStoreManager

Direct Known Subclasses:

KeyStateBackend, OperatorStateBackend

public abstract class AbstractKeyStateBackend
extends Object
implements StateStoreManager

Transaction support primitive operations like finish, commit, ackcommit and rollback.

State value modification is not thread safe! By default, every processing thread has its own space to handle state.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,KeyValueStore<String,Map<Long,byte[]>>>	backStorageCache tablename, KeyValueStore key, checkpointId, content
protected long	currentCheckpointId
protected Object	currentKey
protected Set<String>	descNamespace
protected int	keyGroupIndex
protected Map<String,ListStateStoreManagerProxy>	listManagerProxyHashMap
protected Map<String,MapStateStoreManagerProxy>	mapManagerProxyHashMap
protected Map<String,ValueStateStoreManagerProxy>	valueManagerProxyHashMap

Constructor Summary

Constructors

Constructor and Description
AbstractKeyStateBackend(AbstractStateBackend backend)

Method Summary

Modifier and Type	Method and Description
void	ackCommit(long checkpointId, long timeStamp) The ackCommit method is used for cleaning the last checkpoint, and must be called after commit in the same thread.
void	commit(long checkpointId) The commit method is used for persistent, and can be used in another thread to reach async state commit.
void	finish(long checkpointId) The finish method is used when the batched data is all saved in state.
<K,T> T	get(AbstractStateDescriptor descriptor, K key)
AbstractStateBackend	getBackend()
BackendType	getBackendType()
KeyValueStore<String,Map<Long,byte[]>>	getBackStorage(AbstractStateDescriptor stateDescriptor)
KeyValueStore<String,Map<Long,byte[]>>	getBackStorage(String tableName)
long	getCheckpointId()
Object	getCurrentKey()
int	getKeyGroupIndex()
StateStrategy	getStateStrategy()
<K,T> void	put(AbstractStateDescriptor descriptor, K key, T value)
void	rollBack(long checkpointId) The rollback method is used for recovering the checkpoint.
void	setCheckpointId(long checkpointId)
void	setContext(long checkpointId, Object currentKey)
abstract void	setCurrentKey(Object currentKey)
void	setKeyGroupIndex(int keyGroupIndex)

Methods inherited from class java.lang.Object

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

Field Detail

currentCheckpointId

protected long currentCheckpointId

currentKey

protected Object currentKey

keyGroupIndex

protected int keyGroupIndex

valueManagerProxyHashMap

protected Map<String,ValueStateStoreManagerProxy> valueManagerProxyHashMap

listManagerProxyHashMap

protected Map<String,ListStateStoreManagerProxy> listManagerProxyHashMap

mapManagerProxyHashMap

protected Map<String,MapStateStoreManagerProxy> mapManagerProxyHashMap

descNamespace

protected Set<String> descNamespace

backStorageCache

protected Map<String,KeyValueStore<String,Map<Long,byte[]>>> backStorageCache

tablename, KeyValueStore key, checkpointId, content

Constructor Detail

AbstractKeyStateBackend

public AbstractKeyStateBackend(AbstractStateBackend backend)

Method Detail

put

public <K,T> void put(AbstractStateDescriptor descriptor,
                      K key,
                      T value)

get

public <K,T> T get(AbstractStateDescriptor descriptor,
                   K key)

finish

public void finish(long checkpointId)

Description copied from interface: StateStoreManager

The finish method is used when the batched data is all saved in state. Normally, serialization job is done here.

Specified by:

finish in interface StateStoreManager

commit

public void commit(long checkpointId)

Description copied from interface: StateStoreManager

The commit method is used for persistent, and can be used in another thread to reach async state commit. Normally, data persistent is done here.

Specified by:

commit in interface StateStoreManager

ackCommit

public void ackCommit(long checkpointId,
                      long timeStamp)

Description copied from interface: StateStoreManager

The ackCommit method is used for cleaning the last checkpoint, and must be called after commit in the same thread.

Specified by:

ackCommit in interface StateStoreManager

rollBack

public void rollBack(long checkpointId)

Description copied from interface: StateStoreManager

The rollback method is used for recovering the checkpoint.

Specified by:

rollBack in interface StateStoreManager

getBackStorage

public KeyValueStore<String,Map<Long,byte[]>> getBackStorage(String tableName)

getBackStorage

public KeyValueStore<String,Map<Long,byte[]>> getBackStorage(AbstractStateDescriptor stateDescriptor)

getStateStrategy

public StateStrategy getStateStrategy()

getBackendType

public BackendType getBackendType()

getCurrentKey

public Object getCurrentKey()

setCurrentKey

public abstract void setCurrentKey(Object currentKey)

getCheckpointId

public long getCheckpointId()

setCheckpointId

public void setCheckpointId(long checkpointId)

setContext

public void setContext(long checkpointId,
                       Object currentKey)

getBackend

public AbstractStateBackend getBackend()

getKeyGroupIndex

public int getKeyGroupIndex()

setKeyGroupIndex

public void setKeyGroupIndex(int keyGroupIndex)