Skip to main content

Connection

Struct Connection 

Source
pub struct Connection { /* private fields */ }
Expand description

A live connection to one PostgreSQL server.

Connection is a cheap, cloneable handle to a background actor that owns the socket. Cloning shares the same connection. All clones must be dropped for the connection to close.

Queries are queued and executed one at a time. The queue is unbounded, so a connection is best treated as “one in-flight query at a time”: spawning many queries against a single connection without awaiting them queues their encoded parameters in memory. Use a Pool for concurrency.

Implementations§

Source§

impl Connection

Source

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

Connects using a postgres:// URL.

§TLS

TLS is always required; plaintext connections are not possible.

sslmodeChain verifiedHostname verified
require (default)nono
verify-cayesno
verify-fullyesyes

disable, prefer and allow are rejected. verify-ca and verify-full read trusted roots from sslrootcert (a PEM file) or the operating system trust store.

use postgresql::Connection;

// Encrypted; the server certificate is not verified (default).
let conn = Connection::connect("postgres://user:pass@db.example.com/app").await?;

// Verify the certificate chain and the hostname.
let verified = Connection::connect(
    "postgres://user:pass@db.example.com/app?sslmode=verify-full&sslrootcert=/etc/ssl/db-ca.pem",
)
.await?;
§Errors

Returns a configuration error for an invalid URL, or an I/O, TLS, authentication or protocol error if the handshake fails.

Source

pub fn is_closed(&self) -> bool

Returns true if the connection has been closed or hit an I/O error.

Source

pub fn notifications(&self) -> Receiver<Notification>

Subscribes to LISTEN / NOTIFY notifications.

The returned receiver yields notifications delivered on this connection (after LISTEN). Multiple subscribers are supported.

Source

pub fn cancel_token(&self) -> CancelToken

Returns a token that can cancel the currently running query.

Source

pub async fn ping(&self) -> Result<(), Error>

Verifies the connection is usable with a trivial round trip.

Trait Implementations§

Source§

impl Clone for Connection

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Connection

Source§

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

Formats the value using the given formatter. Read more
Source§

impl ScriptExecutor for Connection

Source§

fn execute_script<'a>( &'a self, sql: &'a str, ) -> impl Future<Output = Result<u64, Error>> + Send + 'a

Runs one or more statements and returns the affected-row count of the last command. 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> Executor for T
where T: Capable + ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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> 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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more