sqltrail_core/lib.rs
1//! # sqltrail-core
2//!
3//! 纯 Rust 结构模型库:PostgreSQL 数据库迁移工具的运行时核心。
4//!
5//! 职责:
6//! - 定义 [`SchemaModel`] / [`TableModel`] / [`ColumnModel`] 等结构模型;
7//! - 定义约束、索引和外键模型;
8//! - 定义 [`DBSchema`] trait,供 `#[derive(DbSchema)]` 过程宏实现;
9//! - 定义差异类型 [`SchemaDiff`](`diff` 模块);
10//! - 定义迁移操作 [`MigrationOperation`] 与危险等级(`plan` 模块);
11//! - 提供统一结构校验 [`validate()`](`validate` 模块)。
12//!
13//! 本库不包含过程宏(见 `sqltrail-macros`),也不连接数据库(见 `sqltrail-cli`)。
14
15pub mod diff;
16pub mod model;
17pub mod plan;
18pub mod validate;
19
20pub use diff::{
21 ColumnDiff, ConstraintDiff, ForeignKeyDiff, IndexDiff, PrimaryKeyDiff, SchemaDiff, TableDiff,
22 compute_diff,
23};
24pub use model::*;
25pub use plan::{DangerLevel, MigrationOperation, MigrationPlan, build_plan};
26pub use validate::validate;
27
28/// 所有数据库结构定义都需要实现的统一接口。
29///
30/// `#[derive(DbSchema)]` 会为结构体生成 `table()` 实现,
31/// 迁移程序只依赖这个 trait,不需要了解具体业务结构体类型。
32pub trait DBSchema {
33 /// 返回本结构体对应的一张表的期望结构
34 fn table() -> TableModel;
35
36 /// 返回包含单张表的完整 [`SchemaModel`](默认实现)
37 fn schema() -> SchemaModel {
38 SchemaModel::from_tables(vec![Self::table()])
39 }
40}