Struct mongodm::Repository

pub struct Repository<M: Model> { /* private fields */ }

Associate a mongodb::Collection and a specific Model.

This type can safely be copied and passed around because std::sync::Arc is used internally. Underlying mongodb::Collection can be retrieved at anytime with Repository::get_underlying.

Implementations

impl<M: Model> Repository<M>

pub fn new(db: Database) -> Self

Create a new repository from the given mongo client.

pub fn new_with_options(db: Database, options: CollectionOptions) -> Self

Create a new repository with associated collection options (override Model::coll_options).

pub fn collection_name(&self) -> &'static str

Returns associated M::collection_name.

pub fn get_underlying(&self) -> Collection<M>

Returns underlying mongodb::Collection.

pub fn cast_model<OtherModel>(self) -> Repository<OtherModel>

where OtherModel: Model<CollConf = M::CollConf>,

Convert this repository to use another Model. Only compiles if both Model::CollConf are identicals.

Example

use mongodm::{ToRepository, Model, CollectionConfig};
use mongodm::mongo::bson::doc;
use mongodm::f;
use serde::{Serialize, Deserialize};

struct UserCollConf;

impl CollectionConfig for UserCollConf {
    fn collection_name() -> &'static str {
        "cast_model"
    }
}

// Latest schema currently in use
#[derive(Serialize, Deserialize)]
struct User {
    username: String,
    last_seen: i64,
}

impl Model for User {
    type CollConf = UserCollConf;
}

// Old schema
#[derive(Serialize, Deserialize)]
struct UserV1 {
    name: String,
    ls: i64,
}

// Versionned version of our `User`
#[derive(Serialize, Deserialize)]
#[serde(untagged)]
enum UserVersionned {
    Last(User),
    V1(UserV1),
}

impl Model for UserVersionned {
    type CollConf = UserCollConf; // same as the non-versionned version
}

// We have some repository for `User`
let repo = db.repository::<User>();

// Assume the following document is stored: { "name": "Bernard", "ls": 1500 }

// Following query should fails because the schema doesn't match
let err = repo.find_one(doc!{ f!(name in UserV1): "Bernard" }, None).await.err().unwrap();
assert_eq!(err.to_string(), "missing field `username`"); // serde deserialization error

// We can get a repository for `UserVersionned` from our `Repository<User>`
// because `User::CollConf` == `UserVersionned::CollConf`
let repo_versionned = repo.cast_model::<UserVersionned>();

// Our versionned model should match with the document
let ret = repo_versionned.find_one(doc!{ f!(name in UserV1): "Bernard" }, None).await?;
match ret {
    Some(UserVersionned::V1(UserV1 { name, ls: 1500 })) if name == "Bernard" => { /* success */ }
    _ => panic!("Expected document was missing"),
}

Following code will fail to compile because CollectionConfig doesn’t match.

use mongodm::{ToRepository, Model, CollectionConfig};
use serde::{Serialize, Deserialize};

struct ACollConf;

impl CollectionConfig for ACollConf {
    fn collection_name() -> &'static str { "a" }
}

#[derive(Serialize, Deserialize)]
struct A;

impl Model for A {
    type CollConf = ACollConf;
}

struct BCollConf;

impl CollectionConfig for BCollConf {
    fn collection_name() -> &'static str { "B" }
}

#[derive(Serialize, Deserialize)]
struct B;

impl Model for B {
    type CollConf = BCollConf;
}

// Doesn't compile because `A` and `B` doesn't share the same `CollectionConfig`.
db.repository::<A>().cast_model::<B>();

pub async fn bulk_update<V, U>(&self, updates: V) -> Result<BulkUpdateResult>

where M: Send + Sync, V: Borrow<Vec<U>> + Send + Sync, U: Borrow<BulkUpdate> + Send + Sync,

Apply multiple update operations in bulk.

This will be removed once support for bulk update is added to the official driver. see for tracking progress on this feature in the official driver.

Example

use mongodm::prelude::*;
/* ... */
let db: mongodb::Database; /* exists */
let repository = db.repository::<User>();
/* ... */
let bulk_update_res = repository
    .bulk_update(&vec![
        &BulkUpdate {
            query: doc! { f!(name in User): "Dane" },
            update: doc! { Set: { f!(age in User): 12 } },
            options: None,
        },
        &BulkUpdate {
            query: doc! { f!(name in User): "David" },
            update: doc! { Set: { f!(age in User): 30 } },
            options: None,
        },
    ])
    .await
    .unwrap();
assert_eq!(bulk_update_res.nb_affected, 2);
assert_eq!(bulk_update_res.nb_modified, 2);

Methods from Deref<Target = Collection<M>>

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<(), Error>

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<(), Error>

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>, Error>

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>, Error>

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, Error>

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, Error>

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 count_documents_with_session( &self, filter: impl Into<Option<Document>>, options: impl Into<Option<CountOptions>>, session: &mut ClientSession ) -> Result<u64, Error>

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 async fn create_index( &self, index: IndexModel, options: impl Into<Option<CreateIndexOptions>> ) -> Result<CreateIndexResult, Error>

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, Error>

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, Error>

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, Error>

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, Error>

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, Error>

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, Error>

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, Error>

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>, Error>

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>, Error>

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<(), Error>

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<(), Error>

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<(), Error>

Drops all indexes associated with this collection.

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

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>, Error>

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>, Error>

Lists all indexes on this collection using the provided ClientSession.

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

Gets the names of all indexes on the collection.

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

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, Error>

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, Error>

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, Error>

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, Error>

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>>, Error>

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>>, Error>

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>, Error>

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>, Error>

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

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

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>, Error>

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

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

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>, Error>

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>, Error>

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>, Error>

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 async fn find_one_and_replace( &self, filter: Document, replacement: impl Borrow<T>, options: impl Into<Option<FindOneAndReplaceOptions>> ) -> Result<Option<T>, Error>

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>, Error>

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 async fn insert_many( &self, docs: impl IntoIterator<Item = impl Borrow<T>>, options: impl Into<Option<InsertManyOptions>> ) -> Result<InsertManyResult, Error>

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, Error>

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, Error>

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, Error>

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, Error>

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, Error>

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

impl<M: Model> Clone for Repository<M>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M: Debug + Model> Debug for Repository<M>

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

Formats the value using the given formatter.

impl<M: Model> Deref for Repository<M>

type Target = Collection<M>

The resulting type after dereferencing.

fn deref(&self) -> &Collection<M>

Dereferences the value.