dvlopt.kstreams
Kafka Streams applications.
An app is a topology of nodes sourcing, processing, and sending records. Such a topology can be built in a rather imperative fashion
by using the dvlopt.kstreams.topology namespace, the so-called "low-level API". The dvlopt.kstreams.builder namespace is the
entry point of the so-called "high-level API". It provides a "builder" which will build a topology for the user while he/she enjoys
the rather functional API. Both APIs are actually complementary. Once a builder produces a topology, it can be augmented using the
low-level API if needed.
The high-level API is usually prefered.
Kafka Streams applications. An app is a topology of nodes sourcing, processing, and sending records. Such a topology can be built in a rather imperative fashion by using the `dvlopt.kstreams.topology` namespace, the so-called "low-level API". The `dvlopt.kstreams.builder` namespace is the entry point of the so-called "high-level API". It provides a "builder" which will build a topology for the user while he/she enjoys the rather functional API. Both APIs are actually complementary. Once a builder produces a topology, it can be augmented using the low-level API if needed. The high-level API is usually prefered.
appclj
(app application-id topology)(app application-id topology options)Given a topology, creates a Kafka Streams application.
In order to release the ressource associated with an application, disband must be always called when done, even if the
application has not been started.
Works with clojure's with-open which behaves like calling disband without options.
A map of options may be given :
:dvlopt.kafka/nodes List of [Host Port].
:dvlopt.kafka.admin/configuration.topics Map of topic properties applying to any topic created by the application. Cf. https://kafka.apache.org/documentation/#topicconfigs
:dvlopt.kafka.in/configuration Map of consumer properties applying to any consumer needed by the app. Cf. https://kafka.apache.org/documentation/#newconsumerconfigs
:dvlopt.kafka.out/configuration Map of producer properties applying to any producer needed by the app. Cf. https://kafka.apache.org/documentation/#producerconfigs
::configuration Map of Kafka Streams properties. Cf. https://kafka.apache.org/documentation/#streamsconfigs
::on-exception Callback taking a Thread and an Exception, called when an error occurs during runtime.
::on-state-change
Callback accepting an old state and a new one, called everytime the state changes.
Cf. state
Given a topology, creates a Kafka Streams application. In order to release the ressource associated with an application, `disband` must be always called when done, even if the application has not been started. Works with clojure's `with-open` which behaves like calling `disband` without options. A map of options may be given : :dvlopt.kafka/nodes List of [Host Port]. :dvlopt.kafka.admin/configuration.topics Map of topic properties applying to any topic created by the application. Cf. https://kafka.apache.org/documentation/#topicconfigs :dvlopt.kafka.in/configuration Map of consumer properties applying to any consumer needed by the app. Cf. https://kafka.apache.org/documentation/#newconsumerconfigs :dvlopt.kafka.out/configuration Map of producer properties applying to any producer needed by the app. Cf. https://kafka.apache.org/documentation/#producerconfigs ::configuration Map of Kafka Streams properties. Cf. https://kafka.apache.org/documentation/#streamsconfigs ::on-exception Callback taking a Thread and an Exception, called when an error occurs during runtime. ::on-state-change Callback accepting an old state and a new one, called everytime the state changes. Cf. `state`
clean-upclj
(clean-up app)Does a clean-up of the local state store directory by deleting all data with regard to the application ID.
Does a clean-up of the local state store directory by deleting all data with regard to the application ID.
disbandclj
(disband app)(disband app options)Releases resources acquired for the Kafka Streams application (after stopping it if it was running).
A map of options may be given :
:timeout
Cf. dvlopt.kafka for description of time intervals
Releases resources acquired for the Kafka Streams application (after stopping it if it was running). A map of options may be given : :timeout Cf. `dvlopt.kafka` for description of time intervals
kv-storeclj
(kv-store app store-name)Retrieves a read-only key-value store used by the application.
Retrieves a read-only key-value store used by the application.
metricsclj
(metrics app)Requests metrics about this application.
Returned valued presented in the same form as dvlopt.kafka.out/metrics.
Requests metrics about this application. Returned valued presented in the same form as `dvlopt.kafka.out/metrics`.
remote-instancesclj
(remote-instances app)Returns a vector of maps about instances of this application running on other hosts.
Each map represents a point in time and contains :
:dvlopt.kafka/host Host of the remote instance.
:dvlopt.kafka/port Port associated with the remote instance.
:dvlopt.kafka/topic-partitions List of [topic partition]'s the remote instance is handling.
:dvlopt.kstreams.store/names List of the store names the instance is handling.
Returns a vector of maps about instances of this application running on other hosts. Each map represents a point in time and contains : :dvlopt.kafka/host Host of the remote instance. :dvlopt.kafka/port Port associated with the remote instance. :dvlopt.kafka/topic-partitions List of [topic partition]'s the remote instance is handling. :dvlopt.kstreams.store/names List of the store names the instance is handling.
session-storeclj
(session-store app store-name)Retrieves a read-only session store used by the application.
Retrieves a read-only session store used by the application.
startclj
(start app)Starts a Kafka Streams application.
Starts a Kafka Streams application.
stateclj
(state app)Returns the current state of the application, one of :
:created :error :not-running :pending-shutdown :rebalancing :running
Returns the current state of the application, one of : :created :error :not-running :pending-shutdown :rebalancing :running
window-storeclj
(window-store app store-name)Retrieves a read-only window store used by the application.
Retrieves a read-only window store used by the application.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close