Struct mongodb::Collection

pub struct Collection<T> { /* private fields */ }

Collection is the client-side abstraction of a MongoDB Collection. It can be used to perform collection-level operations such as CRUD operations. A Collection can be obtained through a Database by calling either Database::collection or Database::collection_with_options.

A Collection can be parameterized with any type that implements the Serialize and Deserialize traits from the serde crate. This includes but is not limited to just Document. The various methods that accept or return instances of the documents in the collection will accept/return instances of the generic parameter (e.g. Collection::insert_one accepts it as an argument, Collection::find_one returns an Option of it). It is recommended to define types that model your data which you can parameterize your Collections with instead of Document, since doing so eliminates a lot of boilerplate deserialization code and is often more performant.

Collection uses std::sync::Arc internally, so it can safely be shared across threads or async tasks.

Example

use serde::{Deserialize, Serialize};

/// Define a type that models our data.
#[derive(Clone, Debug, Deserialize, Serialize)]
struct Item {
    id: u32,
}

// Parameterize our collection with the model.
let coll = client.database("items").collection::<Item>("in_stock");

for i in 0..5 {
    let coll_ref = coll.clone();

    // Spawn several tasks that operate on the same collection concurrently.
    task::spawn(async move {
        // Perform operations with `coll_ref` that work with directly our model.
        coll_ref.insert_one(Item { id: i }, None).await;
    });
}

Implementations

impl<T> Collection<T>

pub fn clone_with_type<U>(&self) -> Collection<U>

Gets a clone of the Collection with a different type U.

pub fn client(&self) -> &Client

Get the Client that this collection descended from.

pub fn name(&self) -> &str

Gets the name of the Collection.

pub fn namespace(&self) -> Namespace

Gets the namespace of the Collection.

The namespace of a MongoDB collection is the concatenation of the name of the database containing it, the ‘.’ character, and the name of the collection itself. For example, if a collection named “bar” is created in a database named “foo”, the namespace of the collection is “foo.bar”.

pub fn selection_criteria(&self) -> Option<&SelectionCriteria>

Gets the selection criteria of the Collection.

pub fn read_concern(&self) -> Option<&ReadConcern>

Gets the read concern of the Collection.

pub fn write_concern(&self) -> Option<&WriteConcern>

Gets the write concern of the Collection.

pub async fn drop( &self, options: impl Into<Option<DropCollectionOptions>> ) -> Result<()>

Drops the collection, deleting all data and indexes stored in it.

pub async fn drop_with_session( &self, options: impl Into<Option<DropCollectionOptions>>, session: &mut ClientSession ) -> Result<()>

Drops the collection, deleting all data and indexes stored in it using the provided ClientSession.

pub async fn aggregate( &self, pipeline: impl IntoIterator<Item = Document>, options: impl Into<Option<AggregateOptions>> ) -> Result<Cursor<Document>>

Runs an aggregation operation.

See the documentation here for more information on aggregations.

pub async fn aggregate_with_session( &self, pipeline: impl IntoIterator<Item = Document>, options: impl Into<Option<AggregateOptions>>, session: &mut ClientSession ) -> Result<SessionCursor<Document>>

Runs an aggregation operation using the provided ClientSession.

See the documentation here for more information on aggregations.

pub async fn estimated_document_count( &self, options: impl Into<Option<EstimatedDocumentCountOptions>> ) -> Result<u64>

Estimates the number of documents in the collection using collection metadata.

Due to an oversight in versions 5.0.0 - 5.0.7 of MongoDB, the count server command, which estimatedDocumentCount uses in its implementation, was not included in v1 of the Stable API. Users of the Stable API with estimatedDocumentCount are recommended to upgrade their cluster to 5.0.8+ or set ServerApi::strict to false to avoid encountering errors.

For more information on the behavior of the count server command, see Count: Behavior.

pub async fn count_documents( &self, filter: impl Into<Option<Document>>, options: impl Into<Option<CountOptions>> ) -> Result<u64>

Gets the number of documents matching filter.

Note that this method returns an accurate count.

pub async fn count_documents_with_session( &self, filter: impl Into<Option<Document>>, options: impl Into<Option<CountOptions>>, session: &mut ClientSession ) -> Result<u64>

Gets the number of documents matching filter using the provided ClientSession.

Note that this method returns an accurate count.

pub async fn create_index( &self, index: IndexModel, options: impl Into<Option<CreateIndexOptions>> ) -> Result<CreateIndexResult>

Creates the given index on this collection.

pub async fn create_index_with_session( &self, index: IndexModel, options: impl Into<Option<CreateIndexOptions>>, session: &mut ClientSession ) -> Result<CreateIndexResult>

Creates the given index on this collection using the provided ClientSession.

pub async fn create_indexes( &self, indexes: impl IntoIterator<Item = IndexModel>, options: impl Into<Option<CreateIndexOptions>> ) -> Result<CreateIndexesResult>

Creates the given indexes on this collection.

pub async fn create_indexes_with_session( &self, indexes: impl IntoIterator<Item = IndexModel>, options: impl Into<Option<CreateIndexOptions>>, session: &mut ClientSession ) -> Result<CreateIndexesResult>

Creates the given indexes on this collection using the provided ClientSession.

pub async fn delete_many( &self, query: Document, options: impl Into<Option<DeleteOptions>> ) -> Result<DeleteResult>

Deletes all documents stored in the collection matching query.

pub async fn delete_many_with_session( &self, query: Document, options: impl Into<Option<DeleteOptions>>, session: &mut ClientSession ) -> Result<DeleteResult>

Deletes all documents stored in the collection matching query using the provided ClientSession.

pub async fn delete_one( &self, query: Document, options: impl Into<Option<DeleteOptions>> ) -> Result<DeleteResult>

Deletes up to one document found matching query.

This operation will retry once upon failure if the connection and encountered error support retryability. See the documentation here for more information on retryable writes.

pub async fn delete_one_with_session( &self, query: Document, options: impl Into<Option<DeleteOptions>>, session: &mut ClientSession ) -> Result<DeleteResult>

Deletes up to one document found matching query using the provided ClientSession.

This operation will retry once upon failure if the connection and encountered error support retryability. See the documentation here for more information on retryable writes.

pub async fn distinct( &self, field_name: impl AsRef<str>, filter: impl Into<Option<Document>>, options: impl Into<Option<DistinctOptions>> ) -> Result<Vec<Bson>>

Finds the distinct values of the field specified by field_name across the collection.

pub async fn distinct_with_session( &self, field_name: impl AsRef<str>, filter: impl Into<Option<Document>>, options: impl Into<Option<DistinctOptions>>, session: &mut ClientSession ) -> Result<Vec<Bson>>

Finds the distinct values of the field specified by field_name across the collection using the provided ClientSession.

pub async fn drop_index( &self, name: impl AsRef<str>, options: impl Into<Option<DropIndexOptions>> ) -> Result<()>

Drops the index specified by name from this collection.

pub async fn drop_index_with_session( &self, name: impl AsRef<str>, options: impl Into<Option<DropIndexOptions>>, session: &mut ClientSession ) -> Result<()>

Drops the index specified by name from this collection using the provided ClientSession.

pub async fn drop_indexes( &self, options: impl Into<Option<DropIndexOptions>> ) -> Result<()>

Drops all indexes associated with this collection.

pub async fn drop_indexes_with_session( &self, options: impl Into<Option<DropIndexOptions>>, session: &mut ClientSession ) -> Result<()>

Drops all indexes associated with this collection using the provided ClientSession.

pub async fn list_indexes( &self, options: impl Into<Option<ListIndexesOptions>> ) -> Result<Cursor<IndexModel>>

Lists all indexes on this collection.

pub async fn list_indexes_with_session( &self, options: impl Into<Option<ListIndexesOptions>>, session: &mut ClientSession ) -> Result<SessionCursor<IndexModel>>

Lists all indexes on this collection using the provided ClientSession.

pub async fn list_index_names(&self) -> Result<Vec<String>>

Gets the names of all indexes on the collection.

pub async fn list_index_names_with_session( &self, session: &mut ClientSession ) -> Result<Vec<String>>

Gets the names of all indexes on the collection using the provided ClientSession.

pub async fn update_many( &self, query: Document, update: impl Into<UpdateModifications>, options: impl Into<Option<UpdateOptions>> ) -> Result<UpdateResult>

Updates all documents matching query in the collection.

Both Document and Vec<Document> implement Into<UpdateModifications>, so either can be passed in place of constructing the enum case. Note: pipeline updates are only supported in MongoDB 4.2+. See the official MongoDB documentation for more information on specifying updates.

pub async fn update_many_with_session( &self, query: Document, update: impl Into<UpdateModifications>, options: impl Into<Option<UpdateOptions>>, session: &mut ClientSession ) -> Result<UpdateResult>

Updates all documents matching query in the collection using the provided ClientSession.

Both Document and Vec<Document> implement Into<UpdateModifications>, so either can be passed in place of constructing the enum case. Note: pipeline updates are only supported in MongoDB 4.2+. See the official MongoDB documentation for more information on specifying updates.

pub async fn update_one( &self, query: Document, update: impl Into<UpdateModifications>, options: impl Into<Option<UpdateOptions>> ) -> Result<UpdateResult>

Updates up to one document matching query in the collection.

Both Document and Vec<Document> implement Into<UpdateModifications>, so either can be passed in place of constructing the enum case. Note: pipeline updates are only supported in MongoDB 4.2+. See the official MongoDB documentation for more information on specifying updates.

This operation will retry once upon failure if the connection and encountered error support retryability. See the documentation here for more information on retryable writes.

pub async fn update_one_with_session( &self, query: Document, update: impl Into<UpdateModifications>, options: impl Into<Option<UpdateOptions>>, session: &mut ClientSession ) -> Result<UpdateResult>

Updates up to one document matching query in the collection using the provided ClientSession.

Both Document and Vec<Document> implement Into<UpdateModifications>, so either can be passed in place of constructing the enum case. Note: pipeline updates are only supported in MongoDB 4.2+. See the official MongoDB documentation for more information on specifying updates.

This operation will retry once upon failure if the connection and encountered error support retryability. See the documentation here for more information on retryable writes.

pub async fn watch( &self, pipeline: impl IntoIterator<Item = Document>, options: impl Into<Option<ChangeStreamOptions>> ) -> Result<ChangeStream<ChangeStreamEvent<T>>>

where T: DeserializeOwned + Unpin + Send + Sync,

Starts a new ChangeStream that receives events for all changes in this collection. A ChangeStream cannot be started on system collections.

See the documentation here on change streams.

Change streams require either a “majority” read concern or no read concern. Anything else will cause a server error.

Also note that using a $project stage to remove any of the _id, operationType or ns fields will cause an error. The driver requires these fields to support resumability. For more information on resumability, see the documentation for ChangeStream

If the pipeline alters the structure of the returned events, the parsed type will need to be changed via ChangeStream::with_type.

pub async fn watch_with_session( &self, pipeline: impl IntoIterator<Item = Document>, options: impl Into<Option<ChangeStreamOptions>>, session: &mut ClientSession ) -> Result<SessionChangeStream<ChangeStreamEvent<T>>>

where T: DeserializeOwned + Unpin + Send + Sync,

Starts a new SessionChangeStream that receives events for all changes in this collection using the provided ClientSession. See Client::watch for more information.

pub async fn find( &self, filter: impl Into<Option<Document>>, options: impl Into<Option<FindOptions>> ) -> Result<Cursor<T>>

Finds the documents in the collection matching filter.

pub async fn find_with_session( &self, filter: impl Into<Option<Document>>, options: impl Into<Option<FindOptions>>, session: &mut ClientSession ) -> Result<SessionCursor<T>>

Finds the documents in the collection matching filter using the provided ClientSession.

impl<T> Collection<T>

where T: DeserializeOwned + Unpin + Send + Sync,

pub async fn find_one( &self, filter: impl Into<Option<Document>>, options: impl Into<Option<FindOneOptions>> ) -> Result<Option<T>>

Finds a single document in the collection matching filter.

pub async fn find_one_with_session( &self, filter: impl Into<Option<Document>>, options: impl Into<Option<FindOneOptions>>, session: &mut ClientSession ) -> Result<Option<T>>

Finds a single document in the collection matching filter using the provided ClientSession.

impl<T> Collection<T>

where T: DeserializeOwned,

pub async fn find_one_and_delete( &self, filter: Document, options: impl Into<Option<FindOneAndDeleteOptions>> ) -> Result<Option<T>>

Atomically finds up to one document in the collection matching filter and deletes it.

This operation will retry once upon failure if the connection and encountered error support retryability. See the documentation here for more information on retryable writes.

pub async fn find_one_and_delete_with_session( &self, filter: Document, options: impl Into<Option<FindOneAndDeleteOptions>>, session: &mut ClientSession ) -> Result<Option<T>>

Atomically finds up to one document in the collection matching filter and deletes it using the provided ClientSession.

This operation will retry once upon failure if the connection and encountered error support retryability. See the documentation here for more information on retryable writes.

pub async fn find_one_and_update( &self, filter: Document, update: impl Into<UpdateModifications>, options: impl Into<Option<FindOneAndUpdateOptions>> ) -> Result<Option<T>>

Atomically finds up to one document in the collection matching filter and updates it. Both Document and Vec<Document> implement Into<UpdateModifications>, so either can be passed in place of constructing the enum case. Note: pipeline updates are only supported in MongoDB 4.2+.

This operation will retry once upon failure if the connection and encountered error support retryability. See the documentation here for more information on retryable writes.

pub async fn find_one_and_update_with_session( &self, filter: Document, update: impl Into<UpdateModifications>, options: impl Into<Option<FindOneAndUpdateOptions>>, session: &mut ClientSession ) -> Result<Option<T>>

Atomically finds up to one document in the collection matching filter and updates it using the provided ClientSession. Both Document and Vec<Document> implement Into<UpdateModifications>, so either can be passed in place of constructing the enum case. Note: pipeline updates are only supported in MongoDB 4.2+.

This operation will retry once upon failure if the connection and encountered error support retryability. See the documentation here for more information on retryable writes.

impl<T> Collection<T>

where T: Serialize + DeserializeOwned,

pub async fn find_one_and_replace( &self, filter: Document, replacement: impl Borrow<T>, options: impl Into<Option<FindOneAndReplaceOptions>> ) -> Result<Option<T>>

Atomically finds up to one document in the collection matching filter and replaces it with replacement.

This operation will retry once upon failure if the connection and encountered error support retryability. See the documentation here for more information on retryable writes.

pub async fn find_one_and_replace_with_session( &self, filter: Document, replacement: impl Borrow<T>, options: impl Into<Option<FindOneAndReplaceOptions>>, session: &mut ClientSession ) -> Result<Option<T>>

Atomically finds up to one document in the collection matching filter and replaces it with replacement using the provided ClientSession.

This operation will retry once upon failure if the connection and encountered error support retryability. See the documentation here for more information on retryable writes.

impl<T> Collection<T>

where T: Serialize,

pub async fn insert_many( &self, docs: impl IntoIterator<Item = impl Borrow<T>>, options: impl Into<Option<InsertManyOptions>> ) -> Result<InsertManyResult>

Inserts the data in docs into the collection.

Note that this method accepts both owned and borrowed values, so the input documents do not need to be cloned in order to be passed in.

This operation will retry once upon failure if the connection and encountered error support retryability. See the documentation here for more information on retryable writes.

pub async fn insert_many_with_session( &self, docs: impl IntoIterator<Item = impl Borrow<T>>, options: impl Into<Option<InsertManyOptions>>, session: &mut ClientSession ) -> Result<InsertManyResult>

Inserts the data in docs into the collection using the provided ClientSession.

Note that this method accepts both owned and borrowed values, so the input documents do not need to be cloned in order to be passed in.

This operation will retry once upon failure if the connection and encountered error support retryability. See the documentation here for more information on retryable writes.

pub async fn insert_one( &self, doc: impl Borrow<T>, options: impl Into<Option<InsertOneOptions>> ) -> Result<InsertOneResult>

Inserts doc into the collection.

Note that either an owned or borrowed value can be inserted here, so the input document does not need to be cloned to be passed in.

This operation will retry once upon failure if the connection and encountered error support retryability. See the documentation here for more information on retryable writes.

pub async fn insert_one_with_session( &self, doc: impl Borrow<T>, options: impl Into<Option<InsertOneOptions>>, session: &mut ClientSession ) -> Result<InsertOneResult>

Inserts doc into the collection using the provided ClientSession.

Note that either an owned or borrowed value can be inserted here, so the input document does not need to be cloned to be passed in.

This operation will retry once upon failure if the connection and encountered error support retryability. See the documentation here for more information on retryable writes.

pub async fn replace_one( &self, query: Document, replacement: impl Borrow<T>, options: impl Into<Option<ReplaceOptions>> ) -> Result<UpdateResult>

Replaces up to one document matching query in the collection with replacement.

This operation will retry once upon failure if the connection and encountered error support retryability. See the documentation here for more information on retryable writes.

pub async fn replace_one_with_session( &self, query: Document, replacement: impl Borrow<T>, options: impl Into<Option<ReplaceOptions>>, session: &mut ClientSession ) -> Result<UpdateResult>

Replaces up to one document matching query in the collection with replacement using the provided ClientSession.

This operation will retry once upon failure if the connection and encountered error support retryability. See the documentation here for more information on retryable writes.

impl<T> Collection<T>

pub async fn create_search_index( &self, model: SearchIndexModel, options: impl Into<Option<CreateSearchIndexOptions>> ) -> Result<String>

Convenience method for creating a single search index.

pub async fn create_search_indexes( &self, models: impl IntoIterator<Item = SearchIndexModel>, _options: impl Into<Option<CreateSearchIndexOptions>> ) -> Result<Vec<String>>

Creates multiple search indexes on the collection.

pub async fn update_search_index( &self, name: impl AsRef<str>, definition: Document, _options: impl Into<Option<UpdateSearchIndexOptions>> ) -> Result<()>

Updates the search index with the given name to use the provided definition.

pub async fn drop_search_index( &self, name: impl AsRef<str>, _options: impl Into<Option<DropSearchIndexOptions>> ) -> Result<()>

Drops the search index with the given name.

pub async fn list_search_indexes( &self, name: impl Into<Option<&str>>, aggregation_options: impl Into<Option<AggregateOptions>>, _list_index_options: impl Into<Option<ListSearchIndexOptions>> ) -> Result<Cursor<Document>>

Gets index information for one or more search indexes in the collection.

If name is not specified, information for all indexes on the specified collection will be returned.

Trait Implementations

impl<T> Clone for Collection<T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for Collection<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.