PgPool

Struct PgPool 

Source
pub struct PgPool(/* private fields */);
Expand description

The shared PostgreSQL connection pool

§Example

use diesel_rocket_pg::PgPool;
use diesel::prelude::*;
use rocket::State;
use serde::Serialize;

#[macro_use] extern crate rocket;

diesel::table! {
    user (id) {
        id -> Int4,
        email -> Varchar,
        password -> Varchar,
    }
}

#[derive(Debug, Queryable, Serialize)]
pub struct AuthUser {
    pub id: i32,
    pub email: String,
    pub password: String,
}

#[get("/user/<mail>")]
async fn get_user(mail: String, pool: &State<PgPool>) -> String {
    let result = pool.run(move |conn| {

        user::dsl::user.filter(
            user::dsl::email.eq(mail)
        ).first::<AuthUser>(conn).ok()
    }).await.unwrap();

    if let Some(u) = result {
        format!("{:?}", u)
    } else {
        "User not found!".to_string()
    }
}

#[launch]
fn rocket() -> _ {
    let uri = "postgres://user:password123@localhost:5432/database";
    let pool = PgPool::create(uri).unwrap();

    rocket::build().manage(pool).mount("/", routes![get_user])
}

Implementations§

Source§

impl PgPool

Source

pub fn create<T: Into<String>>(uri: T) -> Result<Self>

Creates a new connection pool

§Arguments
  • uri - The postgresql connection string
§Example
use diesel_rocket_pg::PgPool;

fn main() {
    let uri = "postgres://user:password123@localhost:5432/database";
    let _pool = PgPool::create(uri).unwrap();
    /* ... */
}
Source

pub fn create_custom<T: Into<String>>( uri: T, builder: Builder<ConnectionManager<PgConnection>>, ) -> Result<Self>

Creates a new connection pool with a custom r2d2 configuration

§Arguments
  • uri - The postgresql connection string
  • builder - A r2d2::Builder with a custom configuration
§Example
use diesel_rocket_pg::PgPool;
use r2d2::Pool;

fn main() {
    let uri = "postgres://user:password123@localhost:5432/database";
    let builder = Pool::builder()
        .max_size(50)
        .min_idle(None)
        .max_lifetime(Some(Duration::from_secs(5)));
    let _pool = PgPool::create_custom(uri, builder).unwrap();
    /* ... */
}
Source

pub async fn run<F, R>(&self, func: F) -> Result<R>
where F: FnOnce(&mut PgConn) -> R + Send + 'static, R: Send + 'static,

Executes a diesel query in a tokio task

§Example
#[get("/user/<mail>")]
async fn get_user(mail: String, pool: &State<PgPool>) -> AuthUser {
    let auth_user = pool.run(move |conn| {
        user::dsl::user.filter(
            user::dsl::email.eq(mail)
        ).first::<AuthUser>(conn).unwrap()
    }).await.unwrap();

    auth_user
}

Trait Implementations§

Source§

impl Clone for PgPool

Source§

fn clone(&self) -> PgPool

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 PgPool

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for PgPool

§

impl !RefUnwindSafe for PgPool

§

impl Send for PgPool

§

impl Sync for PgPool

§

impl Unpin for PgPool

§

impl !UnwindSafe for PgPool

Blanket Implementations§

Source§

impl<T> AggregateExpressionMethods for T

Source§

fn aggregate_distinct(self) -> Self::Output
where Self: DistinctDsl,

DISTINCT modifier for aggregate functions Read more
Source§

fn aggregate_all(self) -> Self::Output
where Self: AllDsl,

ALL modifier for aggregate functions Read more
Source§

fn aggregate_filter<P>(self, f: P) -> Self::Output
where P: AsExpression<Bool>, Self: FilterDsl<<P as AsExpression<Bool>>::Expression>,

Add an aggregate function filter Read more
Source§

fn aggregate_order<O>(self, o: O) -> Self::Output
where Self: OrderAggregateDsl<O>,

Add an aggregate function order Read more
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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Sync + Send>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

Source§

fn into_sql<T>(self) -> Self::Expression

Convert self to an expression for Diesel’s query builder. Read more
Source§

fn as_sql<'a, T>(&'a self) -> <&'a Self as AsExpression<T>>::Expression
where &'a Self: AsExpression<T>, T: SqlType + TypedExpressionType,

Convert &self to an expression for Diesel’s query builder. Read more
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<T> WindowExpressionMethods for T

Source§

fn over(self) -> Self::Output
where Self: OverDsl,

Turn a function call into a window function call Read more
Source§

fn window_filter<P>(self, f: P) -> Self::Output
where P: AsExpression<Bool>, Self: FilterDsl<<P as AsExpression<Bool>>::Expression>,

Add a filter to the current window function Read more
Source§

fn partition_by<E>(self, expr: E) -> Self::Output
where Self: PartitionByDsl<E>,

Add a partition clause to the current window function Read more
Source§

fn window_order<E>(self, expr: E) -> Self::Output
where Self: OrderWindowDsl<E>,

Add a order clause to the current window function Read more
Source§

fn frame_by<E>(self, expr: E) -> Self::Output
where Self: FrameDsl<E>,

Add a frame clause to the current window function Read more