evento-sql-migrator

SQL database migrations for the Evento event sourcing library.

Overview

This crate provides database schema migrations required for storing events and subscriber state in SQL databases. It supports SQLite, MySQL, and PostgreSQL.

Installation

Add to your Cargo.toml:

[dependencies]
evento-sql-migrator = "1.8"

By default, all database backends are enabled. To use only specific databases:

[dependencies]
evento-sql-migrator = { version = "1.8", default-features = false, features = ["postgres"] }

Features

• sqlite - SQLite database support
• mysql - MySQL database support
• postgres - PostgreSQL database support

Usage

use sqlx_migrator::{Migrate, Plan};

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    // Create your database connection pool
    let pool = sqlx::SqlitePool::connect(":memory:").await?;

    // Acquire a connection
    let mut conn = pool.acquire().await?;

    // Create the migrator for your database type
    let migrator = evento_sql_migrator::new::<sqlx::Sqlite>()?;

    // Run all pending migrations
    migrator.run(&mut *conn, &Plan::apply_all()).await?;

    Ok(())
}

When using the main evento crate, the migrator is re-exported:

let migrator = evento::sql_migrator::new::<sqlx::Sqlite>()?;
migrator.run(&mut *conn, &Plan::apply_all()).await?;

Migrations

The crate includes the following migrations:

Database Schema

After running all migrations, the following tables are created:

Event Table

Stores all domain events:

Indexes:

• idx_event_type - On aggregator_type
• idx_event_type_id - On (aggregator_type, aggregator_id)
• idx_event_routing_key_type - On (routing_key, aggregator_type)
• Unique constraint on (aggregator_type, aggregator_id, version)

Subscriber Table

Tracks event subscription progress:

License

See the LICENSE file in the repository root.