[Rust] SeaORM

Rust에서 쓸만한 SQL 도구가 3개 정도 있는데, 이게 그 중 하나다.
다른 것들로는 sqlx, diesel 정도가 있다.

sqlx 기반이며, Active Record 패턴을 구현하는 ORM 라이브러리다.

기본 설정

디펜던시는 3개쯤은 기본으로 갖고간다 보면 된다.

futures = "0.3.30"
sea-orm = { version = "^0.12.0", features = [ "sqlx-postgres", "runtime-tokio-native-tls", "macros" ] }
tokio = { version = "1.35.1", features = ["full"] }

futures와 비동기 런타임이다.
내 경우에는 postgresql과 tokio를 사용해서 디펜던시가 저렇다.
db는 postgres, mysql, sqlite 정도를 지원하고, 비동기 런타임은 tokio, async-std 정도만 지원한다.

기본 커넥션 설정은 이정도로 하면 된다.

DB 접속 URL을 끼워넣고 옵션 객체 생성, 연결을 시도하면 된다.

핑 찍어서 잘 실행되면 세팅은 잘 된 것이다.

엔티티 만들기

seaorm은 엔티티를 기반으로 모든 데이터를 관리하는 것을 지향한다.

근데 엔티티 정의는 다른 라이브러리들에 비해 좀 장황한 편이다.
그냥 간단한 엔티티 하나만 정의해도

use sea_orm::entity::prelude::*;
#[derive(Clone, Debug, PartialEq, Eq, DeriveEntityModel)]
#[sea_orm(table_name = "student")]
pub struct Model {
    #[sea_orm(primary_key)]
    pub id: i32,
    pub name: String,
    #[sea_orm(column_name = "schoolName")]
    pub school_name: String,
}

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

impl ActiveModelBehavior for ActiveModel {}

이정도는 기본으로 깔고가야한다.
그리고 저 구조체들이 매크로 생성을 통해 기묘하게 결합되어있는 형태라서, 저 세트를 각각 별도의 파일이나 모듈 단위로 격리하는 것을 권장하는 것 같다.

난 일단 원코드로 가겠다.

SeaORM CLI

필수는 아니지만 전용 도구가 또 있다.
마이그레이션 쿼리 작성하고 관리하는 용도인데, Windows에서는 설치가 잘 안되더라.
좀.. 크로스플랫폼하게 만들어주면 안되나?

cargo install sea-orm-cli

설치되면 sea라는 명령으로 실행할 수 있는데

init을 때리면

마이그레이션용 서브프로젝트를 생성한다.
저걸 실행해서 마이그레이션을 돌리라는 의미다.

근데 엔티티에서 자동생성해주거나 그런건 없는거같다... 이런 부분은 디젤이 낫다.

마이그레이션 단위를 추가하려면 generate를 쓰면 된다.

CRUD 돌려보기

seaorm에서 데이터를 어떤 형태로 관리하는지 한번 훑어보자.

데이터의 생성은 이런식으로 할 수 있다.

객체를 생성하고, active 모델로 전환한 다음에 insert 명령을 실행하면 된다.

그럼 이렇게 들어갈 것이다.

수정은 그에 비해 좀 간편한 편이다.

액티브 모델로 생성된 상태에서 Set 등으로 값을 변경하고, 마지막에 update를 치면 변경한 내역들을 실제 DB에 업데이트 치는 형태다.
저기서 model을 생성할때는, primary key를 기준으로 찾기 때문에 다른건 일치하지 않아도 된다.

잘 찾아서 수정해줬다.

조회는 저렇게 하지는 않고, Entity에 달린 정적메서드들을 통해서 조회하는게 보통이다.

그러면 적당히 가져올 것이다.
저 상태에서 뭐 가공이 더 필요하다면 active model로 전환해서 처리를 해주면 된다.

delete도 update와 사용법은 비슷한 편이다.

그냥 날리면 된다.

참조
https://www.sea-ql.org/SeaORM/