sea_orm/driver/
sqlx_sqlite.rs

1use futures_util::lock::Mutex;
2use log::LevelFilter;
3use sea_query::Values;
4use std::{future::Future, pin::Pin, sync::Arc};
5
6use sqlx::{
7    Connection, Executor, Sqlite, SqlitePool,
8    pool::PoolConnection,
9    sqlite::{SqliteConnectOptions, SqliteQueryResult, SqliteRow},
10};
11
12use sea_query_sqlx::SqlxValues;
13use tracing::{instrument, warn};
14
15use crate::{
16    AccessMode, ConnectOptions, DatabaseConnection, DatabaseConnectionType, DatabaseTransaction,
17    IsolationLevel, QueryStream, SqliteTransactionMode, Statement, TransactionError, debug_print,
18    error::*, executor::*, sqlx_error_to_exec_err,
19};
20
21use super::sqlx_common::*;
22
23/// Defines the [sqlx::sqlite] connector
24#[derive(Debug)]
25pub struct SqlxSqliteConnector;
26
27/// Defines a sqlx SQLite pool
28#[derive(Clone)]
29pub struct SqlxSqlitePoolConnection {
30    pub(crate) pool: SqlitePool,
31    metric_callback: Option<crate::metric::Callback>,
32}
33
34impl std::fmt::Debug for SqlxSqlitePoolConnection {
35    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
36        write!(f, "SqlxSqlitePoolConnection {{ pool: {:?} }}", self.pool)
37    }
38}
39
40impl From<SqlitePool> for SqlxSqlitePoolConnection {
41    fn from(pool: SqlitePool) -> Self {
42        SqlxSqlitePoolConnection {
43            pool,
44            metric_callback: None,
45        }
46    }
47}
48
49impl From<SqlitePool> for DatabaseConnection {
50    fn from(pool: SqlitePool) -> Self {
51        DatabaseConnectionType::SqlxSqlitePoolConnection(pool.into()).into()
52    }
53}
54
55impl SqlxSqliteConnector {
56    /// Check if the URI provided corresponds to `sqlite:` for a SQLite database
57    pub fn accepts(string: &str) -> bool {
58        string.starts_with("sqlite:") && string.parse::<SqliteConnectOptions>().is_ok()
59    }
60
61    /// Add configuration options for the SQLite database
62    #[instrument(level = "trace")]
63    pub async fn connect(options: ConnectOptions) -> Result<DatabaseConnection, DbErr> {
64        let mut options = options;
65        let mut sqlx_opts = options
66            .url
67            .parse::<SqliteConnectOptions>()
68            .map_err(sqlx_error_to_conn_err)?;
69        if let Some(sqlcipher_key) = &options.sqlcipher_key {
70            sqlx_opts = sqlx_opts.pragma("key", sqlcipher_key.clone());
71        }
72        use sqlx::ConnectOptions;
73        if !options.sqlx_logging {
74            sqlx_opts = sqlx_opts.disable_statement_logging();
75        } else {
76            sqlx_opts = sqlx_opts.log_statements(options.sqlx_logging_level);
77            if options.sqlx_slow_statements_logging_level != LevelFilter::Off {
78                sqlx_opts = sqlx_opts.log_slow_statements(
79                    options.sqlx_slow_statements_logging_level,
80                    options.sqlx_slow_statements_logging_threshold,
81                );
82            }
83        }
84
85        if options.get_max_connections().is_none() {
86            options.max_connections(1);
87        }
88
89        if let Some(f) = &options.sqlite_opts_fn {
90            sqlx_opts = f(sqlx_opts);
91        }
92
93        let after_conn = options.after_connect.clone();
94
95        let pool = if options.connect_lazy {
96            options.sqlx_pool_options().connect_lazy_with(sqlx_opts)
97        } else {
98            options
99                .sqlx_pool_options()
100                .connect_with(sqlx_opts)
101                .await
102                .map_err(sqlx_error_to_conn_err)?
103        };
104
105        let pool = SqlxSqlitePoolConnection {
106            pool,
107            metric_callback: None,
108        };
109
110        #[cfg(feature = "sqlite-use-returning-for-3_35")]
111        {
112            let version = get_version(&pool).await?;
113            super::sqlite::ensure_returning_version(&version)?;
114        }
115
116        let conn: DatabaseConnection =
117            DatabaseConnectionType::SqlxSqlitePoolConnection(pool).into();
118
119        if let Some(cb) = after_conn {
120            cb(conn.clone()).await?;
121        }
122
123        Ok(conn)
124    }
125}
126
127impl SqlxSqliteConnector {
128    /// Instantiate a sqlx pool connection to a [DatabaseConnection]
129    pub fn from_sqlx_sqlite_pool(pool: SqlitePool) -> DatabaseConnection {
130        DatabaseConnectionType::SqlxSqlitePoolConnection(SqlxSqlitePoolConnection {
131            pool,
132            metric_callback: None,
133        })
134        .into()
135    }
136}
137
138impl SqlxSqlitePoolConnection {
139    /// Execute a [Statement] on a SQLite backend
140    #[instrument(level = "trace")]
141    pub async fn execute(&self, stmt: Statement) -> Result<ExecResult, DbErr> {
142        debug_print!("{}", stmt);
143
144        let query = sqlx_query(&stmt);
145        let mut conn = self.pool.acquire().await.map_err(sqlx_conn_acquire_err)?;
146        crate::metric::metric!(self.metric_callback, &stmt, {
147            match query.execute(&mut *conn).await {
148                Ok(res) => Ok(res.into()),
149                Err(err) => Err(sqlx_error_to_exec_err(err)),
150            }
151        })
152    }
153
154    /// Execute an unprepared SQL statement on a SQLite backend
155    #[instrument(level = "trace")]
156    pub async fn execute_unprepared(&self, sql: &str) -> Result<ExecResult, DbErr> {
157        debug_print!("{}", sql);
158
159        let conn = &mut self.pool.acquire().await.map_err(sqlx_conn_acquire_err)?;
160        match conn.execute(sql).await {
161            Ok(res) => Ok(res.into()),
162            Err(err) => Err(sqlx_error_to_exec_err(err)),
163        }
164    }
165
166    /// Get one result from a SQL query. Returns [Option::None] if no match was found
167    #[instrument(level = "trace")]
168    pub async fn query_one(&self, stmt: Statement) -> Result<Option<QueryResult>, DbErr> {
169        debug_print!("{}", stmt);
170
171        let query = sqlx_query(&stmt);
172        let mut conn = self.pool.acquire().await.map_err(sqlx_conn_acquire_err)?;
173        crate::metric::metric!(self.metric_callback, &stmt, {
174            match query.fetch_one(&mut *conn).await {
175                Ok(row) => Ok(Some(row.into())),
176                Err(err) => match err {
177                    sqlx::Error::RowNotFound => Ok(None),
178                    _ => Err(sqlx_error_to_query_err(err)),
179                },
180            }
181        })
182    }
183
184    /// Get the results of a query returning them as a Vec<[QueryResult]>
185    #[instrument(level = "trace")]
186    pub async fn query_all(&self, stmt: Statement) -> Result<Vec<QueryResult>, DbErr> {
187        debug_print!("{}", stmt);
188
189        let query = sqlx_query(&stmt);
190        let mut conn = self.pool.acquire().await.map_err(sqlx_conn_acquire_err)?;
191        crate::metric::metric!(self.metric_callback, &stmt, {
192            match query.fetch_all(&mut *conn).await {
193                Ok(rows) => Ok(rows.into_iter().map(|r| r.into()).collect()),
194                Err(err) => Err(sqlx_error_to_query_err(err)),
195            }
196        })
197    }
198
199    /// Stream the results of executing a SQL query
200    #[instrument(level = "trace")]
201    pub async fn stream(&self, stmt: Statement) -> Result<QueryStream, DbErr> {
202        debug_print!("{}", stmt);
203
204        let conn = self.pool.acquire().await.map_err(sqlx_conn_acquire_err)?;
205        Ok(QueryStream::from((
206            conn,
207            stmt,
208            self.metric_callback.clone(),
209        )))
210    }
211
212    /// Bundle a set of SQL statements that execute together.
213    #[instrument(level = "trace")]
214    pub async fn begin(
215        &self,
216        isolation_level: Option<IsolationLevel>,
217        access_mode: Option<AccessMode>,
218        sqlite_transaction_mode: Option<SqliteTransactionMode>,
219    ) -> Result<DatabaseTransaction, DbErr> {
220        let conn = self.pool.acquire().await.map_err(sqlx_conn_acquire_err)?;
221        DatabaseTransaction::new_sqlite(
222            conn,
223            self.metric_callback.clone(),
224            isolation_level,
225            access_mode,
226            sqlite_transaction_mode,
227        )
228        .await
229    }
230
231    /// Create a SQLite transaction
232    #[instrument(level = "trace", skip(callback))]
233    pub async fn transaction<F, T, E>(
234        &self,
235        callback: F,
236        isolation_level: Option<IsolationLevel>,
237        access_mode: Option<AccessMode>,
238    ) -> Result<T, TransactionError<E>>
239    where
240        F: for<'b> FnOnce(
241                &'b DatabaseTransaction,
242            ) -> Pin<Box<dyn Future<Output = Result<T, E>> + Send + 'b>>
243            + Send,
244        T: Send,
245        E: std::fmt::Display + std::fmt::Debug + Send,
246    {
247        let conn = self.pool.acquire().await.map_err(sqlx_conn_acquire_err)?;
248        let transaction = DatabaseTransaction::new_sqlite(
249            conn,
250            self.metric_callback.clone(),
251            isolation_level,
252            access_mode,
253            None,
254        )
255        .await
256        .map_err(|e| TransactionError::Connection(e))?;
257        transaction.run(callback).await
258    }
259
260    pub(crate) fn set_metric_callback<F>(&mut self, callback: F)
261    where
262        F: Fn(&crate::metric::Info<'_>) + Send + Sync + 'static,
263    {
264        self.metric_callback = Some(Arc::new(callback));
265    }
266
267    /// Checks if a connection to the database is still valid.
268    pub async fn ping(&self) -> Result<(), DbErr> {
269        let conn = &mut self.pool.acquire().await.map_err(sqlx_conn_acquire_err)?;
270        match conn.ping().await {
271            Ok(_) => Ok(()),
272            Err(err) => Err(sqlx_error_to_conn_err(err)),
273        }
274    }
275
276    /// Explicitly close the SQLite connection.
277    /// See [`Self::close_by_ref`] for usage with references.
278    pub async fn close(self) -> Result<(), DbErr> {
279        self.close_by_ref().await
280    }
281
282    /// Explicitly close the SQLite connection
283    pub async fn close_by_ref(&self) -> Result<(), DbErr> {
284        self.pool.close().await;
285        Ok(())
286    }
287}
288
289impl From<SqliteRow> for QueryResult {
290    fn from(row: SqliteRow) -> QueryResult {
291        QueryResult {
292            row: QueryResultRow::SqlxSqlite(row),
293        }
294    }
295}
296
297impl From<SqliteQueryResult> for ExecResult {
298    fn from(result: SqliteQueryResult) -> ExecResult {
299        ExecResult {
300            result: ExecResultHolder::SqlxSqlite(result),
301        }
302    }
303}
304
305pub(crate) fn sqlx_query(stmt: &Statement) -> sqlx::query::Query<'_, Sqlite, SqlxValues> {
306    let values = stmt
307        .values
308        .as_ref()
309        .map_or(Values(Vec::new()), |values| values.clone());
310    sqlx::query_with(&stmt.sql, SqlxValues(values))
311}
312
313pub(crate) async fn set_transaction_config(
314    _conn: &mut PoolConnection<Sqlite>,
315    isolation_level: Option<IsolationLevel>,
316    access_mode: Option<AccessMode>,
317) -> Result<(), DbErr> {
318    if isolation_level.is_some() {
319        warn!("Setting isolation level in a SQLite transaction isn't supported");
320    }
321    if access_mode.is_some() {
322        warn!("Setting access mode in a SQLite transaction isn't supported");
323    }
324    Ok(())
325}
326
327#[cfg(feature = "sqlite-use-returning-for-3_35")]
328async fn get_version(conn: &SqlxSqlitePoolConnection) -> Result<String, DbErr> {
329    let stmt = Statement {
330        sql: "SELECT sqlite_version()".to_string(),
331        values: None,
332        db_backend: crate::DbBackend::Sqlite,
333    };
334    conn.query_one(stmt)
335        .await?
336        .ok_or_else(|| {
337            DbErr::Conn(RuntimeErr::Internal(
338                "Error reading SQLite version".to_string(),
339            ))
340        })?
341        .try_get_by(0)
342}
343
344impl
345    From<(
346        PoolConnection<sqlx::Sqlite>,
347        Statement,
348        Option<crate::metric::Callback>,
349    )> for crate::QueryStream
350{
351    fn from(
352        (conn, stmt, metric_callback): (
353            PoolConnection<sqlx::Sqlite>,
354            Statement,
355            Option<crate::metric::Callback>,
356        ),
357    ) -> Self {
358        crate::QueryStream::build(stmt, crate::InnerConnection::Sqlite(conn), metric_callback)
359    }
360}
361
362impl crate::DatabaseTransaction {
363    pub(crate) async fn new_sqlite(
364        inner: PoolConnection<sqlx::Sqlite>,
365        metric_callback: Option<crate::metric::Callback>,
366        isolation_level: Option<IsolationLevel>,
367        access_mode: Option<AccessMode>,
368        sqlite_transaction_mode: Option<SqliteTransactionMode>,
369    ) -> Result<crate::DatabaseTransaction, DbErr> {
370        Self::begin(
371            Arc::new(Mutex::new(crate::InnerConnection::Sqlite(inner))),
372            crate::DbBackend::Sqlite,
373            metric_callback,
374            isolation_level,
375            access_mode,
376            sqlite_transaction_mode,
377        )
378        .await
379    }
380}
381
382#[cfg(feature = "proxy")]
383pub(crate) fn from_sqlx_sqlite_row_to_proxy_row(row: &sqlx::sqlite::SqliteRow) -> crate::ProxyRow {
384    // https://docs.rs/sqlx-sqlite/0.7.2/src/sqlx_sqlite/type_info.rs.html
385    // https://docs.rs/sqlx-sqlite/0.7.2/sqlx_sqlite/types/index.html
386    use sea_query::Value;
387    use sqlx::{Column, Row, TypeInfo};
388    crate::ProxyRow {
389        values: row
390            .columns()
391            .iter()
392            .map(|c| {
393                (
394                    c.name().to_string(),
395                    match c.type_info().name() {
396                        "BOOLEAN" => {
397                            Value::Bool(row.try_get(c.ordinal()).expect("Failed to get boolean"))
398                        }
399
400                        "INTEGER" => {
401                            Value::Int(row.try_get(c.ordinal()).expect("Failed to get integer"))
402                        }
403
404                        "BIGINT" | "INT8" => Value::BigInt(
405                            row.try_get(c.ordinal()).expect("Failed to get big integer"),
406                        ),
407
408                        "REAL" => {
409                            Value::Double(row.try_get(c.ordinal()).expect("Failed to get double"))
410                        }
411
412                        "TEXT" => Value::String(
413                            row.try_get::<Option<String>, _>(c.ordinal())
414                                .expect("Failed to get string")
415                                .map(Box::new),
416                        ),
417
418                        "BLOB" => Value::Bytes(
419                            row.try_get::<Option<Vec<u8>>, _>(c.ordinal())
420                                .expect("Failed to get bytes")
421                                .map(Box::new),
422                        ),
423
424                        #[cfg(feature = "with-chrono")]
425                        "DATETIME" => {
426                            use chrono::{DateTime, Utc};
427
428                            Value::ChronoDateTimeUtc(
429                                row.try_get::<Option<DateTime<Utc>>, _>(c.ordinal())
430                                    .expect("Failed to get timestamp")
431                                    .map(Box::new),
432                            )
433                        }
434                        #[cfg(all(feature = "with-time", not(feature = "with-chrono")))]
435                        "DATETIME" => {
436                            use time::OffsetDateTime;
437                            Value::TimeDateTimeWithTimeZone(
438                                row.try_get::<Option<OffsetDateTime>, _>(c.ordinal())
439                                    .expect("Failed to get timestamp")
440                                    .map(Box::new),
441                            )
442                        }
443                        #[cfg(feature = "with-chrono")]
444                        "DATE" => {
445                            use chrono::NaiveDate;
446                            Value::ChronoDate(
447                                row.try_get::<Option<NaiveDate>, _>(c.ordinal())
448                                    .expect("Failed to get date")
449                                    .map(Box::new),
450                            )
451                        }
452                        #[cfg(all(feature = "with-time", not(feature = "with-chrono")))]
453                        "DATE" => {
454                            use time::Date;
455                            Value::TimeDate(
456                                row.try_get::<Option<Date>, _>(c.ordinal())
457                                    .expect("Failed to get date")
458                                    .map(Box::new),
459                            )
460                        }
461
462                        #[cfg(feature = "with-chrono")]
463                        "TIME" => {
464                            use chrono::NaiveTime;
465                            Value::ChronoTime(
466                                row.try_get::<Option<NaiveTime>, _>(c.ordinal())
467                                    .expect("Failed to get time")
468                                    .map(Box::new),
469                            )
470                        }
471                        #[cfg(all(feature = "with-time", not(feature = "with-chrono")))]
472                        "TIME" => {
473                            use time::Time;
474                            Value::TimeTime(
475                                row.try_get::<Option<Time>, _>(c.ordinal())
476                                    .expect("Failed to get time")
477                                    .map(Box::new),
478                            )
479                        }
480
481                        _ => unreachable!("Unknown column type: {}", c.type_info().name()),
482                    },
483                )
484            })
485            .collect(),
486    }
487}
sea_orm/driver/sqlx_sqlite.rs

sea_orm/driver/
sqlx_sqlite.rs
