Hindsight: Type-Safe Event Sourcing Documentation

Welcome to Hindsight, a type-safe event sourcing system implemented in Haskell. Hindsight provides strong compile-time guarantees for event handling, versioning, and consistency in event-driven applications with multiple storage backends.

Overview

Hindsight provides type-safe event sourcing with:

• Compile-time event versioning and automatic upgrades

• Multiple storage backends (Memory, Filesystem, PostgreSQL)

• Backend-agnostic projections for building read models

• Real-time event subscriptions with pattern matching

See Introduction to Hindsight for detailed feature descriptions.

Documentation Contents

Introduction

• Introduction to Hindsight
  • What is Event Sourcing?
  • The Schema Evolution Challenge
  • Hindsight’s Approach
  • Core Features
  • Example: Basic Event Definition
  • Project Status
  • When to Use Hindsight
  • Getting Started
  • Further Reading
• Installation
  • Quick Start (Choose Your Path)
  • Prerequisites
  • Adding to Your Project
  • PostgreSQL Setup
  • Development Setup
  • Next Steps

Tutorials

• Tutorials
  • 1. Getting Started with Hindsight
  • 2. In-Memory Projections
  • 3. PostgreSQL Projections
  • 4. Event Versioning
  • 5. Consistency Patterns
  • 6. Backend-Agnostic Code
  • 7. Advanced PostgreSQL Features
  • 8. Multi-Stream Consistency

API Reference

• API Reference
  • Package Documentation
  • Generating API Documentation
  • Key API Modules by Package
  • Architecture Notes
  • Online Documentation

Development

• Building Hindsight
• Testing Guide
• Contributing to Hindsight

Quick Start

Check out our Getting Started with Hindsight to begin using Hindsight in your project.

For installation instructions and development setup, see Building Hindsight.

Community

• Issues: Report bugs and request features on our issue tracker

• Discussions: Join the community discussions

• Contributing: See our Contributing to Hindsight guide

Indices and tables

• Index

• Module Index

• Search Page