diesel_async/pooled_connection/mobc.rs
1//! A pool implementation for `diesel-async` based on [`mobc`]
2//!
3//! ```rust
4//! # include!("../doctest_setup.rs");
5//! use diesel::result::Error;
6//! use futures_util::FutureExt;
7//! use diesel_async::pooled_connection::AsyncDieselConnectionManager;
8//! use diesel_async::pooled_connection::mobc::Pool;
9//! use diesel_async::{RunQueryDsl, AsyncConnection};
10//!
11//! # #[tokio::main(flavor = "current_thread")]
12//! # async fn main() {
13//! # run_test().await.unwrap();
14//! # }
15//! #
16//! # #[cfg(feature = "postgres")]
17//! # fn get_config() -> AsyncDieselConnectionManager<diesel_async::AsyncPgConnection> {
18//! # let db_url = database_url_from_env("PG_DATABASE_URL");
19//! let config = AsyncDieselConnectionManager::<diesel_async::AsyncPgConnection>::new(db_url);
20//! # config
21//! # }
22//! #
23//! # #[cfg(feature = "mysql")]
24//! # fn get_config() -> AsyncDieselConnectionManager<diesel_async::AsyncMysqlConnection> {
25//! # let db_url = database_url_from_env("MYSQL_DATABASE_URL");
26//! # let config = AsyncDieselConnectionManager::<diesel_async::AsyncMysqlConnection>::new(db_url);
27//! # config
28//! # }
29//! #
30//! # #[cfg(feature = "mariadb")]
31//! # fn get_config() -> AsyncDieselConnectionManager<diesel_async::AsyncMariadbConnection> {
32//! # let db_url = database_url_from_env("MARIADB_DATABASE_URL");
33//! # let config = AsyncDieselConnectionManager::<diesel_async::AsyncMariadbConnection>::new(db_url);
34//! # config
35//! # }
36//! #
37//! # #[cfg(feature = "sqlite")]
38//! # fn get_config() -> AsyncDieselConnectionManager<diesel_async::sync_connection_wrapper::SyncConnectionWrapper<diesel::SqliteConnection>> {
39//! # let db_url = database_url_from_env("SQLITE_DATABASE_URL");
40//! # let config = AsyncDieselConnectionManager::<diesel_async::sync_connection_wrapper::SyncConnectionWrapper<diesel::SqliteConnection>>::new(db_url);
41//! # config
42//! # }
43//! #
44//! # async fn run_test() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
45//! # use schema::users::dsl::*;
46//! # let config = get_config();
47//! # #[cfg(feature = "postgres")]
48//! let pool: Pool<AsyncPgConnection> = Pool::new(config);
49//! # #[cfg(not(feature = "postgres"))]
50//! # let pool = Pool::new(config);
51//! let mut conn = pool.get().await?;
52//! # conn.begin_test_transaction();
53//! # create_tables(&mut conn).await;
54//! # conn.begin_test_transaction();
55//! let res = users.load::<(i32, String)>(&mut conn).await?;
56//! # Ok(())
57//! # }
58//! ```
59use super::{AsyncDieselConnectionManager, PoolError, PoolableConnection};
60use diesel::query_builder::QueryFragment;
61use mobc::Manager;
62
63/// Type alias for using [`mobc::Pool`] with [`diesel-async`]
64///
65///
66/// This is **not** equal to [`mobc::Pool`]. It already uses the correct
67/// connection manager and expects only the connection type as generic argument
68pub type Pool<C> = mobc::Pool<AsyncDieselConnectionManager<C>>;
69
70/// Type alias for using [`mobc::Connection`] with [`diesel-async`]
71pub type PooledConnection<C> = mobc::Connection<AsyncDieselConnectionManager<C>>;
72
73/// Type alias for using [`mobc::Builder`] with [`diesel-async`]
74pub type Builder<C> = mobc::Builder<AsyncDieselConnectionManager<C>>;
75
76#[async_trait::async_trait]
77impl<C> Manager for AsyncDieselConnectionManager<C>
78where
79 C: PoolableConnection + 'static,
80 for<'a> diesel::dsl::select<diesel::dsl::AsExprOf<i32, diesel::sql_types::Integer>>:
81 crate::methods::LoadQuery<'a, C, i32>,
82 diesel::query_builder::SqlQuery: QueryFragment<C::Backend>,
83{
84 type Connection = C;
85
86 type Error = PoolError;
87
88 async fn connect(&self) -> Result<Self::Connection, Self::Error> {
89 (self.manager_config.custom_setup)(&self.connection_url)
90 .await
91 .map_err(PoolError::ConnectionError)
92 }
93
94 async fn check(&self, mut conn: Self::Connection) -> Result<Self::Connection, Self::Error> {
95 conn.ping(&self.manager_config.recycling_method)
96 .await
97 .map_err(PoolError::QueryError)?;
98 Ok(conn)
99 }
100
101 fn validate(&self, conn: &mut Self::Connection) -> bool {
102 std::thread::panicking() || conn.is_broken()
103 }
104}