源码github地址: seaormdemo

一、下载工具链

sea-orm-cli 是sea-orm 提供的工具链，可通过cargo下载

$ cargo install sea-orm-cli

二、创建项目

$ cargo new seaormdemo

修改Cargo.toml

使用的数据库是mysql sqlx引擎选择sqlx-mysql ，
sea-orm是一个异步orm, async_runtime需要从 runtime-actix-native-tls, runtime-async-std-native-tls,runtime-tokio-native-tls, runtime-actix-rustls, runtime-async-std-rustls, runtime-tokio-rustls 当中选择一个，后续文章中会集成到rocket web框架中去，rocket采用的异步库是 tokio，所以这里选择 runtime-tokio-native-tls, macros使用框架提供的宏

image.png

使用 sea-orm-cli初始化migration

$ sea-orm-cli migrate init 

image.png

将migration引入项目

sea-orm-cli创建的 migration目录是一个crate，需要将migration 作为主项目的一个依赖，或者修改主项目的Cargo.toml 配置 [workspace]管理两个crate,
此处我们将migration作为依赖，修改主项目的Cargo.toml（即 seaormdemo/Cargo.toml）

migration = { path = "migration" }

编辑 migration/src/mxxx_create_table.rs

这是一个迁移文件,使用这个文件创建一个 post表, 包含字段 id,title,text； migration可通过数据库模型 Entity创建，但是目前没有定义Entity,所以，定义一个枚举 Post 作为数据库的基础模型，

use sea_schema::migration::prelude::*;

pub struct Migration;

impl MigrationName for Migration {
    fn name(&self) -> &str {
        "m20220101_000001_create_table"
    }
}

#[async_trait::async_trait]
impl MigrationTrait for Migration {
    async fn up(&self, manager: &SchemaManager) -> Result<(), DbErr> {
        manager.create_table(
            Table::create()
            // 设置表名称，表明即为枚举的名称
            .table(Post::Table)
            .col(ColumnDef::new(Post::Id).integer().primary_key().auto_increment().not_null())
            .col(ColumnDef::new(Post::Title).string().not_null())
            .col(ColumnDef::new(Post::Text).string().not_null())
            .to_owned()).await
    }

    async fn down(&self, manager: &SchemaManager) -> Result<(), DbErr> {
        manager.drop_table(Table::drop()
        .table(Post::Table)
        .to_owned()).await
    }
}
// 创建枚举，实现Iden （Iden 在sea_schema::migration::prelude模块中，开头已经预导入）
#[derive(Iden)]
pub enum Post{
    Table,
    Id,
    Title,
    Text,
}

三、执行迁移

配置数据库链接信息
根目录下创建 .env文件，填写内容

# <数据库类型>://<用户名>:<密码>@<host地址>/<数据库名称>
DATABASE_URL=mysql://root:123456@localhost/seaormdemo

执行迁移有两种方法

1.使用sea-orm-cli

此种方法需要将migration 目录作为独立crate打包为二进制文件运行，需要添加依赖
修改migration/Cargo.toml，[dependencies]下添加依赖

sea-orm = { version = "^0.7.0", feature = ["sqlx-mysql", "runtime-tokio-native-tls", "macros"] }

# 在 seaormdemo/migration/目录下执行
cargo run
# 或
# 在根目录 seaormdemo/下执行 (up 可省略)
sea-orm-cli migration up

image.png