Skip to main content

SqliteEngine

Struct SqliteEngine 

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

SQLite query engine backed by tokio_rusqlite.

§Breaking changes (0.7)

SqliteEngine no longer has inherent query / query_one / query_opt methods that returned untyped RowData / serde_json::Value. It now implements prax_query::traits::QueryEngine, whose row-returning methods are generic over T: Model + FromRow and return typed models.

Migration:

See CHANGELOG.md for the full migration guide.

§Transaction mode

SqliteEngine has two modes, controlled by tx_conn:

  • Pool mode (tx_conn == None, default): each query acquires a fresh SqliteConnection from the pool and drops it after the call.
  • Transaction mode (tx_conn == Some(..)): each query routes through the same tokio_rusqlite::Connection handle so the whole BEGIN…COMMIT block serialises onto the connection’s background thread in order. The Arc<SqliteConnection> keeps the pool permit alive for the transaction’s lifetime; dropping the last clone returns the connection to the idle pool.

Implementations§

Source§

impl SqliteEngine

Source

pub fn new(pool: SqlitePool) -> Self

Create a new engine with the given pool.

Source

pub fn pool(&self) -> &SqlitePool

Get a reference to the connection pool.

Trait Implementations§

Source§

impl Clone for SqliteEngine

Source§

fn clone(&self) -> SqliteEngine

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 SqliteEngine

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>, ) -> 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. Read more
Source§

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

impl SupportsCorrelatedSubquery for SqliteEngine

Source§

impl SupportsGeneratedColumns for SqliteEngine

Source§

impl SupportsJsonPath for SqliteEngine

Source§

impl SupportsNestedWrites for SqliteEngine

Source§

impl SupportsRelationFilter for SqliteEngine

Source§

impl SupportsScalarSubqueryInSelect for SqliteEngine

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