View Source Klife.Record (Klife v0.5.0)

Kafka record representation.

Represents a Kafka record struct that will be used in the Klife.Client APIs.

In general terms it can be used to represent input or output data.

As an input the Klife.Record may have the following attributes:

:value (required)
:topic (required)
:key (optional)
:headers (optional)
:partition (optional)

As an output the input record will be added with one or more the following attributes:

:offset (if it was succesfully written)
:partition (if it was not present in the input)
:error_code (if something goes wrong on produce. See kafka protocol error code for context)

Summary

Types

t()

Functions

t()

verify_batch(produce_resps)

Utility function to verify if all records in a produce_batch/3 were successfully produced.

verify_batch!(produce_resps)

Same as verify_batch/1 but raises if any record fails and does not return ok/error tuple.

Types

t()

@type t() :: %Klife.Record{
  __batch_index: term(),
  __estimated_size: term(),
  error_code: integer(),
  headers: [%{key: binary(), value: binary()}],
  key: binary(),
  offset: non_neg_integer(),
  partition: non_neg_integer(),
  topic: String.t(),
  value: binary()
}

Functions

t()

verify_batch(produce_resps)

Utility function to verify if all records in a produce_batch/3 were successfully produced.

Examples

iex> rec1 = %Klife.Record{value: "my_val_1", topic: "my_topic_1"}
iex> rec2 = %Klife.Record{value: "my_val_2", topic: "my_topic_2"}
iex> rec3 = %Klife.Record{value: "my_val_3", topic: "my_topic_3"}
iex> input = [rec1, rec2, rec3]
iex> {:ok, [%Klife.Record{value: "my_val_1"}, _r2, _r3]} = MyClient.produce_batch(input) |> Klife.Record.verify_batch()

Partial error example. Notice that records 1 and 3 were successfully produced and only record 2 has errors, so the function will return {:error, [rec1, rec2, rec3]}

iex> rec1 = %Klife.Record{value: "my_val_1", topic: "my_topic_1"}
iex> rec2 = %Klife.Record{value: :rand.bytes(2_000_000), topic: "my_topic_2"}
iex> rec3 = %Klife.Record{value: "my_val_3", topic: "my_topic_3"}
iex> input = [rec1, rec2, rec3]
iex> {:error, [_rec1, %Klife.Record{error_code: 10}, _rec3]} = MyClient.produce_batch(input) |> Klife.Record.verify_batch()

verify_batch!(produce_resps)

Same as verify_batch/1 but raises if any record fails and does not return ok/error tuple.

Examples

iex> rec1 = %Klife.Record{value: "my_val_1", topic: "my_topic_1"}
iex> rec2 = %Klife.Record{value: "my_val_2", topic: "my_topic_2"}
iex> rec3 = %Klife.Record{value: "my_val_3", topic: "my_topic_3"}
iex> input = [rec1, rec2, rec3]
iex> [_r1, _r2, _r3] = MyClient.produce_batch(input) |> Klife.Record.verify_batch!()