caisin/sea-orm
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #121 from SeaQL/fmt-doc-comments

Browse Source 
cargo fmt doc comments
This commit is contained in:
Billy Chan 2021-09-03 15:00:38 +08:00 committed by GitHub
commit aa15c44942
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 87 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
rustfmt.toml Normal file
View File

@ -0,0 +1 @@
format_code_in_doc_comments=true

26
src/entity/base_entity.rs
View File

@ -137,13 +137,18 @@ pub trait EntityTrait: EntityName {
/// assert_eq!( /// assert_eq!(
/// db.into_transaction_log(), /// db.into_transaction_log(),
/// vec![ /// vec![
/// Transaction::from_sql_and_values( /// Transaction::from_sql_and_values(
/// DbBackend::Postgres, r#"SELECT "cake"."id", "cake"."name" FROM "cake" LIMIT $1"#, vec![1u64.into()] /// DbBackend::Postgres,
/// ), /// r#"SELECT "cake"."id", "cake"."name" FROM "cake" LIMIT $1"#,
/// Transaction::from_sql_and_values( /// vec![1u64.into()]
/// DbBackend::Postgres, r#"SELECT "cake"."id", "cake"."name" FROM "cake""#, vec![] /// ),
/// ), /// Transaction::from_sql_and_values(
/// ]); /// DbBackend::Postgres,
/// r#"SELECT "cake"."id", "cake"."name" FROM "cake""#,
/// vec![]
/// ),
/// ]
/// );
/// ``` /// ```
fn find() -> Select<Self> { fn find() -> Select<Self> {
Select::new() Select::new()
@ -186,8 +191,11 @@ pub trait EntityTrait: EntityName {
/// assert_eq!( /// assert_eq!(
/// db.into_transaction_log(), /// db.into_transaction_log(),
/// vec![Transaction::from_sql_and_values( /// vec![Transaction::from_sql_and_values(
/// DbBackend::Postgres, r#"SELECT "cake"."id", "cake"."name" FROM "cake" WHERE "cake"."id" = $1"#, vec![11i32.into()] /// DbBackend::Postgres,
/// )]); /// r#"SELECT "cake"."id", "cake"."name" FROM "cake" WHERE "cake"."id" = $1"#,
/// vec![11i32.into()]
/// )]
/// );
/// ``` /// ```
/// Find by composite key /// Find by composite key
/// ``` /// ```

4
src/entity/column.rs
View File

@ -103,7 +103,7 @@ pub trait ColumnTrait: IdenStatic + Iterable + FromStr {
/// ///
/// assert_eq!( /// assert_eq!(
/// cake::Entity::find() /// cake::Entity::find()
/// .filter(cake::Column::Id.between(2,3)) /// .filter(cake::Column::Id.between(2, 3))
/// .build(DbBackend::MySql) /// .build(DbBackend::MySql)
/// .to_string(), /// .to_string(),
/// "SELECT `cake`.`id`, `cake`.`name` FROM `cake` WHERE `cake`.`id` BETWEEN 2 AND 3" /// "SELECT `cake`.`id`, `cake`.`name` FROM `cake` WHERE `cake`.`id` BETWEEN 2 AND 3"
@ -121,7 +121,7 @@ pub trait ColumnTrait: IdenStatic + Iterable + FromStr {
/// ///
/// assert_eq!( /// assert_eq!(
/// cake::Entity::find() /// cake::Entity::find()
/// .filter(cake::Column::Id.not_between(2,3)) /// .filter(cake::Column::Id.not_between(2, 3))
/// .build(DbBackend::MySql) /// .build(DbBackend::MySql)
/// .to_string(), /// .to_string(),
/// "SELECT `cake`.`id`, `cake`.`name` FROM `cake` WHERE `cake`.`id` NOT BETWEEN 2 AND 3" /// "SELECT `cake`.`id`, `cake`.`name` FROM `cake` WHERE `cake`.`id` NOT BETWEEN 2 AND 3"

76
src/executor/select.rs
View File

@ -290,14 +290,15 @@ where
/// ///
/// # let _: Result<(), DbErr> = smol::block_on(async { /// # let _: Result<(), DbErr> = smol::block_on(async {
/// # /// #
/// let res: Vec<SelectResult> = cake::Entity::find().from_raw_sql( /// let res: Vec<SelectResult> = cake::Entity::find()
/// Statement::from_sql_and_values( /// .from_raw_sql(Statement::from_sql_and_values(
/// DbBackend::Postgres, r#"SELECT "cake"."name", count("cake"."id") AS "num_of_cakes" FROM "cake""#, vec![] /// DbBackend::Postgres,
/// ) /// r#"SELECT "cake"."name", count("cake"."id") AS "num_of_cakes" FROM "cake""#,
/// ) /// vec![],
/// .into_model::<SelectResult>() /// ))
/// .all(&db) /// .into_model::<SelectResult>()
/// .await?; /// .all(&db)
/// .await?;
/// ///
/// assert_eq!( /// assert_eq!(
/// res, /// res,
@ -318,11 +319,12 @@ where
/// ///
/// assert_eq!( /// assert_eq!(
/// db.into_transaction_log(), /// db.into_transaction_log(),
/// vec![ /// vec![Transaction::from_sql_and_values(
/// Transaction::from_sql_and_values( /// DbBackend::Postgres,
/// DbBackend::Postgres, r#"SELECT "cake"."name", count("cake"."id") AS "num_of_cakes" FROM "cake""#, vec![] /// r#"SELECT "cake"."name", count("cake"."id") AS "num_of_cakes" FROM "cake""#,
/// ), /// vec![]
/// ]); /// ),]
/// );
/// ``` /// ```
pub fn into_model<M>(self) -> SelectorRaw<SelectModel<M>> pub fn into_model<M>(self) -> SelectorRaw<SelectModel<M>>
where where
@ -407,22 +409,26 @@ where
/// ///
/// # let _: Result<(), DbErr> = smol::block_on(async { /// # let _: Result<(), DbErr> = smol::block_on(async {
/// # /// #
/// let _: Option<cake::Model> = cake::Entity::find().from_raw_sql( /// let _: Option<cake::Model> = cake::Entity::find()
/// Statement::from_sql_and_values( /// .from_raw_sql(Statement::from_sql_and_values(
/// DbBackend::Postgres, r#"SELECT "cake"."id", "cake"."name" FROM "cake" WHERE "id" = $1"#, vec![1.into()] /// DbBackend::Postgres,
/// ) /// r#"SELECT "cake"."id", "cake"."name" FROM "cake" WHERE "id" = $1"#,
/// ).one(&db).await?; /// vec![1.into()],
/// ))
/// .one(&db)
/// .await?;
/// # /// #
/// # Ok(()) /// # Ok(())
/// # }); /// # });
/// ///
/// assert_eq!( /// assert_eq!(
/// db.into_transaction_log(), /// db.into_transaction_log(),
/// vec![ /// vec![Transaction::from_sql_and_values(
/// Transaction::from_sql_and_values( /// DbBackend::Postgres,
/// DbBackend::Postgres, r#"SELECT "cake"."id", "cake"."name" FROM "cake" WHERE "id" = $1"#, vec![1.into()] /// r#"SELECT "cake"."id", "cake"."name" FROM "cake" WHERE "id" = $1"#,
/// ), /// vec![1.into()]
/// ]); /// ),]
/// );
/// ``` /// ```
pub async fn one(self, db: &DatabaseConnection) -> Result<Option<S::Item>, DbErr> { pub async fn one(self, db: &DatabaseConnection) -> Result<Option<S::Item>, DbErr> {
let row = db.query_one(self.stmt).await?; let row = db.query_one(self.stmt).await?;
@ -442,22 +448,26 @@ where
/// ///
/// # let _: Result<(), DbErr> = smol::block_on(async { /// # let _: Result<(), DbErr> = smol::block_on(async {
/// # /// #
/// let _: Vec<cake::Model> = cake::Entity::find().from_raw_sql( /// let _: Vec<cake::Model> = cake::Entity::find()
/// Statement::from_sql_and_values( /// .from_raw_sql(Statement::from_sql_and_values(
/// DbBackend::Postgres, r#"SELECT "cake"."id", "cake"."name" FROM "cake""#, vec![] /// DbBackend::Postgres,
/// ) /// r#"SELECT "cake"."id", "cake"."name" FROM "cake""#,
/// ).all(&db).await?; /// vec![],
/// ))
/// .all(&db)
/// .await?;
/// # /// #
/// # Ok(()) /// # Ok(())
/// # }); /// # });
/// ///
/// assert_eq!( /// assert_eq!(
/// db.into_transaction_log(), /// db.into_transaction_log(),
/// vec![ /// vec![Transaction::from_sql_and_values(
/// Transaction::from_sql_and_values( /// DbBackend::Postgres,
/// DbBackend::Postgres, r#"SELECT "cake"."id", "cake"."name" FROM "cake""#, vec![] /// r#"SELECT "cake"."id", "cake"."name" FROM "cake""#,
/// ), /// vec![]
/// ]); /// ),]
/// );
/// ``` /// ```
pub async fn all(self, db: &DatabaseConnection) -> Result<Vec<S::Item>, DbErr> { pub async fn all(self, db: &DatabaseConnection) -> Result<Vec<S::Item>, DbErr> {
let rows = db.query_all(self.stmt).await?; let rows = db.query_all(self.stmt).await?;

6
src/lib.rs
View File

@ -77,10 +77,8 @@
//! let fruits: Vec<fruit::Model> = cheese.find_related(Fruit).all(db).await?; //! let fruits: Vec<fruit::Model> = cheese.find_related(Fruit).all(db).await?;
//! //!
//! // find related models (eager) //! // find related models (eager)
//! let cake_with_fruits: Vec<(cake::Model, Vec<fruit::Model>)> = Cake::find() //! let cake_with_fruits: Vec<(cake::Model, Vec<fruit::Model>)> =
//! .find_with_related(Fruit) //! Cake::find().find_with_related(Fruit).all(db).await?;
//! .all(db)
//! .await?;
//! //!
//! # Ok(()) //! # Ok(())
//! # } //! # }

42
src/query/insert.rs
View File

@ -43,11 +43,11 @@ where
/// ///
/// assert_eq!( /// assert_eq!(
/// Insert::one(cake::Model { /// Insert::one(cake::Model {
/// id: 1, /// id: 1,
/// name: "Apple Pie".to_owned(), /// name: "Apple Pie".to_owned(),
/// }) /// })
/// .build(DbBackend::Postgres) /// .build(DbBackend::Postgres)
/// .to_string(), /// .to_string(),
/// r#"INSERT INTO "cake" ("id", "name") VALUES (1, 'Apple Pie')"#, /// r#"INSERT INTO "cake" ("id", "name") VALUES (1, 'Apple Pie')"#,
/// ); /// );
/// ``` /// ```
@ -57,11 +57,11 @@ where
/// ///
/// assert_eq!( /// assert_eq!(
/// Insert::one(cake::ActiveModel { /// Insert::one(cake::ActiveModel {
/// id: Unset(None), /// id: Unset(None),
/// name: Set("Apple Pie".to_owned()), /// name: Set("Apple Pie".to_owned()),
/// }) /// })
/// .build(DbBackend::Postgres) /// .build(DbBackend::Postgres)
/// .to_string(), /// .to_string(),
/// r#"INSERT INTO "cake" ("name") VALUES ('Apple Pie')"#, /// r#"INSERT INTO "cake" ("name") VALUES ('Apple Pie')"#,
/// ); /// );
/// ``` /// ```
@ -79,17 +79,17 @@ where
/// ///
/// assert_eq!( /// assert_eq!(
/// Insert::many(vec![ /// Insert::many(vec![
/// cake::Model { /// cake::Model {
/// id: 1, /// id: 1,
/// name: "Apple Pie".to_owned(), /// name: "Apple Pie".to_owned(),
/// }, /// },
/// cake::Model { /// cake::Model {
/// id: 2, /// id: 2,
/// name: "Orange Scone".to_owned(), /// name: "Orange Scone".to_owned(),
/// } /// }
/// ]) /// ])
/// .build(DbBackend::Postgres) /// .build(DbBackend::Postgres)
/// .to_string(), /// .to_string(),
/// r#"INSERT INTO "cake" ("id", "name") VALUES (1, 'Apple Pie'), (2, 'Orange Scone')"#, /// r#"INSERT INTO "cake" ("id", "name") VALUES (1, 'Apple Pie'), (2, 'Orange Scone')"#,
/// ); /// );
/// ``` /// ```

2
src/query/update.rs
View File

@ -59,7 +59,7 @@ impl Update {
/// Update many ActiveModel /// Update many ActiveModel
/// ///
/// ``` /// ```
/// use sea_orm::{entity::*, query::*, tests_cfg::fruit, sea_query::Expr, DbBackend}; /// use sea_orm::{entity::*, query::*, sea_query::Expr, tests_cfg::fruit, DbBackend};
/// ///
/// assert_eq!( /// assert_eq!(
/// Update::many(fruit::Entity) /// Update::many(fruit::Entity)