Commanded

v1.0.0

Commanded v1.0.0 Commanded.EventStore.Adapter behaviour View Source

Defines the behaviour to be implemented by an event store adapter to be used by Commanded.

Link to this section Summary

Types

adapter_meta()
application()
config()
error()
expected_version()
source_uuid()
start_from()
stream_uuid()
subscriber()
subscription()
subscription_name()

Callbacks

ack_event(adapter_meta, pid, arg3)

Acknowledge receipt and successful processing of the given event received from a subscription to an event stream.

append_to_stream(adapter_meta, stream_uuid, expected_version, events)

Append one or more events to a stream atomically.

child_spec(application, config)

Return a child spec defining all processes required by the event store.

delete_snapshot(adapter_meta, source_uuid)

Delete a previously recorded snapshot for a given source

delete_subscription(adapter_meta, arg2, subscription_name)

Delete an existing subscription.

read_snapshot(adapter_meta, source_uuid)

Read a snapshot, if available, for a given source.

record_snapshot(adapter_meta, arg2)

Record a snapshot of the data and metadata for a given source

stream_forward(adapter_meta, stream_uuid, start_version, read_batch_size)

Streams events from the given stream, in the order in which they were originally written.

subscribe(adapter_meta, arg2)

Create a transient subscription to a single event stream.

subscribe_to(adapter_meta, arg2, subscription_name, subscriber, start_from)

Create a persistent subscription to an event stream.

unsubscribe(adapter_meta, subscription)

Unsubscribe an existing subscriber from event notifications.

Link to this section Types

Link to this type

adapter_meta()

View Source 
adapter_meta() :: map()
Link to this type

application()

View Source 
application() :: Commanded.Application.t()
Link to this type

config()

View Source 
config() :: Keyword.t()
Link to this type

error()

View Source 
error() :: term()
Link to this type

expected_version()

View Source 
expected_version() ::
  :any_version | :no_stream | :stream_exists | non_neg_integer()
Link to this type

source_uuid()

View Source 
source_uuid() :: String.t()
Link to this type

start_from()

View Source 
start_from() :: :origin | :current | integer()
Link to this type

stream_uuid()

View Source 
stream_uuid() :: String.t()
Link to this type

subscriber()

View Source 
subscriber() :: pid()
Link to this type

subscription()

View Source 
subscription() :: any()
Link to this type

subscription_name()

View Source 
subscription_name() :: String.t()

Link to this section Callbacks

Link to this callback

ack_event(adapter_meta, pid, arg3)

View Source 
ack_event(adapter_meta(), pid(), Commanded.EventStore.RecordedEvent.t()) :: :ok

Acknowledge receipt and successful processing of the given event received from a subscription to an event stream.

Link to this callback

append_to_stream(adapter_meta, stream_uuid, expected_version, events)

View Source 
append_to_stream(
  adapter_meta(),
  stream_uuid(),
  expected_version(),
  events :: [Commanded.EventStore.EventData.t()]
) :: :ok | {:error, :wrong_expected_version} | {:error, error()}

Append one or more events to a stream atomically.

Link to this callback

child_spec(application, config)

View Source 
child_spec(application(), config()) ::
  {:ok, [:supervisor.child_spec() | {module(), term()} | module()],
   adapter_meta()}

Return a child spec defining all processes required by the event store.

Link to this callback

delete_snapshot(adapter_meta, source_uuid)

View Source 
delete_snapshot(adapter_meta(), source_uuid()) :: :ok | {:error, error()}

Delete a previously recorded snapshot for a given source

Link to this callback

delete_subscription(adapter_meta, arg2, subscription_name)

View Source 
delete_subscription(adapter_meta(), stream_uuid() | :all, subscription_name()) ::
  :ok | {:error, :subscription_not_found} | {:error, error()}

Delete an existing subscription.

Link to this callback

read_snapshot(adapter_meta, source_uuid)

View Source 
read_snapshot(adapter_meta(), source_uuid()) ::
  {:ok, Commanded.EventStore.SnapshotData.t()} | {:error, :snapshot_not_found}

Read a snapshot, if available, for a given source.

Link to this callback

record_snapshot(adapter_meta, arg2)

View Source 
record_snapshot(adapter_meta(), Commanded.EventStore.SnapshotData.t()) ::
  :ok | {:error, error()}

Record a snapshot of the data and metadata for a given source

Link to this callback

stream_forward(adapter_meta, stream_uuid, start_version, read_batch_size)

View Source 
stream_forward(
  adapter_meta(),
  stream_uuid(),
  start_version :: non_neg_integer(),
  read_batch_size :: non_neg_integer()
) :: Enumerable.t() | {:error, :stream_not_found} | {:error, error()}

Streams events from the given stream, in the order in which they were originally written.

Link to this callback

subscribe(adapter_meta, arg2)

View Source 
subscribe(adapter_meta(), stream_uuid() | :all) :: :ok | {:error, error()}

Create a transient subscription to a single event stream.

The event store will publish any events appended to the given stream to the subscriber process as an {:events, events} message.

The subscriber does not need to acknowledge receipt of the events.

Link to this callback

subscribe_to(adapter_meta, arg2, subscription_name, subscriber, start_from)

View Source 
subscribe_to(
  adapter_meta(),
  stream_uuid() | :all,
  subscription_name(),
  subscriber(),
  start_from()
) ::
  {:ok, subscription()}
  | {:error, :subscription_already_exists}
  | {:error, error()}

Create a persistent subscription to an event stream.

Link to this callback

unsubscribe(adapter_meta, subscription)

View Source 
unsubscribe(adapter_meta(), subscription()) :: :ok

Unsubscribe an existing subscriber from event notifications.

This should not delete the subscription.