AshEvents.EventLog.Info (ash_events v0.4.1)

View Source

Introspection helpers for AshEvents.EventLog

Summary

Functions

event_log DSL entities

The value to use when acquiring advisory locks during event inserts. Must be an integer or a list of two 32-bit integers.

The value to use when acquiring advisory locks during event inserts. Must be an integer or a list of two 32-bit integers.

A module with the AshEvents.AdvisoryLockKeyGenerator-behaviour, that is expected to generate advisory lock keys when inserting events.

A module with the AshEvents.AdvisoryLockKeyGenerator-behaviour, that is expected to generate advisory lock keys when inserting events.

A module with the AshEvents.ClearRecords-behaviour, that is expected to clear all records before an event replay.

A module with the AshEvents.ClearRecords-behaviour, that is expected to clear all records before an event replay.

The vault module to use for encrypting and decrypting both the event data and metadata.

The vault module to use for encrypting and decrypting both the event data and metadata.

event_log DSL options

The type of the primary key used by the event log resource. Valid options are :integer and :uuid_v7. Defaults to :integer.

The type of the primary key used by the event log resource. Valid options are :integer and :uuid_v7. Defaults to :integer.

The type of the primary key used by the system, which will be the type of the record_id-field on the events. Defaults to :uuid.

The type of the primary key used by the system, which will be the type of the record_id-field on the events. Defaults to :uuid.

replay_overrides DSL entities

Functions

event_log(dsl_or_extended)

@spec event_log(dsl_or_extended :: module() | map()) :: [struct()]

event_log DSL entities

event_log_advisory_lock_key_default(dsl_or_extended)

@spec event_log_advisory_lock_key_default(dsl_or_extended :: module() | map()) ::
  {:ok, integer() | [integer()]} | :error

The value to use when acquiring advisory locks during event inserts. Must be an integer or a list of two 32-bit integers.

event_log_advisory_lock_key_default!(dsl_or_extended)

@spec event_log_advisory_lock_key_default!(dsl_or_extended :: module() | map()) ::
  (integer() | [integer()]) | no_return()

The value to use when acquiring advisory locks during event inserts. Must be an integer or a list of two 32-bit integers.

event_log_advisory_lock_key_generator(dsl_or_extended)

@spec event_log_advisory_lock_key_generator(dsl_or_extended :: module() | map()) ::
  {:ok, module()} | :error

A module with the AshEvents.AdvisoryLockKeyGenerator-behaviour, that is expected to generate advisory lock keys when inserting events.

event_log_advisory_lock_key_generator!(dsl_or_extended)

@spec event_log_advisory_lock_key_generator!(dsl_or_extended :: module() | map()) ::
  module() | no_return()

A module with the AshEvents.AdvisoryLockKeyGenerator-behaviour, that is expected to generate advisory lock keys when inserting events.

event_log_clear_records_for_replay(dsl_or_extended)

@spec event_log_clear_records_for_replay(dsl_or_extended :: module() | map()) ::
  {:ok, module()} | :error

A module with the AshEvents.ClearRecords-behaviour, that is expected to clear all records before an event replay.

event_log_clear_records_for_replay!(dsl_or_extended)

@spec event_log_clear_records_for_replay!(dsl_or_extended :: module() | map()) ::
  module() | no_return()

A module with the AshEvents.ClearRecords-behaviour, that is expected to clear all records before an event replay.

event_log_cloak_vault(dsl_or_extended)

@spec event_log_cloak_vault(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

The vault module to use for encrypting and decrypting both the event data and metadata.

event_log_cloak_vault!(dsl_or_extended)

@spec event_log_cloak_vault!(dsl_or_extended :: module() | map()) ::
  atom() | no_return()

The vault module to use for encrypting and decrypting both the event data and metadata.

event_log_options(dsl_or_extended)

@spec event_log_options(dsl_or_extended :: module() | map()) :: %{
  required(atom()) => any()
}

event_log DSL options

Returns a map containing the and any configured or default values.

event_log_primary_key_type(dsl_or_extended)

@spec event_log_primary_key_type(dsl_or_extended :: module() | map()) ::
  {:ok, Ash.Type.UUIDv7 | :integer} | :error

The type of the primary key used by the event log resource. Valid options are :integer and :uuid_v7. Defaults to :integer.

event_log_primary_key_type!(dsl_or_extended)

@spec event_log_primary_key_type!(dsl_or_extended :: module() | map()) ::
  (Ash.Type.UUIDv7 | :integer) | no_return()

The type of the primary key used by the event log resource. Valid options are :integer and :uuid_v7. Defaults to :integer.

event_log_record_id_type(dsl_or_extended)

@spec event_log_record_id_type(dsl_or_extended :: module() | map()) ::
  {:ok, any()} | :error

The type of the primary key used by the system, which will be the type of the record_id-field on the events. Defaults to :uuid.

event_log_record_id_type!(dsl_or_extended)

@spec event_log_record_id_type!(dsl_or_extended :: module() | map()) ::
  any() | no_return()

The type of the primary key used by the system, which will be the type of the record_id-field on the events. Defaults to :uuid.

replay_overrides(dsl_or_extended)

@spec replay_overrides(dsl_or_extended :: module() | map()) :: [struct()]

replay_overrides DSL entities