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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
use crate::config::{Backend, DbkitConfig};
use crate::DbkitError;
use sqlx::migrate::MigrateDatabase;
use sqlx::{Any, AnyPool, any::AnyPoolOptions};
use std::time::Duration;
use tracing::{info, warn};
/// Multi-backend connection pool with optional automatic database creation.
///
/// The backend (Postgres, MySQL, or SQLite) is selected from the URL scheme.
/// If `auto_create_db` is enabled (default) and the target database doesn't
/// exist, it is created before the pool is opened.
pub struct ConnectionManager {
pool: AnyPool,
backend: Backend,
db_name: String,
connection_string: String,
config: DbkitConfig,
}
impl ConnectionManager {
/// Connect using a [`DbkitConfig`].
pub async fn connect(config: DbkitConfig) -> Result<Self, DbkitError> {
// Registers the Postgres/MySQL/SQLite drivers compiled in via features.
sqlx::any::install_default_drivers();
let backend = Backend::from_url(&config.url)?;
let db_name = Self::extract_db_name(&config.url, backend);
let connection_string = config.url.clone();
if config.auto_create_db {
Self::ensure_database(&config.url, &db_name).await?;
}
let pool = Self::build_pool(&config)
.await
.map_err(|e| Self::map_connect_error(e, &db_name))?;
info!("connected to database '{}' ({:?})", db_name, backend);
Ok(Self {
pool,
backend,
db_name,
connection_string,
config,
})
}
/// Connect using a connection URL with default settings.
///
/// Shorthand for `ConnectionManager::connect(DbkitConfig::from_url(url))`.
pub async fn new(url: &str) -> Result<Self, DbkitError> {
Self::connect(DbkitConfig::from_url(url)).await
}
/// Get the underlying sqlx connection pool.
pub fn pool(&self) -> &AnyPool {
&self.pool
}
/// The detected backend for this connection.
pub fn backend(&self) -> Backend {
self.backend
}
/// Acquire a connection from the pool.
pub async fn get_connection(&self) -> Result<sqlx::pool::PoolConnection<Any>, DbkitError> {
self.pool
.acquire()
.await
.map_err(|e| DbkitError::Pool(e.to_string()))
}
/// Check if the database is reachable.
pub async fn is_connected(&self) -> bool {
self.pool.acquire().await.is_ok()
}
/// The database name extracted from the connection URL.
pub fn db_name(&self) -> &str {
&self.db_name
}
/// The full connection string.
pub fn connection_string(&self) -> &str {
&self.connection_string
}
/// The config used to create this connection.
pub fn config(&self) -> &DbkitConfig {
&self.config
}
/// Create a native sqlx [`PgPool`](sqlx::PgPool) from this connection's URL.
///
/// The multi-backend `Any` pool can only represent basic scalar types
/// (bool/int/float/text/bytes). This native pool restores full Postgres type
/// support — `uuid`, `chrono` timestamps, `json`/`jsonb`, arrays, etc. — for
/// the queries that need it. Use it alongside [`pool`](Self::pool): `Any` for
/// portable work, the native pool for rich-typed Postgres work.
///
/// Errors if this connection is not Postgres.
///
/// ```ignore
/// let pg = conn.pg_native_pool().await?;
/// let row = sqlx::query("SELECT id, created_at FROM users WHERE id = $1")
/// .bind(some_uuid)
/// .fetch_one(&pg)
/// .await?;
/// let id: sqlx::types::Uuid = row.get("id");
/// ```
#[cfg(feature = "postgres-native")]
pub async fn pg_native_pool(&self) -> Result<sqlx::PgPool, DbkitError> {
if self.backend != Backend::Postgres {
return Err(DbkitError::UnsupportedBackend(format!(
"pg_native_pool requires a Postgres connection, got {:?}",
self.backend
)));
}
sqlx::postgres::PgPoolOptions::new()
.max_connections(self.config.pool_size as u32)
.acquire_timeout(Duration::from_secs(self.config.connect_timeout_secs))
.idle_timeout(Duration::from_secs(self.config.idle_timeout_secs))
// Don't ping before every acquire — that's a round-trip per query.
// Matches the old deadpool `RecyclingMethod::Fast` behavior.
.test_before_acquire(false)
.connect(&self.connection_string)
.await
.map_err(|e| DbkitError::Pool(e.to_string()))
}
/// Pool health metrics.
pub fn pool_status(&self) -> PoolStatus {
PoolStatus {
max_size: self.pool.options().get_max_connections() as usize,
size: self.pool.size() as usize,
idle: self.pool.num_idle(),
}
}
async fn build_pool(config: &DbkitConfig) -> Result<AnyPool, sqlx::Error> {
AnyPoolOptions::new()
.max_connections(config.pool_size as u32)
.acquire_timeout(Duration::from_secs(config.connect_timeout_secs))
.idle_timeout(Duration::from_secs(config.idle_timeout_secs))
// Skip the per-acquire liveness ping (a round-trip per query).
.test_before_acquire(false)
.connect(&config.url)
.await
}
/// Create the database if it does not already exist.
///
/// Uses sqlx's backend-agnostic `MigrateDatabase`, which handles
/// `CREATE DATABASE` for Postgres/MySQL and file creation for SQLite.
async fn ensure_database(url: &str, db_name: &str) -> Result<(), DbkitError> {
let exists = Any::database_exists(url).await.map_err(|e| {
DbkitError::DatabaseCreation {
name: db_name.to_string(),
reason: e.to_string(),
}
})?;
if !exists {
warn!("database '{}' does not exist, creating...", db_name);
Any::create_database(url)
.await
.map_err(|e| DbkitError::DatabaseCreation {
name: db_name.to_string(),
reason: e.to_string(),
})?;
info!("database '{}' created", db_name);
}
Ok(())
}
/// Map a sqlx connection error onto a more specific [`DbkitError`] where the
/// backend exposes a recognizable SQLSTATE.
fn map_connect_error(e: sqlx::Error, db_name: &str) -> DbkitError {
if let sqlx::Error::Database(ref db) = e {
match db.code().as_deref() {
// Postgres: invalid_password / invalid_authorization_specification
Some("28P01") | Some("28000") => return DbkitError::AuthFailed,
// Postgres: too_many_connections
Some("53300") => return DbkitError::TooManyConnections,
_ => {}
}
}
DbkitError::Connection(format!("could not connect to '{}': {}", db_name, e))
}
fn extract_db_name(url: &str, backend: Backend) -> String {
match backend {
// sqlite://path/to/file.db -> path/to/file.db
Backend::Sqlite => url
.splitn(2, ':')
.nth(1)
.unwrap_or("")
.trim_start_matches("//")
.split('?')
.next()
.unwrap_or("")
.to_string(),
// ...://host:port/dbname?params -> dbname
_ => url
.rsplit('/')
.next()
.unwrap_or("")
.split('?')
.next()
.unwrap_or("")
.to_string(),
}
}
}
/// Snapshot of connection pool health.
#[derive(Debug, Clone)]
pub struct PoolStatus {
/// Maximum number of connections in the pool.
pub max_size: usize,
/// Current number of connections (active + idle).
pub size: usize,
/// Number of idle connections available.
pub idle: usize,
}
impl std::fmt::Display for PoolStatus {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(
f,
"pool: {}/{} connections, {} idle",
self.size, self.max_size, self.idle
)
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn extract_db_name_server() {
assert_eq!(
ConnectionManager::extract_db_name("postgres://u:p@host:5432/myapp", Backend::Postgres),
"myapp"
);
assert_eq!(
ConnectionManager::extract_db_name(
"mysql://host:3306/app?ssl-mode=required",
Backend::MySql
),
"app"
);
}
#[test]
fn extract_db_name_sqlite() {
assert_eq!(
ConnectionManager::extract_db_name("sqlite://data/app.db", Backend::Sqlite),
"data/app.db"
);
}
}