SeaORM

🐚 An async & dynamic ORM for Rust

[![crate](https://img.shields.io/crates/v/sea-orm.svg)](https://crates.io/crates/sea-orm) [![docs](https://docs.rs/sea-orm/badge.svg)](https://docs.rs/sea-orm) [![build status](https://github.com/SeaQL/sea-orm/actions/workflows/rust.yml/badge.svg)](https://github.com/SeaQL/sea-orm/actions/workflows/rust.yml) Built with 🔥 by 🌊🦀🐚

SeaORM

Inspired by ActiveRecord, Eloquent and TypeORM, SeaORM aims to provide you an intuitive and ergonomic API to make working with databases in Rust a first-class experience.

markdown This is an early release of SeaORM, the API is not stable yet.

Features

  1. Async

Relying on SQLx, SeaORM is a new library with async support from day 1.

  1. Dynamic

Built upon SeaQuery, SeaORM allows you to build complex queries without 'fighting the ORM'.

  1. Testable

Use mock connections to write unit tests for your logic.

  1. Service oriented

Quickly build services that join, filter, sort and paginate data in APIs.

A quick taste of SeaORM

Select

```rust // find all models let cakes: Vec = Cake::find().all(db).await?;

// find and filter let chocolate: Vec = Cake::find() .filter(cake::Column::Name.contains("chocolate")) .all(db) .await?;

// find one model let cheese: Option = Cake::findbyid(1).one(db).await?; let cheese: cake::Model = cheese.unwrap();

// find related models (lazy) let fruits: Vec = cheese.find_related(Fruit).all(db).await?;

// find related models (eager) let cakewithfruits: Vec<(cake::Model, Vec)> = Cake::find() .findwithrelated(Fruit) .all(db) .await?;

```

Insert

```rust let apple = fruit::ActiveModel { name: Set("Apple".to_owned()), ..Default::default() // no need to set primary key };

let pear = fruit::ActiveModel { name: Set("Pear".to_owned()), ..Default::default() };

// insert one let res: InsertResult = Fruit::insert(pear).exec(db).await?;

println!("InsertResult: {}", res.lastinsertid);

// insert many Fruit::insert_many(vec![apple, pear]).exec(db).await?; ```

Update

```rust use seaorm::seaquery::{Expr, Value};

let pear: Option = Fruit::findbyid(1).one(db).await?; let mut pear: fruit::ActiveModel = pear.unwrap().into();

pear.name = Set("Sweet pear".to_owned());

// update one let pear: fruit::ActiveModel = Fruit::update(pear).exec(db).await?;

// update many: UPDATE "fruit" SET "cakeid" = NULL WHERE "fruit"."name" LIKE '%Apple%' Fruit::updatemany() .col_expr(fruit::Column::CakeId, Expr::value(Value::Null)) .filter(fruit::Column::Name.contains("Apple")) .exec(db) .await?;

```

Save

```rust let banana = fruit::ActiveModel { id: Unset(None), name: Set("Banana".to_owned()), ..Default::default() };

// create, because primary key id is Unset let mut banana = banana.save(db).await?;

banana.name = Set("Banana Mongo".to_owned());

// update, because primary key id is Set let banana = banana.save(db).await?;

```

Delete

```rust let orange: Option = Fruit::findbyid(1).one(db).await?; let orange: fruit::ActiveModel = orange.unwrap().into();

// delete one fruit::Entity::delete(orange).exec(db).await?; // or simply orange.delete(db).await?;

// delete many: DELETE FROM "fruit" WHERE "fruit"."name" LIKE 'Orange' fruit::Entity::delete_many() .filter(fruit::Column::Name.contains("Orange")) .exec(db) .await?;

```

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.