API Reference Scriba v#0.1.0

Copy Markdown View Source

Modules

Public API surface for Scriba projections.

Raised in a source's producer process when a batch failed to commit.

Per-projection failure state that has to outlive the producer.

Helpers for the scriba_dead_letters table — failed events recorded for later inspection or replay.

The unit of data that flows from a Scriba.Source through the engine to a Scriba.Target.

Classifies a failed commit into one of three kinds, so the engine can pick a response that terminates.

Snapshot of a projection's runtime state, returned by Scriba.info/2.

Ecto migration helpers users invoke from their own migration files.

Routes events to workers by hashing stream_id.

Per-stream position tracking helpers — pure functions, no process.

Behaviour + use macro for the user-facing projection module.

Behaviour for event sources.

Broadway producer that subscribes to a Commanded event store and yields events as %Scriba.Event{}-wrapped Broadway.Messages.

Behaviour for read-model targets.

Postgres-backed read-model target.

In-memory Scriba.Target for property tests and user-facing test helpers.

Catalog of telemetry events emitted by Scriba.