Struct mongodb::sync::Collection [−][src]
pub struct Collection<T> { /* fields omitted */ }
sync
only.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. For example:
let coll = client.database("items").collection("in_stock");
for i in 0..5 {
let coll_ref = coll.clone();
std::thread::spawn(move || {
// Perform operations with `coll_ref`. For example:
coll_ref.insert_one(doc! { "x": i }, None);
});
}
Implementations
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, users, and indexes stored in it.
pub fn drop_with_session(
&self,
options: impl Into<Option<DropCollectionOptions>>,
session: &mut ClientSession
) -> Result<()>
pub fn drop_with_session(
&self,
options: impl Into<Option<DropCollectionOptions>>,
session: &mut ClientSession
) -> Result<()>
Drops the collection, deleting all data, users, and indexes stored in it using the provided
ClientSession
.
pub fn aggregate(
&self,
pipeline: impl IntoIterator<Item = Document>,
options: impl Into<Option<AggregateOptions>>
) -> Result<Cursor<Document>>
pub 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 fn aggregate_with_session(
&self,
pipeline: impl IntoIterator<Item = Document>,
options: impl Into<Option<AggregateOptions>>,
session: &mut ClientSession
) -> Result<SessionCursor<Document>>
pub 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 fn estimated_document_count(
&self,
options: impl Into<Option<EstimatedDocumentCountOptions>>
) -> Result<u64>
pub fn estimated_document_count(
&self,
options: impl Into<Option<EstimatedDocumentCountOptions>>
) -> Result<u64>
Estimates the number of documents in the collection using collection metadata.
pub fn count_documents(
&self,
filter: impl Into<Option<Document>>,
options: impl Into<Option<CountOptions>>
) -> Result<u64>
pub 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 using Collection::estimated_document_count
is recommended instead of this method is most cases.
pub fn count_documents_with_session(
&self,
filter: impl Into<Option<Document>>,
options: impl Into<Option<CountOptions>>,
session: &mut ClientSession
) -> Result<u64>
pub 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 using Collection::estimated_document_count
is recommended instead of this method is most cases.
pub fn create_index(
&self,
index: IndexModel,
options: impl Into<Option<CreateIndexOptions>>
) -> Result<CreateIndexResult>
pub fn create_index(
&self,
index: IndexModel,
options: impl Into<Option<CreateIndexOptions>>
) -> Result<CreateIndexResult>
Creates the given index on this collection.
pub fn create_index_with_session(
&self,
index: IndexModel,
options: impl Into<Option<CreateIndexOptions>>,
session: &mut ClientSession
) -> Result<CreateIndexResult>
pub 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 fn create_indexes(
&self,
indexes: impl IntoIterator<Item = IndexModel>,
options: impl Into<Option<CreateIndexOptions>>
) -> Result<CreateIndexesResult>
pub fn create_indexes(
&self,
indexes: impl IntoIterator<Item = IndexModel>,
options: impl Into<Option<CreateIndexOptions>>
) -> Result<CreateIndexesResult>
Creates the given indexes on this collection.
pub fn create_indexes_with_session(
&self,
indexes: impl IntoIterator<Item = IndexModel>,
options: impl Into<Option<CreateIndexOptions>>,
session: &mut ClientSession
) -> Result<CreateIndexesResult>
pub 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 fn delete_many(
&self,
query: Document,
options: impl Into<Option<DeleteOptions>>
) -> Result<DeleteResult>
pub fn delete_many(
&self,
query: Document,
options: impl Into<Option<DeleteOptions>>
) -> Result<DeleteResult>
Deletes all documents stored in the collection matching query
.
pub fn delete_many_with_session(
&self,
query: Document,
options: impl Into<Option<DeleteOptions>>,
session: &mut ClientSession
) -> Result<DeleteResult>
pub 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 fn delete_one(
&self,
query: Document,
options: impl Into<Option<DeleteOptions>>
) -> Result<DeleteResult>
pub 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 fn delete_one_with_session(
&self,
query: Document,
options: impl Into<Option<DeleteOptions>>,
session: &mut ClientSession
) -> Result<DeleteResult>
pub 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.
Finds the distinct values of the field specified by field_name
across the collection.
pub 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>>
pub 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 fn update_many(
&self,
query: Document,
update: impl Into<UpdateModifications>,
options: impl Into<Option<UpdateOptions>>
) -> Result<UpdateResult>
pub 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 fn drop_index(
&self,
name: impl AsRef<str>,
options: impl Into<Option<DropIndexOptions>>
) -> Result<()>
pub fn drop_index(
&self,
name: impl AsRef<str>,
options: impl Into<Option<DropIndexOptions>>
) -> Result<()>
Drops the index specified by name
from this collection.
pub fn drop_index_with_session(
&self,
name: impl AsRef<str>,
options: impl Into<Option<DropIndexOptions>>,
session: &mut ClientSession
) -> Result<()>
pub 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
.
Drops all indexes associated with this collection.
pub fn drop_indexes_with_session(
&self,
options: impl Into<Option<DropIndexOptions>>,
session: &mut ClientSession
) -> Result<()>
pub 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 fn list_indexes(
&self,
options: impl Into<Option<ListIndexesOptions>>
) -> Result<Cursor<IndexModel>>
pub fn list_indexes(
&self,
options: impl Into<Option<ListIndexesOptions>>
) -> Result<Cursor<IndexModel>>
Lists all indexes on this collection.
pub fn list_indexes_with_session(
&self,
options: impl Into<Option<ListIndexesOptions>>,
session: &mut ClientSession
) -> Result<SessionCursor<IndexModel>>
pub 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
.
Gets the names of all indexes on the collection.
pub fn list_index_names_with_session(
&self,
session: &mut ClientSession
) -> Result<Vec<String>>
pub 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 fn update_many_with_session(
&self,
query: Document,
update: impl Into<UpdateModifications>,
options: impl Into<Option<UpdateOptions>>,
session: &mut ClientSession
) -> Result<UpdateResult>
pub 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 fn update_one(
&self,
query: Document,
update: impl Into<UpdateModifications>,
options: impl Into<Option<UpdateOptions>>
) -> Result<UpdateResult>
pub 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 fn update_one_with_session(
&self,
query: Document,
update: impl Into<UpdateModifications>,
options: impl Into<Option<UpdateOptions>>,
session: &mut ClientSession
) -> Result<UpdateResult>
pub 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.
Finds the documents in the collection matching filter
.
pub fn find_with_session(
&self,
filter: impl Into<Option<Document>>,
options: impl Into<Option<FindOptions>>,
session: &mut ClientSession
) -> Result<SessionCursor<T>>
pub 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
.
Finds a single document in the collection matching filter
.
pub fn find_one_with_session(
&self,
filter: impl Into<Option<Document>>,
options: impl Into<Option<FindOneOptions>>,
session: &mut ClientSession
) -> Result<Option<T>>
pub 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
.
pub fn find_one_and_delete(
&self,
filter: Document,
options: impl Into<Option<FindOneAndDeleteOptions>>
) -> Result<Option<T>>
pub 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 fn find_one_and_delete_with_session(
&self,
filter: Document,
options: impl Into<Option<FindOneAndDeleteOptions>>,
session: &mut ClientSession
) -> Result<Option<T>>
pub 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 fn find_one_and_update(
&self,
filter: Document,
update: impl Into<UpdateModifications>,
options: impl Into<Option<FindOneAndUpdateOptions>>
) -> Result<Option<T>>
pub 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 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>>
pub 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.
pub fn find_one_and_replace(
&self,
filter: Document,
replacement: T,
options: impl Into<Option<FindOneAndReplaceOptions>>
) -> Result<Option<T>>
pub 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 fn find_one_and_replace_with_session(
&self,
filter: Document,
replacement: T,
options: impl Into<Option<FindOneAndReplaceOptions>>,
session: &mut ClientSession
) -> Result<Option<T>>
pub fn find_one_and_replace_with_session(
&self,
filter: Document,
replacement: 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.
pub fn insert_many(
&self,
docs: impl IntoIterator<Item = impl Borrow<T>>,
options: impl Into<Option<InsertManyOptions>>
) -> Result<InsertManyResult>
pub fn insert_many(
&self,
docs: impl IntoIterator<Item = impl Borrow<T>>,
options: impl Into<Option<InsertManyOptions>>
) -> Result<InsertManyResult>
Inserts the documents 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 fn insert_many_with_session(
&self,
docs: impl IntoIterator<Item = impl Borrow<T>>,
options: impl Into<Option<InsertManyOptions>>,
session: &mut ClientSession
) -> Result<InsertManyResult>
pub 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 documents in docs
into the collection 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 fn insert_one(
&self,
doc: impl Borrow<T>,
options: impl Into<Option<InsertOneOptions>>
) -> Result<InsertOneResult>
pub fn insert_one(
&self,
doc: impl Borrow<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 fn insert_one_with_session(
&self,
doc: impl Borrow<T>,
options: impl Into<Option<InsertOneOptions>>,
session: &mut ClientSession
) -> Result<InsertOneResult>
pub 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
.
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 fn replace_one(
&self,
query: Document,
replacement: impl Borrow<T>,
options: impl Into<Option<ReplaceOptions>>
) -> Result<UpdateResult>
pub 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 fn replace_one_with_session(
&self,
query: Document,
replacement: impl Borrow<T>,
options: impl Into<Option<ReplaceOptions>>,
session: &mut ClientSession
) -> Result<UpdateResult>
pub 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.
Trait Implementations
Auto Trait Implementations
impl<T> !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> where
T: Unpin,
impl<T> !UnwindSafe for Collection<T>
Blanket Implementations
Mutably borrows from an owned value. Read more