capy-db 0.2.0

SeaORM database connections and explicit migrations for Capy.
Documentation
//! SeaORM connection and migration integration.

use capy_core::{AppError, DatabaseSettings, Result};
use sea_orm::{ConnectOptions, Database};
use std::time::Duration;

pub use sea_orm::DatabaseConnection;
pub use sea_orm_migration::{MigrationTrait, MigratorTrait};

/// Connect to the configured database, with SQL logging disabled by default.
pub async fn connect(settings: &DatabaseSettings) -> Result<DatabaseConnection> {
    settings.validate()?;
    let max = if settings.url.starts_with("sqlite:") && settings.url.contains(":memory:") {
        1
    } else {
        settings.max_connections
    };
    let mut options = ConnectOptions::new(&settings.url);
    options
        .max_connections(max)
        .connect_timeout(Duration::from_secs(settings.connect_timeout_seconds))
        .acquire_timeout(Duration::from_secs(settings.connect_timeout_seconds))
        .sqlx_logging(false);
    Database::connect(options)
        .await
        .map_err(AppError::DatabaseConnection)
}

/// Default migrator for applications that have no migrations yet.
pub struct NoMigrations;

#[sea_orm_migration::async_trait::async_trait]
impl MigratorTrait for NoMigrations {
    fn migrations() -> Vec<Box<dyn MigrationTrait>> {
        Vec::new()
    }
}

/// A migration's name and current database status.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct MigrationStatus {
    /// Stable name used in the SeaORM migration ledger.
    pub name: String,
    /// Whether this migration has been applied.
    pub applied: bool,
}

/// List applied and pending migrations using SeaORM's native migration ledger.
pub async fn status<M: MigratorTrait>(db: &DatabaseConnection) -> Result<Vec<MigrationStatus>> {
    use sea_orm_migration::MigrationStatus as Status;
    Ok(M::get_migration_with_status(db)
        .await?
        .into_iter()
        .map(|migration| MigrationStatus {
            name: migration.name().to_owned(),
            applied: migration.status() == Status::Applied,
        })
        .collect())
}