bottle_orm/
database.rs

1//! # Database Module
2//!
3//! This module provides the core database connection and management functionality for Bottle ORM.
4//! It handles connection pooling, driver detection, table creation, and foreign key management
5//! across PostgreSQL, MySQL, and SQLite.
6
7// ============================================================================
8// External Crate Imports
9// ============================================================================
10
11use futures::future::BoxFuture;
12use heck::ToSnakeCase;
13use sqlx::{any::AnyArguments, AnyPool, Row, Arguments};
14use std::sync::Arc;
15
16// ============================================================================
17// Internal Crate Imports
18// ============================================================================
19
20use crate::{migration::Migrator, Error, Model, QueryBuilder};
21
22// ============================================================================
23// Database Driver Enum
24// ============================================================================
25
26/// Supported database drivers for Bottle ORM.
27#[derive(Debug, Clone, Copy, PartialEq, Eq)]
28pub enum Drivers {
29    /// PostgreSQL driver
30    Postgres,
31    /// MySQL driver
32    MySQL,
33    /// SQLite driver
34    SQLite,
35}
36
37// ============================================================================
38// Database Struct
39// ============================================================================
40
41/// The main entry point for Bottle ORM database operations.
42///
43/// `Database` manages a connection pool and provides methods for starting
44/// transactions, creating tables, and building queries for models.
45///
46/// It is designed to be thread-safe and easily shared across an application
47/// (internally uses an `Arc` for the connection pool).
48#[derive(Debug, Clone)]
49pub struct Database {
50    /// The underlying SQLx connection pool
51    pub(crate) pool: AnyPool,
52    /// The detected database driver
53    pub(crate) driver: Drivers,
54}
55
56// ============================================================================
57// Database Implementation
58// ============================================================================
59
60impl Database {
61    /// Creates a new DatabaseBuilder for configuring the connection.
62    pub fn builder() -> DatabaseBuilder {
63        DatabaseBuilder::new()
64    }
65
66    /// Connects to a database using the provided connection string.
67    ///
68    /// This is a convenience method that uses default builder settings.
69    ///
70    /// # Arguments
71    ///
72    /// * `url` - A database connection URL (e.g., "postgres://user:pass@localhost/db")
73    pub async fn connect(url: &str) -> Result<Self, Error> {
74        DatabaseBuilder::new().connect(url).await
75    }
76
77    /// Returns a new Migrator instance for managing schema changes.
78    pub fn migrator(&self) -> Migrator<'_> {
79        Migrator::new(self)
80    }
81
82    /// Starts building a query for the specified model.
83    ///
84    /// # Type Parameters
85    ///
86    /// * `T` - The Model type to query.
87    pub fn model<T: Model + Send + Sync + Unpin + crate::AnyImpl>(&self) -> QueryBuilder<T, Self> {
88        let active_columns = T::active_columns();
89        let mut columns: Vec<String> = Vec::with_capacity(active_columns.capacity());
90
91        for col in active_columns {
92            columns.push(col.strip_prefix("r#").unwrap_or(col).to_snake_case());
93        }
94
95        QueryBuilder::new(self.clone(), self.driver, T::table_name(), <T as Model>::columns(), columns)
96    }
97
98    /// Creates a raw SQL query builder.
99    pub fn raw<'a>(&self, sql: &'a str) -> RawQuery<'a, Self> {
100        RawQuery::new(self.clone(), sql)
101    }
102
103    /// Starts a new database transaction.
104    pub async fn begin(&self) -> Result<crate::transaction::Transaction<'_>, Error> {
105        let tx = self.pool.begin().await?;
106        Ok(crate::transaction::Transaction {
107            tx: Arc::new(tokio::sync::Mutex::new(Some(tx))),
108            pool: self.pool.clone(),
109            driver: self.driver,
110        })
111    }
112
113    /// Checks if a table exists in the database.
114    pub async fn table_exists(&self, table_name: &str) -> Result<bool, Error> {
115        let table_name_snake = table_name.to_snake_case();
116        let query = match self.driver {
117            Drivers::Postgres => {
118                "SELECT EXISTS (SELECT FROM information_schema.tables WHERE table_name = $1 AND table_schema = 'public')".to_string()
119            }
120            Drivers::MySQL => {
121                "SELECT EXISTS (SELECT FROM information_schema.tables WHERE table_name = ? AND table_schema = DATABASE())".to_string()
122            }
123            Drivers::SQLite => {
124                "SELECT count(*) FROM sqlite_master WHERE type='table' AND name=?".to_string()
125            }
126        };
127
128        let row = sqlx::query(&query).bind(&table_name_snake).fetch_one(&self.pool).await?;
129
130        match self.driver {
131            Drivers::SQLite => {
132                let count: i64 = row.try_get(0)?;
133                Ok(count > 0)
134            }
135            _ => {
136                let exists: bool = row.try_get(0)?;
137                Ok(exists)
138            }
139        }
140    }
141
142    /// Creates a table based on the provided Model metadata.
143    pub async fn create_table<T: Model>(&self) -> Result<(), Error> {
144        let table_name = T::table_name().to_snake_case();
145        let columns = T::columns();
146
147        let mut query = format!("CREATE TABLE IF NOT EXISTS \"{}\" (", table_name);
148        let mut column_defs = Vec::new();
149        let mut indexes = Vec::new();
150
151        // Identify primary key columns
152        let pk_columns: Vec<String> = columns.iter()
153            .filter(|c| c.is_primary_key)
154            .map(|c| format!("\"{}\"", c.name.strip_prefix("r#").unwrap_or(c.name).to_snake_case()))
155            .collect();
156
157        for col in columns {
158            let col_name_clean = col.name.strip_prefix("r#").unwrap_or(col.name).to_snake_case();
159            let mut def = format!("\"{}\" {}", col_name_clean, col.sql_type);
160
161            // If it's a single primary key, we can keep it inline for simplicity
162            // If it's composite, we MUST define it as a table constraint
163            if col.is_primary_key && pk_columns.len() == 1 {
164                def.push_str(" PRIMARY KEY");
165            } else if !col.is_nullable || col.is_primary_key {
166                def.push_str(" NOT NULL");
167            }
168
169            if col.unique && !col.is_primary_key {
170                def.push_str(" UNIQUE");
171            }
172
173            if col.index && !col.is_primary_key && !col.unique {
174                indexes.push(format!(
175                    "CREATE INDEX IF NOT EXISTS \"idx_{}_{}\" ON \"{}\" (\"{}\")",
176                    table_name, col_name_clean, table_name, col_name_clean
177                ));
178            }
179
180            column_defs.push(def);
181        }
182
183        // Add composite primary key if multiple columns are specified
184        if pk_columns.len() > 1 {
185            column_defs.push(format!("PRIMARY KEY ({})", pk_columns.join(", ")));
186        }
187
188        query.push_str(&column_defs.join(", "));
189        query.push(')');
190
191        sqlx::query(&query).execute(&self.pool).await?;
192
193        for idx_query in indexes {
194            sqlx::query(&idx_query).execute(&self.pool).await?;
195        }
196
197        Ok(())
198    }
199
200    /// Synchronizes a table schema by adding missing columns or indexes.
201    pub async fn sync_table<T: Model>(&self) -> Result<(), Error> {
202        if !self.table_exists(T::table_name()).await? {
203            return self.create_table::<T>().await;
204        }
205
206        let table_name = T::table_name().to_snake_case();
207        let model_columns = T::columns();
208        let existing_columns = self.get_table_columns(&table_name).await?;
209
210        for col in model_columns {
211            let col_name_clean = col.name.strip_prefix("r#").unwrap_or(col.name).to_snake_case();
212            if !existing_columns.contains(&col_name_clean) {
213                let mut alter_query = format!("ALTER TABLE \"{}\" ADD COLUMN \"{}\" {}", table_name, col_name_clean, col.sql_type);
214                if !col.is_nullable {
215                    alter_query.push_str(" DEFAULT ");
216                    match col.sql_type {
217                        "INTEGER" | "INT" | "BIGINT" => alter_query.push('0'),
218                        "BOOLEAN" | "BOOL" => alter_query.push_str("FALSE"),
219                        _ => alter_query.push_str("''"),
220                    }
221                }
222                sqlx::query(&alter_query).execute(&self.pool).await?;
223            }
224
225            if col.index || col.unique {
226                let existing_indexes = self.get_table_indexes(&table_name).await?;
227                let idx_name = format!("idx_{}_{}", table_name, col_name_clean);
228                let uniq_name = format!("unique_{}_{}", table_name, col_name_clean);
229
230                if col.unique && !existing_indexes.contains(&uniq_name) {
231                    let mut query = format!("CREATE UNIQUE INDEX \"{}\" ON \"{}\" (\"{}\")", uniq_name, table_name, col_name_clean);
232                    if matches!(self.driver, Drivers::SQLite) {
233                        query = format!("CREATE UNIQUE INDEX IF NOT EXISTS \"{}\" ON \"{}\" (\"{}\")", uniq_name, table_name, col_name_clean);
234                    }
235                    sqlx::query(&query).execute(&self.pool).await?;
236                } else if col.index && !existing_indexes.contains(&idx_name) && !col.unique {
237                    let mut query = format!("CREATE INDEX \"{}\" ON \"{}\" (\"{}\")", idx_name, table_name, col_name_clean);
238                    if matches!(self.driver, Drivers::SQLite) {
239                        query = format!("CREATE INDEX IF NOT EXISTS \"{}\" ON \"{}\" (\"{}\")", idx_name, table_name, col_name_clean);
240                    }
241                    sqlx::query(&query).execute(&self.pool).await?;
242                }
243            }
244        }
245
246        Ok(())
247    }
248
249    /// Returns the current columns of a table.
250    pub async fn get_table_columns(&self, table_name: &str) -> Result<Vec<String>, Error> {
251        let table_name_snake = table_name.to_snake_case();
252        let query = match self.driver {
253            Drivers::Postgres => "SELECT column_name::TEXT FROM information_schema.columns WHERE table_name = $1 AND table_schema = 'public'".to_string(),
254            Drivers::MySQL => "SELECT column_name FROM information_schema.columns WHERE table_name = ? AND table_schema = DATABASE()".to_string(),
255            Drivers::SQLite => format!("PRAGMA table_info(\"{}\")", table_name_snake),
256        };
257
258        let rows = if let Drivers::SQLite = self.driver {
259            sqlx::query(&query).fetch_all(&self.pool).await?
260        } else {
261            sqlx::query(&query).bind(&table_name_snake).fetch_all(&self.pool).await?
262        };
263
264        let mut columns = Vec::new();
265        for row in rows {
266            let col_name: String = if let Drivers::SQLite = self.driver {
267                row.try_get("name")?
268            } else {
269                row.try_get(0)?
270            };
271            columns.push(col_name);
272        }
273        Ok(columns)
274    }
275
276    /// Returns the current indexes of a table.
277    pub async fn get_table_indexes(&self, table_name: &str) -> Result<Vec<String>, Error> {
278        let table_name_snake = table_name.to_snake_case();
279        let query = match self.driver {
280            Drivers::Postgres => "SELECT indexname::TEXT FROM pg_indexes WHERE tablename = $1 AND schemaname = 'public'".to_string(),
281            Drivers::MySQL => "SELECT INDEX_NAME FROM information_schema.STATISTICS WHERE TABLE_NAME = ? AND TABLE_SCHEMA = DATABASE()".to_string(),
282            Drivers::SQLite => format!("PRAGMA index_list(\"{}\")", table_name_snake),
283        };
284
285        let rows = if let Drivers::SQLite = self.driver {
286            sqlx::query(&query).fetch_all(&self.pool).await?
287        } else {
288            sqlx::query(&query).bind(&table_name_snake).fetch_all(&self.pool).await?
289        };
290
291        let mut indexes = Vec::new();
292        for row in rows {
293            let idx_name: String = if let Drivers::SQLite = self.driver {
294                row.try_get("name")?
295            } else {
296                row.try_get(0)?
297            };
298            indexes.push(idx_name);
299        }
300        Ok(indexes)
301    }
302
303    /// Assigns foreign keys to a table.
304    pub async fn assign_foreign_keys<T: Model>(&self) -> Result<(), Error> {
305        let table_name = T::table_name().to_snake_case();
306        let columns = T::columns();
307
308        for col in columns {
309            if let (Some(f_table), Some(f_key)) = (col.foreign_table, col.foreign_key) {
310                if matches!(self.driver, Drivers::SQLite) { continue; }
311                let constraint_name = format!("fk_{}_{}_{}", table_name, f_table.to_snake_case(), col.name.to_snake_case());
312                let query = format!(
313                    "ALTER TABLE \"{}\" ADD CONSTRAINT \"{}\" FOREIGN KEY (\"{}\") REFERENCES \"{}\"(\"{}\")",
314                    table_name, constraint_name, col.name.to_snake_case(), f_table.to_snake_case(), f_key.to_snake_case()
315                );
316                let _ = sqlx::query(&query).execute(&self.pool).await;
317            }
318        }
319        Ok(())
320    }
321}
322
323// ============================================================================
324// DatabaseBuilder Struct
325// ============================================================================
326
327pub struct DatabaseBuilder {
328    max_connections: u32,
329}
330
331impl DatabaseBuilder {
332    /// Creates a new DatabaseBuilder with default settings.
333    ///
334    /// # Example
335    ///
336    /// ```rust,ignore
337    /// let builder = DatabaseBuilder::new();
338    /// ```
339    pub fn new() -> Self { Self { max_connections: 5 } }
340
341    /// Sets the maximum number of connections for the database pool.
342    ///
343    /// # Arguments
344    ///
345    /// * `max` - The maximum number of connections.
346    ///
347    /// # Example
348    ///
349    /// ```rust,ignore
350    /// let db = Database::builder()
351    ///     .max_connections(10)
352    ///     .connect("sqlite::memory:")
353    ///     .await?;
354    /// ```
355    pub fn max_connections(mut self, max: u32) -> Self { self.max_connections = max; self }
356
357    /// Connects to the database using the configured settings.
358    ///
359    /// # Arguments
360    ///
361    /// * `url` - The database connection string.
362    ///
363    /// # Example
364    ///
365    /// ```rust,ignore
366    /// let db = Database::builder()
367    ///     .connect("sqlite::memory:")
368    ///     .await?;
369    /// ```
370    pub async fn connect(self, url: &str) -> Result<Database, Error> {
371        // Ensure sqlx drivers are registered for Any driver support
372        let _ = sqlx::any::install_default_drivers();
373
374        let pool = sqlx::any::AnyPoolOptions::new().max_connections(self.max_connections).connect(url).await?;
375        let driver = if url.starts_with("postgres") { Drivers::Postgres }
376                    else if url.starts_with("mysql") { Drivers::MySQL }
377                    else { Drivers::SQLite };
378        Ok(Database { pool, driver })
379    }
380}
381
382// ============================================================================
383// Connection Trait
384// ============================================================================
385
386pub trait Connection: Send + Sync {
387    fn driver(&self) -> Drivers;
388    fn execute<'a, 'q: 'a>(&'a self, sql: &'q str, args: AnyArguments<'q>) -> BoxFuture<'a, Result<sqlx::any::AnyQueryResult, sqlx::Error>>;
389    fn fetch_all<'a, 'q: 'a>(&'a self, sql: &'q str, args: AnyArguments<'q>) -> BoxFuture<'a, Result<Vec<sqlx::any::AnyRow>, sqlx::Error>>;
390    fn fetch_one<'a, 'q: 'a>(&'a self, sql: &'q str, args: AnyArguments<'q>) -> BoxFuture<'a, Result<sqlx::any::AnyRow, sqlx::Error>>;
391    fn fetch_optional<'a, 'q: 'a>(&'a self, sql: &'q str, args: AnyArguments<'q>) -> BoxFuture<'a, Result<Option<sqlx::any::AnyRow>, sqlx::Error>>;
392    fn clone_db(&self) -> Database;
393}
394
395impl Connection for Database {
396    fn driver(&self) -> Drivers { self.driver }
397    fn execute<'a, 'q: 'a>(&'a self, sql: &'q str, args: AnyArguments<'q>) -> BoxFuture<'a, Result<sqlx::any::AnyQueryResult, sqlx::Error>> {
398        Box::pin(async move { sqlx::query_with(sql, args).execute(&self.pool).await })
399    }
400    fn fetch_all<'a, 'q: 'a>(&'a self, sql: &'q str, args: AnyArguments<'q>) -> BoxFuture<'a, Result<Vec<sqlx::any::AnyRow>, sqlx::Error>> {
401        Box::pin(async move { sqlx::query_with(sql, args).fetch_all(&self.pool).await })
402    }
403    fn fetch_one<'a, 'q: 'a>(&'a self, sql: &'q str, args: AnyArguments<'q>) -> BoxFuture<'a, Result<sqlx::any::AnyRow, sqlx::Error>> {
404        Box::pin(async move { sqlx::query_with(sql, args).fetch_one(&self.pool).await })
405    }
406    fn fetch_optional<'a, 'q: 'a>(&'a self, sql: &'q str, args: AnyArguments<'q>) -> BoxFuture<'a, Result<Option<sqlx::any::AnyRow>, sqlx::Error>> {
407        Box::pin(async move { sqlx::query_with(sql, args).fetch_optional(&self.pool).await })
408    }
409    fn clone_db(&self) -> Database { self.clone() }
410}
411
412// ============================================================================
413// Raw SQL Query Builder
414// ============================================================================
415
416pub struct RawQuery<'a, C> {
417    conn: C,
418    sql: &'a str,
419    args: AnyArguments<'a>,
420}
421
422impl<'a, C> RawQuery<'a, C> where C: Connection {
423    pub(crate) fn new(conn: C, sql: &'a str) -> Self {
424        Self { conn, sql, args: AnyArguments::default() }
425    }
426
427    /// Binds a value to the SQL query.
428    ///
429    /// # Type Parameters
430    ///
431    /// * `T` - The type of the value to bind.
432    ///
433    /// # Example
434    ///
435    /// ```rust,ignore
436    /// let user: User = db.raw("SELECT * FROM users WHERE id = ?")
437    ///     .bind(1)
438    ///     .fetch_one()
439    ///     .await?;
440    /// ```
441    pub fn bind<T>(mut self, value: T) -> Self where T: 'a + sqlx::Encode<'a, sqlx::Any> + sqlx::Type<sqlx::Any> + Send + Sync {
442        let _ = self.args.add(value);
443        self
444    }
445
446    /// Executes the query and returns all matching rows.
447    ///
448    /// # Type Parameters
449    ///
450    /// * `T` - The type to map the rows to.
451    ///
452    /// # Example
453    ///
454    /// ```rust,ignore
455    /// let users: Vec<User> = db.raw("SELECT * FROM users")
456    ///     .fetch_all()
457    ///     .await?;
458    /// ```
459    pub async fn fetch_all<T>(self) -> Result<Vec<T>, Error> where T: for<'r> sqlx::FromRow<'r, sqlx::any::AnyRow> + Send + Unpin {
460        let rows = self.conn.fetch_all(self.sql, self.args).await?;
461        Ok(rows.iter().map(|r| T::from_row(r).unwrap()).collect())
462    }
463
464    /// Executes the query and returns exactly one row.
465    ///
466    /// # Type Parameters
467    ///
468    /// * `T` - The type to map the row to.
469    ///
470    /// # Example
471    ///
472    /// ```rust,ignore
473    /// let user: User = db.raw("SELECT * FROM users WHERE id = 1")
474    ///     .fetch_one()
475    ///     .await?;
476    /// ```
477    pub async fn fetch_one<T>(self) -> Result<T, Error> where T: for<'r> sqlx::FromRow<'r, sqlx::any::AnyRow> + Send + Unpin {
478        let row = self.conn.fetch_one(self.sql, self.args).await?;
479        Ok(T::from_row(&row)?)
480    }
481
482    /// Executes the query and returns an optional row.
483    ///
484    /// # Type Parameters
485    ///
486    /// * `T` - The type to map the row to.
487    ///
488    /// # Example
489    ///
490    /// ```rust,ignore
491    /// let user: Option<User> = db.raw("SELECT * FROM users WHERE id = 1")
492    ///     .fetch_optional()
493    ///     .await?;
494    /// ```
495    pub async fn fetch_optional<T>(self) -> Result<Option<T>, Error> where T: for<'r> sqlx::FromRow<'r, sqlx::any::AnyRow> + Send + Unpin {
496        let row = self.conn.fetch_optional(self.sql, self.args).await?;
497        Ok(row.map(|r| T::from_row(&r).unwrap()))
498    }
499
500    /// Executes the query and returns the number of affected rows.
501    ///
502    /// Useful for UPDATE, DELETE or INSERT queries.
503    ///
504    /// # Example
505    ///
506    /// ```rust,ignore
507    /// let affected = db.raw("DELETE FROM users WHERE id = 1")
508    ///     .execute()
509    ///     .await?;
510    /// ```
511    pub async fn execute(self) -> Result<u64, Error> {
512        let result = self.conn.execute(self.sql, self.args).await?;
513        Ok(result.rows_affected())
514    }
515}
bottle_orm/database.rs

bottle_orm/
database.rs
