Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kazuma512/sea-orm

SeaORM is a Rust ORM (Object Relational Mapping) library that provides an easy-to-use and efficient API for developers to interact with databases.
https://github.com/kazuma512/sea-orm

database graphql kazuma512 orm rocket rust

Last synced: 16 days ago
JSON representation

SeaORM is a Rust ORM (Object Relational Mapping) library that provides an easy-to-use and efficient API for developers to interact with databases.

Host: GitHub
URL: https://github.com/kazuma512/sea-orm
Owner: kazuma512
License: apache-2.0
Created: 2023-06-22T15:04:34.000Z (over 1 year ago)
Default Branch: master
Last Pushed: 2023-06-22T18:33:53.000Z (over 1 year ago)
Last Synced: 2024-10-25T00:19:00.510Z (about 2 months ago)
Topics: database, graphql, kazuma512, orm, rocket, rust
Language: Rust
Homepage: https://www.sea-ql.org/SeaORM/docs/index/
Size: 5.67 MB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE-APACHE

Awesome Lists containing this project

README

        


  

  
SeaORM


  
🐚 An async & dynamic ORM for Rust




# SeaORM

#### SeaORM is a relational ORM to help you build web services in Rust with the familiarity of dynamic languages.

## Getting Started

[![GitHub stars](https://img.shields.io/github/stars/SeaQL/sea-orm.svg?style=social&label=Star&maxAge=1)](https://github.com/SeaQL/sea-orm/stargazers/)

If you like what we do, consider starring, commenting, sharing and contributing!

[![Discord](https://img.shields.io/discord/873880840487206962?label=Discord)](https://discord.com/invite/uCPdDXzbdv)

Join our Discord server to chat with others in the SeaQL community!

+ [Getting Started](https://www.sea-ql.org/SeaORM/docs/index)

+ [Step-by-step Tutorials](https://www.sea-ql.org/sea-orm-tutorial/)

+ [Cookbook](https://www.sea-ql.org/sea-orm-cookbook/)

+ [Usage Example](https://github.com/SeaQL/sea-orm/tree/master/examples/basic)

Integration examples

+ [Actix v4 Example](https://github.com/SeaQL/sea-orm/tree/master/examples/actix_example)

+ [Actix v3 Example](https://github.com/SeaQL/sea-orm/tree/master/examples/actix3_example)

+ [Axum Example](https://github.com/SeaQL/sea-orm/tree/master/examples/axum_example)

+ [GraphQL Example](https://github.com/SeaQL/sea-orm/tree/master/examples/graphql_example)

+ [jsonrpsee Example](https://github.com/SeaQL/sea-orm/tree/master/examples/jsonrpsee_example)

+ [Poem Example](https://github.com/SeaQL/sea-orm/tree/master/examples/poem_example)

+ [Rocket Example](https://github.com/SeaQL/sea-orm/tree/master/examples/rocket_example)

+ [Salvo Example](https://github.com/SeaQL/sea-orm/tree/master/examples/salvo_example)

+ [Tonic Example](https://github.com/SeaQL/sea-orm/tree/master/examples/tonic_example)

## Features

1. Async

    Relying on [SQLx](https://github.com/launchbadge/sqlx), SeaORM is a new library with async support from day 1.

2. Dynamic

    Built upon [SeaQuery](https://github.com/SeaQL/sea-query), SeaORM allows you to build complex queries without 'fighting the ORM'.

3. Testable

    Use mock connections to write unit tests for your logic.

4. Service Oriented

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

## A quick taste of SeaORM

### Entity

```rust

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 Related for Entity {

    fn to() -> RelationDef {

        Relation::Fruit.def()

    }

}

```

### 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::find_by_id(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 cake_with_fruits: Vec<(cake::Model, Vec)> =

    Cake::find().find_with_related(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 pear = pear.insert(db).await?;

// insert many

Fruit::insert_many([apple, pear]).exec(db).await?;

```

### Update

```rust

use sea_orm::sea_query::{Expr, Value};

let pear: Option = Fruit::find_by_id(1).one(db).await?;

let mut pear: fruit::ActiveModel = pear.unwrap().into();

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

// update one

let pear: fruit::Model = pear.update(db).await?;

// update many: UPDATE "fruit" SET "cake_id" = NULL WHERE "fruit"."name" LIKE '%Apple%'

Fruit::update_many()

    .col_expr(fruit::Column::CakeId, Expr::value(Value::Int(None)))

    .filter(fruit::Column::Name.contains("Apple"))

    .exec(db)

    .await?;

```

### Save

```rust

let banana = fruit::ActiveModel {

    id: NotSet,

    name: Set("Banana".to_owned()),

    ..Default::default()

};

// create, because primary key `id` is `NotSet`

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

// delete one

let orange: Option = Fruit::find_by_id(1).one(db).await?;

let orange: fruit::Model = orange.unwrap();

fruit::Entity::delete(orange.into_active_model())

    .exec(db)

    .await?;

// or simply

let orange: Option = Fruit::find_by_id(1).one(db).await?;

let orange: fruit::Model = orange.unwrap();

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?;

```

## Learn More

1. [Design](https://github.com/SeaQL/sea-orm/tree/master/DESIGN.md)

1. [Architecture](https://www.sea-ql.org/SeaORM/docs/internal-design/architecture/)

1. [Release Model](https://www.sea-ql.org/SeaORM/blog/2021-08-30-release-model)

1. [Change Log](https://github.com/SeaQL/sea-orm/tree/master/CHANGELOG.md)

## Who's using SeaORM?

The following products are powered by SeaORM:

  

    

      

A lightweight web security auditing toolkit

      
The enterprise ready webhooks service

      
A personal search engine

    

  

SeaORM is the foundation of:

+ [StarfishQL](https://github.com/SeaQL/starfish-ql): an experimental graph database

+ [Seaography](https://github.com/SeaQL/seaography): GraphQL framework for SeaORM

For more projects, see [Built with SeaORM](https://github.com/SeaQL/sea-orm/blob/master/COMMUNITY.md#built-with-seaorm).

## License

Licensed under either of

-   Apache License, Version 2.0

    ([LICENSE-APACHE](LICENSE-APACHE) or )

-   MIT license

    ([LICENSE-MIT](LICENSE-MIT) or )

at your option.

## Mascot

A friend of Ferris, Terres the hermit crab is the official mascot of SeaORM. His hobby is collecting shells.