Struct mongodb::Collection [−][src]
pub struct Collection<T = Document> where
T: Serialize + DeserializeOwned + Unpin + Debug, { /* fields omitted */ }
Expand description
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
.
Collection
uses std::sync::Arc
internally,
so it can safely be shared across threads or async tasks. For example:
let coll = client.database("items").collection("in_stock");
for i in 0..5 {
let coll_ref = coll.clone();
task::spawn(async move {
// Perform operations with `coll_ref`. For example:
coll_ref.insert_one(doc! { "x": i }, None).await;
});
}
Implementations
pub fn clone_with_type<U: Serialize + DeserializeOwned + Unpin + Debug>(
&self
) -> Collection<U>
pub fn clone_with_type<U: Serialize + DeserializeOwned + Unpin + Debug>(
&self
) -> Collection<U>
Gets a clone of the Collection
with a different type U
.
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”.
Gets the selection criteria of the Collection
.
Gets the read concern of the Collection
.
Gets the write concern of the Collection
.
Drops the collection, deleting all data and indexes stored in it.
pub async fn aggregate(
&self,
pipeline: impl IntoIterator<Item = Document>,
options: impl Into<Option<AggregateOptions>>
) -> Result<Cursor>
pub async fn aggregate(
&self,
pipeline: impl IntoIterator<Item = Document>,
options: impl Into<Option<AggregateOptions>>
) -> Result<Cursor>
Runs an aggregation operation.
See the documentation here for more information on aggregations.
pub async fn estimated_document_count(
&self,
options: impl Into<Option<EstimatedDocumentCountOptions>>
) -> Result<i64>
pub async fn estimated_document_count(
&self,
options: impl Into<Option<EstimatedDocumentCountOptions>>
) -> Result<i64>
Estimates the number of documents in the collection using collection metadata.
pub async fn count_documents(
&self,
filter: impl Into<Option<Document>>,
options: impl Into<Option<CountOptions>>
) -> Result<i64>
pub async fn count_documents(
&self,
filter: impl Into<Option<Document>>,
options: impl Into<Option<CountOptions>>
) -> Result<i64>
Gets the number of documents matching filter
.
Note that using Collection::estimated_document_count
is recommended instead of this method is most cases.
pub async fn delete_many(
&self,
query: Document,
options: impl Into<Option<DeleteOptions>>
) -> Result<DeleteResult>
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_one(
&self,
query: Document,
options: impl Into<Option<DeleteOptions>>
) -> Result<DeleteResult>
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.
Finds the distinct values of the field specified by field_name
across the collection.
Finds the documents in the collection matching filter
.
Finds a single document in the collection matching filter
.
pub async fn find_one_and_delete(
&self,
filter: Document,
options: impl Into<Option<FindOneAndDeleteOptions>>
) -> Result<Option<T>>
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_replace(
&self,
filter: Document,
replacement: T,
options: impl Into<Option<FindOneAndReplaceOptions>>
) -> Result<Option<T>>
pub async fn find_one_and_replace(
&self,
filter: Document,
replacement: 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_update(
&self,
filter: Document,
update: impl Into<UpdateModifications>,
options: impl Into<Option<FindOneAndUpdateOptions>>
) -> Result<Option<T>>
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 insert_many(
&self,
docs: impl IntoIterator<Item = T>,
options: impl Into<Option<InsertManyOptions>>
) -> Result<InsertManyResult>
pub async fn insert_many(
&self,
docs: impl IntoIterator<Item = T>,
options: impl Into<Option<InsertManyOptions>>
) -> Result<InsertManyResult>
Inserts the data in docs
into the collection.
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: T,
options: impl Into<Option<InsertOneOptions>>
) -> Result<InsertOneResult>
pub async fn insert_one(
&self,
doc: T,
options: impl Into<Option<InsertOneOptions>>
) -> Result<InsertOneResult>
Inserts doc
into the collection.
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: T,
options: impl Into<Option<ReplaceOptions>>
) -> Result<UpdateResult>
pub async fn replace_one(
&self,
query: Document,
replacement: 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 update_many(
&self,
query: Document,
update: impl Into<UpdateModifications>,
options: impl Into<Option<UpdateOptions>>
) -> Result<UpdateResult>
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_one(
&self,
query: Document,
update: impl Into<UpdateModifications>,
options: impl Into<Option<UpdateOptions>>
) -> Result<UpdateResult>
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.
Trait Implementations
Auto Trait Implementations
impl<T = Document> !RefUnwindSafe for Collection<T>
impl<T> Send for Collection<T> where
T: Send,
impl<T> Sync for Collection<T> where
T: Sync,
impl<T> Unpin for Collection<T>
impl<T = Document> !UnwindSafe for Collection<T>
Blanket Implementations
Mutably borrows from an owned value. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more