org.apache.kafka.streams.state

Interface Stores.PersistentKeyValueFactory<K,V>

Type Parameters:

K - the type of keys

V - the type of values

Enclosing class:

Stores

public static interface Stores.PersistentKeyValueFactory<K,V>

The interface used to create off-heap key-value stores that use a local database.

Method Summary

Methods

Modifier and Type	Method and Description
StateStoreSupplier	build() Return the instance of StateStoreSupplier of new key-value store.
Stores.PersistentKeyValueFactory<K,V>	disableLogging() Indicates that a changelog should not be created for the key-value store
Stores.PersistentKeyValueFactory<K,V>	enableCaching() Caching should be enabled on the created store.
Stores.PersistentKeyValueFactory<K,V>	enableLogging(java.util.Map<java.lang.String,java.lang.String> config) Indicates that a changelog should be created for the store.
Stores.PersistentKeyValueFactory<K,V>	sessionWindowed(long retentionPeriod) Set the persistent store as a SessionStore for use with SessionWindows
Stores.PersistentKeyValueFactory<K,V>	windowed(long windowSize, long retentionPeriod, int numSegments, boolean retainDuplicates) Set the persistent store as a windowed key-value store

Method Detail

windowed

Stores.PersistentKeyValueFactory<K,V> windowed(long windowSize,
                                             long retentionPeriod,
                                             int numSegments,
                                             boolean retainDuplicates)

Set the persistent store as a windowed key-value store

Parameters:

windowSize - size of the windows

retentionPeriod - the maximum period of time in milli-second to keep each window in this store

numSegments - the maximum number of segments for rolling the windowed store

retainDuplicates - whether or not to retain duplicate data within the window

sessionWindowed

Stores.PersistentKeyValueFactory<K,V> sessionWindowed(long retentionPeriod)

Set the persistent store as a SessionStore for use with SessionWindows

Parameters:

retentionPeriod - period of time in milliseconds to keep each window in this store

enableLogging

Stores.PersistentKeyValueFactory<K,V> enableLogging(java.util.Map<java.lang.String,java.lang.String> config)

Indicates that a changelog should be created for the store. The changelog will be created with the provided cleanupPolicy and configs. Note: Any unrecognized configs will be ignored.

Parameters:

config - any configs that should be applied to the changelog

Returns:

the factory to create a persistent key-value store

disableLogging

Stores.PersistentKeyValueFactory<K,V> disableLogging()

Indicates that a changelog should not be created for the key-value store

Returns:

the factory to create a persistent key-value store

enableCaching

Stores.PersistentKeyValueFactory<K,V> enableCaching()

Caching should be enabled on the created store.

Returns:

the factory to create a persistent key-value store

build

StateStoreSupplier build()

Return the instance of StateStoreSupplier of new key-value store.

Returns:

the key-value store; never null