diesel_async/pooled_connection/bb8.rs
1//! A pool implementation for `diesel-async` based on [`bb8`]
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::bb8::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().build(config).await?;
49//! # #[cfg(not(feature = "postgres"))]
50//! # let pool = Pool::builder().build(config).await?;
51//! let mut conn = pool.get().await?;
52//! # conn.begin_test_transaction();
53//! # create_tables(&mut conn).await;
54//! # #[cfg(feature = "mysql")]
55//! # conn.begin_test_transaction();
56//! let res = users.load::<(i32, String)>(&mut conn).await?;
57//! # Ok(())
58//! # }
59//! ```
60use super::{AsyncDieselConnectionManager, PoolError, PoolableConnection};
61use bb8::ManageConnection;
62use diesel::query_builder::QueryFragment;
63
64/// Type alias for using [`bb8::Pool`] with [`diesel-async`]
65///
66/// This is **not** equal to [`bb8::Pool`]. It already uses the correct
67/// connection manager and expects only the connection type as generic argument
68pub type Pool<C> = bb8::Pool<AsyncDieselConnectionManager<C>>;
69/// Type alias for using [`bb8::PooledConnection`] with [`diesel-async`]
70pub type PooledConnection<'a, C> = bb8::PooledConnection<'a, AsyncDieselConnectionManager<C>>;
71/// Type alias for using [`bb8::RunError`] with [`diesel-async`]
72pub type RunError = bb8::RunError<super::PoolError>;
73
74impl<C> ManageConnection for AsyncDieselConnectionManager<C>
75where
76 C: PoolableConnection + 'static,
77 for<'a> diesel::dsl::select<diesel::dsl::AsExprOf<i32, diesel::sql_types::Integer>>:
78 crate::methods::LoadQuery<'a, C, i32>,
79 diesel::query_builder::SqlQuery: QueryFragment<C::Backend>,
80{
81 type Connection = C;
82
83 type Error = PoolError;
84
85 async fn connect(&self) -> Result<Self::Connection, Self::Error> {
86 (self.manager_config.custom_setup)(&self.connection_url)
87 .await
88 .map_err(PoolError::ConnectionError)
89 }
90
91 async fn is_valid(&self, conn: &mut Self::Connection) -> Result<(), Self::Error> {
92 conn.ping(&self.manager_config.recycling_method)
93 .await
94 .map_err(PoolError::QueryError)
95 }
96
97 fn has_broken(&self, conn: &mut Self::Connection) -> bool {
98 std::thread::panicking() || conn.is_broken()
99 }
100}