Struct mongodm::repository::Repository

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

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

Returns underlying mongodb::Collection.

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

Drops the underlying collection, deleting all data, users, and indexes stored inside.

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

Runs an aggregation operation.

Mongo manual

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>

Gets the number of documents matching filter.

Note that using Repository::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>

Deletes all documents stored in the collection matching query.

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

Deletes up to one document found matching query.

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

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

pub async fn find<'_>(
    &'_ self,
    filter: impl Into<Option<Document>>,
    options: impl Into<Option<FindOptions>>
) -> Result<ModelCursor<M>>

Finds the documents in the collection matching filter.

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

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<M>>

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

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

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

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

Atomically finds up to one model 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+.

pub async fn insert_many<'_>(
    &'_ self,
    models: impl IntoIterator<Item = M>,
    options: impl Into<Option<InsertManyOptions>>
) -> Result<InsertManyResult>

Inserts the models into the collection.

pub async fn insert_one<'_, '_>(
    &'_ self,
    model: &'_ M,
    options: impl Into<Option<InsertOneOptions>>
) -> Result<InsertOneResult>

Inserts model M into the collection.

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

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

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>

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.

pub async fn sync_indexes<'_>(&'_ self) -> Result<(), Error>

Synchronize model with underlying mongo collection.

This should be called once per model on startup to synchronize indexes defined by the Model. Indexes found in the backend and not defined in the model are destroyed except for the special index "_id".

Trait Implementations

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

fn clone(&self) -> Repository<M>

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.