Struct sqlx::pool::PoolConnection

pub struct PoolConnection<DB> where
    DB: Database,  { /* fields omitted */ }

A connection managed by a Pool.

Will be returned to the pool on-drop.

Implementations

impl<DB> PoolConnection<DB> where
    DB: Database, 

pub fn release(self) -> <DB as Database>::Connection

👎 Deprecated:

renamed to .detach() for clarity

Explicitly release a connection from the pool

pub fn detach(self) -> <DB as Database>::Connection

Detach this connection from the pool, allowing it to open a replacement.

Note that if your application uses a single shared pool, this effectively lets the application exceed the max_connections setting.

If you want the pool to treat this connection as permanently checked-out, use .leak() instead.

pub fn leak(self) -> <DB as Database>::Connection

Detach this connection from the pool, treating it as permanently checked-out.

This effectively will reduce the maximum capacity of the pool by 1 every time it is used.

If you don’t want to impact the pool’s capacity, use .detach() instead.

Trait Implementations

impl<'c> Acquire<'c> for &'c mut PoolConnection<Postgres>

type Database = Postgres

type Connection = &'c mut <Postgres as Database>::Connection

pub fn acquire(
    self
) -> Pin<Box<dyn Future<Output = Result<<&'c mut PoolConnection<Postgres> as Acquire<'c>>::Connection, Error>> + Send + 'c, Global>>

pub fn begin(
    self
) -> Pin<Box<dyn Future<Output = Result<Transaction<'c, Postgres>, Error>> + Send + 'c, Global>>

impl<'c> Acquire<'c> for &'c mut PoolConnection<Any>

type Database = Any

type Connection = &'c mut <Any as Database>::Connection

pub fn acquire(
    self
) -> Pin<Box<dyn Future<Output = Result<<&'c mut PoolConnection<Any> as Acquire<'c>>::Connection, Error>> + Send + 'c, Global>>

pub fn begin(
    self
) -> Pin<Box<dyn Future<Output = Result<Transaction<'c, Any>, Error>> + Send + 'c, Global>>

impl<'c> Acquire<'c> for &'c mut PoolConnection<Mssql>

type Database = Mssql

type Connection = &'c mut <Mssql as Database>::Connection

pub fn acquire(
    self
) -> Pin<Box<dyn Future<Output = Result<<&'c mut PoolConnection<Mssql> as Acquire<'c>>::Connection, Error>> + Send + 'c, Global>>

pub fn begin(
    self
) -> Pin<Box<dyn Future<Output = Result<Transaction<'c, Mssql>, Error>> + Send + 'c, Global>>

impl<'c> Acquire<'c> for &'c mut PoolConnection<Sqlite>

type Database = Sqlite

type Connection = &'c mut <Sqlite as Database>::Connection

pub fn acquire(
    self
) -> Pin<Box<dyn Future<Output = Result<<&'c mut PoolConnection<Sqlite> as Acquire<'c>>::Connection, Error>> + Send + 'c, Global>>

pub fn begin(
    self
) -> Pin<Box<dyn Future<Output = Result<Transaction<'c, Sqlite>, Error>> + Send + 'c, Global>>

impl<'c> Acquire<'c> for &'c mut PoolConnection<MySql>

type Database = MySql

type Connection = &'c mut <MySql as Database>::Connection

pub fn acquire(
    self
) -> Pin<Box<dyn Future<Output = Result<<&'c mut PoolConnection<MySql> as Acquire<'c>>::Connection, Error>> + Send + 'c, Global>>

pub fn begin(
    self
) -> Pin<Box<dyn Future<Output = Result<Transaction<'c, MySql>, Error>> + Send + 'c, Global>>

impl<DB> Debug for PoolConnection<DB> where
    DB: Database, 

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

Formats the value using the given formatter.

impl<DB> Deref for PoolConnection<DB> where
    DB: Database, 

type Target = <DB as Database>::Connection

The resulting type after dereferencing.

pub fn deref(&self) -> &<PoolConnection<DB> as Deref>::Target

Dereferences the value.

impl<DB> DerefMut for PoolConnection<DB> where
    DB: Database, 

pub fn deref_mut(&mut self) -> &mut <PoolConnection<DB> as Deref>::Target

Mutably dereferences the value.

impl<DB> Drop for PoolConnection<DB> where
    DB: Database, 

Returns the connection to the Pool it was checked-out from.

pub fn drop(&mut self)

Executes the destructor for this type.

impl<'c> Executor<'c> for &'c mut PoolConnection<Mssql>

type Database = Mssql

pub fn fetch_many<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<Either<<Mssql as Database>::QueryResult, MssqlRow>, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Mssql>, 

Execute multiple queries and return the generated results as a stream from each query, in a stream.

pub fn fetch_optional<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<Option<MssqlRow>, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Mssql>, 

Execute the query and returns at most one row.

pub fn prepare_with<'e, 'q>(
    self,
    sql: &'q str,
    parameters: &'e [<Mssql as Database>::TypeInfo]
) -> Pin<Box<dyn Future<Output = Result<<Mssql as HasStatement<'q>>::Statement, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e, 

Prepare the SQL query, with parameter type information, to inspect the type information about its parameters and results.

fn execute<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::QueryResult, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute the query and return the total number of rows affected.

fn execute_many<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::QueryResult, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute multiple queries and return the rows affected from each query, in a stream.

fn fetch<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::Row, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute the query and return the generated results as a stream.

fn fetch_all<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<Vec<<Self::Database as Database>::Row, Global>, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute the query and return all the generated results, collected into a Vec.

fn fetch_one<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::Row, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute the query and returns exactly one row.

fn prepare<'e, 'q>(
    self,
    query: &'q str
) -> Pin<Box<dyn Future<Output = Result<<Self::Database as HasStatement<'q>>::Statement, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e, 

Prepare the SQL query to inspect the type information of its parameters and results.

impl<'c> Executor<'c> for &'c mut PoolConnection<MySql>

type Database = MySql

pub fn fetch_many<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<Either<<MySql as Database>::QueryResult, MySqlRow>, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, MySql>, 

Execute multiple queries and return the generated results as a stream from each query, in a stream.

pub fn fetch_optional<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<Option<MySqlRow>, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, MySql>, 

Execute the query and returns at most one row.

pub fn prepare_with<'e, 'q>(
    self,
    sql: &'q str,
    parameters: &'e [<MySql as Database>::TypeInfo]
) -> Pin<Box<dyn Future<Output = Result<<MySql as HasStatement<'q>>::Statement, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e, 

Prepare the SQL query, with parameter type information, to inspect the type information about its parameters and results.

fn execute<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::QueryResult, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute the query and return the total number of rows affected.

fn execute_many<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::QueryResult, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute multiple queries and return the rows affected from each query, in a stream.

fn fetch<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::Row, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute the query and return the generated results as a stream.

fn fetch_all<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<Vec<<Self::Database as Database>::Row, Global>, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute the query and return all the generated results, collected into a Vec.

fn fetch_one<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::Row, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute the query and returns exactly one row.

fn prepare<'e, 'q>(
    self,
    query: &'q str
) -> Pin<Box<dyn Future<Output = Result<<Self::Database as HasStatement<'q>>::Statement, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e, 

Prepare the SQL query to inspect the type information of its parameters and results.

impl<'c> Executor<'c> for &'c mut PoolConnection<Any>

type Database = Any

pub fn fetch_many<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<Either<<Any as Database>::QueryResult, AnyRow>, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Any>, 

Execute multiple queries and return the generated results as a stream from each query, in a stream.

pub fn fetch_optional<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<Option<AnyRow>, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Any>, 

Execute the query and returns at most one row.

pub fn prepare_with<'e, 'q>(
    self,
    sql: &'q str,
    parameters: &'e [<Any as Database>::TypeInfo]
) -> Pin<Box<dyn Future<Output = Result<<Any as HasStatement<'q>>::Statement, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e, 

Prepare the SQL query, with parameter type information, to inspect the type information about its parameters and results.

fn execute<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::QueryResult, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute the query and return the total number of rows affected.

fn execute_many<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::QueryResult, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute multiple queries and return the rows affected from each query, in a stream.

fn fetch<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::Row, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute the query and return the generated results as a stream.

fn fetch_all<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<Vec<<Self::Database as Database>::Row, Global>, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute the query and return all the generated results, collected into a Vec.

fn fetch_one<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::Row, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute the query and returns exactly one row.

fn prepare<'e, 'q>(
    self,
    query: &'q str
) -> Pin<Box<dyn Future<Output = Result<<Self::Database as HasStatement<'q>>::Statement, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e, 

Prepare the SQL query to inspect the type information of its parameters and results.

impl<'c> Executor<'c> for &'c mut PoolConnection<Sqlite>

type Database = Sqlite

pub fn fetch_many<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<Either<<Sqlite as Database>::QueryResult, SqliteRow>, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Sqlite>, 

Execute multiple queries and return the generated results as a stream from each query, in a stream.

pub fn fetch_optional<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<Option<SqliteRow>, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Sqlite>, 

Execute the query and returns at most one row.

pub fn prepare_with<'e, 'q>(
    self,
    sql: &'q str,
    parameters: &'e [<Sqlite as Database>::TypeInfo]
) -> Pin<Box<dyn Future<Output = Result<<Sqlite as HasStatement<'q>>::Statement, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e, 

Prepare the SQL query, with parameter type information, to inspect the type information about its parameters and results.

fn execute<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::QueryResult, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute the query and return the total number of rows affected.

fn execute_many<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::QueryResult, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute multiple queries and return the rows affected from each query, in a stream.

fn fetch<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::Row, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute the query and return the generated results as a stream.

fn fetch_all<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<Vec<<Self::Database as Database>::Row, Global>, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute the query and return all the generated results, collected into a Vec.

fn fetch_one<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::Row, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute the query and returns exactly one row.

fn prepare<'e, 'q>(
    self,
    query: &'q str
) -> Pin<Box<dyn Future<Output = Result<<Self::Database as HasStatement<'q>>::Statement, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e, 

Prepare the SQL query to inspect the type information of its parameters and results.

impl<'c> Executor<'c> for &'c mut PoolConnection<Postgres>

type Database = Postgres

pub fn fetch_many<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<Either<<Postgres as Database>::QueryResult, PgRow>, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Postgres>, 

Execute multiple queries and return the generated results as a stream from each query, in a stream.

pub fn fetch_optional<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<Option<PgRow>, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Postgres>, 

Execute the query and returns at most one row.

pub fn prepare_with<'e, 'q>(
    self,
    sql: &'q str,
    parameters: &'e [<Postgres as Database>::TypeInfo]
) -> Pin<Box<dyn Future<Output = Result<<Postgres as HasStatement<'q>>::Statement, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e, 

Prepare the SQL query, with parameter type information, to inspect the type information about its parameters and results.

fn execute<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::QueryResult, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute the query and return the total number of rows affected.

fn execute_many<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::QueryResult, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute multiple queries and return the rows affected from each query, in a stream.

fn fetch<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::Row, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute the query and return the generated results as a stream.

fn fetch_all<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<Vec<<Self::Database as Database>::Row, Global>, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute the query and return all the generated results, collected into a Vec.

fn fetch_one<'e, 'q, E>(
    self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::Row, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e,
    E: 'q + Execute<'q, Self::Database>, 

Execute the query and returns exactly one row.

fn prepare<'e, 'q>(
    self,
    query: &'q str
) -> Pin<Box<dyn Future<Output = Result<<Self::Database as HasStatement<'q>>::Statement, Error>> + Send + 'e, Global>> where
    'q: 'e,
    'c: 'e, 

Prepare the SQL query to inspect the type information of its parameters and results.

impl PgConnectionInfo for PoolConnection<Postgres>

pub fn server_version_num(&self) -> Option<u32>

the version number of the server in libpq format