Struct Pool 

pub struct Pool { /* private fields */ }

connection pool for a set of connections to database. Can be used as entry point of query

Examples

let pool = xitca_postgres::pool::Pool::builder("db_url").build()?;
xitca_postgres::Statement::named("SELECT 1", &[]).bind_none().execute(&pool).await?;

Caching

When connection pool is used as executor through Execute::query and Execute::execute methods it would prepare and cache statement for reuse. For selective caching consider use PoolConnection

Implementations

impl Pool

pub fn builder<C>(cfg: C) -> PoolBuilder

where Config: TryFrom<C>, Error: From<<Config as TryFrom<C>>::Error>,

start a builder of pool where it’s behavior can be configured.

pub async fn get(&self) -> Result<PoolConnection<'_>, Error>

try to get a connection from pool. when pool is empty it will try to spawn new connection to database and if the process failed the outcome will return as Error

pub fn config(&self) -> &Config

get configration of current connection pool.

Trait Implementations

impl<'c, 's> Execute<&'c Pool> for &'s str

where 's: 'c,

Available on non-crate feature nightly only.

type ExecuteOutput = Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'c>>

outcome of execute. used for single time database response: number of rows affected by execution for example.

type QueryOutput = Pin<Box<dyn Future<Output = Result<GenericRowStream<Vec<Column>, NoTyped>, Error>> + Send + 'c>>

outcome of query. used for repeated database response: database rows for example

fn execute(self, pool: &'c Pool) -> Self::ExecuteOutput

define how a statement is executed with single time response

fn query(self, pool: &'c Pool) -> Self::QueryOutput

define how a statement is queried with repeated response

impl<'c, 's, P, const N: usize> Execute<&'c Pool> for [StatementQuery<'s, P>; N]

where P: AsParams + Send + 'c, 's: 'c,

Available on non-crate feature nightly only.

type ExecuteOutput = Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'c>>

outcome of execute. used for single time database response: number of rows affected by execution for example.

type QueryOutput = Pin<Box<dyn Future<Output = Result<Vec<GenericRowStream<Arc<[Column]>, Typed>>, Error>> + Send + 'c>>

outcome of query. used for repeated database response: database rows for example

fn execute(self, pool: &'c Pool) -> Self::ExecuteOutput

define how a statement is executed with single time response

fn query(self, pool: &'c Pool) -> Self::QueryOutput

define how a statement is queried with repeated response

impl<'c, 's, P> Execute<&'c Pool> for StatementQuery<'s, P>

where P: AsParams + Send + 'c, 's: 'c,

Available on non-crate feature nightly only.

type ExecuteOutput = Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'c>>

outcome of execute. used for single time database response: number of rows affected by execution for example.

type QueryOutput = Pin<Box<dyn Future<Output = Result<GenericRowStream<Arc<[Column]>, Typed>, Error>> + Send + 'c>>

outcome of query. used for repeated database response: database rows for example

fn execute(self, pool: &'c Pool) -> Self::ExecuteOutput

define how a statement is executed with single time response

fn query(self, pool: &'c Pool) -> Self::QueryOutput

define how a statement is queried with repeated response

impl<'c, 's, P> Execute<&'c Pool> for Vec<StatementQuery<'s, P>>

where P: AsParams + Send + 'c, 's: 'c,

Available on non-crate feature nightly only.

type ExecuteOutput = Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'c>>

outcome of execute. used for single time database response: number of rows affected by execution for example.

type QueryOutput = Pin<Box<dyn Future<Output = Result<Vec<GenericRowStream<Arc<[Column]>, Typed>>, Error>> + Send + 'c>>

outcome of query. used for repeated database response: database rows for example

fn execute(self, pool: &'c Pool) -> Self::ExecuteOutput

define how a statement is executed with single time response

fn query(self, pool: &'c Pool) -> Self::QueryOutput

define how a statement is queried with repeated response