orbit-orm 0.4.0

An ORM for Rocket.rs apps, with MySQL and MariaDB, PostgreSQL and SQLite
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

#[cfg(feature = "mysql")]
use sqlx::MySql;
#[cfg(feature = "mysql")]
use sqlx::MySqlConnection;
#[cfg(feature = "postgres")]
use sqlx::Postgres;
#[cfg(feature = "sqlite")]
use sqlx::Sqlite;

use crate::database::Pool;
use crate::{Database, Driver, Error};

/// An open transaction, given to the closure of `Database::transaction`. Pass it to queries as
/// `&mut *tx`. It commits or rolls back when that closure returns.
pub struct Transaction {
    pub(crate) inner: TxInner,
}

/// The open transaction on the connection of one driver.
#[doc(hidden)]
pub enum TxInner {
    #[cfg(feature = "mysql")]
    MySql(sqlx::Transaction<'static, MySql>),
    #[cfg(feature = "postgres")]
    Postgres(sqlx::Transaction<'static, Postgres>),
    #[cfg(feature = "sqlite")]
    Sqlite(sqlx::Transaction<'static, Sqlite>),
}

impl TxInner {
    pub(crate) fn driver(&self) -> Driver {
        match self {
            #[cfg(feature = "mysql")]
            Self::MySql(_) => Driver::MySql,
            #[cfg(feature = "postgres")]
            Self::Postgres(_) => Driver::Postgres,
            #[cfg(feature = "sqlite")]
            Self::Sqlite(_) => Driver::Sqlite,
        }
    }
}

impl Transaction {
    pub(crate) async fn begin(pool: &Pool) -> Result<Self, Error> {
        let inner = match pool {
            #[cfg(feature = "mysql")]
            Pool::MySql(pool) => TxInner::MySql(pool.begin().await?),
            #[cfg(feature = "postgres")]
            Pool::Postgres(pool) => TxInner::Postgres(pool.begin().await?),
            #[cfg(feature = "sqlite")]
            Pool::Sqlite(pool) => TxInner::Sqlite(pool.begin().await?),
        };
        Ok(Self { inner })
    }

    pub(crate) async fn commit(self) -> Result<(), Error> {
        match self.inner {
            #[cfg(feature = "mysql")]
            TxInner::MySql(tx) => Ok(tx.commit().await?),
            #[cfg(feature = "postgres")]
            TxInner::Postgres(tx) => Ok(tx.commit().await?),
            #[cfg(feature = "sqlite")]
            TxInner::Sqlite(tx) => Ok(tx.commit().await?),
        }
    }

    pub(crate) async fn rollback(self) -> Result<(), Error> {
        match self.inner {
            #[cfg(feature = "mysql")]
            TxInner::MySql(tx) => Ok(tx.rollback().await?),
            #[cfg(feature = "postgres")]
            TxInner::Postgres(tx) => Ok(tx.rollback().await?),
            #[cfg(feature = "sqlite")]
            TxInner::Sqlite(tx) => Ok(tx.rollback().await?),
        }
    }

    /// The database this transaction runs on.
    pub fn driver(&self) -> Driver {
        self.inner.driver()
    }

    /// The MySQL connection of this transaction, for queries that Orbit does not wrap yet.
    ///
    /// # Panics
    ///
    /// Panics when the database is not MySQL. Check `driver()` first.
    #[cfg(feature = "mysql")]
    pub fn connection(&mut self) -> &mut MySqlConnection {
        #[cfg(any(feature = "postgres", feature = "sqlite"))]
        let driver = self.inner.driver();
        match &mut self.inner {
            TxInner::MySql(tx) => tx,
            #[cfg(any(feature = "postgres", feature = "sqlite"))]
            _ => panic!(
                "`connection` is for MySQL; this transaction is on {}",
                driver.name()
            ),
        }
    }
}

/// Where a query runs: a `&Database`, on a pooled connection, or a `&mut Transaction`, on the
/// transaction's connection. Terminal methods such as `get` take either.
pub trait Executor<'a> {
    #[doc(hidden)]
    fn target(self) -> Target<'a>;
}

/// The connection a query runs on.
#[doc(hidden)]
pub enum Target<'a> {
    Pool(&'a Pool),
    Tx(&'a mut TxInner),
}

impl Target<'_> {
    /// The database the query runs on.
    pub(crate) fn driver(&self) -> Driver {
        match self {
            Self::Pool(pool) => pool.driver(),
            Self::Tx(tx) => tx.driver(),
        }
    }
}

impl<'a> Executor<'a> for &'a Database {
    fn target(self) -> Target<'a> {
        Target::Pool(&self.pool)
    }
}

impl<'a> Executor<'a> for &'a mut Transaction {
    fn target(self) -> Target<'a> {
        Target::Tx(&mut self.inner)
    }
}