mongor 0.1.10

Ergonomic MongoDB ODM
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

// Authors: Robert Lopez
// License: MIT (See `LICENSE.md`)

use crate::error::Error;
use mongodb::{
    bson::Document, options::DeleteOptions, results::DeleteResult, ClientSession, Collection,
};
use serde::{Deserialize, Serialize};

/// Executes a `deleteOne` query on `Collection`
///
/// https://www.mongodb.com/docs/manual/reference/method/db.collection.deleteOne/
///
/// ---
/// Example Usage:
/// ```
///
/// let collection: Collection<D> = ...;
///
/// let deletion_result: DeleteResult = delete_one(
///     &collection,
///     doc! { ... },
///     None::<DeleteOptions>,
///     None::<&mut ClientSession>,
/// ).await?;
/// ```
pub async fn delete_one<D>(
    collection: &Collection<D>,
    query: Document,
    options: Option<DeleteOptions>,
    session: Option<&mut ClientSession>,
) -> Result<DeleteResult, Error>
where
    D: Serialize + for<'a> Deserialize<'a> + Send + Sync,
{
    let result = if let Some(session) = session {
        collection
            .delete_one(query)
            .with_options(options)
            .session(session)
            .await
    } else {
        collection.delete_one(query).with_options(options).await
    }
    .map_err(Error::Mongo)?;

    Ok(result)
}

/// Executes a `deleteMany` query on `Collection`
///
/// https://www.mongodb.com/docs/manual/reference/method/db.collection.deleteMany/
///
/// ---
/// Example Usage:
/// ```
///
/// let collection: Collection<D> = ...;
///
/// let deletion_result: DeleteResult = delete_many(
///     &collection,
///     doc! { ... },
///     None::<DeleteOptions>,
///     None::<&mut ClientSession>,
/// ).await?;
/// ```
pub async fn delete_many<D>(
    collection: &Collection<D>,
    query: Document,
    options: Option<DeleteOptions>,
    session: Option<&mut ClientSession>,
) -> Result<DeleteResult, Error>
where
    D: Serialize + for<'a> Deserialize<'a> + Send + Sync,
{
    let result = if let Some(session) = session {
        collection
            .delete_many(query)
            .with_options(options)
            .session(session)
            .await
    } else {
        collection.delete_many(query).with_options(options).await
    }
    .map_err(Error::Mongo)?;

    Ok(result)
}