Struct Database 

pub struct Database { /* private fields */ }

The connection pool for one database. Clone-free: share it behind an Arc or in Rocket’s state.

The driver comes from the URL’s scheme: mysql:// (or mariadb://), postgres:// (or postgresql://) and sqlite:. A scheme whose feature is not enabled is an error.

Implementations

impl Database

pub async fn connect(url: &str) -> Result<Self, Error>

Connects to the database at url, such as mysql://user:password@host/database, postgres://user:password@host/database or sqlite:path/to/file.db.

pub async fn connect_with( url: &str, options: PoolOptions, ) -> Result<Self, Error>

Connects to the database at url with the pool settings in options. connect uses PoolOptions::default().

pub fn driver(&self) -> Driver

The database this pool talks to.

pub fn pool(&self) -> &MySqlPool

The MySQL pool, for queries that Orbit does not wrap yet.

Panics

Panics when the database is not MySQL. Check driver() first, or use postgres_pool or sqlite_pool.

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

Checks that the database answers.

pub async fn transaction<T, E, F>(&self, f: F) -> Result<T, E>

where E: From<Error>, F: AsyncFnOnce(&mut Transaction) -> Result<T, E>,

Runs f in a transaction and returns what it returns. The transaction commits when f returns Ok and rolls back when it returns Err. A panic in f rolls it back too, since nothing commits before f returns. Queries that must run inside the transaction take it as &mut *tx.

The closure is an async closure: db.transaction(async |tx| { ... Ok(value) }).await.

pub async fn close(&self)

Closes every connection in the pool.

Trait Implementations

impl Debug for Database

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

Formats the value using the given formatter.

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