Skip to main content

DatabaseClient

Enum DatabaseClient 

Source
pub enum DatabaseClient {
    Postgres(PgPool),
}
Expand description

The database client, wrapping an sqlx connection pool.

Supports PostgreSQL and SQLite via feature flags.

Variants§

§

Postgres(PgPool)

Implementations§

Source§

impl DatabaseClient

Source

pub async fn connect_postgres(url: &str) -> Result<Self, FerriormError>

Connect to a PostgreSQL database.

Source

pub async fn connect_postgres_with_config( url: &str, config: &PoolConfig, ) -> Result<Self, FerriormError>

Connect to a PostgreSQL database with custom pool configuration.

Source

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

Connect by auto-detecting the database type from the URL.

Source

pub async fn connect_with_config( url: &str, config: &PoolConfig, ) -> Result<Self, FerriormError>

Connect by auto-detecting the database type from the URL, using custom pool configuration.

Source

pub fn pg_pool(&self) -> Result<&PgPool, FerriormError>

Get a reference to the underlying PostgreSQL pool for raw queries.

Returns an error if this client is not connected to PostgreSQL.

Source

pub async fn disconnect(self)

Close the connection pool.

Source

pub async fn raw_fetch_all_pg<T>( &self, sql: &str, ) -> Result<Vec<T>, FerriormError>
where T: for<'r> FromRow<'r, PgRow> + Send + Unpin,

Execute raw SQL and return all rows mapped to T (PostgreSQL).

Source

pub async fn raw_fetch_one_pg<T>(&self, sql: &str) -> Result<T, FerriormError>
where T: for<'r> FromRow<'r, PgRow> + Send + Unpin,

Execute raw SQL and return exactly one row mapped to T (PostgreSQL).

Source

pub async fn raw_fetch_optional_pg<T>( &self, sql: &str, ) -> Result<Option<T>, FerriormError>
where T: for<'r> FromRow<'r, PgRow> + Send + Unpin,

Execute raw SQL and return an optional row mapped to T (PostgreSQL).

Source

pub async fn raw_execute_pg(&self, sql: &str) -> Result<u64, FerriormError>

Execute raw SQL without returning rows (PostgreSQL). Returns the number of rows affected.

Source

pub async fn fetch_all_pg<'q, T>( &self, qb: QueryBuilder<'q, Postgres>, ) -> Result<Vec<T>, FerriormError>
where T: for<'r> FromRow<'r, PgRow> + Send + Unpin,

Execute a query builder against the appropriate pool, returning all rows.

Source

pub async fn fetch_optional_pg<'q, T>( &self, qb: QueryBuilder<'q, Postgres>, ) -> Result<Option<T>, FerriormError>
where T: for<'r> FromRow<'r, PgRow> + Send + Unpin,

Source

pub async fn fetch_one_pg<'q, T>( &self, qb: QueryBuilder<'q, Postgres>, ) -> Result<T, FerriormError>
where T: for<'r> FromRow<'r, PgRow> + Send + Unpin,

Source

pub async fn execute_pg<'q>( &self, qb: QueryBuilder<'q, Postgres>, ) -> Result<u64, FerriormError>

Trait Implementations§

Source§

impl Clone for DatabaseClient

Source§

fn clone(&self) -> DatabaseClient

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DatabaseClient

Source§

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

Formats the value using the given formatter. Read more

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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