Struct deadpool_postgres::ClientWrapper [−][src]
pub struct ClientWrapper { pub statement_cache: Arc<StatementCache>, // some fields omitted }
Expand description
A wrapper for tokio_postgres::Client
which includes a statement cache.
Fields
statement_cache: Arc<StatementCache>
The statement cache
Implementations
impl ClientWrapper
[src]
impl ClientWrapper
[src]pub fn new(client: PgClient) -> Self
[src]
pub fn new(client: PgClient) -> Self
[src]Create new wrapper instance using an existing tokio_postgres::Client
pub async fn prepare_cached(&self, query: &str) -> Result<Statement, Error>
[src]
pub async fn prepare_cached(&self, query: &str) -> Result<Statement, Error>
[src]Like tokio_postgres::Transaction::prepare
but uses an existing statement from the cache if possible.
pub async fn prepare_typed_cached(
&self,
query: &str,
types: &[Type]
) -> Result<Statement, Error>
[src]
pub async fn prepare_typed_cached(
&self,
query: &str,
types: &[Type]
) -> Result<Statement, Error>
[src]Like tokio_postgres::Transaction::prepare_typed
but uses an existing statement from the cache if possible.
pub async fn transaction(&mut self) -> Result<Transaction<'_>, Error>
[src]
pub async fn transaction(&mut self) -> Result<Transaction<'_>, Error>
[src]Like tokio_postgres::Client::transaction
but returns a deadpool-postgres
wrapped transaction with a statement cache.
pub fn build_transaction(&mut self) -> TransactionBuilder<'_>
[src]
pub fn build_transaction(&mut self) -> TransactionBuilder<'_>
[src]Like tokio_postgres::Client::transaction_builder
but creates a deadpool-postgres
wrapped transaction with a statement cache.
Methods from Deref<Target = PgClient>
pub async fn prepare(&'_ self, query: &'_ str) -> Result<Statement, Error>
[src]
pub async fn prepare(&'_ self, query: &'_ str) -> Result<Statement, Error>
[src]Creates a new prepared statement.
Prepared statements can be executed repeatedly, and may contain query parameters (indicated by $1
, $2
, etc),
which are set when executed. Prepared statements can only be used with the connection that created them.
pub async fn prepare_typed(
&'_ self,
query: &'_ str,
parameter_types: &'_ [Type]
) -> Result<Statement, Error>
[src]
pub async fn prepare_typed(
&'_ self,
query: &'_ str,
parameter_types: &'_ [Type]
) -> Result<Statement, Error>
[src]Like prepare
, but allows the types of query parameters to be explicitly specified.
The list of types may be smaller than the number of parameters - the types of the remaining parameters will be
inferred. For example, client.prepare_typed(query, &[])
is equivalent to client.prepare(query)
.
pub async fn query<T>(
&'_ self,
statement: &'_ T,
params: &'_ [&'_ (dyn ToSql + '_ + Sync)]
) -> Result<Vec<Row, Global>, Error> where
T: ToStatement + ?Sized,
[src]
pub async fn query<T>(
&'_ self,
statement: &'_ T,
params: &'_ [&'_ (dyn ToSql + '_ + Sync)]
) -> Result<Vec<Row, Global>, Error> where
T: ToStatement + ?Sized,
[src]Executes a statement, returning a vector of the resulting rows.
A statement may contain parameters, specified by $n
, where n
is the index of the parameter of the list
provided, 1-indexed.
The statement
argument can either be a Statement
, or a raw query string. If the same statement will be
repeatedly executed (perhaps with different query parameters), consider preparing the statement up front
with the prepare
method.
Panics
Panics if the number of parameters provided does not match the number expected.
pub async fn query_one<T>(
&'_ self,
statement: &'_ T,
params: &'_ [&'_ (dyn ToSql + '_ + Sync)]
) -> Result<Row, Error> where
T: ToStatement + ?Sized,
[src]
pub async fn query_one<T>(
&'_ self,
statement: &'_ T,
params: &'_ [&'_ (dyn ToSql + '_ + Sync)]
) -> Result<Row, Error> where
T: ToStatement + ?Sized,
[src]Executes a statement which returns a single row, returning it.
Returns an error if the query does not return exactly one row.
A statement may contain parameters, specified by $n
, where n
is the index of the parameter of the list
provided, 1-indexed.
The statement
argument can either be a Statement
, or a raw query string. If the same statement will be
repeatedly executed (perhaps with different query parameters), consider preparing the statement up front
with the prepare
method.
Panics
Panics if the number of parameters provided does not match the number expected.
pub async fn query_opt<T>(
&'_ self,
statement: &'_ T,
params: &'_ [&'_ (dyn ToSql + '_ + Sync)]
) -> Result<Option<Row>, Error> where
T: ToStatement + ?Sized,
[src]
pub async fn query_opt<T>(
&'_ self,
statement: &'_ T,
params: &'_ [&'_ (dyn ToSql + '_ + Sync)]
) -> Result<Option<Row>, Error> where
T: ToStatement + ?Sized,
[src]Executes a statements which returns zero or one rows, returning it.
Returns an error if the query returns more than one row.
A statement may contain parameters, specified by $n
, where n
is the index of the parameter of the list
provided, 1-indexed.
The statement
argument can either be a Statement
, or a raw query string. If the same statement will be
repeatedly executed (perhaps with different query parameters), consider preparing the statement up front
with the prepare
method.
Panics
Panics if the number of parameters provided does not match the number expected.
pub async fn query_raw<T, P, I>(
&'_ self,
statement: &'_ T,
params: I
) -> Result<RowStream, Error> where
T: ToStatement + ?Sized,
I: IntoIterator<Item = P>,
P: BorrowToSql,
<I as IntoIterator>::IntoIter: ExactSizeIterator,
[src]
pub async fn query_raw<T, P, I>(
&'_ self,
statement: &'_ T,
params: I
) -> Result<RowStream, Error> where
T: ToStatement + ?Sized,
I: IntoIterator<Item = P>,
P: BorrowToSql,
<I as IntoIterator>::IntoIter: ExactSizeIterator,
[src]The maximally flexible version of query
.
A statement may contain parameters, specified by $n
, where n
is the index of the parameter of the list
provided, 1-indexed.
The statement
argument can either be a Statement
, or a raw query string. If the same statement will be
repeatedly executed (perhaps with different query parameters), consider preparing the statement up front
with the prepare
method.
Panics
Panics if the number of parameters provided does not match the number expected.
Examples
use tokio_postgres::types::ToSql; use futures::{pin_mut, TryStreamExt}; let params: Vec<String> = vec![ "first param".into(), "second param".into(), ]; let mut it = client.query_raw( "SELECT foo FROM bar WHERE biz = $1 AND baz = $2", params, ).await?; pin_mut!(it); while let Some(row) = it.try_next().await? { let foo: i32 = row.get("foo"); println!("foo: {}", foo); }
pub async fn execute<T>(
&'_ self,
statement: &'_ T,
params: &'_ [&'_ (dyn ToSql + '_ + Sync)]
) -> Result<u64, Error> where
T: ToStatement + ?Sized,
[src]
pub async fn execute<T>(
&'_ self,
statement: &'_ T,
params: &'_ [&'_ (dyn ToSql + '_ + Sync)]
) -> Result<u64, Error> where
T: ToStatement + ?Sized,
[src]Executes a statement, returning the number of rows modified.
A statement may contain parameters, specified by $n
, where n
is the index of the parameter of the list
provided, 1-indexed.
The statement
argument can either be a Statement
, or a raw query string. If the same statement will be
repeatedly executed (perhaps with different query parameters), consider preparing the statement up front
with the prepare
method.
If the statement does not modify any rows (e.g. SELECT
), 0 is returned.
Panics
Panics if the number of parameters provided does not match the number expected.
pub async fn execute_raw<T, P, I>(
&'_ self,
statement: &'_ T,
params: I
) -> Result<u64, Error> where
T: ToStatement + ?Sized,
I: IntoIterator<Item = P>,
P: BorrowToSql,
<I as IntoIterator>::IntoIter: ExactSizeIterator,
[src]
pub async fn execute_raw<T, P, I>(
&'_ self,
statement: &'_ T,
params: I
) -> Result<u64, Error> where
T: ToStatement + ?Sized,
I: IntoIterator<Item = P>,
P: BorrowToSql,
<I as IntoIterator>::IntoIter: ExactSizeIterator,
[src]The maximally flexible version of execute
.
A statement may contain parameters, specified by $n
, where n
is the index of the parameter of the list
provided, 1-indexed.
The statement
argument can either be a Statement
, or a raw query string. If the same statement will be
repeatedly executed (perhaps with different query parameters), consider preparing the statement up front
with the prepare
method.
Panics
Panics if the number of parameters provided does not match the number expected.
pub async fn copy_in<T, U>(
&'_ self,
statement: &'_ T
) -> Result<CopyInSink<U>, Error> where
T: ToStatement + ?Sized,
U: Buf + 'static + Send,
[src]
pub async fn copy_in<T, U>(
&'_ self,
statement: &'_ T
) -> Result<CopyInSink<U>, Error> where
T: ToStatement + ?Sized,
U: Buf + 'static + Send,
[src]Executes a COPY FROM STDIN
statement, returning a sink used to write the copy data.
PostgreSQL does not support parameters in COPY
statements, so this method does not take any. The copy must
be explicitly completed via the Sink::close
or finish
methods. If it is not, the copy will be aborted.
Panics
Panics if the statement contains parameters.
pub async fn copy_out<T>(
&'_ self,
statement: &'_ T
) -> Result<CopyOutStream, Error> where
T: ToStatement + ?Sized,
[src]
pub async fn copy_out<T>(
&'_ self,
statement: &'_ T
) -> Result<CopyOutStream, Error> where
T: ToStatement + ?Sized,
[src]Executes a COPY TO STDOUT
statement, returning a stream of the resulting data.
PostgreSQL does not support parameters in COPY
statements, so this method does not take any.
Panics
Panics if the statement contains parameters.
pub async fn simple_query(
&'_ self,
query: &'_ str
) -> Result<Vec<SimpleQueryMessage, Global>, Error>
[src]
pub async fn simple_query(
&'_ self,
query: &'_ str
) -> Result<Vec<SimpleQueryMessage, Global>, Error>
[src]Executes a sequence of SQL statements using the simple query protocol, returning the resulting rows.
Statements should be separated by semicolons. If an error occurs, execution of the sequence will stop at that
point. The simple query protocol returns the values in rows as strings rather than in their binary encodings,
so the associated row type doesn’t work with the FromSql
trait. Rather than simply returning a list of the
rows, this method returns a list of an enum which indicates either the completion of one of the commands,
or a row of data. This preserves the framing between the separate statements in the request.
Warning
Prepared statements should be use for any query which contains user-specified data, as they provided the functionality to safely embed that data in the request. Do not form statements via string concatenation and pass them to this method!
pub async fn batch_execute(&'_ self, query: &'_ str) -> Result<(), Error>
[src]
pub async fn batch_execute(&'_ self, query: &'_ str) -> Result<(), Error>
[src]Executes a sequence of SQL statements using the simple query protocol.
Statements should be separated by semicolons. If an error occurs, execution of the sequence will stop at that point. This is intended for use when, for example, initializing a database schema.
Warning
Prepared statements should be use for any query which contains user-specified data, as they provided the functionality to safely embed that data in the request. Do not form statements via string concatenation and pass them to this method!
pub async fn transaction(&'_ mut self) -> Result<Transaction<'_>, Error>
[src]
pub async fn transaction(&'_ mut self) -> Result<Transaction<'_>, Error>
[src]Begins a new database transaction.
The transaction will roll back by default - use the commit
method to commit it.
pub fn build_transaction(&mut self) -> TransactionBuilder<'_>
[src]
pub fn build_transaction(&mut self) -> TransactionBuilder<'_>
[src]Returns a builder for a transaction with custom settings.
Unlike the transaction
method, the builder can be used to control the transaction’s isolation level and other
attributes.
pub fn cancel_token(&self) -> CancelToken
[src]
pub fn cancel_token(&self) -> CancelToken
[src]Constructs a cancellation token that can later be used to request cancellation of a query running on the connection associated with this client.
pub async fn cancel_query<T>(&'_ self, tls: T) -> Result<(), Error> where
T: MakeTlsConnect<Socket>,
[src]
👎 Deprecated since 0.6.0: use Client::cancel_token() instead
pub async fn cancel_query<T>(&'_ self, tls: T) -> Result<(), Error> where
T: MakeTlsConnect<Socket>,
[src]use Client::cancel_token() instead
Attempts to cancel an in-progress query.
The server provides no information about whether a cancellation attempt was successful or not. An error will only be returned if the client was unable to connect to the database.
Requires the runtime
Cargo feature (enabled by default).
pub async fn cancel_query_raw<S, T>(
&'_ self,
stream: S,
tls: T
) -> Result<(), Error> where
T: TlsConnect<S>,
S: AsyncRead + AsyncWrite + Unpin,
[src]
👎 Deprecated since 0.6.0: use Client::cancel_token() instead
pub async fn cancel_query_raw<S, T>(
&'_ self,
stream: S,
tls: T
) -> Result<(), Error> where
T: TlsConnect<S>,
S: AsyncRead + AsyncWrite + Unpin,
[src]use Client::cancel_token() instead
Like cancel_query
, but uses a stream which is already connected to the server rather than opening a new
connection itself.
pub fn clear_type_cache(&self)
[src]
pub fn clear_type_cache(&self)
[src]Clears the client’s type information cache.
When user-defined types are used in a query, the client loads their definitions from the database and caches them for the lifetime of the client. If those definitions are changed in the database, this method can be used to flush the local cache and allow the new, updated definitions to be loaded.
Trait Implementations
impl Deref for ClientWrapper
[src]
impl Deref for ClientWrapper
[src]Auto Trait Implementations
impl !RefUnwindSafe for ClientWrapper
impl Send for ClientWrapper
impl Sync for ClientWrapper
impl Unpin for ClientWrapper
impl !UnwindSafe for ClientWrapper
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
type Output = T
Should always be Self
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,