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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

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

use crate::error::Error;
use mongodb::{
    bson::Document,
    options::{FindOneAndUpdateOptions, UpdateOptions},
    results::UpdateResult,
    ClientSession, Collection,
};
use serde::{Deserialize, Serialize};

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

    Ok(result)
}

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

    Ok(result)
}

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

    Ok(result)
}