AuditLog.Query (AuditLog v0.1.0)

Composable Ecto queries for audit timelines.

Every helper returns an %Ecto.Query{} and uses occurred_at, id for a deterministic display order. UUID order is only a tie-breaker; it does not imply causality.

All helpers accept:

:order - :desc by default, or :asc
:prefix - optional PostgreSQL schema prefix

Summary

Functions

all(opts \\ [])

Returns the complete event timeline.

between(from, to, opts \\ [])

Filters events to the half-open [from, to) time window.

for_actor(actor, opts \\ [])

Filters the timeline to one actor.

for_actor(type, id, opts)

Filters the timeline to an explicit actor type and identifier.

for_correlation(correlation_id, opts \\ [])

Filters the timeline to one correlation UUID.

for_subject(subject, opts \\ [])

Filters the timeline to one subject.

for_subject(type, id, opts)

Filters the timeline to an explicit subject type and identifier.

Functions

all(opts \\ [])

@spec all(keyword()) :: Ecto.Query.t()

Returns the complete event timeline.

between(from, to, opts \\ [])

@spec between(DateTime.t(), DateTime.t(), keyword()) :: Ecto.Query.t()

Filters events to the half-open [from, to) time window.

Both boundaries must be DateTime values and from must be earlier than to.

for_actor(actor, opts \\ [])

@spec for_actor(
  AuditLog.Actor.t(),
  keyword()
) :: Ecto.Query.t()

Filters the timeline to one actor.

The filter includes both actor type and ID.

for_actor(type, id, opts)

@spec for_actor(String.Chars.t(), String.Chars.t(), keyword()) :: Ecto.Query.t()

Filters the timeline to an explicit actor type and identifier.

The type and ID are normalized in the same way as AuditLog.Actor.new!/3.

for_correlation(correlation_id, opts \\ [])

@spec for_correlation(
  Ecto.UUID.t(),
  keyword()
) :: Ecto.Query.t()

Filters the timeline to one correlation UUID.

for_subject(subject, opts \\ [])

@spec for_subject(
  AuditLog.Subject.t(),
  keyword()
) :: Ecto.Query.t()

Filters the timeline to one subject.

The filter includes both subject type and ID.

for_subject(type, id, opts)

@spec for_subject(String.Chars.t(), String.Chars.t(), keyword()) :: Ecto.Query.t()

Filters the timeline to an explicit subject type and identifier.

The type and ID are normalized in the same way as AuditLog.Subject.new!/3.