Kafka.Metadata

Module with metadata types and functions.

Documentation

data KafkaMetadata

Constructors

KafkaMetadata

Fields

• kmBrokers :: [BrokerMetadata]
• kmTopics :: [TopicMetadata]
• kmOrigBroker :: !BrokerId

Instances

Eq KafkaMetadata

Defined in Kafka.Metadata

Methods

(==) :: KafkaMetadata -> KafkaMetadata -> Bool

(/=) :: KafkaMetadata -> KafkaMetadata -> Bool

Show KafkaMetadata

Defined in Kafka.Metadata

Methods

showsPrec :: Int -> KafkaMetadata -> ShowS

show :: KafkaMetadata -> String

showList :: [KafkaMetadata] -> ShowS

Generic KafkaMetadata

Defined in Kafka.Metadata

Associated Types

type Rep KafkaMetadata :: Type -> Type

Methods

from :: KafkaMetadata -> Rep KafkaMetadata x

to :: Rep KafkaMetadata x -> KafkaMetadata

type Rep KafkaMetadata

Defined in Kafka.Metadata

type Rep KafkaMetadata = D1 ('MetaData "KafkaMetadata" "Kafka.Metadata" "hw-kafka-client-4.0.3-inplace" 'False) (C1 ('MetaCons "KafkaMetadata" 'PrefixI 'True) (S1 ('MetaSel ('Just "kmBrokers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [BrokerMetadata]) :*: (S1 ('MetaSel ('Just "kmTopics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TopicMetadata]) :*: S1 ('MetaSel ('Just "kmOrigBroker") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BrokerId))))

data BrokerMetadata

Constructors

BrokerMetadata

Fields

• bmBrokerId :: !BrokerId
• bmBrokerHost :: !Text
• bmBrokerPort :: !Int

Instances

Eq BrokerMetadata

Defined in Kafka.Metadata

Methods

(==) :: BrokerMetadata -> BrokerMetadata -> Bool

(/=) :: BrokerMetadata -> BrokerMetadata -> Bool

Show BrokerMetadata

Defined in Kafka.Metadata

Methods

showsPrec :: Int -> BrokerMetadata -> ShowS

show :: BrokerMetadata -> String

showList :: [BrokerMetadata] -> ShowS

Generic BrokerMetadata

Defined in Kafka.Metadata

Associated Types

type Rep BrokerMetadata :: Type -> Type

Methods

from :: BrokerMetadata -> Rep BrokerMetadata x

to :: Rep BrokerMetadata x -> BrokerMetadata

type Rep BrokerMetadata

Defined in Kafka.Metadata

type Rep BrokerMetadata = D1 ('MetaData "BrokerMetadata" "Kafka.Metadata" "hw-kafka-client-4.0.3-inplace" 'False) (C1 ('MetaCons "BrokerMetadata" 'PrefixI 'True) (S1 ('MetaSel ('Just "bmBrokerId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BrokerId) :*: (S1 ('MetaSel ('Just "bmBrokerHost") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "bmBrokerPort") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int))))

data TopicMetadata

Constructors

TopicMetadata

Fields

• tmTopicName :: !TopicName
• tmPartitions :: [PartitionMetadata]
• tmError :: Maybe KafkaError

Instances

Eq TopicMetadata

Defined in Kafka.Metadata

Methods

(==) :: TopicMetadata -> TopicMetadata -> Bool

(/=) :: TopicMetadata -> TopicMetadata -> Bool

Show TopicMetadata

Defined in Kafka.Metadata

Methods

showsPrec :: Int -> TopicMetadata -> ShowS

show :: TopicMetadata -> String

showList :: [TopicMetadata] -> ShowS

Generic TopicMetadata

Defined in Kafka.Metadata

Associated Types

type Rep TopicMetadata :: Type -> Type

Methods

from :: TopicMetadata -> Rep TopicMetadata x

to :: Rep TopicMetadata x -> TopicMetadata

type Rep TopicMetadata

Defined in Kafka.Metadata

type Rep TopicMetadata = D1 ('MetaData "TopicMetadata" "Kafka.Metadata" "hw-kafka-client-4.0.3-inplace" 'False) (C1 ('MetaCons "TopicMetadata" 'PrefixI 'True) (S1 ('MetaSel ('Just "tmTopicName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TopicName) :*: (S1 ('MetaSel ('Just "tmPartitions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [PartitionMetadata]) :*: S1 ('MetaSel ('Just "tmError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe KafkaError)))))

data PartitionMetadata

Constructors

PartitionMetadata

Fields

• pmPartitionId :: !PartitionId
• pmError :: Maybe KafkaError
• pmLeader :: !BrokerId
• pmReplicas :: [BrokerId]
• pmInSyncReplicas :: [BrokerId]

Instances

Eq PartitionMetadata

Defined in Kafka.Metadata

Methods

(==) :: PartitionMetadata -> PartitionMetadata -> Bool

(/=) :: PartitionMetadata -> PartitionMetadata -> Bool

Show PartitionMetadata

Defined in Kafka.Metadata

Methods

showsPrec :: Int -> PartitionMetadata -> ShowS

show :: PartitionMetadata -> String

showList :: [PartitionMetadata] -> ShowS

Generic PartitionMetadata

Defined in Kafka.Metadata

Associated Types

type Rep PartitionMetadata :: Type -> Type

Methods

from :: PartitionMetadata -> Rep PartitionMetadata x

to :: Rep PartitionMetadata x -> PartitionMetadata

type Rep PartitionMetadata

Defined in Kafka.Metadata

type Rep PartitionMetadata = D1 ('MetaData "PartitionMetadata" "Kafka.Metadata" "hw-kafka-client-4.0.3-inplace" 'False) (C1 ('MetaCons "PartitionMetadata" 'PrefixI 'True) ((S1 ('MetaSel ('Just "pmPartitionId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PartitionId) :*: S1 ('MetaSel ('Just "pmError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe KafkaError))) :*: (S1 ('MetaSel ('Just "pmLeader") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BrokerId) :*: (S1 ('MetaSel ('Just "pmReplicas") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [BrokerId]) :*: S1 ('MetaSel ('Just "pmInSyncReplicas") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [BrokerId])))))

data WatermarkOffsets

Constructors

WatermarkOffsets

Fields

• woTopicName :: !TopicName
• woPartitionId :: !PartitionId
• woLowWatermark :: !Offset
• woHighWatermark :: !Offset

Instances

Eq WatermarkOffsets

Defined in Kafka.Metadata

Methods

(==) :: WatermarkOffsets -> WatermarkOffsets -> Bool

(/=) :: WatermarkOffsets -> WatermarkOffsets -> Bool

Show WatermarkOffsets

Defined in Kafka.Metadata

Methods

showsPrec :: Int -> WatermarkOffsets -> ShowS

show :: WatermarkOffsets -> String

showList :: [WatermarkOffsets] -> ShowS

Generic WatermarkOffsets

Defined in Kafka.Metadata

Associated Types

type Rep WatermarkOffsets :: Type -> Type

Methods

from :: WatermarkOffsets -> Rep WatermarkOffsets x

to :: Rep WatermarkOffsets x -> WatermarkOffsets

type Rep WatermarkOffsets

Defined in Kafka.Metadata

type Rep WatermarkOffsets = D1 ('MetaData "WatermarkOffsets" "Kafka.Metadata" "hw-kafka-client-4.0.3-inplace" 'False) (C1 ('MetaCons "WatermarkOffsets" 'PrefixI 'True) ((S1 ('MetaSel ('Just "woTopicName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TopicName) :*: S1 ('MetaSel ('Just "woPartitionId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PartitionId)) :*: (S1 ('MetaSel ('Just "woLowWatermark") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Offset) :*: S1 ('MetaSel ('Just "woHighWatermark") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Offset))))

newtype GroupMemberId

Constructors

GroupMemberId Text

Instances

Eq GroupMemberId

Defined in Kafka.Metadata

Methods

(==) :: GroupMemberId -> GroupMemberId -> Bool

(/=) :: GroupMemberId -> GroupMemberId -> Bool

Ord GroupMemberId

Defined in Kafka.Metadata

Methods

compare :: GroupMemberId -> GroupMemberId -> Ordering

(<) :: GroupMemberId -> GroupMemberId -> Bool

(<=) :: GroupMemberId -> GroupMemberId -> Bool

(>) :: GroupMemberId -> GroupMemberId -> Bool

(>=) :: GroupMemberId -> GroupMemberId -> Bool

max :: GroupMemberId -> GroupMemberId -> GroupMemberId

min :: GroupMemberId -> GroupMemberId -> GroupMemberId

Read GroupMemberId

Defined in Kafka.Metadata

Methods

readsPrec :: Int -> ReadS GroupMemberId

readList :: ReadS [GroupMemberId]

readPrec :: ReadPrec GroupMemberId

readListPrec :: ReadPrec [GroupMemberId]

Show GroupMemberId

Defined in Kafka.Metadata

Methods

showsPrec :: Int -> GroupMemberId -> ShowS

show :: GroupMemberId -> String

showList :: [GroupMemberId] -> ShowS

data GroupMemberInfo

Constructors

GroupMemberInfo

Fields

• gmiMemberId :: !GroupMemberId
• gmiClientId :: !ClientId
• gmiClientHost :: !Text
• gmiMetadata :: !ByteString
• gmiAssignment :: !ByteString

Instances

Eq GroupMemberInfo

Defined in Kafka.Metadata

Methods

(==) :: GroupMemberInfo -> GroupMemberInfo -> Bool

(/=) :: GroupMemberInfo -> GroupMemberInfo -> Bool

Show GroupMemberInfo

Defined in Kafka.Metadata

Methods

showsPrec :: Int -> GroupMemberInfo -> ShowS

show :: GroupMemberInfo -> String

showList :: [GroupMemberInfo] -> ShowS

Generic GroupMemberInfo

Defined in Kafka.Metadata

Associated Types

type Rep GroupMemberInfo :: Type -> Type

Methods

from :: GroupMemberInfo -> Rep GroupMemberInfo x

to :: Rep GroupMemberInfo x -> GroupMemberInfo

type Rep GroupMemberInfo

Defined in Kafka.Metadata

type Rep GroupMemberInfo = D1 ('MetaData "GroupMemberInfo" "Kafka.Metadata" "hw-kafka-client-4.0.3-inplace" 'False) (C1 ('MetaCons "GroupMemberInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "gmiMemberId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GroupMemberId) :*: S1 ('MetaSel ('Just "gmiClientId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ClientId)) :*: (S1 ('MetaSel ('Just "gmiClientHost") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "gmiMetadata") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ByteString) :*: S1 ('MetaSel ('Just "gmiAssignment") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ByteString)))))

newtype GroupProtocolType

Constructors

GroupProtocolType Text

Instances

Eq GroupProtocolType

Defined in Kafka.Metadata

Methods

(==) :: GroupProtocolType -> GroupProtocolType -> Bool

(/=) :: GroupProtocolType -> GroupProtocolType -> Bool

Ord GroupProtocolType

Defined in Kafka.Metadata

Methods

compare :: GroupProtocolType -> GroupProtocolType -> Ordering

(<) :: GroupProtocolType -> GroupProtocolType -> Bool

(<=) :: GroupProtocolType -> GroupProtocolType -> Bool

(>) :: GroupProtocolType -> GroupProtocolType -> Bool

(>=) :: GroupProtocolType -> GroupProtocolType -> Bool

max :: GroupProtocolType -> GroupProtocolType -> GroupProtocolType

min :: GroupProtocolType -> GroupProtocolType -> GroupProtocolType

Read GroupProtocolType

Defined in Kafka.Metadata

Methods

readsPrec :: Int -> ReadS GroupProtocolType

readList :: ReadS [GroupProtocolType]

readPrec :: ReadPrec GroupProtocolType

readListPrec :: ReadPrec [GroupProtocolType]

Show GroupProtocolType

Defined in Kafka.Metadata

Methods

showsPrec :: Int -> GroupProtocolType -> ShowS

show :: GroupProtocolType -> String

showList :: [GroupProtocolType] -> ShowS

Generic GroupProtocolType

Defined in Kafka.Metadata

Associated Types

type Rep GroupProtocolType :: Type -> Type

Methods

from :: GroupProtocolType -> Rep GroupProtocolType x

to :: Rep GroupProtocolType x -> GroupProtocolType

type Rep GroupProtocolType

Defined in Kafka.Metadata

type Rep GroupProtocolType = D1 ('MetaData "GroupProtocolType" "Kafka.Metadata" "hw-kafka-client-4.0.3-inplace" 'True) (C1 ('MetaCons "GroupProtocolType" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype GroupProtocol

Constructors

GroupProtocol Text

Instances

Eq GroupProtocol

Defined in Kafka.Metadata

Methods

(==) :: GroupProtocol -> GroupProtocol -> Bool

(/=) :: GroupProtocol -> GroupProtocol -> Bool

Ord GroupProtocol

Defined in Kafka.Metadata

Methods

compare :: GroupProtocol -> GroupProtocol -> Ordering

(<) :: GroupProtocol -> GroupProtocol -> Bool

(<=) :: GroupProtocol -> GroupProtocol -> Bool

(>) :: GroupProtocol -> GroupProtocol -> Bool

(>=) :: GroupProtocol -> GroupProtocol -> Bool

max :: GroupProtocol -> GroupProtocol -> GroupProtocol

min :: GroupProtocol -> GroupProtocol -> GroupProtocol

Read GroupProtocol

Defined in Kafka.Metadata

Methods

readsPrec :: Int -> ReadS GroupProtocol

readList :: ReadS [GroupProtocol]

readPrec :: ReadPrec GroupProtocol

readListPrec :: ReadPrec [GroupProtocol]

Show GroupProtocol

Defined in Kafka.Metadata

Methods

showsPrec :: Int -> GroupProtocol -> ShowS

show :: GroupProtocol -> String

showList :: [GroupProtocol] -> ShowS

Generic GroupProtocol

Defined in Kafka.Metadata

Associated Types

type Rep GroupProtocol :: Type -> Type

Methods

from :: GroupProtocol -> Rep GroupProtocol x

to :: Rep GroupProtocol x -> GroupProtocol

type Rep GroupProtocol

Defined in Kafka.Metadata

type Rep GroupProtocol = D1 ('MetaData "GroupProtocol" "Kafka.Metadata" "hw-kafka-client-4.0.3-inplace" 'True) (C1 ('MetaCons "GroupProtocol" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data GroupState

Constructors

GroupPreparingRebalance

Group is preparing to rebalance

GroupEmpty

Group has no more members, but lingers until all offsets have expired

GroupAwaitingSync

Group is awaiting state assignment from the leader

GroupStable

Group is stable

GroupDead

Group has no more members and its metadata is being removed

Instances

Eq GroupState

Defined in Kafka.Metadata

Methods

(==) :: GroupState -> GroupState -> Bool

(/=) :: GroupState -> GroupState -> Bool

Ord GroupState

Defined in Kafka.Metadata

Methods

compare :: GroupState -> GroupState -> Ordering

(<) :: GroupState -> GroupState -> Bool

(<=) :: GroupState -> GroupState -> Bool

(>) :: GroupState -> GroupState -> Bool

(>=) :: GroupState -> GroupState -> Bool

max :: GroupState -> GroupState -> GroupState

min :: GroupState -> GroupState -> GroupState

Read GroupState

Defined in Kafka.Metadata

Methods

readsPrec :: Int -> ReadS GroupState

readList :: ReadS [GroupState]

readPrec :: ReadPrec GroupState

readListPrec :: ReadPrec [GroupState]

Show GroupState

Defined in Kafka.Metadata

Methods

showsPrec :: Int -> GroupState -> ShowS

show :: GroupState -> String

showList :: [GroupState] -> ShowS

Generic GroupState

Defined in Kafka.Metadata

Associated Types

type Rep GroupState :: Type -> Type

Methods

from :: GroupState -> Rep GroupState x

to :: Rep GroupState x -> GroupState

type Rep GroupState

Defined in Kafka.Metadata

type Rep GroupState = D1 ('MetaData "GroupState" "Kafka.Metadata" "hw-kafka-client-4.0.3-inplace" 'False) ((C1 ('MetaCons "GroupPreparingRebalance" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "GroupEmpty" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "GroupAwaitingSync" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "GroupStable" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "GroupDead" 'PrefixI 'False) (U1 :: Type -> Type))))

data GroupInfo

Constructors

GroupInfo

Fields

• giGroup :: !ConsumerGroupId
• giError :: Maybe KafkaError
• giState :: !GroupState
• giProtocolType :: !GroupProtocolType
• giProtocol :: !GroupProtocol
• giMembers :: [GroupMemberInfo]

Instances

Eq GroupInfo

Defined in Kafka.Metadata

Methods

(==) :: GroupInfo -> GroupInfo -> Bool

(/=) :: GroupInfo -> GroupInfo -> Bool

Show GroupInfo

Defined in Kafka.Metadata

Methods

showsPrec :: Int -> GroupInfo -> ShowS

show :: GroupInfo -> String

showList :: [GroupInfo] -> ShowS

Generic GroupInfo

Defined in Kafka.Metadata

Associated Types

type Rep GroupInfo :: Type -> Type

Methods

from :: GroupInfo -> Rep GroupInfo x

to :: Rep GroupInfo x -> GroupInfo

type Rep GroupInfo

Defined in Kafka.Metadata

type Rep GroupInfo = D1 ('MetaData "GroupInfo" "Kafka.Metadata" "hw-kafka-client-4.0.3-inplace" 'False) (C1 ('MetaCons "GroupInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "giGroup") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ConsumerGroupId) :*: (S1 ('MetaSel ('Just "giError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe KafkaError)) :*: S1 ('MetaSel ('Just "giState") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GroupState))) :*: (S1 ('MetaSel ('Just "giProtocolType") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GroupProtocolType) :*: (S1 ('MetaSel ('Just "giProtocol") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GroupProtocol) :*: S1 ('MetaSel ('Just "giMembers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [GroupMemberInfo])))))

allTopicsMetadata :: (MonadIO m, HasKafka k) => k -> Timeout -> m (Either KafkaError KafkaMetadata)

Returns metadata for all topics in the cluster

topicMetadata :: (MonadIO m, HasKafka k) => k -> Timeout -> TopicName -> m (Either KafkaError KafkaMetadata)

Returns metadata only for specified topic

watermarkOffsets :: (MonadIO m, HasKafka k) => k -> Timeout -> TopicName -> m [Either KafkaError WatermarkOffsets]

Query broker for low (oldestbeginning) and high (newestend) offsets for a given topic.

watermarkOffsets' :: (MonadIO m, HasKafka k) => k -> Timeout -> TopicMetadata -> m [Either KafkaError WatermarkOffsets]

Query broker for low (oldestbeginning) and high (newestend) offsets for a given topic.

partitionWatermarkOffsets :: (MonadIO m, HasKafka k) => k -> Timeout -> TopicName -> PartitionId -> m (Either KafkaError WatermarkOffsets)

Query broker for low (oldestbeginning) and high (newestend) offsets for a specific partition

offsetsForTime :: (MonadIO m, HasKafka k) => k -> Timeout -> Millis -> [(TopicName, PartitionId)] -> m (Either KafkaError [TopicPartition])

Look up the offsets for the given partitions by timestamp.

The returned offset for each partition is the earliest offset whose timestamp is greater than or equal to the given timestamp in the corresponding partition.

offsetsForTime' :: (MonadIO m, HasKafka k) => k -> Timeout -> Millis -> TopicMetadata -> m (Either KafkaError [TopicPartition])

Look up the offsets for the given metadata by timestamp.

The returned offset for each partition is the earliest offset whose timestamp is greater than or equal to the given timestamp in the corresponding partition.

topicOffsetsForTime :: (MonadIO m, HasKafka k) => k -> Timeout -> Millis -> TopicName -> m (Either KafkaError [TopicPartition])

Look up the offsets for the given topic by timestamp.

The returned offset for each partition is the earliest offset whose timestamp is greater than or equal to the given timestamp in the corresponding partition.

allConsumerGroupsInfo :: (MonadIO m, HasKafka k) => k -> Timeout -> m (Either KafkaError [GroupInfo])

List and describe all consumer groups in cluster.

consumerGroupInfo :: (MonadIO m, HasKafka k) => k -> Timeout -> ConsumerGroupId -> m (Either KafkaError [GroupInfo])

Describe a given consumer group.