gaman-core 0.3.22

Offline core engine for Gaman migrations
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

//! Core schema modeling, lexical diffing, semantic drift, migration planning,
//! replay, clarification, and SQL rendering primitives.
//!
//! Gaman works with three schema sources: authored input, replayed migration
//! state, and live inspected state. Authored input is normalized and lexically
//! diffed against replayed state to generate migrations. Live inspected state is
//! normalized through the selected dialect and semantically drift-diffed against
//! replayed state using dialect comparator callbacks.
//!
//! ```text
//! input Schema -> normalize + prepare(dialect)
//!                         |
//! replayed Schema --------+-> DiffEngine -> raw operations -> Clarifier -> Migration
//!
//! inspected Schema -> normalize_inspected_schema(dialect)
//!                         |
//! replayed Schema --------+-> drift::diff -> VerificationReport
//!
//! VerificationReport -> repair::plan_repair -> repair operations -> SQL
//!
//! Migration replay -> prepare(dialect) -> SqlPlanRenderer + Dialect -> SQL
//! ```
//!
//! `parsers` loads SQL DDL into `Schema`; `offline_planner` owns offline
//! generation; `drift` owns semantic live drift reports; `repair` owns
//! database-I/O-free drift repair planning; `sql_plan` renders forward,
//! rollback, and repair SQL from migrations.

pub mod clarifier;
pub mod column_type;
pub mod dialects;
pub mod diff;
pub mod drift;
pub mod graphs;
pub mod migrations;
pub mod operations;
pub mod parsers;
pub mod repair;
pub mod replay;
#[doc(hidden)]
pub mod sql_plan;
pub mod states;

mod offline_planner;
mod opaque;

pub use dialects::{Dialect, DialectError};
pub use migrations::Migration;
pub use offline_planner::{EmbeddedMigrations, OfflineError, OfflinePlanner};

pub mod schema {
    pub use crate::column_type::{ColumnDesc, ColumnType};
    pub use crate::operations::Operation;
    pub use crate::parsers::ParseError;
    pub use crate::states::{
        Column, ColumnBuilder, ColumnRef, Constraint, ConstraintInput, EnumDef, EnumInput,
        ExtensionDef, ExtensionInput, ForeignKey, FunctionDef, FunctionInput, Index, IndexInput,
        InputSchema, IntoTable, PrimaryKey, ReplayError, Schema, SchemaBuilder, SchemaLoadError,
        SchemaValidationError, Table, TableBuilder, TableInput, TriggerDef, TriggerEvent,
        TriggerInput, TriggerScope, TriggerTiming, ViewDef, ViewInput, Volatility, is_volatile,
        schema_qualified_key,
    };
}