tork-orm-core 0.1.0

//! Database migrations: revision-based schema changes with up/down.
//!
//! A migration describes a schema change and how to undo it. The
//! [`SchemaManager`] handed to its `up`/`down` offers a fluent, backend-neutral DDL
//! builder; the [`render`] layer turns that into SQL for the active dialect. A
//! migration's rendered DDL is also what a later runner hashes into a stable
//! checksum and applies in revision order.
//!
//! This module is the migration engine; the command-line tooling that scaffolds and
//! drives migrations is separate.
//!
//! # Examples
//!
//! ```
//! use tork_orm_core::dialect::SqliteDialect;
//! use tork_orm_core::migration::{Column, ForeignKey, ForeignKeyAction, SchemaManager};
//!
//! # async fn run() -> tork_orm_core::Result<()> {
//! let dialect = SqliteDialect::new();
//! let mut schema = SchemaManager::collect(&dialect);
//! schema
//!     .create_table("posts")
//!     .column(Column::new("id").bigint().primary_key().auto_increment())
//!     .column(Column::new("user_id").bigint().not_null())
//!     .column(Column::new("title").varchar(255).not_null())
//!     .foreign_key(
//!         ForeignKey::new()
//!             .from("posts", "user_id")
//!             .to("users", "id")
//!             .on_delete(ForeignKeyAction::Cascade),
//!     )
//!     .execute()
//!     .await?;
//! assert!(schema.into_collected()[0].contains("FOREIGN KEY"));
//! # Ok(())
//! # }
//! ```

pub mod checksum;
pub mod ddl;
pub mod files;
pub mod generate;
pub mod introspect;
pub mod registry;
pub mod render;
pub mod runner;
pub mod schema;

mod store;

// `BoxFuture` lives at the crate root so both migrations and transactions share
// the same type alias. Re-export it from this module so the `#[migration]`
// macro (which emits `::tork_orm::migration::BoxFuture`) continues to work.
pub use crate::BoxFuture;

pub use ddl::{
    AlterAction, AlterTable, ColumnSpec, DefaultValue, ForeignKeyAction, ForeignKeySpec, TableDef,
};
pub use crate::index::{IndexColumn, IndexDef, NullsOrder};
pub use files::{head_revision, Applied, FileMigrator, FileStatus};
pub use registry::{boxed, MigrationSet, MigrationTrait, MigrationTransaction};
pub use runner::{MigrationStatus, Migrator, OnMismatch};
pub use schema::{
    Column, CreateTable, CreateTrigger, DropTable, DropTrigger, DynExecutor, ForeignKey,
    SchemaManager, TriggerEvent, TriggerTiming,
};

/// The common imports for writing a migration.
pub mod prelude {
    pub use super::{
        Column, ForeignKey, ForeignKeyAction, SchemaManager, TriggerEvent, TriggerTiming,
    };
    pub use crate::dialect::DialectKind;
    pub use crate::Result;
}