Skip to main content

Crate sqltrail_cli

Crate sqltrail_cli 

Source
Expand description

§sqltrail-cli

通用的 PostgreSQL 结构迁移库与命令行工具。

提供完整迁移流水线: 连接数据库 → 读取实际结构 → 与期望结构比较 → 生成迁移计划 → 渲染 SQL → 执行并记录历史。

§作为库使用(可被任意 Rust 项目引用)

ⓘ
use sqltrail_cli::{plan_from_database, SchemaModel, MigrationPlan};

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let client = sqltrail_cli::database::connect("postgres://user:pass@localhost:5432/db").await?;

    // 期望结构来源一:你的 Rust struct(配合 sqltrail-macros 派生宏)
    let desired: SchemaModel = /* User::schema() 或从 JSON 加载 */ SchemaModel::default();

    // 期望结构来源二:加载 SchemaModel JSON 文件(可由 inspect 导出)
    // let desired: SchemaModel = serde_json::from_str(&std::fs::read_to_string("desired.json")?)?;

    let plan: MigrationPlan = plan_from_database(&client, &desired).await?;
    println!("{}", sqltrail_cli::generator::render_plan(&plan));
    Ok(())
}

§作为 CLI 使用

sqltrail-cli status
sqltrail-cli inspect
sqltrail-cli plan --desired desired.json
sqltrail-cli generate add_user_avatar --desired desired.json
sqltrail-cli apply [--allow-destructive]

Modules§

database
数据库连接:sqltrail-cli 是唯一允许连接本地 PostgreSQL 的组件。
diff
结构差异计算:比较「期望结构」与「实际结构」,产生 SchemaDiff。
generator
SQL 生成:把 MigrationPlan 渲染为可审查的 PostgreSQL DDL。
history
迁移文件与历史表管理(实施计划第 8 阶段)。
introspection
结构读取(introspection):从 PostgreSQL 元数据读取实际结构,归一化为 SchemaModel。
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 中无意义的空白。
plan_from_database
便捷入口:读取数据库实际结构,与期望结构比较,返回迁移计划。
validate
校验结构模型,返回 Ok(()) 或全部错误列表。