Skip to main content

Connection

Struct Connection 

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

Postgres connection

Implementations§

Source§

impl Connection

Source

pub fn new(transport: Transport) -> Self

Create connection from transport

Source

pub const fn state(&self) -> ConnectionState

Get current connection state

Source

pub async fn startup(&mut self, config: &ConnectionConfig) -> Result<()>

Perform startup and authentication

§Errors

Returns Error::InvalidState if the connection is not in the initial state. Returns Error::Authentication if authentication fails. Returns Error::Io if sending or receiving protocol messages fails.

Source

pub async fn simple_query(&mut self, query: &str) -> Result<Vec<BackendMessage>>

Execute a simple query (returns all backend messages)

§Errors

Returns Error::ConnectionBusy if the connection is not idle. Returns Error::InvalidState if a state transition is invalid. Returns Error::Io if sending or receiving protocol messages fails.

Source

pub async fn close(self) -> Result<()>

Close the connection

§Errors

Returns Error::InvalidState if the connection cannot transition to closed. Returns Error::Io if the transport shutdown fails.

Source

pub async fn streaming_query( self, query: &str, chunk_size: usize, max_memory: Option<usize>, soft_limit_warn_threshold: Option<f32>, soft_limit_fail_threshold: Option<f32>, enable_adaptive_chunking: bool, adaptive_min_chunk_size: Option<usize>, adaptive_max_chunk_size: Option<usize>, ) -> Result<JsonStream>

Execute a streaming query

Note: This method consumes the connection. The stream maintains the connection internally. Once the stream is exhausted or dropped, the connection is closed.

§Errors

Returns Error::ConnectionBusy if the connection is not idle. Returns Error::InvalidState if a state transition is invalid. Returns Error::Sql if the database returns an error response. Returns Error::Protocol if the query produces no result set or an unexpected message. Returns Error::InvalidSchema if the row description does not match requirements. Returns Error::Io if sending or receiving protocol messages fails.

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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