View Source KafkaEx.New.Structs.ClusterMetadata (kafka_ex v0.14.0)

Encapsulates what we know about the state of a Kafka broker cluster

This module is mainly used internally in New.Client, but some of its functions may be useful for extracting metadata information

Summary

Types

node_select_error()

Possible errors given by select_node/2

t()

Functions

broker_by_node_id(cluster_metadata, node_id)

Returns a t:Broker.t/0 for the given t:KafkaExAPI.node_id/0 or nil if there is no known broker with that node id

brokers(cluster_metadata)

Return a list of the known brokers

from_metadata_v1_response(metadata)

Constructs a t/0 from a Kayrock.Metadata.V1.Response struct.

known_topics(cluster_metadata)

List names of topics known by the cluster metadata

put_consumer_group_coordinator(cluster_metadata, consumer_group, coordinator_node_id)

update a consumer group coordinator node id

remove_topics(cluster_metadata, topics_to_remove)

remove the given topics (e.g., when they are deleted)

select_node(cluster_metadata, node_selector)

Find the node id for a given selector

topics_metadata(cluster_metadata, wanted_topics)

Return the metadata for the given topics

Types

node_select_error()

@type node_select_error() ::
  :no_such_node | :no_such_topic | :no_such_partition | :no_such_consumer_group

Possible errors given by select_node/2

t()

@type t() :: %KafkaEx.New.Structs.ClusterMetadata{
  brokers: %{
    required(KafkaEx.New.KafkaExAPI.node_id()) => KafkaEx.New.Structs.Broker.t()
  },
  consumer_group_coordinators: %{
    required(KafkaEx.New.KafkaExAPI.consumer_group_name()) =>
      KafkaEx.New.KafkaExAPI.node_id()
  },
  controller_id: KafkaEx.New.KafkaExAPI.node_id(),
  topics: %{
    required(KafkaEx.New.KafkaExAPI.topic_name()) =>
      KafkaEx.New.Structs.Topic.t()
  }
}

Functions

broker_by_node_id(cluster_metadata, node_id)

@spec broker_by_node_id(t(), KafkaEx.New.KafkaExAPI.node_id()) ::
  KafkaEx.New.Structs.Broker.t()

Returns a t:Broker.t/0 for the given t:KafkaExAPI.node_id/0 or nil if there is no known broker with that node id

brokers(cluster_metadata)

@spec brokers(t()) :: [KafkaEx.New.Structs.Broker.t()]

Return a list of the known brokers

from_metadata_v1_response(metadata)

@spec from_metadata_v1_response(map()) :: t()

Constructs a t/0 from a Kayrock.Metadata.V1.Response struct.

The V1 here is a minimum - this should work with higher versions of the metadata response struct.

known_topics(cluster_metadata)

@spec known_topics(t()) :: [KafkaEx.New.KafkaExAPI.topic_name()]

List names of topics known by the cluster metadata

NOTE this is a subset of the topics in the cluster - it will only contain topics for which we have fetched metadata

put_consumer_group_coordinator(cluster_metadata, consumer_group, coordinator_node_id)

@spec put_consumer_group_coordinator(
  t(),
  KafkaEx.New.KafkaExAPI.consumer_group_name(),
  KafkaEx.New.KafkaExAPI.node_id()
) :: t()

update a consumer group coordinator node id

remove_topics(cluster_metadata, topics_to_remove)

@spec remove_topics(t(), [KafkaEx.New.KafkaExAPI.topic_name()]) :: t()

remove the given topics (e.g., when they are deleted)

select_node(cluster_metadata, node_selector)

@spec select_node(t(), KafkaEx.New.Structs.NodeSelector.t()) ::
  {:ok, KafkaEx.New.KafkaExAPI.node_id()} | {:error, node_select_error()}

Find the node id for a given selector

Note this will not update the metadata, only select a node given the current metadata.

See KafkaEx.New.Structs.NodeSelector.t/0

topics_metadata(cluster_metadata, wanted_topics)

@spec topics_metadata(t(), [KafkaEx.New.KafkaExAPI.topic_name()]) :: [
  KafkaEx.New.Structs.Topic.t()
]

Return the metadata for the given topics