Expand description
§sqlx-transaction-manager
A type-safe transaction management wrapper for SQLx with automatic commit/rollback.
§Features
- Automatic Rollback: Transactions automatically roll back on drop if not explicitly committed
- Type-Safe: Transaction boundaries are enforced at compile time
- Ergonomic API: Simple
with_transactionfunction for common use cases - Nested Transactions: Support for savepoints to simulate nested transactions
- Zero Runtime Overhead: Thin wrapper around SQLx’s native transaction support
§Quick Start
Add to your Cargo.toml:
[dependencies]
sqlx = { version = "0.8", features = ["mysql", "runtime-tokio"] }
sqlx-transaction-manager = "0.1"§Examples
§Basic Transaction
use sqlx::MySqlPool;
use sqlx_transaction_manager::with_transaction;
let pool = MySqlPool::connect("mysql://localhost/test").await?;
with_transaction(&pool, |tx| {
Box::pin(async move {
sqlx::query("INSERT INTO users (name) VALUES (?)")
.bind("Alice")
.execute(tx.as_executor())
.await?;
Ok::<_, sqlx::Error>(())
})
}).await?;§Multiple Operations
use sqlx::MySqlPool;
use sqlx_transaction_manager::with_transaction;
let user_id = with_transaction(&pool, |tx| {
Box::pin(async move {
// Insert user
let result = sqlx::query("INSERT INTO users (name) VALUES (?)")
.bind("Bob")
.execute(tx.as_executor())
.await?;
let user_id = result.last_insert_id() as i64;
// Insert profile (same transaction)
sqlx::query("INSERT INTO profiles (user_id, bio) VALUES (?, ?)")
.bind(user_id)
.bind("Software Developer")
.execute(tx.as_executor())
.await?;
// Both operations commit together
Ok::<_, sqlx::Error>(user_id)
})
}).await?;
println!("Created user with ID: {}", user_id);§Using with sqlx-named-bind
This library works seamlessly with sqlx-named-bind:
use sqlx::MySqlPool;
use sqlx_transaction_manager::with_transaction;
use sqlx_named_bind::PreparedQuery;
with_transaction(&pool, |tx| {
Box::pin(async move {
let name = "Charlie".to_string();
let age = 30;
let mut query = PreparedQuery::new(
"INSERT INTO users (name, age) VALUES (:name, :age)",
|q, key| match key {
":name" => q.bind(name.clone()),
":age" => q.bind(age),
_ => q,
}
)?;
query.execute(tx.as_executor()).await?;
Ok::<_, sqlx_named_bind::Error>(())
})
}).await?;§Nested Transactions (Savepoints)
use sqlx::MySqlPool;
use sqlx_transaction_manager::{with_transaction, with_nested_transaction};
with_transaction(&pool, |tx| {
Box::pin(async move {
// Main transaction operations
sqlx::query("INSERT INTO users (name) VALUES (?)")
.bind("David")
.execute(tx.as_executor())
.await?;
// Nested transaction with savepoint
let _ = with_nested_transaction(tx, |nested_tx| {
Box::pin(async move {
sqlx::query("INSERT INTO audit_log (action) VALUES (?)")
.bind("User created")
.execute(nested_tx.as_executor())
.await?;
Ok::<_, sqlx::Error>(())
})
}).await; // If this fails, only the audit log is rolled back
Ok::<_, sqlx::Error>(())
})
}).await?;§Manual Transaction Control
For more control, use TransactionContext directly:
use sqlx::MySqlPool;
use sqlx_transaction_manager::TransactionContext;
let mut tx = TransactionContext::begin(&pool).await?;
sqlx::query("INSERT INTO users (name) VALUES (?)")
.bind("Eve")
.execute(tx.as_executor())
.await?;
// Explicitly commit
tx.commit().await?;§Error Handling
When an error occurs inside a transaction, it automatically rolls back:
use sqlx::MySqlPool;
use sqlx_transaction_manager::with_transaction;
let result = with_transaction(&pool, |tx| {
Box::pin(async move {
sqlx::query("INSERT INTO users (name) VALUES (?)")
.bind("Frank")
.execute(tx.as_executor())
.await?;
// This will cause a rollback
return Err(sqlx::Error::RowNotFound);
#[allow(unreachable_code)]
Ok::<_, sqlx::Error>(())
})
}).await;
assert!(result.is_err());
// The INSERT was rolled back, "Frank" is not in the database§How It Works
- TransactionContext: Wraps SQLx’s
Transactionand tracks its state - Automatic Cleanup: Uncommitted transactions are rolled back on drop
- Type Safety: Consumed transactions can’t be reused (enforced at compile time)
- Executor Access: Provides
&mut MySqlConnectionfor use with SQLx queries
§Limitations
- Currently only supports MySQL (PostgreSQL and SQLite support planned)
- Nested transactions use savepoints (MySQL limitation)
- Error type is
sqlx_transaction_manager::Error(wrapssqlx::Error)
§License
Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Re-exports§
pub use context::TransactionContext;pub use error::Error;pub use error::Result;pub use executor::with_nested_transaction;pub use executor::with_transaction;