Package org.apache.flink.state.forst.sync

Class AbstractForStSyncState<K,N,V>

java.lang.Object
org.apache.flink.state.forst.sync.AbstractForStSyncState<K,N,V>
Type Parameters:
K - The type of the key.
N - The type of the namespace.
V - The type of values kept internally in state.
All Implemented Interfaces:
org.apache.flink.api.common.state.State, org.apache.flink.runtime.state.internal.InternalKvState<K,N,V>
public abstract class AbstractForStSyncState<K,N,V> extends Object implements org.apache.flink.runtime.state.internal.InternalKvState<K,N,V>, 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 ForStStateBackend manages and checkpoints.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.apache.flink.runtime.state.internal.InternalKvState

    org.apache.flink.runtime.state.internal.InternalKvState.StateIncrementalVisitor<K extends Object,N extends Object,V extends Object>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected ForStSyncKeyedStateBackend<K>
    backend
    Backend that holds the actual RocksDB instance where we store state.
    protected org.forstdb.ColumnFamilyHandle
    columnFamily
    The column family of this particular instance of state.
    protected final org.apache.flink.core.memory.DataInputDeserializer
    dataInputView
     
    protected final org.apache.flink.core.memory.DataOutputSerializer
    dataOutputView
     
    protected V
    defaultValue
     
    protected final org.forstdb.WriteOptions
    writeOptions
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    AbstractForStSyncState(org.forstdb.ColumnFamilyHandle columnFamily, org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer, org.apache.flink.api.common.typeutils.TypeSerializer<V> valueSerializer, V defaultValue, ForStSyncKeyedStateBackend<K> backend)
    Creates a new RocksDB backed state.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clear()
     
    protected V
    getDefaultValue()
     
    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<V> safeValueSerializer)
     
    org.apache.flink.runtime.state.internal.InternalKvState.StateIncrementalVisitor<K,N,V>
    getStateIncrementalVisitor(int recommendedMaxNumberOfReturnedRecords)
     
    void
    migrateSerializedValue(org.apache.flink.core.memory.DataInputDeserializer serializedOldValueInput, org.apache.flink.core.memory.DataOutputSerializer serializedMigratedValueOutput, org.apache.flink.api.common.typeutils.TypeSerializer<V> priorSerializer, org.apache.flink.api.common.typeutils.TypeSerializer<V> newSerializer)
     
    void
    setCurrentNamespace(N namespace)
     
    protected AbstractForStSyncState<K,N,V>
    setDefaultValue(V defaultValue)
     
    protected AbstractForStSyncState<K,N,V>
    setNamespaceSerializer(org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer)
     
    protected AbstractForStSyncState<K,N,V>
    setValueSerializer(org.apache.flink.api.common.typeutils.TypeSerializer<V> valueSerializer)
     

    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

    getKeySerializer, getNamespaceSerializer, getValueSerializer

  • Field Details

    • backend

      protected ForStSyncKeyedStateBackend<K> backend
      Backend that holds the actual RocksDB instance where we store state.

    • columnFamily

      protected org.forstdb.ColumnFamilyHandle columnFamily
      The column family of this particular instance of state.

    • defaultValue

      protected V defaultValue

    • writeOptions

      protected final org.forstdb.WriteOptions writeOptions

    • dataOutputView

      protected final org.apache.flink.core.memory.DataOutputSerializer dataOutputView

    • dataInputView

      protected final org.apache.flink.core.memory.DataInputDeserializer dataInputView

  • Constructor Details

    • AbstractForStSyncState

      protected AbstractForStSyncState(org.forstdb.ColumnFamilyHandle columnFamily, org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer, org.apache.flink.api.common.typeutils.TypeSerializer<V> valueSerializer, V defaultValue, ForStSyncKeyedStateBackend<K> backend)
      Creates a new RocksDB backed state.
      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 Details

    • 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.internal.InternalKvState<K,N,V>

    • 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<V> safeValueSerializer) throws Exception
      Specified by:
      getSerializedValue in interface org.apache.flink.runtime.state.internal.InternalKvState<K,N,V>
      Throws:
      Exception

    • migrateSerializedValue

      public void migrateSerializedValue(org.apache.flink.core.memory.DataInputDeserializer serializedOldValueInput, org.apache.flink.core.memory.DataOutputSerializer serializedMigratedValueOutput, org.apache.flink.api.common.typeutils.TypeSerializer<V> priorSerializer, org.apache.flink.api.common.typeutils.TypeSerializer<V> newSerializer) throws org.apache.flink.util.StateMigrationException
      Throws:
      org.apache.flink.util.StateMigrationException

    • getDefaultValue

      protected V getDefaultValue()

    • setNamespaceSerializer

      protected AbstractForStSyncState<K,N,V> setNamespaceSerializer(org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer)

    • setValueSerializer

      protected AbstractForStSyncState<K,N,V> setValueSerializer(org.apache.flink.api.common.typeutils.TypeSerializer<V> valueSerializer)

    • setDefaultValue

      protected AbstractForStSyncState<K,N,V> setDefaultValue(V defaultValue)

    • getStateIncrementalVisitor

      public org.apache.flink.runtime.state.internal.InternalKvState.StateIncrementalVisitor<K,N,V> getStateIncrementalVisitor(int recommendedMaxNumberOfReturnedRecords)
      Specified by:
      getStateIncrementalVisitor in interface org.apache.flink.runtime.state.internal.InternalKvState<K,N,V>