Spectre.Journal.Store behaviour (Spectre v0.3.3)

Storage boundary for structured Spectre journal records.

A runtime store only needs to append records. Querying, retention, indexing, and transactional outboxes remain application concerns. Adapters used by configured Instance erasure additionally expose the optional, idempotent erase_instance/2 callback.

Summary

Types

config()

normalized()

Callbacks

append(t, keyword)

erase_instance(t, keyword)

Functions

erase_instance(store, ref, opts)

Erases all journal records bound to one exact Instance Ref.

erasure_capability(arg1)

Checks whether a configured journal supports idempotent Instance erasure.

normalize(value)

Normalizes the journal configurations accepted by the runtime.

Types

config()

@type config() :: module() | {module(), keyword()} | keyword() | false | nil

normalized()

@type normalized() :: nil | {module(), keyword()}

Callbacks

append(t, keyword)

@callback append(
  Spectre.Journal.Record.t(),
  keyword()
) :: :ok | {:ok, term()} | {:error, term()}

erase_instance(t, keyword)

(optional)

@callback erase_instance(
  Spectre.Instance.Ref.t(),
  keyword()
) :: {:ok, :erased | :already_erased} | {:error, term()}

Functions

erase_instance(store, ref, opts)

@spec erase_instance(normalized(), Spectre.Instance.Ref.t(), keyword()) ::
  {:ok, :erased | :already_erased | :not_configured} | {:error, term()}

Erases all journal records bound to one exact Instance Ref.

erasure_capability(arg1)

@spec erasure_capability(normalized()) :: :ok | {:error, term()}

Checks whether a configured journal supports idempotent Instance erasure.

normalize(value)

@spec normalize(config()) :: {:ok, normalized()} | {:error, term()}

Normalizes the journal configurations accepted by the runtime.