Packages
reckon_db
5.5.3
5.11.0
5.10.4
5.10.3
5.10.1
5.10.0
5.9.1
5.9.0
5.8.3
5.8.2
5.8.1
5.8.0
5.7.0
5.6.1
5.6.0
5.5.5
5.5.4
5.5.3
5.5.2
5.5.1
5.5.0
5.4.0
5.2.2
5.2.1
5.2.0
5.1.0
5.0.0
4.0.0
3.1.2
3.1.1
3.0.0
2.3.7
2.3.6
2.3.5
2.3.4
2.3.3
2.3.2
2.3.1
2.3.0
2.2.2
2.2.0
2.1.4
2.1.3
2.1.2
2.1.1
2.1.0
2.0.0
1.7.7
1.7.6
1.7.5
1.7.4
1.7.3
1.7.2
1.7.1
1.7.0
1.6.3
1.6.2
1.6.1
1.6.0
1.5.1
1.5.0
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.3
1.3.2
1.3.1
1.3.0
1.2.7
1.2.6
1.2.5
1.2.4
1.2.3
1.2.2
1.2.1
1.2.0
1.1.1
1.1.0
1.0.3
1.0.2
1.0.1
1.0.0
BEAM-native Event Store built on Khepri/Ra with Raft consensus. Event sourcing, persistent subscriptions, snapshots, and automatic cluster formation via UDP multicast discovery. Ships embedded Rust NIFs for 3-15x acceleration of crypto, hashing, compression, aggregation, filter matching, and grap...
Current section
Files
Jump to
Current section
Files
guides/README.md
# reckon-db guides
Developer + operator reference for [reckon-db](../README.md), the BEAM-native
event store built on Khepri/Ra. Each page is self-contained; read by topic or
follow one of the suggested orders below.
## Core event sourcing
| Guide | What it covers |
|---|---|
| [Event Sourcing Paradigms](event_sourcing_paradigms.md) | Entity, relationship, and process-centric modelling; how reckon-db supports each. |
| [Event Sourcing](event_sourcing.md) | Streams, append/read, versioning, optimistic concurrency, event metadata, and the secondary index. |
| [CQRS](cqrs.md) | Command/query separation with reckon-db; building read models from event streams. |
| [Subscriptions](subscriptions.md) | Persistent subscriptions by stream, event type, pattern, and payload; acking and delivery. |
| [Snapshots](snapshots.md) | Aggregate-state snapshots: save, load, load-at-version, and replay acceleration. |
| [Stream Links](stream_links.md) | Linking events across streams and building projection streams. |
| [System Streams](system_streams.md) | The `$` namespace and store-internal system streams. |
| [Temporal Queries](temporal_queries.md) | Time-based reads over event history. |
## DCB and CCC (conditional append)
| Guide | What it covers |
|---|---|
| [Dynamic Consistency Boundaries (DCB)](dcb.md) | Conditional append on a tag-filter context query; tag and `event_type` leaves, boolean algebra, the seven filter shapes. |
| [DCB: Raft Design](dcb_raft_design.md) | Why Raft single-leader serialization makes the DCB primitive sound; index layout and the `try_append` transaction path. |
| [CCC Payload Indexes](ccc.md) | Command Context Consistency: `{payload, Key}` / `{payload_hash, [Keys]}` index declarations, payload filters, and the Horus extraction constraint. |
## Operations
| Guide | What it covers |
|---|---|
| [Configuration](configuration.md) | sys.config / app env: stores, pools, timeouts, telemetry, cluster discovery (multicast + k8s DNS), cluster secret. |
| [Cluster Consistency](cluster_consistency.md) | Split-brain prevention, quorum behaviour, and consistency guarantees. |
| [Memory Pressure](memory_pressure.md) | Memory-pressure monitoring and back-pressure behaviour. |
| [Scavenging](scavenging.md) | Event lifecycle, deleting old events, and the snapshot/replay interaction. |
| [Schema Evolution](schema_evolution.md) | Versioning event shapes and upcasting on read. |
| [Store Inspector](store_inspector.md) | Inspecting a live store's contents and structure. |
## Internals
| Guide | What it covers |
|---|---|
| [Storage Internals](storage_internals.md) | The Khepri on-disk layout, Model C structural aggregate-type namespace, and the write-maintained secondary index. |
## Suggested reading orders
**I am modelling a domain on reckon-db:**
1. [Event Sourcing Paradigms](event_sourcing_paradigms.md)
2. [Event Sourcing](event_sourcing.md)
3. [CQRS](cqrs.md), then [Subscriptions](subscriptions.md) and [Snapshots](snapshots.md)
4. [Schema Evolution](schema_evolution.md) when your events start changing shape
**I need strong consistency across streams (DCB/CCC):**
1. [Dynamic Consistency Boundaries (DCB)](dcb.md)
2. [CCC Payload Indexes](ccc.md)
3. [DCB: Raft Design](dcb_raft_design.md) for the why
**I am operating a reckon-db cluster:**
1. [Configuration](configuration.md)
2. [Cluster Consistency](cluster_consistency.md)
3. [Memory Pressure](memory_pressure.md), [Scavenging](scavenging.md), [Store Inspector](store_inspector.md)
**I want to understand how it stores things:**
1. [Storage Internals](storage_internals.md)
2. [DCB: Raft Design](dcb_raft_design.md)
For the ecosystem map (gater, evoq, gateway, Go client, and more), see the
[Reckon stack](../README.md#reckon-stack) section in the top-level README.