Merge pull request #1425 from SeaQL/record_not_updated

RecordNotFound -> RecordNotUpdated

CHANGELOG.md

@@ -63,6 +63,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Breaking changes
 
+* Added to `RecordNotInserted` and `RecordNotUpdated` to `DbErr` 
 * Added `ConnectionTrait::execute_unprepared` method https://github.com/SeaQL/sea-orm/pull/1327
 * As part of https://github.com/SeaQL/sea-orm/pull/1311, the required method of `TryGetable` changed:
 ```rust
@@ -90,6 +91,26 @@ impl ActiveModelBehavior for ActiveModel {
     // ...
 }
 ```
+* `DbErr::RecordNotFound("None of the database rows are affected")` is moved to a dedicated error variant `DbErr::RecordNotUpdated`
+```rust
+let res = Update::one(cake::ActiveModel {
+        name: Set("Cheese Cake".to_owned()),
+        ..model.into_active_model()
+    })
+    .exec(&db)
+    .await;
+
+// then
+assert_eq!(
+    res,
+    Err(DbErr::RecordNotFound(
+        "None of the database rows are affected".to_owned()
+    ))
+);
+
+// now
+assert_eq!(res, Err(DbErr::RecordNotUpdated));
+```
 
 ## 0.10.7 - 2023-01-19
 

src/error.rs

@@ -55,11 +55,14 @@ pub enum DbErr {
     /// A migration error
     #[error("Migration Error: {0}")]
     Migration(String),
-    /// None of the records are being inserted into the database,
-    /// if you insert with upsert expression that means
-    /// all of them conflict with existing records in the database
-    #[error("None of the records are being inserted")]
+    /// None of the records are inserted,
+    /// that probably means all of them conflict with existing records in the table
+    #[error("None of the records are inserted")]
     RecordNotInserted,
+    /// None of the records are updated, that means a WHERE condition has no matches.
+    /// May be the table is empty or the record does not exist
+    #[error("None of the records are updated")]
+    RecordNotUpdated,
 }
 
 /// Runtime error

src/executor/update.rs

@@ -74,9 +74,7 @@ impl Updater {
         let statement = builder.build(&self.query);
         let result = db.execute(statement).await?;
         if self.check_record_exists && result.rows_affected() == 0 {
-            return Err(DbErr::RecordNotFound(
-                "None of the database rows are affected".to_owned(),
-            ));
+            return Err(DbErr::RecordNotUpdated);
         }
         Ok(UpdateResult {
             rows_affected: result.rows_affected(),
@@ -114,9 +112,7 @@ impl Updater {
                 // If we got `None` then we are updating a row that does not exist.
                 match found {
                     Some(model) => Ok(model),
-                    None => Err(DbErr::RecordNotFound(
-                        "None of the database rows are affected".to_owned(),
-                    )),
+                    None => Err(DbErr::RecordNotUpdated),
                 }
             }
             false => {
@@ -216,9 +212,7 @@ mod tests {
             }
             .update(&db)
             .await,
-            Err(DbErr::RecordNotFound(
-                "None of the database rows are affected".to_owned()
-            ))
+            Err(DbErr::RecordNotUpdated)
         );
 
         assert_eq!(
@@ -228,9 +222,7 @@ mod tests {
             })
             .exec(&db)
             .await,
-            Err(DbErr::RecordNotFound(
-                "None of the database rows are affected".to_owned()
-            ))
+            Err(DbErr::RecordNotUpdated)
         );
 
         assert_eq!(
@@ -240,9 +232,7 @@ mod tests {
             })
             .exec(&db)
             .await,
-            Err(DbErr::RecordNotFound(
-                "None of the database rows are affected".to_owned()
-            ))
+            Err(DbErr::RecordNotUpdated)
         );
 
         assert_eq!(

tests/byte_primary_key_tests.rs

@@ -45,12 +45,7 @@ pub async fn create_and_update(db: &DatabaseConnection) -> Result<(), DbErr> {
         .exec(db)
         .await;
 
-    assert_eq!(
-        update_res,
-        Err(DbErr::RecordNotFound(
-            "None of the database rows are affected".to_owned()
-        ))
-    );
+    assert_eq!(update_res, Err(DbErr::RecordNotUpdated));
 
     let update_res = Entity::update(updated_active_model)
         .filter(Column::Id.eq(vec![1_u8, 2_u8, 3_u8])) // annotate it as Vec<u8> explicitly

tests/crud/updates.rs

@@ -121,12 +121,7 @@ pub async fn test_update_deleted_customer(db: &DbConn) {
 
     let customer_update_res = customer.update(db).await;
 
-    assert_eq!(
-        customer_update_res,
-        Err(DbErr::RecordNotFound(
-            "None of the database rows are affected".to_owned()
-        ))
-    );
+    assert_eq!(customer_update_res, Err(DbErr::RecordNotUpdated));
 
     assert_eq!(Customer::find().count(db).await.unwrap(), init_n_customers);
 

tests/string_primary_key_tests.rs

@@ -130,12 +130,7 @@ pub async fn create_and_update_repository(db: &DatabaseConnection) -> Result<(),
         .exec(db)
         .await;
 
-    assert_eq!(
-        update_res,
-        Err(DbErr::RecordNotFound(
-            "None of the database rows are affected".to_owned()
-        ))
-    );
+    assert_eq!(update_res, Err(DbErr::RecordNotUpdated));
 
     let update_res = Repository::update(updated_active_model)
         .filter(repository::Column::Id.eq("unique-id-002".to_owned()))

tests/uuid_tests.rs

@@ -85,12 +85,7 @@ pub async fn create_and_update_metadata(db: &DatabaseConnection) -> Result<(), D
     .exec(db)
     .await;
 
-    assert_eq!(
-        update_res,
-        Err(DbErr::RecordNotFound(
-            "None of the database rows are affected".to_owned()
-        ))
-    );
+    assert_eq!(update_res, Err(DbErr::RecordNotUpdated));
 
     Ok(())
 }