kafka-streams-Stores.adoc

Stores Utility — Factory of State Stores

Stores is a utility for creating state stores (via StoreSuppliers or StoreBuilders).

import org.apache.kafka.streams.state.Stores
val kvStore = Stores.inMemoryKeyValueStore("store-name")
scala> :type kvStore
org.apache.kafka.streams.state.KeyValueBytesStoreSupplier

Table 1. Stores API (Static Methods)

Method	Description
inMemoryKeyValueStore	KeyValueBytesStoreSupplier inMemoryKeyValueStore( String name) Creates a KeyValueBytesStoreSupplier of KeyValueStores (i.e. InMemoryKeyValueStore)
inMemorySessionStore	SessionBytesStoreSupplier inMemorySessionStore( String name, Duration retentionPeriod) Creates a SessionBytesStoreSupplier of SessionStores (i.e. InMemorySessionBytesStoreSupplier)
inMemoryWindowStore	WindowBytesStoreSupplier inMemoryWindowStore( String name, Duration retentionPeriod, Duration windowSize, boolean retainDuplicates) Creates a WindowBytesStoreSupplier of WindowStores (i.e. InMemoryWindowBytesStoreSupplier)
keyValueStoreBuilder	StoreBuilder<KeyValueStore<K, V>> keyValueStoreBuilder( KeyValueBytesStoreSupplier supplier, Serde<K> keySerde, Serde<V> valueSerde) Creates a KeyValueStoreBuilder of KeyValueStores (i.e. KeyValueStoreBuilder)
lruMap	KeyValueBytesStoreSupplier lruMap( String name, int maxCacheSize) Creates a KeyValueBytesStoreSupplier of KeyValueStores (i.e. MemoryNavigableLRUCache)
persistentKeyValueStore	KeyValueBytesStoreSupplier persistentKeyValueStore( String name) Creates a KeyValueBytesStoreSupplier of KeyValueStores (i.e. RocksDbKeyValueBytesStoreSupplier)
persistentSessionStore	SessionBytesStoreSupplier persistentSessionStore( String name, Duration retentionPeriod) Creates a SessionBytesStoreSupplier of SessionStores (i.e. RocksDbSessionBytesStoreSupplier)
persistentTimestampedKeyValueStore	KeyValueBytesStoreSupplier persistentTimestampedKeyValueStore( String name) Creates a KeyValueBytesStoreSupplier of KeyValueStores (i.e. RocksDbKeyValueBytesStoreSupplier)
persistentTimestampedWindowStore	WindowBytesStoreSupplier persistentTimestampedWindowStore( String name, Duration retentionPeriod, Duration windowSize, boolean retainDuplicates) Creates a WindowBytesStoreSupplier of WindowStores (i.e. RocksDbWindowBytesStoreSupplier)
persistentWindowStore	WindowBytesStoreSupplier persistentWindowStore( String name, Duration retentionPeriod, Duration windowSize, boolean retainDuplicates) WindowBytesStoreSupplier persistentWindowStore( String name, Duration retentionPeriod, Duration windowSize, boolean retainDuplicates, boolean timestampedStore) WindowBytesStoreSupplier persistentWindowStore( String name, long retentionPeriod, long windowSize, boolean retainDuplicates, long segmentInterval, boolean timestampedStore) Creates a WindowBytesStoreSupplier of WindowStores (i.e. RocksDbWindowBytesStoreSupplier)
sessionStoreBuilder	StoreBuilder<SessionStore<K, V>> sessionStoreBuilder( SessionBytesStoreSupplier supplier, Serde<K> keySerde, Serde<V> valueSerde) Creates a StoreBuilder of SessionStores (i.e. SessionStoreBuilder)
timestampedKeyValueStoreBuilder	StoreBuilder<TimestampedKeyValueStore<K, V>> timestampedKeyValueStoreBuilder( KeyValueBytesStoreSupplier supplier, Serde<K> keySerde, Serde<V> valueSerde) Creates a StoreBuilder of TimestampedKeyValueStores (i.e. TimestampedKeyValueStoreBuilder)
timestampedWindowStoreBuilder	StoreBuilder<TimestampedWindowStore<K, V>> timestampedWindowStoreBuilder( WindowBytesStoreSupplier supplier, Serde<K> keySerde, Serde<V> valueSerde) Creates a StoreBuilder of TimestampedWindowStores (i.e. TimestampedWindowStoreBuilder)
windowStoreBuilder	StoreBuilder<WindowStore<K, V>> windowStoreBuilder( WindowBytesStoreSupplier supplier, Serde<K> keySerde, Serde<V> valueSerde) Creates a StoreBuilder of WindowStores (i.e. WindowStoreBuilder)