Struct Database

pub struct Database(/* private fields */);

Main API wrapper.

All operations can be started with methods of this struct.

Implementations

impl Database

pub async fn connect( configuration: DatabaseConfiguration, ) -> Result<Self, Error>

Connect to the database using configuration.

pub async fn raw_sql<'a>( &self, query_string: &'a str, bind_params: Option<&[Value<'a>]>, transaction: Option<&mut Transaction>, ) -> Result<Vec<Row>, Error>

Execute raw SQL statements on the database.

If possible, the statement is executed as prepared statement.

To bind parameter, use ? as placeholder in SQLite and MySQL and $1, $2, $n in Postgres.

Parameter:

• query_string: Reference to a valid SQL query.
• bind_params: Optional list of values to bind in the query.
• transaction: Optional transaction to execute the query on.

Returns a list of rows. If there are no values to retrieve, an empty list is returned.

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

Entry point for a Transaction.

pub async fn close(self)

Closes the database connection

Trait Implementations

impl Clone for Database

fn clone(&self) -> Database

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Drop for Database

fn drop(&mut self)

Executes the destructor for this type.

impl<'executor> Executor<'executor> for &'executor Database

type EnsureTransactionFuture = Pin<Box<dyn Future<Output = Result<TransactionGuard<'executor>, Error>> + Send + 'executor>>

A future producing a TransactionGuard returned by ensure_transaction

fn execute<'data, 'result, Q>( self, query: String, values: Vec<Value<'data>>, ) -> Q::Result<'result>

where Q: QueryStrategy, 'executor: 'result, 'data: 'result,

Execute a query

fn dialect(&self) -> DBImpl

Get the executor’s sql dialect.

fn ensure_transaction( self, ) -> BoxFuture<'executor, Result<TransactionGuard<'executor>, Error>>

Ensure a piece of code is run inside a transaction using a TransactionGuard.