diesel_async/pooled_connection/deadpool.rs
1//! A connection pool implementation for `diesel-async` based on [`deadpool`]
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::deadpool::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::builder(config).build()?;
49//! # #[cfg(not(feature = "postgres"))]
50//! # let pool = Pool::builder(config).build()?;
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, PoolableConnection};
60use deadpool::managed::Manager;
61use diesel::query_builder::QueryFragment;
62
63/// Type alias for using [`deadpool::managed::Pool`] with [`diesel-async`]
64///
65/// This is **not** equal to [`deadpool::managed::Pool`]. It already uses the correct
66/// connection manager and expects only the connection type as generic argument
67pub type Pool<C> = deadpool::managed::Pool<AsyncDieselConnectionManager<C>>;
68/// Type alias for using [`deadpool::managed::PoolBuilder`] with [`diesel-async`]
69pub type PoolBuilder<C> = deadpool::managed::PoolBuilder<AsyncDieselConnectionManager<C>>;
70/// Type alias for using [`deadpool::managed::BuildError`] with [`diesel-async`]
71pub type BuildError = deadpool::managed::BuildError;
72/// Type alias for using [`deadpool::managed::PoolError`] with [`diesel-async`]
73pub type PoolError = deadpool::managed::PoolError<super::PoolError>;
74/// Type alias for using [`deadpool::managed::Object`] with [`diesel-async`]
75pub type Object<C> = deadpool::managed::Object<AsyncDieselConnectionManager<C>>;
76/// Type alias for using [`deadpool::managed::Hook`] with [`diesel-async`]
77pub type Hook<C> = deadpool::managed::Hook<AsyncDieselConnectionManager<C>>;
78/// Type alias for using [`deadpool::managed::HookError`] with [`diesel-async`]
79pub type HookError = deadpool::managed::HookError<super::PoolError>;
80
81impl<C> Manager for AsyncDieselConnectionManager<C>
82where
83 C: PoolableConnection + Send + 'static,
84 for<'a> diesel::dsl::select<diesel::dsl::AsExprOf<i32, diesel::sql_types::Integer>>:
85 crate::methods::LoadQuery<'a, C, i32>,
86 diesel::query_builder::SqlQuery: QueryFragment<C::Backend>,
87{
88 type Type = C;
89
90 type Error = super::PoolError;
91
92 async fn create(&self) -> Result<Self::Type, Self::Error> {
93 (self.manager_config.custom_setup)(&self.connection_url)
94 .await
95 .map_err(super::PoolError::ConnectionError)
96 }
97
98 async fn recycle(
99 &self,
100 obj: &mut Self::Type,
101 _: &deadpool::managed::Metrics,
102 ) -> deadpool::managed::RecycleResult<Self::Error> {
103 if std::thread::panicking() || obj.is_broken() {
104 return Err(deadpool::managed::RecycleError::Message(
105 "Broken connection".into(),
106 ));
107 }
108 obj.ping(&self.manager_config.recycling_method)
109 .await
110 .map_err(super::PoolError::QueryError)?;
111 Ok(())
112 }
113}