For looking things up. Each page covers one class or one part of the framework: what it does, its methods and settings, and what differs between databases. If you already know what you are looking for, start here.
perform(), its plan, its params and result, blocking or async.
Where perform() stages its changes: add() and update().
Building one, what one transaction per shard means, retries, cross-shard.
The immutable domain object that emits events: #[model], copy(), with_event().
Saved and versioned like a model, but emits no events: #[entity].
The event a model carries: #[model_event], and the row it becomes.
ActionSpec and ActionAssert: run perform() with no database. VirtualClock.
AbstractRepository: the mapping you write; the reads and writes you get; picking a database.
Transactions outside an action: begin(), in_transaction().
ShardIdentifier, ShardedId, the strategies, and the unknown-shard policy.
DataSourceConfig: URLs, logins, pools, driver settings, and TLS.
The ekbatan section: shards, pools, jobs and the event handler, from one JSON file.
Plain SQL files with Flyway names, run by the app: per shard, and without a transaction when asked.
Table definitions generated in build.rs from a migrated throwaway database.
A lock named by a string, in-process or on the database, and how a lease behaves.
The three databases, the column-type cheatsheet, and the UTC rule.
Which framework tables you need, where they live, and how they get into your database.
The outbox: event rows written in the same transaction as each action.
Optional. One delivery row per event and handler: states, retries, handler names.
Optional. One row per distributed job: the slot, the claim, the heartbeat.
ekbatan::blocking and ekbatan::aio: the twins, the runtime under the blocking API, block_on.
OpenTelemetry spans and metrics, and the log targets.
DistributedJob and JobRegistry: background work that runs once per slot across a cluster.
Handling your own events in your own service: the fan-out and handling jobs.