Struct DefaultDb 

pub struct DefaultDb {
    pub(crate) pool: PgPool,
    pub(crate) acquired: Option<PoolConnection<Postgres>>,
}

Default implementation that works without a transaction

Fields

pool: PgPool

db pool

acquired: Option<PoolConnection<Postgres>>

when starting a transaction,

Implementations

impl DefaultDb

pub fn new(pool: PgPool) -> DefaultDb

Creates a new db instance.

pub async fn from_env() -> Result<Self, DatabaseError>

Connects to a postgresql database, using environment variables. If the DATABASE_URL variable is set, connection options are derived from it. Otherwise, refer to [PgConnectOptions::new_without_pgpass()] for the specific environment variables used for configuration. If the ARMINIUS_LAZY environment variable is set to 1 or true, a lazy connection pool is created, meaning that an actual connection attempt is deferred until the first query is executed.

pub async fn connect( pg_connect_options: PgConnectOptions, pg_pool_options: PgPoolOptions, lazy: bool, ) -> Result<Self, DatabaseError>

Connect to a PostgreSQL database endpoint. Creates a connection pool with the given [PgConnectOptions] and [PgPoolOptions].

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

Run the migrations defined in the migrations directory.

pub async fn run_migrations_with( &self, migrator: &Migrator, ) -> Result<(), Error>

Run the migrations from the given Migrator

pub async fn listener(&self) -> Result<PgListener, DatabaseError>

Create a PgListener using this instance’s connection pool

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

Run a database connectivity check

Trait Implementations

impl AsRef<Pool<Postgres>> for DefaultDb

Available on crate feature expose_pool only.

Exposes the inner connection pool. Unfortunately, this is still required because some tests are still using sqlx directly.

fn as_ref(&self) -> &PgPool

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for DefaultDb

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Database for DefaultDb

async fn connection(&mut self) -> Result<&mut RawPgConnection, DatabaseError>

Acquires a new connection from the pool.

async fn begin_transaction<'c>( &'c mut self, ) -> Result<TransactedDb<'c>, DatabaseError>

Starts a new transaction, acquiring a fresh connection from the pool Once a transaction has been started, it is the callers’ responsibility to make changes permanent by committing it. If the transaction is dropped without being committed, all changes are rolled back.

impl Debug for DefaultDb

for whatever reason…

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

Formats the value using the given formatter.