# AuditLog v0.3.1 - Table of Contents

> Explicit semantic audit events for Ecto and PostgreSQL

## Pages

- [AuditLog](readme.md)
- [Temporal subjects](temporal_subjects.md)
- [Limits and operations](limits.md)
- [Changelog](changelog.md)
- [Roadmap](roadmap.md)

## Modules

- [AuditLog](AuditLog.md): Writes explicit semantic audit events through an Ecto repository.

- Value objects
  - [AuditLog.Actor](AuditLog.Actor.md): Represents a durable snapshot of the person or service responsible for an
event.
  - [AuditLog.Context](AuditLog.Context.md): An audit context carries an explicit actor, correlation ID, causation ID, and
shared event metadata.
  - [AuditLog.Subject](AuditLog.Subject.md): Represents a durable subject identity and an optional exact temporal version
boundary.

- Storage
  - [AuditLog.Event](AuditLog.Event.md): Defines the stored representation of one semantic audit event.
  - [AuditLog.Migration](AuditLog.Migration.md): Installs and removes the PostgreSQL objects used by `AuditLog`.
  - [AuditLog.Query](AuditLog.Query.md): Builds composable Ecto queries for audit timelines.

- Exceptions
  - [AuditLog.InvalidValueError](AuditLog.InvalidValueError.md): Describes a rejected value without retaining or printing that value.

## Mix Tasks

- [mix audit_log.gen.migration](Mix.Tasks.AuditLog.Gen.Migration.md): Generates a reversible Ecto migration that installs AuditLog

