RustのORMであるSeaORMを使うときのメモ

Daisuke Oku 2022/04/18に更新

仕事ではdieselを使っているが、非同期に対応していないのでsea-ormを使ってみる。

entityを作って、マイグレーションファイルも作るみたいだが、バージョン0.7.0ではそんなことなさそう。
どこかでまとめるためのメモ書き。

Daisuke Oku 2022/04/16

データベースにつなげた。

mod entity;

use std::env;

use dotenv::dotenv;
use sea_orm::Database;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    dotenv().ok();
    let database = env::var("DATABASE_URL")?;
    let _ = Database::connect(database).await?;
    Ok(())
}

Daisuke Oku 2022/04/16に更新

$ sea-orm-cli generate entity

は既存のデータベースからエンティティを作るコマンド。
なので、エンティティは自分でゴリゴリ書く。

$ cargo new entity --lib

でエンティティを作るディレクトリを作成する。

Daisuke Oku 2022/04/16に更新

エンティティを書くには、deriveを使うのと使わないので2種類方法がある。
とりあえずderiveを使う書き方を試す。
ドキュメントから引用すると以下の2つは同じ。

use sea_orm::entity::prelude::*;

#[derive(Clone, Debug, PartialEq, DeriveEntityModel)]
#[sea_orm(table_name = "cake")]
pub struct Model {
    #[sea_orm(primary_key)]
    pub id: i32,
    pub name: String,
}

#[derive(Copy, Clone, Debug, EnumIter, DeriveRelation)]
pub enum Relation {
    #[sea_orm(has_many = "super::fruit::Entity")]
    Fruit,
}

impl ActiveModelBehavior for ActiveModel {}

#[derive(Copy, Clone, Default, Debug, DeriveEntity)]
pub struct Entity;

impl EntityName for Entity {
    fn schema_name(&self) -> Option<&str> {
        None
    }

    fn table_name(&self) -> &str {
        "cake"
    }
}
#[derive(Copy, Clone, Debug, EnumIter, DeriveColumn)]
pub enum Column {
    Id,
    Name,
}

impl ColumnTrait for Column {
    type EntityName = Entity;

    fn def(&self) -> ColumnDef {
        match self {
            Self::Id => ColumnType::Integer.def(),
            Self::Name => ColumnType::String(None).def(),
        }
    }
}
#[derive(Copy, Clone, Debug, EnumIter)]
pub enum Relation {
    Fruit,
}

impl RelationTrait for Relation {
    fn def(&self) -> RelationDef {
        match self {
            Self::Fruit => Entity::has_many(super::fruit::Entity).into(),
        }
    }
}
impl Related<super::fruit::Entity> for Entity {
    fn to() -> RelationDef {
        Relation::Fruit.def()
    }
}

impl Related<super::filling::Entity> for Entity {
    fn to() -> RelationDef {
        super::cake_filling::Relation::Filling.def()
    }

    fn via() -> Option<RelationDef> {
        Some(super::cake_filling::Relation::Cake.def().rev())
    }
}

Daisuke Oku 2022/04/16に更新

deriveを使ってエンティティを書く場合は、primary_key、Relation、ActiveModelBehaviorを書く必要がある。例えばこんな感じ。

use sea_orm::entity::prelude::*;

#[derive(Clone, Debug, PartialEq, DeriveEntityModel)]
#[sea_orm(table_name = "tag")]
pub struct Model {
    #[sea_orm(primary_key, auto_increase = true)]
    pub id: i32,
    pub name: String,
    pub created_at: Date,
    pub updated_at: Date,
}

#[derive(Copy, Clone, Debug, EnumIter, DeriveRelation)]
pub enum Relation {}

impl Related<super::post::Entity> for Entity {
    fn to() -> RelationDef {
        super::post_tag::Relation::Post.def()
    }

    fn via() -> Option<RelationDef> {
        Some(super::post_tag::Relation::Post.def().rev())
    }
}

impl ActiveModelBehavior for ActiveModel {}

Daisuke Oku 2022/04/16に更新

ルートディレクトリで以下のコマンドを叩いて、migrationディレクトリを作る。

$ sea-orm-cli migrate init

./migration/scr/mYYYYMMDD_000001_create_tableに雛形ができる。
以下のように、create_table_from_entityを使うと作成したエンティティを使って、テーブル定義が書ける。

use entity::user::*;
use sea_orm::{DbBackend, Schema};
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> {
        let db_mysql = DbBackend::MySql;
        let schema = Schema::new(db_mysql);
        manager
            .create_table(schema.create_table_from_entity(Entity).to_owned())
            .await
    }

    async fn down(&self, manager: &SchemaManager) -> Result<(), DbErr> {
        manager
            .drop_table(Table::drop().table(Entity).to_owned())
            .await
    }
}

./migration/scr/lib.rsにマイグレーションファイルを追加する。

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

mod m20220416_000001_create_user_table;
mod m20220416_000002_create_post_table;
mod m20220416_000003_create_favorite_table;
mod m20220416_000004_create_tag_table;
mod m20220416_000005_create_post_tag_table;

pub struct Migrator;

#[async_trait::async_trait]
impl MigratorTrait for Migrator {
    fn migrations() -> Vec<Box<dyn MigrationTrait>> {
        vec![
            Box::new(m20220416_000001_create_user_table::Migration),
            Box::new(m20220416_000002_create_post_table::Migration),
            Box::new(m20220416_000003_create_favorite_table::Migration),
            Box::new(m20220416_000004_create_tag_table::Migration),
            Box::new(m20220416_000005_create_post_tag_table::Migration),
        ]
    }
}

ルートディレクトリで以下のコマンドを叩くとデータベースにテーブルが作成される。

$ sea-orm-cli migrate up

Daisuke Oku 2022/04/17

カラムを消すときはsea_queryでsql文を書く。

use entity::user::*;
use sea_schema::migration::prelude::*;

pub struct Migration;

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

#[async_trait::async_trait]
impl MigrationTrait for Migration {
    async fn up(&self, manager: &SchemaManager) -> Result<(), DbErr> {
        manager
            .alter_table(
                sea_query::Table::alter()
                    .table(Entity)
                    .drop_column(Column::Password)
                    .to_owned(),
            )
            .await
    }

    async fn down(&self, manager: &SchemaManager) -> Result<(), DbErr> {
        manager
            .drop_table(Table::drop().table(Entity).to_owned())
            .await
    }
}

Daisuke Oku 2022/04/18

Tableを作るときもsea_queryで書く。
各カラムにつける属性はメゾットチェーンで書く。

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

pub struct Migration;

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

#[derive(sea_query::Iden)]
pub enum User {
    Table,
    Id,
    Name,
    Email,
    Password,
    Enable,
    CreatedAt,
    UpdatedAt,
}

#[async_trait::async_trait]
impl MigrationTrait for Migration {
    async fn up(&self, manager: &SchemaManager) -> Result<(), DbErr> {
        manager
            .create_table(
                sea_query::Table::create()
                    .table(User::Table)
                    .if_not_exists()
                    .col(
                        ColumnDef::new(User::Id)
                            .integer()
                            .not_null()
                            .auto_increment()
                            .primary_key(),
                    )
                    .col(ColumnDef::new(User::Name).string().not_null())
                    .col(ColumnDef::new(User::Email).string().not_null())
                    .col(ColumnDef::new(User::Password).string().not_null())
                    .col(ColumnDef::new(User::Enable).boolean().not_null())
                    .col(ColumnDef::new(User::CreatedAt).date_time().not_null())
                    .col(ColumnDef::new(User::UpdatedAt).date_time().not_null())
                    .to_owned(),
            )
            .await
    }

    async fn down(&self, manager: &SchemaManager) -> Result<(), DbErr> {
        manager
            .drop_table(Table::drop().table(User::Table).to_owned())
            .await
    }
}

Daisuke Oku 2022/04/18に更新

マイグレーションするときにentityディレクトリがないと怒られるので、必ず作る。

$ cargo new entity --lib

Cargo.tomlの[dependencies]を以下のように設定する。

sea-orm = { version = "^0", features = [
  "sqlx-mysql",
  "runtime-actix-rustls",
  "macros",
], default-features = false }

このスクラップは2022/06/08にクローズされました