View Source Commanded.EventStore.RecordedEvent (Commanded v1.4.6)

Contains the persisted stream identity, type, data, and metadata for a single event.

Events are immutable once recorded.

Recorded event fields

event_id - a globally unique UUID to identify the event.
event_number - a globally unique, monotonically incrementing and gapless integer used to order the event amongst all events.
stream_id - the stream identity for the event.
stream_version - the version of the stream for the event.
causation_id - an optional UUID identifier used to identify which message you are responding to.
correlation_id - an optional UUID identifier used to correlate related messages.
data - the event data deserialized into a struct.
metadata - a string keyed map of metadata associated with the event.
created_at - the datetime, in UTC, indicating when the event was created.

Summary

Types

causation_id()

correlation_id()

created_at()

data()

domain_event()

enriched_metadata()

event_id()

event_number()

event_type()

metadata()

stream_id()

stream_version()

t()

uuid()

Functions

enrich_metadata(event, opts)

Enrich the event's metadata with fields from the RecordedEvent struct and any additional metadata passed as an option.

Types

causation_id()

@type causation_id() :: uuid() | nil

correlation_id()

@type correlation_id() :: uuid() | nil

created_at()

@type created_at() :: DateTime.t()

data()

@type data() :: domain_event()

domain_event()

@type domain_event() :: struct()

enriched_metadata()

@type enriched_metadata() :: %{
  :event_id => event_id(),
  :event_number => event_number(),
  :stream_id => stream_id(),
  :stream_version => stream_version(),
  :correlation_id => correlation_id(),
  :causation_id => causation_id(),
  :created_at => created_at(),
  optional(atom()) => term(),
  optional(String.t()) => term()
}

event_id()

@type event_id() :: uuid()

event_number()

@type event_number() :: non_neg_integer()

event_type()

@type event_type() :: String.t()

metadata()

@type metadata() :: map()

stream_id()

@type stream_id() :: String.t()

stream_version()

@type stream_version() :: non_neg_integer()

t()

@type t() :: %Commanded.EventStore.RecordedEvent{
  causation_id: causation_id(),
  correlation_id: correlation_id(),
  created_at: created_at(),
  data: data(),
  event_id: event_id(),
  event_number: event_number(),
  event_type: event_type(),
  metadata: metadata(),
  stream_id: stream_id(),
  stream_version: stream_version()
}

uuid()

@type uuid() :: String.t()

Functions

enrich_metadata(event, opts)

@spec enrich_metadata(t(), [{:additional_metadata, map()}]) :: enriched_metadata()

Enrich the event's metadata with fields from the RecordedEvent struct and any additional metadata passed as an option.