rustauth-sqlx 0.2.0

SQLx database adapters for RustAuth.
Documentation 
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

use rustauth_core::error::RustAuthError;
use sqlx::pool::PoolConnection;
use sqlx::sqlite::SqlitePoolOptions;
use sqlx::{Executor, Sqlite, SqlitePool, Transaction};

use super::errors::sql_error;

/// Recommended [`SqlitePoolOptions`] for RustAuth SQLite adapters.
///
/// Enables `PRAGMA foreign_keys = ON` on every connection checked out from the pool.
pub fn pool_options() -> SqlitePoolOptions {
    SqlitePoolOptions::new().after_connect(|connection, _metadata| {
        Box::pin(async move {
            connection.execute("PRAGMA foreign_keys = ON").await?;
            Ok(())
        })
    })
}

pub(super) async fn acquire_with_foreign_keys(
    pool: &SqlitePool,
) -> Result<PoolConnection<Sqlite>, sqlx::Error> {
    let mut connection = pool.acquire().await?;
    connection
        .execute("PRAGMA foreign_keys = ON")
        .await
        .map(|_| ())?;
    Ok(connection)
}

pub(super) async fn enable_on_transaction(
    transaction: &mut Transaction<'_, Sqlite>,
) -> Result<(), RustAuthError> {
    transaction
        .execute("PRAGMA foreign_keys = ON")
        .await
        .map(|_| ())
        .map_err(sql_error)
}

/// Starts a write transaction that acquires SQLite's reserved lock immediately.
///
/// Rate-limit consumes must use this instead of a deferred `BEGIN` so concurrent
/// pool connections cannot read stale counts before another transaction commits.
pub(super) async fn begin_immediate_transaction(
    pool: &SqlitePool,
) -> Result<Transaction<'_, Sqlite>, RustAuthError> {
    let connection = acquire_with_foreign_keys(pool).await.map_err(sql_error)?;
    Transaction::begin(connection, Some("BEGIN IMMEDIATE".into()))
        .await
        .map_err(sql_error)
}