Skip to main content

Crate sqltrail

Crate sqltrail 

Source
Expand description

单一入口:同时重新导出结构模型、差异/计划 API 与 DbSchema 派生宏。

use sqltrail::{DBSchema, DbSchema};

#[derive(DbSchema)]
#[db_table(schema = "public", name = "users", comment = "用户表")]
struct User {
    #[db_column(primary_key)]
    id: i64,
}

assert_eq!(User::table().name, "users");

Modules§

diff
结构差异计算:比较「期望结构」与「实际结构」,产生 SchemaDiff。
model
结构模型:描述数据库的「期望结构」与「实际结构」。
plan
迁移计划:将 SchemaDiff 转换为有序的迁移操作序列。
validate
结构校验:任何 SchemaModel 的通用一致性检查。

Structs§

ColumnModel
字段(列)模型。
ForeignKeyModel
外键约束模型。
FunctionModel
PostgreSQL 数据库函数。
IndexModel
普通索引模型(不含主键/唯一约束背书的索引)。
MigrationPlan
迁移计划:一组有序的迁移操作。
PrimaryKeyDiff
主键差异。
PrimaryKeyModel
主键约束模型。
SchemaDiff
顶层差异:需要新建的 schema + 各表差异。
SchemaModel
数据库整体结构:schema 列表 + 表列表。
TableModel
单张表的期望/实际结构。
UniqueConstraintModel
唯一约束模型。

Enums§

ColumnDiff
字段级差异类型。
ConstraintDiff
唯一约束差异。
DangerLevel
危险等级。
ForeignKeyDiff
外键差异。
IndexDiff
普通索引差异。
MigrationOperation
单个迁移操作。
TableDiff
单张表的差异类型。

Traits§

DBSchema
所有数据库结构定义都需要实现的统一接口。

Functions§

build_plan
由 SchemaDiff 构建有序的 MigrationPlan。
compute_diff
计算期望结构与实际结构之间的全部差异。
normalize_identity_arguments
归一化函数 identity arguments 中无意义的空白。
validate
校验结构模型,返回 Ok(()) 或全部错误列表。

Derive Macros§

DbSchema
派生数据库结构模型。