Compound Operations

Modify Find and Delete Behavior

You can optionally modify the behavior of the find_one_and_delete() method by chaining option builder methods to find_one_and_delete(). These builder methods set FindOneAndDeleteOptions struct fields.

The following table describes the options available in FindOneAndDeleteOptions:

The following code shows how to set the comment field by chaining the comment() method to the find_one_and_delete() method:

let res = my_coll.find_one_and_delete(filter)
    .comment(bson!("hello"))
    .await?;

Find and Delete Example

The following example uses the find_one_and_delete() method to match and delete the first document where the value of the age field is less than or equal to 10:

let filter = doc! { "age": doc! { "$lte": 10 } };
let res = my_coll.find_one_and_delete(filter).await?;
println!("Deleted document:\n{:?}", res);

Deleted document:
Some(Document({"_id": ObjectId("..."),
"name": String("Deanna Porowski"), "age": Int32(10), "school":
String("Lakeside Elementary")}))

Modify Find and Update Behavior

You can optionally modify the behavior of the find_one_and_update() method by chaining option builder methods to find_one_and_update(). These builder methods set FindOneAndUpdateOptions struct fields.

The following table describes the options available in FindOneAndUpdateOptions:

The following code shows how to set the comment field by chaining the comment() method to the find_one_and_update() method:

let res = my_coll.find_one_and_update(filter, update)
    .comment(bson!("hello"))
    .await?;

Find and Update Example

This example shows how to perform the following actions:

• Call the find_one_and_update() method

• Pass a query filter to find_one_and_update() that matches a document where the value of school is "Aurora High School"

• Pass an update document to find_one_and_update() that sets the school field to "Durango High School" and increments the age field by 1

• Chain the return_document() method to find_one_and_update() to return the matched document after the update

let filter = doc! { "school": "Aurora High School" };
let update =
    doc! { "$set": doc! { "school": "Durango High School" },
           "$inc": doc! { "age": 1 } };
let res = my_coll.find_one_and_update(filter, update)
    .return_document(ReturnDocument::After)
    .await?;
println!("Updated document:\n{:?}", res);

Updated document:
Some(Document({"_id": ObjectId("..."),
"name": String("Ben Joseph"), "age": Int32(17), "school":
String("Durango High School")}))

Modify Find and Replace Behavior

You can optionally modify the behavior of the find_one_and_replace() method by chaining option builder methods to find_one_and_replace(). These builder methods set FindOneAndReplaceOptions struct fields.

The following table describes the options available in FindOneAndReplaceOptions:

The following code shows how to set the comment field by chaining the comment() method to the find_one_and_replace() method:

let res = my_coll.find_one_and_replace(filter, replacement)
    .comment(bson!("hello"))
    .await?;

Find and Replace Example

This example performs the following actions:

• Calls the find_one_and_replace() method

• Passes a query filter to find_one_and_replace() that matches a document where the value of name includes the string "Johnson"

• Passes a replacement document to find_one_and_replace() that describes a new student

• Chains the return_document() method to find_one_and_replace() to return the document after replacement

• Chains the projection() method to find_one_and_replace()``to project only the ``name and school fields in the output

let filter = doc! { "name": doc! { "$regex": "Johnson" } };
let replacement =
    doc! { "name": "Toby Fletcher", 
           "age": 14,
           "school": "Durango High School" };
let res = my_coll.find_one_and_replace(filter, replacement)
    .return_document(ReturnDocument::After)
    .projection(doc! { "name": 1, "school": 1, "_id": 0 })
    .await?;
println!("Document after replacement:\n{:?}", res);

Document after replacement:
Some(Document({"name": String("Toby Fletcher"), "school":
String("Durango High School")}))

API Documentation

To learn more about the methods and types mentioned in this guide, see the following API documentation:

• find_one_and_delete()

• FindOneAndDeleteOptions

• find_one_and_update()

• FindOneAndUpdateOptions

• ReturnDocument

• find_one_and_replace()

• FindOneAndReplaceOptions