org.apache.kafka.streams.state

Interface DslStoreSuppliers

All Superinterfaces:

org.apache.kafka.common.Configurable

All Known Implementing Classes:

BuiltInDslStoreSuppliers.InMemoryDslStoreSuppliers, BuiltInDslStoreSuppliers.RocksDBDslStoreSuppliers, Materialized.StoreType

public interface DslStoreSuppliers
extends org.apache.kafka.common.Configurable

DslStoreSuppliers defines a grouping of factories to construct stores for each of the types of state store implementations in Kafka Streams. This allows configuration of a default store supplier beyond the builtin defaults of RocksDB and In-Memory.

There are various ways that this configuration can be supplied to the application (in order of precedence):

1. Passed in directly to a DSL operator via either Materialized.as(DslStoreSuppliers), Materialized.withStoreType(DslStoreSuppliers), or StreamJoined.withDslStoreSuppliers(DslStoreSuppliers)
2. Passed in via a Topology configuration override (configured in a TopologyConfig and passed into the StreamsBuilder(TopologyConfig) constructor
3. Configured as a global default in StreamsConfig using the StreamsConfig.DSL_STORE_SUPPLIERS_CLASS_CONFIG
configuration.

Kafka Streams is packaged with some pre-existing DslStoreSuppliers that exist in BuiltInDslStoreSuppliers

Method Summary

Modifier and Type	Method and Description
default void	configure(Map<String,?> configs)
KeyValueBytesStoreSupplier	keyValueStore(DslKeyValueParams params)
SessionBytesStoreSupplier	sessionStore(DslSessionParams params)
WindowBytesStoreSupplier	windowStore(DslWindowParams params)

Method Detail

configure

default void configure(Map<String,?> configs)

Specified by:

configure in interface org.apache.kafka.common.Configurable

keyValueStore

KeyValueBytesStoreSupplier keyValueStore(DslKeyValueParams params)

windowStore

WindowBytesStoreSupplier windowStore(DslWindowParams params)

sessionStore

SessionBytesStoreSupplier sessionStore(DslSessionParams params)