2eda8aa3f2
* Update heck dependency * Fix formatter error * Drop the use of `sea-strum` and depends on the original `strum` with a tailored `EnumIter` provided * fmt * Depends on `strum` 0.23 * Depends on `strum` 0.24 * Source code adapted from https://github.com/Peternator7/strum * Update LICENSE --------- Co-authored-by: Sergei Ivankov <sergeiivankov@pm.me> Co-authored-by: Sergei Ivankov <96142843+sergeiivankov@users.noreply.github.com> Co-authored-by: Chris Tsang <chris.2y3@outlook.com>
364 lines
12 KiB
Rust
364 lines
12 KiB
Rust
#![cfg_attr(docsrs, feature(doc_cfg))]
|
|
#![warn(missing_docs)]
|
|
#![deny(
|
|
missing_debug_implementations,
|
|
clippy::missing_panics_doc,
|
|
clippy::unwrap_used,
|
|
clippy::print_stderr,
|
|
clippy::print_stdout
|
|
)]
|
|
|
|
//! <div align="center">
|
|
//!
|
|
//! <img src="https://www.sea-ql.org/SeaORM/img/SeaORM banner.png"/>
|
|
//!
|
|
//! <h1>SeaORM</h1>
|
|
//!
|
|
//! <h3>🐚 An async & dynamic ORM for Rust</h3>
|
|
//!
|
|
//! [](https://crates.io/crates/sea-orm)
|
|
//! [](https://docs.rs/sea-orm)
|
|
//! [](https://github.com/SeaQL/sea-orm/actions/workflows/rust.yml)
|
|
//!
|
|
//! </div>
|
|
//!
|
|
//! # SeaORM
|
|
//!
|
|
//! #### SeaORM is a relational ORM to help you build web services in Rust with the familiarity of dynamic languages.
|
|
//!
|
|
//! ## Getting Started
|
|
//!
|
|
//! [](https://github.com/SeaQL/sea-orm/stargazers/)
|
|
//! If you like what we do, consider starring, commenting, sharing and contributing!
|
|
//!
|
|
//! [](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
|
|
//! ```
|
|
//! # #[cfg(feature = "macros")]
|
|
//! # mod entities {
|
|
//! # mod fruit {
|
|
//! # use sea_orm::entity::prelude::*;
|
|
//! # #[derive(Clone, Debug, PartialEq, DeriveEntityModel)]
|
|
//! # #[sea_orm(table_name = "fruit")]
|
|
//! # pub struct Model {
|
|
//! # #[sea_orm(primary_key)]
|
|
//! # pub id: i32,
|
|
//! # pub name: String,
|
|
//! # pub cake_id: Option<i32>,
|
|
//! # }
|
|
//! # #[derive(Copy, Clone, Debug, EnumIter, DeriveRelation)]
|
|
//! # pub enum Relation {
|
|
//! # #[sea_orm(
|
|
//! # belongs_to = "super::cake::Entity",
|
|
//! # from = "Column::CakeId",
|
|
//! # to = "super::cake::Column::Id"
|
|
//! # )]
|
|
//! # Cake,
|
|
//! # }
|
|
//! # impl Related<super::cake::Entity> for Entity {
|
|
//! # fn to() -> RelationDef {
|
|
//! # Relation::Cake.def()
|
|
//! # }
|
|
//! # }
|
|
//! # impl ActiveModelBehavior for ActiveModel {}
|
|
//! # }
|
|
//! # mod cake {
|
|
//! 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<super::fruit::Entity> for Entity {
|
|
//! fn to() -> RelationDef {
|
|
//! Relation::Fruit.def()
|
|
//! }
|
|
//! }
|
|
//! # impl ActiveModelBehavior for ActiveModel {}
|
|
//! # }
|
|
//! # }
|
|
//! ```
|
|
//!
|
|
//! ### Select
|
|
//! ```
|
|
//! # use sea_orm::{DbConn, error::*, entity::*, query::*, tests_cfg::*};
|
|
//! # async fn function(db: &DbConn) -> Result<(), DbErr> {
|
|
//! // find all models
|
|
//! let cakes: Vec<cake::Model> = Cake::find().all(db).await?;
|
|
//!
|
|
//! // find and filter
|
|
//! let chocolate: Vec<cake::Model> = Cake::find()
|
|
//! .filter(cake::Column::Name.contains("chocolate"))
|
|
//! .all(db)
|
|
//! .await?;
|
|
//!
|
|
//! // find one model
|
|
//! let cheese: Option<cake::Model> = Cake::find_by_id(1).one(db).await?;
|
|
//! let cheese: cake::Model = cheese.unwrap();
|
|
//!
|
|
//! // find related models (lazy)
|
|
//! let fruits: Vec<fruit::Model> = cheese.find_related(Fruit).all(db).await?;
|
|
//!
|
|
//! // find related models (eager)
|
|
//! let cake_with_fruits: Vec<(cake::Model, Vec<fruit::Model>)> =
|
|
//! Cake::find().find_with_related(Fruit).all(db).await?;
|
|
//!
|
|
//! # Ok(())
|
|
//! # }
|
|
//! ```
|
|
//! ### Insert
|
|
//! ```
|
|
//! # use sea_orm::{DbConn, error::*, entity::*, query::*, tests_cfg::*};
|
|
//! # async fn function(db: &DbConn) -> Result<(), DbErr> {
|
|
//! 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?;
|
|
//! # Ok(())
|
|
//! # }
|
|
//! # async fn function2(db: &DbConn) -> Result<(), DbErr> {
|
|
//! # 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 many
|
|
//! Fruit::insert_many([apple, pear]).exec(db).await?;
|
|
//! # Ok(())
|
|
//! # }
|
|
//! ```
|
|
//! ### Update
|
|
//! ```
|
|
//! # use sea_orm::{DbConn, error::*, entity::*, query::*, tests_cfg::*};
|
|
//! use sea_orm::sea_query::{Expr, Value};
|
|
//!
|
|
//! # async fn function(db: &DbConn) -> Result<(), DbErr> {
|
|
//! let pear: Option<fruit::Model> = 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?;
|
|
//!
|
|
//! # Ok(())
|
|
//! # }
|
|
//! ```
|
|
//! ### Save
|
|
//! ```
|
|
//! # use sea_orm::{DbConn, error::*, entity::*, query::*, tests_cfg::*};
|
|
//! # async fn function(db: &DbConn) -> Result<(), DbErr> {
|
|
//! 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?;
|
|
//!
|
|
//! # Ok(())
|
|
//! # }
|
|
//! ```
|
|
//! ### Delete
|
|
//! ```
|
|
//! # use sea_orm::{DbConn, error::*, entity::*, query::*, tests_cfg::*};
|
|
//! # async fn function(db: &DbConn) -> Result<(), DbErr> {
|
|
//! // delete one
|
|
//! let orange: Option<fruit::Model> = 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::Model> = 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?;
|
|
//!
|
|
//! # Ok(())
|
|
//! # }
|
|
//! ```
|
|
//!
|
|
//! ## 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:
|
|
//!
|
|
//! <table>
|
|
//! <tbody>
|
|
//! <tr>
|
|
//! <td><br><a href="https://caido.io/"><img src="https://www.sea-ql.org/SeaORM/img/other/caido-logo.png" width="250"/></a><br>A lightweight web security auditing toolkit</td>
|
|
//! <td><a href="https://www.svix.com/"><img src="https://www.sea-ql.org/SeaORM/img/other/svix-logo.svg" width="250"/></a><br>The enterprise ready webhooks service</td>
|
|
//! <td><a href="https://www.spyglass.fyi/"><img src="https://www.sea-ql.org/SeaORM/img/other/spyglass-logo.svg" width="250"/></a><br/>A personal search engine</td>
|
|
//! </tr>
|
|
//! </tbody>
|
|
//! </table>
|
|
//!
|
|
//! 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 <http://www.apache.org/licenses/LICENSE-2.0>)
|
|
//! - MIT license
|
|
//! ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)
|
|
//!
|
|
//! 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.
|
|
//!
|
|
//! SeaORM is a community driven project. We welcome you to participate, contribute and together help build Rust's future.
|
|
//!
|
|
//! A big shout out to our contributors:
|
|
//!
|
|
//! [](https://github.com/SeaQL/sea-orm/graphs/contributors)
|
|
//!
|
|
//! ## Mascot
|
|
//!
|
|
//! A friend of Ferris, Terres the hermit crab is the official mascot of SeaORM. His hobby is collecting shells.
|
|
//!
|
|
//! <img alt="Terres" src="https://www.sea-ql.org/SeaORM/img/Terres.png" width="400"/>
|
|
#![doc(
|
|
html_logo_url = "https://raw.githubusercontent.com/SeaQL/sea-query/master/docs/SeaQL icon dark.png"
|
|
)]
|
|
|
|
mod database;
|
|
mod docs;
|
|
mod driver;
|
|
/// Module for the Entity type and operations
|
|
pub mod entity;
|
|
/// Error types for all database operations
|
|
pub mod error;
|
|
/// This module performs execution of queries on a Model or ActiveModel
|
|
mod executor;
|
|
/// Holds types and methods to perform metric collection
|
|
pub mod metric;
|
|
/// Holds types and methods to perform queries
|
|
pub mod query;
|
|
/// Holds types that defines the schemas of an Entity
|
|
pub mod schema;
|
|
#[doc(hidden)]
|
|
#[cfg(all(feature = "macros", feature = "tests-cfg"))]
|
|
pub mod tests_cfg;
|
|
mod util;
|
|
|
|
pub use database::*;
|
|
pub use driver::*;
|
|
pub use entity::*;
|
|
pub use error::*;
|
|
pub use executor::*;
|
|
pub use query::*;
|
|
pub use schema::*;
|
|
|
|
#[cfg(feature = "macros")]
|
|
pub use sea_orm_macros::{
|
|
DeriveActiveEnum, DeriveActiveModel, DeriveActiveModelBehavior, DeriveColumn,
|
|
DeriveCustomColumn, DeriveEntity, DeriveEntityModel, DeriveIntoActiveModel,
|
|
DeriveMigrationName, DeriveModel, DerivePrimaryKey, DeriveRelation, FromJsonQueryResult,
|
|
FromQueryResult,
|
|
};
|
|
|
|
pub use sea_query;
|
|
pub use sea_query::Iden;
|
|
#[cfg(feature = "macros")]
|
|
pub use sea_query::Iden as DeriveIden;
|
|
|
|
pub use sea_orm_macros::EnumIter;
|
|
pub use strum;
|