Package org.apache.kafka.streams.state

Interface VersionedBytesStoreSupplier

All Superinterfaces:
KeyValueBytesStoreSupplier, StoreSupplier<KeyValueStore<org.apache.kafka.common.utils.Bytes,byte[]>>
public interface VersionedBytesStoreSupplier extends KeyValueBytesStoreSupplier
A store supplier that can be used to create one or more versioned key-value stores, specifically, VersionedBytesStore instances.

Rather than representing the returned store as a VersionedKeyValueStore of type <Bytes, byte[]>, this supplier interface represents the returned store as a KeyValueStore of type <Bytes, byte[]> (via VersionedBytesStore) in order to be compatible with existing DSL methods for passing key-value stores such as StreamsBuilder.table(String, Materialized) and KTable.filter(Predicate, Materialized). A VersionedKeyValueStore<Bytes, byte[]> is represented as a KeyValueStore KeyValueStore<Bytes, byte[]> by interpreting the value bytes as containing record timestamp information in addition to raw record values.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    historyRetentionMs()
    Returns the history retention (in milliseconds) that stores created from this supplier will have.

    Methods inherited from interface org.apache.kafka.streams.state.StoreSupplier

    get, metricsScope, name

  • Method Details

    • historyRetentionMs

      long historyRetentionMs()
      Returns the history retention (in milliseconds) that stores created from this supplier will have. This value is used to set compaction configs on store changelog topics (if relevant).
      Returns:
      history retention, i.e., length of time that old record versions are available for query from a versioned store