模型

模型是一个SQL迁移管理工具。它支持PostgreSQL、MySQL和SQLite。

快速入门

通过运行以下命令安装CLI

$ cargo install models-cli

现在运行以下命令，创建一个环境文件，并设置DATABASE_URL变量

$ echo "DATABASE_URL=sqlite://database.db" > .env

或者也可以使用以下命令将其设置为环境变量

$ export DATABASE_URL=sqlite://database.db

现在我们可以运行以下命令来创建数据库

$ models database create

此命令将创建一个名为database.db的SQLite文件。现在您可以在您的结构上推导出Model特质，而models将为您管理迁移。例如，在src/main.rs中写入

#![allow(dead_code)]
use models::Model; 

#[derive(Model)]
struct Profile {
    #[primary_key]
    id: i32,
    #[unique]
    email: String,
    password: String,
    is_admin: bool,
}

#[derive(Model)]
struct Post {
    #[primary_key]
    id: i32,
    #[foreign_key(Profile.id)]
    author: i32,
    #[default("<Untitled Post>")]
    title: String,
    content: String,
}

#[derive(Model)]
struct PostLike {
    #[foreign_key(Profile.id, on_delete="cascade")]
    #[primary_key(post_id)]
    profile_id: i32,
    #[foreign_key(Post.id, on_delete="cascade")]
    post_id: i32,
}

#[derive(Model)]
struct CommentLike {
    #[foreign_key(Profile.id)]
    #[primary_key(comment_id)]
    profile_id: i32,
    #[foreign_key(Comment.id)]
    comment_id: i32,
    is_dislike: bool,
}

#[derive(Model)]
struct Comment {
    #[primary_key]
    id: i32,
    #[foreign_key(Profile.id)]
    author: i32,
    #[foreign_key(Post.id)]
    post: i32,
}
fn main() {}

如果您现在运行以下命令，您的迁移应该会自动创建。

$ models generate

输出应该如下所示

Generated: migrations/1632280793452 profile
Generated: migrations/1632280793459 post
Generated: migrations/1632280793465 postlike
Generated: migrations/1632280793471 comment
Generated: migrations/1632280793476 commentlike

您可以在migrations/文件夹中查看生成的迁移。要执行这些迁移，您可以执行以下命令

models migrate run

输出应该如下所示

Applied 1631716729974/migrate profile (342.208µs)
Applied 1631716729980/migrate post (255.958µs)
Applied 1631716729986/migrate comment (287.792µs)
Applied 1631716729993/migrate postlike (349.834µs)
Applied 1631716729998/migrate commentlike (374.625µs)

如果我们稍后修改了应用程序中的这些结构，我们可以生成新的迁移来更新表。

撤销迁移

模型可以使用带有-r标志的down迁移。请注意，简单且可逆的迁移不能混合使用

$ models generate -r

要撤销最后执行的迁移，您可以运行

$ models migrate revert

如果您稍后想查看哪些迁移尚未应用，也可以执行

$ models migrate info

必须先撤销已应用的应用迁移，然后才能删除。

可用属性

primary_key

用于标记表的主键。

    #[primary_key]
    id: i32, 

对于具有多列主键的表，使用以下语法

    #[primary_key(second_id)]
    first_id: i32, 
    second_id: i32, 

这相当于

    PRIMARY KEY (first_id, second_id),

foreign_key

用于标记外键约束。

    #[foreign_key(Profile.id)]
    profile: i32, 

它还可以指定on_delete和on_update约束

    #[foreign_key(Profile.id, on_delete="cascade")]
    profile_id: i32, 

这相当于

    FOREIGN KEY (profile_id) REFERENCES profile (id) ON DELETE CASCADE,

default

可以用于设置列的默认值。

    #[default(false)] // when using SQLite use 0 or 1
    is_admin: bool, 
    #[default("")]
    text: String, 
    #[default(0)]
    number: i32, 

unique

用于标记唯一约束。

    #[unique]
    email: String, 

对于多列唯一约束，使用以下语法

    #[unique(post_id)]
    profile_id: String,
    post_id: i32,

这相当于

    UNIQUE (profile_id, post_id),