zeph-db 0.21.4

Database abstraction layer for Zeph (SQLite and PostgreSQL backends)
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

// SPDX-FileCopyrightText: 2026 Andrei G <bug-ops>
// SPDX-License-Identifier: MIT OR Apache-2.0

use crate::DbPool;

/// Begin a standard deferred transaction.
///
/// # Errors
///
/// Returns a sqlx error if the transaction cannot be started.
#[tracing::instrument(name = "db.tx.begin", skip_all, err)]
pub async fn begin(pool: &DbPool) -> Result<crate::DbTransaction<'_>, sqlx::Error> {
    pool.begin().await
}

/// Begin a write-intent transaction.
///
/// `SQLite`: issues `BEGIN IMMEDIATE` to acquire the write lock upfront,
/// preventing `SQLITE_BUSY` errors when another writer is active.
///
/// `PostgreSQL`: issues a standard `BEGIN` (MVCC handles concurrency).
/// Callers that need write-exclusion semantics must use `SELECT ... FOR UPDATE`
/// inside the transaction.
///
/// # Errors
///
/// Returns a sqlx error if the transaction cannot be started.
#[cfg(all(feature = "sqlite", not(feature = "postgres")))]
#[tracing::instrument(name = "db.tx.begin_write", skip_all, err)]
pub async fn begin_write(pool: &DbPool) -> Result<crate::DbTransaction<'_>, sqlx::Error> {
    pool.begin_with("BEGIN IMMEDIATE").await
}

/// Begin a read-write transaction on `PostgreSQL`.
///
/// # Errors
///
/// Returns a sqlx error if the transaction cannot be started.
#[cfg(feature = "postgres")]
#[tracing::instrument(name = "db.tx.begin_write", skip_all, err)]
pub async fn begin_write(pool: &DbPool) -> Result<crate::DbTransaction<'_>, sqlx::Error> {
    pool.begin().await
}