View Source Spear.BatchAppendResult (Spear v1.4.1)

A data structure representing the response to a batch-append request

This structure is sent to the :send_ack_to option when using Spear.append_batch/5.

Summary

Types

t()

A response to a batch-append request

Types

t()

(since 0.10.0)

@type t() :: %Spear.BatchAppendResult{
  batch_id: String.t(),
  position: Spear.Position.t() | :empty | nil,
  request_id: reference(),
  result:
    :ok
    | {:error,
       %Spear.Grpc.Response{
         data: term(),
         message: term(),
         status: term(),
         status_code: term()
       }}
    | tuple(),
  revision: non_neg_integer() | :empty | nil
}

A response to a batch-append request

When the batch-append succeeds, EventStoreDB returns the current revision and position info in the appended stream. These fields will be nil if the append does not succeed.