Struct SqlxEngine 

pub struct SqlxEngine { /* private fields */ }

SQLx-based query engine for Prax.

This engine provides compile-time checked queries through SQLx, supporting PostgreSQL, MySQL, and SQLite.

Two modes, controlled by the tx field:

• Pool mode (tx == None, the default): each query acquires a fresh connection from the pool and drops it after the call.
• Transaction mode (tx == Some(handle)): every query routes through the transaction’s pinned connection. The tx-bound engine is built by QueryEngine::transaction, which issues COMMIT or ROLLBACK on the same transaction when the closure resolves.

Example

use prax_sqlx::{SqlxEngine, SqlxConfig};

let config = SqlxConfig::from_url("postgres://localhost/mydb")?;
let engine = SqlxEngine::new(config).await?;

// Execute queries
let count = engine.count_table("users", None).await?;

Implementations

impl SqlxEngine

pub async fn new(config: SqlxConfig) -> SqlxResult<Self>

Create a new SQLx engine from configuration.

pub fn from_pool(pool: SqlxPool) -> Self

Create a new engine from an existing pool.

pub fn backend(&self) -> DatabaseBackend

Get the database backend type.

pub fn pool(&self) -> &SqlxPool

Get the connection pool.

pub async fn close(&self)

Close the engine and all connections.

pub async fn raw_query_many( &self, sql: &str, params: &[FilterValue], ) -> SqlxResult<Vec<SqlxRow>>

Execute a raw SQL query and return multiple rows.

pub async fn raw_query_one( &self, sql: &str, params: &[FilterValue], ) -> SqlxResult<SqlxRow>

Execute a raw SQL query and return a single row.

pub async fn raw_query_optional( &self, sql: &str, params: &[FilterValue], ) -> SqlxResult<Option<SqlxRow>>

Execute a raw SQL query and return an optional row.

pub async fn raw_execute( &self, sql: &str, params: &[FilterValue], ) -> SqlxResult<u64>

Execute a SQL statement (INSERT, UPDATE, DELETE) and return affected rows.

pub async fn count_table( &self, table: &str, filter: Option<&str>, ) -> SqlxResult<u64>

Count rows in a table with optional filter.

Trait Implementations

impl Clone for SqlxEngine

fn clone(&self) -> SqlxEngine

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl QueryEngine for SqlxEngine

fn dialect(&self) -> &dyn SqlDialect

The SQL dialect this engine targets.

fn query_many<T: Model + FromRow + Send + 'static>( &self, sql: &str, params: Vec<FilterValue>, ) -> BoxFuture<'_, QueryResult<Vec<T>>>

Execute a SELECT query and return rows.

fn query_one<T: Model + FromRow + Send + 'static>( &self, sql: &str, params: Vec<FilterValue>, ) -> BoxFuture<'_, QueryResult<T>>

Execute a SELECT query expecting one result.

fn query_optional<T: Model + FromRow + Send + 'static>( &self, sql: &str, params: Vec<FilterValue>, ) -> BoxFuture<'_, QueryResult<Option<T>>>

Execute a SELECT query expecting zero or one result.

fn execute_insert<T: Model + FromRow + Send + 'static>( &self, sql: &str, params: Vec<FilterValue>, ) -> BoxFuture<'_, QueryResult<T>>

Execute an INSERT query and return the created row.

fn execute_update<T: Model + FromRow + Send + 'static>( &self, sql: &str, params: Vec<FilterValue>, ) -> BoxFuture<'_, QueryResult<Vec<T>>>

Execute an UPDATE query and return affected rows.

fn execute_delete( &self, sql: &str, params: Vec<FilterValue>, ) -> BoxFuture<'_, QueryResult<u64>>

Execute a DELETE query and return affected rows count.

fn execute_raw( &self, sql: &str, params: Vec<FilterValue>, ) -> BoxFuture<'_, QueryResult<u64>>

Execute a raw SQL query.

fn count( &self, sql: &str, params: Vec<FilterValue>, ) -> BoxFuture<'_, QueryResult<u64>>

Get a count of records.

fn aggregate_query( &self, sql: &str, params: Vec<FilterValue>, ) -> BoxFuture<'_, QueryResult<Vec<HashMap<String, FilterValue>>>>

Execute an aggregate query (COUNT/SUM/AVG/MIN/MAX/GROUP BY) and return one map of column name → crate::filter::FilterValue per result row.

fn in_transaction(&self) -> bool

Whether this engine is currently executing inside an open transaction.

fn transaction<'a, R, Fut, F>(&'a self, f: F) -> BoxFuture<'a, QueryResult<R>>

where F: FnOnce(Self) -> Fut + Send + 'a, Fut: Future<Output = QueryResult<R>> + Send + 'a, R: Send + 'a, Self: Clone,

Run the closure inside a transaction.

fn refresh_materialized_view( &self, view_name: &str, concurrently: bool, ) -> Pin<Box<dyn Future<Output = Result<(), QueryError>> + Send + '_>>

Refresh a materialized view.

impl SupportsScalarSubqueryInSelect for SqlxEngine

SQLx routes exclusively to SQL backends (Postgres, MySQL, SQLite), all of which support scalar subqueries in SELECT. Implementing this marker here lets callers use [FindManyOperation::with_scalar_projection] and its siblings on SqlxEngine just like the individual SQL engine crates.