Skip to main content

SqlxEngine

Struct SqlxEngine 

Source
pub struct SqlxEngine { /* private fields */ }
Expand description

SQLx-based query engine for Prax.

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

§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§

Source§

impl SqlxEngine

Source

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

Create a new SQLx engine from configuration.

Source

pub fn from_pool(pool: SqlxPool) -> Self

Create a new engine from an existing pool.

Source

pub fn backend(&self) -> DatabaseBackend

Get the database backend type.

Source

pub fn pool(&self) -> &SqlxPool

Get the connection pool.

Source

pub async fn close(&self)

Close the engine and all connections.

Source

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

Execute a raw SQL query and return multiple rows.

Source

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

Execute a raw SQL query and return a single row.

Source

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

Execute a raw SQL query and return an optional row.

Source

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

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

Source

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

Count rows in a table with optional filter.

Trait Implementations§

Source§

impl Clone for SqlxEngine

Source§

fn clone(&self) -> SqlxEngine

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl QueryEngine for SqlxEngine

Source§

fn dialect(&self) -> &dyn SqlDialect

The SQL dialect this engine targets. Read more
Source§

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.
Source§

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

Execute a SELECT query expecting one result.
Source§

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.
Source§

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.
Source§

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.
Source§

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

Execute a DELETE query and return affected rows count.
Source§

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

Execute a raw SQL query.
Source§

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

Get a count of records.
Source§

fn aggregate_query( &self, sql: &str, params: Vec<FilterValue>, ) -> Pin<Box<dyn Future<Output = Result<Vec<HashMap<String, FilterValue>>, QueryError>> + Send + '_>>

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

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

Refresh a materialized view. Read more
Source§

fn in_transaction(&self) -> bool

Whether this engine is currently executing inside an open transaction. Read more
Source§

fn transaction<'a, R, Fut, F>( &'a self, f: F, ) -> Pin<Box<dyn Future<Output = Result<R, QueryError>> + Send + 'a>>
where F: FnOnce(Self) -> Fut + Send + 'a, Fut: Future<Output = Result<R, QueryError>> + Send + 'a, R: Send + 'a, Self: Clone,

Run the closure inside a transaction. Read more
Source§

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.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ProcedureEngine for T
where T: QueryEngine + Clone + 'static,

Source§

fn call(&self, name: impl Into<String>) -> ProcedureCall

Call a stored procedure.
Source§

fn function(&self, name: impl Into<String>) -> ProcedureCall

Call a function.
Source§

fn execute_procedure( &self, call: ProcedureCall, ) -> Pin<Box<dyn Future<Output = Result<ProcedureResult, QueryError>> + Send + '_>>
where Self: Clone + 'static,

Execute a procedure call.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more