elsa v0.5.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 Functions

Link to this function

create_topic(endpoints, topic, opts \\ [])

See Elsa.Topic.create/3.

Link to this function

default_client()
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.

Link to this function

delete_topic(endpoints, topic)

See Elsa.Topic.delete/2.

Link to this function

fetch(endpoints, topic, opts \\ [])

See Elsa.Fetch.fetch/3.

Link to this macro

kafka_message(args \\ []) (macro)

Link to this macro

kafka_message(record, args) (macro)

Link to this function

list_topics(endpoints)

See Elsa.Topic.list/1.

Link to this function

produce(endpoints, topic, messages, opts \\ [])

See Elsa.Producer.produce/4.

Link to this function

produce_sync(topic, messages, opts \\ [])

See Elsa.Producer.produce_sync/3.

Link to this function

topic?(endpoints, topic)

See Elsa.Topic.exists?/2.