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

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

use crate::error::Error;
use mongodb::{
    options::{SessionOptions, TransactionOptions},
    Client, ClientSession,
};

/// Starts a new `ClientSession`.
///
/// https://www.mongodb.com/docs/manual/reference/method/Session/
///
/// ---
/// Example Usage:
/// ```
///
/// let client: Client = ...;
///
/// let mut session: ClientSession = start_session(
///     &client,
///     None::<SessionOptions>,
/// ).await?;
/// ```
pub async fn start_session(
    client: &Client,
    options: Option<SessionOptions>,
) -> Result<ClientSession, Error> {
    client
        .start_session()
        .with_options(options)
        .await
        .map_err(Error::Mongo)
}

/// Starts a new transaction on a `ClientSession`.
///
/// https://www.mongodb.com/docs/manual/reference/method/Session.startTransaction/
///
/// ---
/// Example Usage:
/// ```
///
/// let client: Client = ...;
///
/// let mut session: ClientSession = start_session(
///     &client,
///     None::<SessionOptions>,
/// ).await?;
///
/// start_transaction(&mut session, None).await?;
/// ```
pub async fn start_transaction(
    session: &mut ClientSession,
    options: Option<TransactionOptions>,
) -> Result<(), Error> {
    let options = options.unwrap_or_default();

    session
        .start_transaction()
        .with_options(options)
        .await
        .map_err(Error::Mongo)
}

/// Aborts the current transaction to a `ClientSession`.
///
/// https://www.mongodb.com/docs/manual/reference/method/Session.abortTransaction/
///
/// ---
/// Example Usage:
/// ```
///
/// let client: Client = ...;
///
/// let mut session: ClientSession = start_session(
///     &client,
///     None::<SessionOptions>,
/// ).await?;
///
/// start_transaction(&mut session, None).await?;
///
/// ...
///
/// abort_transaction(&mut session).await?;
/// ```
pub async fn abort_transaction(session: &mut ClientSession) -> Result<(), Error> {
    session
        .abort_transaction()
        .await
        .map_err(Error::Mongo)
}

/// Commits the current transaction to a `ClientSession`.
///
/// https://www.mongodb.com/docs/manual/reference/method/Session.commitTransaction/
///
/// ---
/// Example Usage:
/// ```
///
/// let client: Client = ...;
///
/// let mut session: ClientSession = start_session(
///     &client,
///     None::<SessionOptions>,
/// ).await?;
///
/// start_transaction(&mut session, None).await?;
///
/// ...
///
/// commit_transaction(&mut session).await?;
/// ```
pub async fn commit_transaction(session: &mut ClientSession) -> Result<(), Error> {
    session
        .commit_transaction()
        .await
        .map_err(Error::Mongo)
}