Disco v0.1.3 Disco.EventStore.Client behaviour View Source

The Disco.EventStore.Client specification.

A client is used to interact with Disco.EventStore while keeping details isolated.

Like other components in Disco, even the Disco.EventStore.Client is built as a behaviour that implements default callbacks. This means that the simplest definition of a client can be achieved like the following:

defmodule MyApp.EventStoreClient do
  use Disco.EventStore.Client
end

Link to this section Summary

Callbacks

emit(map)

Called to emit an event to the event store

get_consumer_offset(consumer)

Called to obtain the current offset for a given cosumer. Returns 0 by default

load_aggregate_events(id)

Called to load events for a given aggregate id from event store

load_events_after_offset(events_listened, offset)

Called to load events to be consumed after a given offset

load_events_with_types(event_types)

Called to load emitted events that need to be consumed

update_consumer_offset(consumer, offset)

Called to update current offset counter

Link to this section Callbacks

emit(map)

emit(map()) :: {:ok, event :: map()} | {:error, reason :: any()}

Called to emit an event to the event store.

get_consumer_offset(consumer)

get_consumer_offset(consumer :: binary()) :: integer()

Called to obtain the current offset for a given cosumer. Returns 0 by default.

load_aggregate_events(id)

load_aggregate_events(id :: any()) :: list()

Called to load events for a given aggregate id from event store.

load_events_after_offset(events_listened, offset)

load_events_after_offset(events_listened :: [binary()], offset :: integer()) ::
  [map()]

Called to load events to be consumed after a given offset.

load_events_with_types(event_types)

load_events_with_types(event_types :: [binary()]) :: list()

Called to load emitted events that need to be consumed.

update_consumer_offset(consumer, offset)

update_consumer_offset(consumer :: binary(), offset :: integer()) ::
  {:ok, integer()}

Called to update current offset counter.