Struct Database 

pub struct Database { /* private fields */ }

A Turso database with a pool of connections.

Cloning is cheap; every clone shares the same engine handle and pool.

Implementations

impl Database

pub async fn connect( options: impl Into<ConnectOptions>, ) -> Result<Database, Error>

Opens the database described by options.

One connection is opened eagerly and dropped back into the pool so that a bad path, a wrong key or a rejected pragma fails here rather than on the first query.

Errors

Returns Error::InvalidOptions when encryption is combined with a sync source, and Error::Turso with ErrorKind::Connection or ErrorKind::Other when the engine cannot open the database, open the first connection or apply its pragmas.

pub fn options(&self) -> &ConnectOptions

The options this database was opened with.

pub async fn ping(&self) -> Result<(), Error>

Checks that the database answers queries.

Errors

Returns Error::PoolTimeout when no connection is free within the acquire timeout, Error::Misuse when the pool is closed, and Error::Turso when a connection cannot be opened or the probe query fails.

pub async fn push(&self) -> Result<(), Error>

Available on crate feature sync only.

Pushes local changes to Turso Cloud — embedded replica only.

Errors

Returns Error::InvalidOptions when this database is not a replica, and Error::Turso when the sync fails.

pub async fn pull(&self) -> Result<bool, Error>

Available on crate feature sync only.

Pulls remote changes from Turso Cloud — embedded replica only — and returns whether anything changed.

Errors

Returns Error::InvalidOptions when this database is not a replica, and Error::Turso when the sync fails.

Trait Implementations

impl Clone for Database

fn clone(&self) -> Database

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConnectionTrait for Database

fn execute<'life0, 'async_trait>( &'life0 self, statement: Statement, ) -> Pin<Box<dyn Future<Output = Result<ExecResult, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Database: 'async_trait,

Runs a statement that returns no rows.

fn execute_unprepared<'life0, 'life1, 'async_trait>( &'life0 self, sql: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<ExecResult, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Database: 'async_trait,

Runs one or more ;-separated statements without parameters.

fn query_one<'life0, 'async_trait>( &'life0 self, statement: Statement, ) -> Pin<Box<dyn Future<Output = Result<Option<Row>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Database: 'async_trait,

Fetches at most one row.

fn query_all<'life0, 'async_trait>( &'life0 self, statement: Statement, ) -> Pin<Box<dyn Future<Output = Result<Vec<Row>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Database: 'async_trait,

Fetches all rows.

impl ConnectionTrait for &Database

fn execute<'life0, 'async_trait>( &'life0 self, statement: Statement, ) -> Pin<Box<dyn Future<Output = Result<ExecResult, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, &Database: 'async_trait,

Runs a statement that returns no rows.

fn execute_unprepared<'life0, 'life1, 'async_trait>( &'life0 self, sql: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<ExecResult, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, &Database: 'async_trait,

Runs one or more ;-separated statements without parameters.

fn query_one<'life0, 'async_trait>( &'life0 self, statement: Statement, ) -> Pin<Box<dyn Future<Output = Result<Option<Row>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, &Database: 'async_trait,

Fetches at most one row.

fn query_all<'life0, 'async_trait>( &'life0 self, statement: Statement, ) -> Pin<Box<dyn Future<Output = Result<Vec<Row>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, &Database: 'async_trait,

Fetches all rows.

impl Debug for Database

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl StreamTrait for Database

fn stream<'a>( &'a self, statement: Statement, ) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = Result<Row, Error>> + Send + 'a>>, Error>> + Send + 'a>>

Runs a query and streams its rows.

impl TransactionTrait for Database

fn begin<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Transaction, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Database: 'async_trait,

Begins with BEGIN DEFERRED, or a savepoint when called on a transaction.

fn begin_with_mode<'life0, 'async_trait>( &'life0 self, mode: TransactionMode, ) -> Pin<Box<dyn Future<Output = Result<Transaction, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Database: 'async_trait,

Begins with an explicit mode; the mode is ignored for nested transactions, which are always savepoints.

fn transaction<'life0, 'async_trait, F, T, E>( &'life0 self, callback: F, ) -> Pin<Box<dyn Future<Output = Result<T, E>> + Send + 'async_trait>>

where 'life0: 'async_trait, F: for<'c> FnOnce(&'c Transaction) -> Pin<Box<dyn Future<Output = Result<T, E>> + Send + 'c>> + Send + 'async_trait, T: Send + 'async_trait, E: From<Error> + Send + 'async_trait, Self: 'async_trait,

Runs callback inside a transaction, committing on Ok and rolling back on Err.