elsa v0.10.0 Elsa
Provides public api to Elsa. Top-level short-cuts to sub-module functions for performing basic interactions with Kafka including listing, creating, deleting, and validating topics. Also provides a function for one-off produce_sync of message(s) to a topic.
Link to this section Summary
Functions
Define a default client name for establishing persistent connections to the Kafka cluster by producers and consumers. Useful for optimizing interactions by passing the identifier of a standing connection instead of instantiating a new one at each interaction, but when only a single connection is required, aleviating the need for the caller to differentiate and pass around a name.
Link to this section Types
connection()
connection() :: atom()
connection() :: atom()
named connection, must be an atom
endpoints()
endpoints to connect to kafka brokers
hostname()
partition()
partition() :: integer()
partition() :: integer()
portnum()
portnum() :: pos_integer()
portnum() :: pos_integer()
topic()
topic() :: String.t()
topic() :: String.t()
Link to this section Functions
create_topic(endpoints, topic, opts \\ [])
See Elsa.Topic.create/3
.
default_client()
default_client() :: atom()
default_client() :: atom()
Define a default client name for establishing persistent connections to the Kafka cluster by producers and consumers. Useful for optimizing interactions by passing the identifier of a standing connection instead of instantiating a new one at each interaction, but when only a single connection is required, aleviating the need for the caller to differentiate and pass around a name.
delete_topic(endpoints, topic)
See Elsa.Topic.delete/2
.
fetch(endpoints, topic, opts \\ [])
See Elsa.Fetch.fetch/3
.
list_topics(endpoints)
See Elsa.Topic.list/1
.
produce(endpoints_or_connection, topic, messages, opts \\ [])
topic?(endpoints, topic)
See Elsa.Topic.exists?/2
.