Struct quaint::connector::PostgresUrl

pub struct PostgresUrl { /* private fields */ }

Available on crate feature postgresql only.

Wraps a connection url and exposes the parsing logic used by Quaint, including default values.

Implementations

impl PostgresUrl

pub fn new(url: Url) -> Result<Self, Error>

Parse Url to PostgresUrl. Returns error for mistyped connection parameters.

pub fn url(&self) -> &Url

The bare Url to the database.

pub fn username(&self) -> Cow<'_, str>

The percent-decoded database username.

pub fn host(&self) -> &str

The database host. Taken first from the host query parameter, then from the host part of the URL. For socket connections, the query parameter must be used.

If none of them are set, defaults to localhost.

pub fn dbname(&self) -> &str

Name of the database connected. Defaults to postgres.

pub fn password(&self) -> Cow<'_, str>

The percent-decoded database password.

pub fn port(&self) -> u16

The database port, defaults to 5432.

pub fn schema(&self) -> &str

The database schema, defaults to public.

pub fn pg_bouncer(&self) -> bool

Whether the pgbouncer mode is enabled.

pub fn connect_timeout(&self) -> Option<Duration>

The connection timeout.

pub fn pool_timeout(&self) -> Option<Duration>

Pool check_out timeout

pub fn socket_timeout(&self) -> Option<Duration>

The socket timeout

pub fn max_connection_lifetime(&self) -> Option<Duration>

The maximum connection lifetime

pub fn max_idle_connection_lifetime(&self) -> Option<Duration>

The maximum idle connection lifetime

pub fn application_name(&self) -> Option<&str>

The custom application name

pub fn channel_binding(&self) -> ChannelBinding

pub fn set_flavour(&mut self, flavour: PostgresFlavour)

Sets whether the URL points to a Postgres, Cockroach or Unknown database. This is used to avoid a network roundtrip at connection to set the search path.

The different behaviours are:

• Postgres: Always avoid a network roundtrip by setting the search path through client connection parameters.
• Cockroach: Avoid a network roundtrip if the schema name is deemed “safe” (i.e. no escape quoting required). Otherwise, set the search path through a database query.
• Unknown: Always add a network roundtrip by setting the search path through a database query.

pub fn flavour(&self) -> PostgresFlavour

Trait Implementations

impl Clone for PostgresUrl

fn clone(&self) -> PostgresUrl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PostgresUrl

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

Formats the value using the given formatter.