lenso-postgres-kit 0.1.0

Module-owned PostgreSQL schema lifecycle kit for Lenso applications
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

//! `PostgreSQL` lifecycle support for storage owned by one Lenso Module.
//!
//! This crate deliberately is not a shared State Module, SQL Capability, or
//! repository abstraction. A Module keeps ownership of its data model,
//! migrations, queries, and transaction boundaries. The kit only makes the
//! repetitive `PostgreSQL` schema lifecycle explicit and fail-closed.

mod error;
mod lifecycle;
mod plan;

pub use error::{PostgresKitError, SetupOutcome, UpgradeOutcome};
pub use lifecycle::{OwnedPostgres, SchemaOperator};
pub use plan::{Migration, PlanError, SchemaPlan};

/// Declares immutable migrations whose SQL bodies live in dedicated files.
///
/// Paths are resolved from the owning crate's `CARGO_MANIFEST_DIR`. Keeping the
/// ordered version and stable name explicit makes review and checksum drift
/// behavior unchanged.
///
/// ```ignore
/// use lenso_postgres_kit::{Migration, sql_migrations};
///
/// const MIGRATIONS: &[Migration] = sql_migrations![
///     (1, "create-orders", "migrations/001_create_orders.sql"),
///     (2, "add-order-status", "migrations/002_add_order_status.sql"),
/// ];
/// ```
#[macro_export]
macro_rules! sql_migrations {
    (
        $(
            ($version:literal, $name:literal, $path:literal $(,)?)
        ),+ $(,)?
    ) => {
        &[
            $(
                $crate::Migration::new(
                    $version,
                    $name,
                    include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/", $path)),
                ),
            )+
        ]
    };
}