Parrhesia.Storage.Events behaviour (parrhesia v0.14.0)

Storage callbacks for event persistence and query operations.

Summary

context()

count_result()

event()

event_id()

event_ref()

filter()

paginate_opts()

query_opts()

reason()

@type context() :: map()

@type count_result() :: non_neg_integer() | %{optional(atom()) => term()}

@type event() :: map()

@type event_id() :: binary()

@type event_ref() :: %{created_at: non_neg_integer(), id: binary()}

@type filter() :: map()

@type paginate_opts() :: keyword()

@type query_opts() :: keyword()

@type reason() :: term()

@callback count(context(), [filter()], query_opts()) ::
  {:ok, count_result()} | {:error, reason()}

@callback delete_by_request(context(), event()) ::
  {:ok, non_neg_integer()} | {:error, reason()}

@callback get_event(context(), event_id()) :: {:ok, event() | nil} | {:error, reason()}

@callback paginate_events(context(), filter(), paginate_opts()) ::
  {:ok, [event()]} | {:error, reason()}

@callback purge_expired(query_opts()) :: {:ok, non_neg_integer()} | {:error, reason()}

@callback put_event(context(), event()) :: {:ok, event()} | {:error, reason()}

@callback put_events(context(), [event()]) ::
  {:ok, %{stored: [event()], duplicates: [event()]}} | {:error, reason()}

@callback query(context(), [filter()], query_opts()) ::
  {:ok, [event()]} | {:error, reason()}

@callback query_event_refs(context(), [filter()], query_opts()) ::
  {:ok, [event_ref()]} | {:error, reason()}

@callback vanish(context(), event()) :: {:ok, non_neg_integer()} | {:error, reason()}