Ecto query implementations for the Threadline public API.
All functions require an explicit :repo option and return plain lists of
Ecto structs. Database errors propagate as exceptions, matching normal Ecto
repository query behavior.
Timeline filters
timeline/2, timeline_query/1, and Threadline.Export accept the same
filter keyword list. Only these keys are allowed: :repo, :table_schema,
:table, :actor_ref, :from, :to, :correlation_id.
Unknown keys raise ArgumentError (breaking vs
pre-1.0 callers that relied on silent ignores — see CHANGELOG when upgrading).
When :correlation_id is set to a non-empty string (after trimming), results are
limited to changes whose transaction is linked to an audit_actions row with that
correlation_id (strict inner-join semantics; see CHANGELOG). Omit the key to leave
correlation out of the filter.
Use timeline_repo!/2 to resolve :repo from filters and opts with the same
messages as export entrypoints.
See also
Threadline.Export— CSV / JSON export using the same filter vocabulary.audit_changes_for_transaction/2— all changes for oneaudit_transactions.id(transaction drill-down vstimeline/2slices).
Summary
Functions
Returns a keyset page of AuditTransaction records for a given actor, ordered by
occurred_at descending, then id descending.
Returns the latest stored row snapshot for a schema record at or before timestamp.
Returns every %AuditChange{} for a single capture transaction.
Returns one AuditTransaction by id or nil when the row does not exist.
Query returning one row per matching change with change + transaction columns
for export (Threadline.Export).
Returns AuditChange records for a given schema record, ordered by
captured_at descending.
Returns AuditChange records for one schema row using timeline ordering.
Returns one keyset page of row history for a single schema row.
Returns AuditChange records across tables, filtered by the given options,
ordered by captured_at descending, then id descending.
Returns one keyset page of AuditChange records in timeline order.
Builds the shared AuditChange query used by timeline/2 and export.
Resolves Ecto.Repo for timeline/2, export, and related APIs.
Validates row-history helper filters.
Validates that filters contains only timeline filter keys.
Functions
Returns a keyset page of AuditTransaction records for a given actor, ordered by
occurred_at descending, then id descending.
For an anonymous actor, returns every transaction whose actor identity is absent. Anonymous transactions intentionally have no finer-grained actor distinction, so they are equivalent for this query.
Options
:repo— requiredEcto.Repomodule:limit— integer, maximum number of records to return (default 50):after— cursor to fetch older records:before— cursor to fetch newer records:from— inclusive lower bound onoccurred_at:to— inclusive upper bound onoccurred_at
Example
Threadline.actor_history(actor_ref, repo: MyApp.Repo)
Returns the latest stored row snapshot for a schema record at or before timestamp.
Returns {:ok, map} when the latest matching snapshot is an insert/update row,
{:error, :deleted_record} when the latest snapshot is a delete, and
{:error, :before_audit_horizon} when the row has no snapshot at or before the
requested timestamp.
@spec audit_changes_for_transaction( term(), keyword() ) :: [ %Threadline.Capture.AuditChange{ __meta__: term(), captured_at: term(), changed_fields: term(), changed_from: term(), data_after: term(), id: term(), op: term(), table_name: term(), table_pk: term(), table_schema: term(), transaction: term(), transaction_id: term() } ]
Returns every %AuditChange{} for a single capture transaction.
transaction_id is audit_transactions.id — the same column as
AuditChange.transaction_id (:binary_id). Accepts UUID strings or 16-byte
binaries per Ecto.UUID.cast/1.
Ordering
Same total order as timeline/2: captured_at descending, then id descending
(via timeline_order/1). Random binary_id values are not a monotonic
sequence; ordering is only defined on (captured_at, id).
Empty results
Returns [] when the UUID is well-formed but no audit_changes rows match
(whether the parent transaction row exists or not).
Options
:repo— requiredEcto.Repomodule (Keyword.fetch!/2if missing).:preload— optional association list forrepo.preload/3when non-empty (intended:[:transaction]).
Errors
Raises ArgumentError with message containing invalid audit transaction id
when transaction_id fails UUID cast (before hitting Postgrex).
@spec audit_transaction( term(), keyword() ) :: %Threadline.Capture.AuditTransaction{ __meta__: term(), action: term(), action_id: term(), actor_ref: term(), changes: term(), id: term(), meta: term(), occurred_at: term(), source: term(), txid: term() } | nil
Returns one AuditTransaction by id or nil when the row does not exist.
Raises ArgumentError when transaction_id is not a valid UUID.
@spec export_changes_query(keyword()) :: Ecto.Query.t()
Query returning one row per matching change with change + transaction columns
for export (Threadline.Export).
Validates filters, then builds the same predicate stack as timeline/2, adds an
optional LEFT JOIN to audit_actions when :correlation_id is absent (so JSON
can surface linked action metadata without changing filter semantics), and selects
export column maps.
@spec export_changes_query(keyword(), keyword()) :: Ecto.Query.t()
Returns AuditChange records for a given schema record, ordered by
captured_at descending.
Options
:repo— requiredEcto.Repomodule
Example
Threadline.history(MyApp.User, user.id, repo: MyApp.Repo)Each AuditChange loads all table columns mapped on the schema, including
changed_from when the database column is populated (no narrowing select).
@spec row_history(module(), term(), keyword(), keyword()) :: [ %Threadline.Capture.AuditChange{ __meta__: term(), captured_at: term(), changed_fields: term(), changed_from: term(), data_after: term(), id: term(), op: term(), table_name: term(), table_pk: term(), table_schema: term(), transaction: term(), transaction_id: term() } ]
Returns AuditChange records for one schema row using timeline ordering.
The helper fixes table_name and primary-key containment internally so callers
do not need to construct low-level row predicates.
@spec row_history_page(module(), term(), keyword(), keyword()) :: Threadline.Query.TimelinePage.t()
Returns one keyset page of row history for a single schema row.
Returns AuditChange records across tables, filtered by the given options,
ordered by captured_at descending, then id descending.
Options
:table— string or atom; filters bytable_name:table_schema— string or atom; filters by captured host table schema:actor_ref—%ActorRef{}; filters by actor via joinedaudit_transactions:from—DateTime; inclusive lower bound oncaptured_at:to—DateTime; inclusive upper bound oncaptured_at:correlation_id— binary; strict filter on linkedAuditAction.correlation_id(see moduledoc / CHANGELOG):repo— requiredEcto.Repomodule (infiltersoropts; seeThreadline.Export):storage_schema— optional Threadline storage schema override
Example
Threadline.timeline(table: "users", from: ~U[2026-01-01 00:00:00Z], repo: MyApp.Repo)See also
Threadline.Export— CSV / JSON export using the same filter vocabulary.Threadline.export_csv/2andThreadline.export_json/2— top-level delegators.
@spec timeline_page(keyword(), keyword()) :: Threadline.Query.TimelinePage.t()
Returns one keyset page of AuditChange records in timeline order.
Paging controls live in opts:
:page_size— positive integer, defaults to1000:cursor—%{captured_at: %DateTime{}, id: binary}ornil
@spec timeline_query(keyword()) :: Ecto.Query.t()
Builds the shared AuditChange query used by timeline/2 and export.
Does not call validate_timeline_filters!/1 — callers must validate first
when accepting external filter lists.
Resolves Ecto.Repo for timeline/2, export, and related APIs.
Checks opts first, then filters. Raises ArgumentError if missing or not an atom module.
@spec validate_row_history_filters!(keyword()) :: :ok
Validates row-history helper filters.
Allowed keys: :repo, :from, :to.
@spec validate_timeline_filters!(keyword()) :: :ok
Validates that filters contains only timeline filter keys.
Allowed keys: :repo, :table_schema, :table,
:actor_ref, :from, :to, :correlation_id.
Returns :ok or raises ArgumentError.