/ /

Quick Reference Syntax Examples

On this page, you can see examples that use the Rust driver to perform several common MongoDB tasks. Each row of the following table describes the task, shows the driver syntax to execute the task, and includes links to the related reference and API documentation.

The Rust driver offers an asynchronous runtime for executing async applications. Additionally, the driver supports a blocking synchronous runtime. For each MongoDB task listed in the following table, you can see examples that use both the asynchronous and synchronous APIs.

Tip

To learn more about asynchronous and synchronous runtimes, see the Asynchronous and Synchronous APIs guide.

Command

Syntax

Find a Document

API Documentation
Find Documents

Async Runtime

let result = collection.find_one(doc! { "title": "Peter Pan" }).await?;

Sync Runtime

let result = collection.find_one(doc! { "title": "Peter Pan" }).run()?;

Find Multiple Documents

API Documentation
Find Documents

Async Runtime

let filter = doc! { "year": 1925 };
let mut cursor = collection.find(filter).await?;

Sync Runtime

let filter = doc! { "year": 1925 };
let mut cursor = collection.find(filter).run()?;

Insert a Document

API Documentation
Insert Documents Guide

Async Runtime

let doc = doc! {
    "title": "Mistress America", "type": "movie"
};
let result = collection.insert_one(doc).await?;

Sync Runtime

let doc = doc! {
    "title": "Mistress America", "type": "movie"
};
let result = collection.insert_one(doc).run()?;

Insert Multiple Documents

API Documentation
Insert Documents Guide

Async Runtime

let docs = vec![
    doc! { "title": "Friends With Money", "runtime": 88 },
    doc! { "title": "Please Give", "runtime": 90 },
    doc! { "title": "You Hurt My Feelings", "runtime": 93 },
];
let result = collection.insert_many(docs).await?;

Sync Runtime

let docs = vec![
    doc! { "title": "Friends With Money", "runtime": 88 },
    doc! { "title": "Please Give", "runtime": 90 },
    doc! { "title": "You Hurt My Feelings", "runtime": 93 },
];
let result = collection.insert_many(docs).run()?;

Update a Document

API Documentation
Update Documents Guide

Async Runtime

let filter = doc! { "title": "Burn After Reading"};
let update = doc! {
        "$set": doc!{ "num_mflix_comments": 1 }
};
let result = collection.update_one(filter, update).await?;

Sync Runtime

let filter = doc! { "title": "Burn After Reading"};
let update = doc! {
        "$set": doc!{ "num_mflix_comments": 1 }
};
let result = collection.update_one(filter, update).run()?;

Update Multiple Documents

API Documentation
Update Documents Guide

Async Runtime

let filter = doc! { "rated": "PASSED"};
let update = doc! {
        "$set": doc!{ "rated": "Not Rated" }
};
let result = collection.update_many(filter, update).await?;

Sync Runtime

let filter = doc! { "rated": "PASSED"};
let update = doc! {
        "$set": doc!{ "rated": "Not Rated" }
};
let result = collection.update_many(filter, update).run()?;

Replace a Document

API Documentation
Replace Documents Guide

Async Runtime

let filter = doc! { "title": "è Nous la Libertè" };
let replacement = doc! {
    "title": "À nous la liberté",
    "type": "movie",
    "directors": vec! [ "René Clair" ]
};
let result = collection.replace_one(filter, replacement).await?;

Sync Runtime

let filter = doc! { "title": "è Nous la Libertè" };
let replacement = doc! {
    "title": "À nous la liberté",
    "type": "movie",
    "directors": vec! [ "René Clair" ]
};
let result = collection.replace_one(filter, replacement).run()?;

Delete a Document

API Documentation
Delete Documents Guide

Async Runtime

let filter = doc! { "title": "Search and Destroy" };
let result = collection.delete_one(filter).await?;

Sync Runtime

let filter = doc! { "title": "Search and Destroy" };
let result = collection.delete_one(filter).run()?;

Delete Multiple Documents

API Documentation
Delete Documents Guide

Async Runtime

let filter = doc! {
    "year": doc! { "$lt": 1920 }
};
let result = collection.delete_many(filter).await?;

Sync Runtime

let filter = doc! {
    "year": doc! { "$lt": 1920 }
};
let result = collection.delete_many(filter).run()?;

Access Data from a Cursor Iteratively

API Documentation
Access Data from a Cursor Guide

Async Runtime

let mut cursor = collection
    .find(doc! { "$and": vec!
    [
        doc! { "metacritic": doc! { "$gt": 90 } },
        doc! { "directors": vec! [ "Martin Scorsese" ] }
    ] })
    .await?;
while let Some(result) = cursor.try_next().await? {
    println!("{}", result);
}

Sync Runtime

let cursor = collection
    .find(doc! { "$and": vec!
    [
        doc! { "metacritic": doc! { "$gt": 90 } },
        doc! { "directors": vec! [ "Martin Scorsese" ] }
    ] })
    .run()?;
for result in cursor {
    println!("{}", result?);
}

Access Data from a Cursor as an Array

API Documentation
Access Data from a Cursor Guide

Async Runtime

let cursor = collection.find(doc! { "title": "Secrets & Lies" }).await?;
let results: Vec<Document> = cursor.try_collect().await?;

Sync Runtime

let cursor = collection.find(doc! { "title": "Secrets & Lies" }).run()?;
let results: Vec<Result<Document>> = cursor.collect();

Count Documents

API Documentation
Count Documents Guide

Async Runtime

let filter = doc! {
    "languages": vec! [ "Mandarin" ]
};
let result = collection.count_documents(filter).await?;

Sync Runtime

let filter = doc! {
    "languages": vec! [ "Mandarin" ]
};
let result = collection.count_documents(filter).run()?;

List Distinct Values of a Field

API Documentation
Distinct Field Values Guide

Async Runtime

let field_name = "title";
let filter = doc! {
    "directors": vec! [ "Sean Baker" ]
};
let results = collection.distinct(field_name, filter).await?;

Sync Runtime

let field_name = "title";
let filter = doc! {
    "directors": vec! [ "Sean Baker" ]
};
let results = collection.distinct(field_name, filter).run()?;

Limit the Number of Documents Retrieved

API Documentation
Specify Documents Guide

Async Runtime

let filter = doc! { "awards.wins": 25};
let mut cursor = collection.find(filter).limit(5).await?;

Sync Runtime

let filter = doc! { "awards.wins": 25};
let mut cursor = collection.find(filter).limit(5).run()?;

Skip Retrieved Documents

API Documentation
Specify Documents Guide

Async Runtime

let filter = doc! { "runtime": 100 };
let mut cursor = collection.find(filter).skip(1).await?;

Sync Runtime

let filter = doc! { "runtime": 100 };
let mut cursor = collection.find(filter).skip(1).run()?;

Sort the Documents When Retrieving Them

API Documentation
Specify Documents Guide

Async Runtime

let filter = doc! {
    "directors": vec! [ "Nicole Holofcener" ]
};
let mut cursor = collection
    .find(filter)
    .sort(doc! { "imdb.rating": 1 })
    .await?;

Sync Runtime

let filter = doc! {
    "directors": vec! [ "Nicole Holofcener" ]
};
let mut cursor = collection
    .find(filter)
    .sort(doc! { "imdb.rating": 1 })
    .run()?;

Project Document Fields When Retrieving Them

API Documentation
Specify Fields Guide

Async Runtime

let filter = doc! { "year": 2015 };
let mut cursor = collection
    .find(filter)
    .projection(doc! { "title": 1, "metacritic": 1, "_id": 0 })
    .await?;

Sync Runtime

let filter = doc! { "year": 2015 };
let mut cursor = collection
    .find(filter)
    .projection(doc! { "title": 1, "metacritic": 1, "_id": 0 })
    .run()?;

Create an Index

API Documentation
Create Indexes Guide

Async Runtime

let index: IndexModel = IndexModel::builder().keys(doc! { "title": 1 }).build();
let result = collection.create_index(index).await?;

Sync Runtime

let index: IndexModel = IndexModel::builder().keys(doc! { "title": 1 }).build();
let result = collection.create_index(index).run()?;

Back

Upgrade Versions

Operation Error Handling