Struct ConnectBuilder

pub struct ConnectBuilder<'s, T, H> {
    server: &'s TestServer,
    pg_config: Config,
    port: u16,
    tls: T,
    notice_callback: Option<Box<dyn FnMut(DbError) + Send + 'static>>,
    _with_handle: H,
}

A builder struct to configure a pgwire connection to a running TestServer.

You can create this struct, and thus open a pgwire connection, using TestServer::connect.

Fields

server: &'s TestServer

A running environmentd test server.

pg_config: Config

Postgres configuration for connecting to the test server.

port: u16

Port to use when connecting to the test server.

tls: T

Tls settings to use.

notice_callback: Option<Box<dyn FnMut(DbError) + Send + 'static>>

Callback that gets invoked for every notice we receive.

_with_handle: H

Type variable for whether or not we include the handle for the spawned tokio::task.

Implementations

impl<'s> ConnectBuilder<'s, (), NoHandle>

fn new(server: &'s TestServer) -> Self

impl<'s, T, H> ConnectBuilder<'s, T, H>

pub fn no_tls(self) -> ConnectBuilder<'s, NoTls, H>

Create a pgwire connection without using TLS.

Note: this is the default for all connections.

pub fn with_tls<Tls>(self, tls: Tls) -> ConnectBuilder<'s, Tls, H>

where Tls: MakeTlsConnect<Socket> + Send + 'static, Tls::TlsConnect: Send, Tls::Stream: Send, <Tls::TlsConnect as TlsConnect<Socket>>::Future: Send,

Create a pgwire connection with TLS.

pub fn with_config(self, pg_config: Config) -> Self

Create a ConnectBuilder using the provided tokio_postgres::Config.

pub fn ssl_mode(self, mode: SslMode) -> Self

Set the SslMode to be used with the resulting connection.

pub fn user(self, user: &str) -> Self

Set the user for the pgwire connection.

pub fn password(self, password: &str) -> Self

Set the password for the pgwire connection.

pub fn application_name(self, application_name: &str) -> Self

Set the application name for the pgwire connection.

pub fn dbname(self, dbname: &str) -> Self

Set the database name for the pgwire connection.

pub fn options(self, options: &str) -> Self

Set the options for the pgwire connection.

pub fn internal(self) -> Self

Configures this ConnectBuilder to connect to the internal SQL port of the running TestServer.

For example, this will change the port we connect to, and the user we connect as.

pub fn notice_callback( self, callback: impl FnMut(DbError) + Send + 'static, ) -> Self

Sets a callback for any database notices that are received from the TestServer.

pub fn with_handle(self) -> ConnectBuilder<'s, T, WithHandle>

Configures this ConnectBuilder to return the mz_ore::task::JoinHandle that is polling the underlying postgres connection, associated with the returned client.

pub fn as_pg_config(&self) -> &Config

Returns the tokio_postgres::Config that will be used to connect.

Trait Implementations

impl<'s, T, H> IntoFuture for ConnectBuilder<'s, T, H>

where T: MakeTlsConnect<Socket> + Send + 'static, T::TlsConnect: Send, T::Stream: Send, <T::TlsConnect as TlsConnect<Socket>>::Future: Send, H: IncludeHandle,

type Output = Result<<H as IncludeHandle>::Output, Error>

The output that the future will produce on completion.

type IntoFuture = Pin<Box<dyn Future<Output = <ConnectBuilder<'s, T, H> as IntoFuture>::Output> + Send>>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.