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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
use crate::connection::Connection;
use crate::database::Database;
use crate::error::Error;
use crate::pool::inner::SharedPool;
use crate::pool::Pool;
use std::cmp;
use std::fmt::{self, Debug, Formatter};
use std::sync::Arc;
use std::time::{Duration, Instant};
use mco::co;
pub struct PoolOptions<DB: Database> {
pub test_before_acquire: bool,
pub after_connect: Option<
Box<
dyn Fn(&mut DB::Connection) -> Result<(), Error> + 'static + Send + Sync,
>,
>,
pub before_acquire: Option<
Box<
dyn Fn(&mut DB::Connection) -> Result<bool, Error>
+ 'static
+ Send
+ Sync,
>,
>,
pub after_release:
Option<Box<dyn Fn(&mut DB::Connection) -> bool + 'static + Send + Sync>>,
pub max_connections: u32,
pub connect_timeout: Duration,
pub min_connections: u32,
pub max_lifetime: Option<Duration>,
pub idle_timeout: Option<Duration>,
}
impl<DB: Database> Default for PoolOptions<DB> {
fn default() -> Self {
Self::new()
}
}
impl<DB: Database> PoolOptions<DB> {
pub fn new() -> Self {
Self {
after_connect: None,
test_before_acquire: true,
before_acquire: None,
after_release: None,
max_connections: 10,
min_connections: 0,
connect_timeout: Duration::from_secs(30),
idle_timeout: Some(Duration::from_secs(10 * 60)),
max_lifetime: Some(Duration::from_secs(30 * 60)),
}
}
/// Set the maximum number of connections that this pool should maintain.
pub fn max_connections(mut self, max: u32) -> Self {
self.max_connections = max;
self
}
/// Set the amount of time to attempt connecting to the database.
///
/// If this timeout elapses, [`Pool::acquire`] will return an error.
pub fn connect_timeout(mut self, timeout: Duration) -> Self {
self.connect_timeout = timeout;
self
}
/// Set the minimum number of connections to maintain at all times.
///
/// When the pool is built, this many connections will be automatically spun up.
///
/// If any connection is reaped by [`max_lifetime`] or [`idle_timeout`] and it brings
/// the connection count below this amount, a new connection will be opened to replace it.
///
/// [`max_lifetime`]: Self::max_lifetime
/// [`idle_timeout`]: Self::idle_timeout
pub fn min_connections(mut self, min: u32) -> Self {
self.min_connections = min;
self
}
/// Set the maximum lifetime of individual connections.
///
/// Any connection with a lifetime greater than this will be closed.
///
/// When set to `None`, all connections live until either reaped by [`idle_timeout`]
/// or explicitly disconnected.
///
/// Infinite connections are not recommended due to the unfortunate reality of memory/resource
/// leaks on the database-side. It is better to retire connections periodically
/// (even if only once daily) to allow the database the opportunity to clean up data structures
/// (parse trees, query metadata caches, thread-local storage, etc.) that are associated with a
/// session.
///
/// [`idle_timeout`]: Self::idle_timeout
pub fn max_lifetime(mut self, lifetime: impl Into<Option<Duration>>) -> Self {
self.max_lifetime = lifetime.into();
self
}
/// Set a maximum idle duration for individual connections.
///
/// Any connection with an idle duration longer than this will be closed.
///
/// For usage-based database server billing, this can be a cost saver.
pub fn idle_timeout(mut self, timeout: impl Into<Option<Duration>>) -> Self {
self.idle_timeout = timeout.into();
self
}
/// If true, the health of a connection will be verified by a call to [`Connection::ping`]
/// before returning the connection.
///
/// Defaults to `true`.
pub fn test_before_acquire(mut self, test: bool) -> Self {
self.test_before_acquire = test;
self
}
/// Perform an action after connecting to the database.
///
/// # Example
///
/// ```no_run
/// # fn f() -> Result<(), Box<dyn std::error::Error>> {
/// use cdbc::executor::Executor;
/// use cdbc_pg::PgPoolOptions;
/// // PostgreSQL
/// let pool = PgPoolOptions::new()
/// .after_connect(|conn| {
/// conn.execute("SET application_name = 'your_app';")?;
/// conn.execute("SET search_path = 'my_schema';")?;
///
/// Ok(())
/// })
/// .connect("postgres:// …")?;
/// # Ok(())
/// # }
/// ```
pub fn after_connect<F>(mut self, callback: F) -> Self
where
for<'c> F:
Fn(&'c mut DB::Connection) -> Result<(), Error> + 'static + Send + Sync,
{
self.after_connect = Some(Box::new(callback));
self
}
pub fn before_acquire<F>(mut self, callback: F) -> Self
where
for<'c> F: Fn(&'c mut DB::Connection) -> Result<bool, Error>
+ 'static
+ Send
+ Sync,
{
self.before_acquire = Some(Box::new(callback));
self
}
pub fn after_release<F>(mut self, callback: F) -> Self
where
F: Fn(&mut DB::Connection) -> bool + 'static + Send + Sync,
{
self.after_release = Some(Box::new(callback));
self
}
/// Creates a new pool from this configuration and immediately establishes one connection.
pub fn connect(self, uri: &str) -> Result<Pool<DB>, Error> {
self.connect_with(uri.parse()?)
}
/// Creates a new pool from this configuration and immediately establishes one connection.
pub fn connect_with(
self,
options: <DB::Connection as Connection>::Options,
) -> Result<Pool<DB>, Error> {
let shared = SharedPool::new_arc(self, options);
init_min_connections(&shared)?;
Ok(Pool(shared))
}
/// Creates a new pool from this configuration and will establish a connections as the pool
/// starts to be used.
pub fn connect_lazy(self, uri: &str) -> Result<Pool<DB>, Error> {
Ok(self.connect_lazy_with(uri.parse()?))
}
/// Creates a new pool from this configuration and will establish a connections as the pool
/// starts to be used.
pub fn connect_lazy_with(self, options: <DB::Connection as Connection>::Options) -> Pool<DB> {
let shared = SharedPool::new_arc(self, options);
let shared_clone = Arc::clone(&shared);
let _ = co!(move ||{
let _ = init_min_connections(&shared_clone);
});
Pool(shared)
}
}
fn init_min_connections<DB: Database>(pool: &SharedPool<DB>) -> Result<(), Error> {
for _ in 0..cmp::max(pool.options.min_connections, 1) {
let deadline = Instant::now() + pool.options.connect_timeout;
let permit = pool.semaphore.acquire();
// this guard will prevent us from exceeding `max_size`
if let Ok(guard) = pool.try_increment_size(permit) {
// [connect] will raise an error when past deadline
let conn = pool.connection(deadline, guard)?;
pool.release(conn);
}
}
Ok(())
}
impl<DB: Database> Debug for PoolOptions<DB> {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
f.debug_struct("PoolOptions")
.field("max_connections", &self.max_connections)
.field("min_connections", &self.min_connections)
.field("connect_timeout", &self.connect_timeout)
.field("max_lifetime", &self.max_lifetime)
.field("idle_timeout", &self.idle_timeout)
.field("test_before_acquire", &self.test_before_acquire)
.finish()
}
}