Struct sqlx::postgres::PgConnectOptions [−][src]
pub struct PgConnectOptions { /* fields omitted */ }
postgres
only.Expand description
Options and flags which can be used to configure a PostgreSQL connection.
A value of PgConnectOptions
can be parsed from a connection URI,
as described by libpq.
The general form for a connection URI is:
postgresql://[user[:password]@][host][:port][/dbname][?param1=value1&...]
Parameters
Parameter | Default | Description |
---|---|---|
sslmode | prefer | Determines whether or with what priority a secure SSL TCP/IP connection will be negotiated. See PgSslMode . |
sslrootcert | None | Sets the name of a file containing a list of trusted SSL Certificate Authorities. |
statement-cache-capacity | 100 | The maximum number of prepared statements stored in the cache. Set to 0 to disable. |
host | None | Path to the directory containing a PostgreSQL unix domain socket, which will be used instead of TCP if set. |
hostaddr | None | Same as host , but only accepts IP addresses. |
application-name | None | The name will be displayed in the pg_stat_activity view and included in CSV log entries. |
user | result of whoami | PostgreSQL user name to connect as. |
password | None | Password to be used if the server demands password authentication. |
port | 5432 | Port number to connect to at the server host, or socket file name extension for Unix-domain connections. |
dbname | None | The database name. |
options | None | The runtime parameters to send to the server at connection start. |
The URI scheme designator can be either postgresql://
or postgres://
.
Each of the URI parts is optional.
postgresql://
postgresql://localhost
postgresql://localhost:5433
postgresql://localhost/mydb
postgresql://user@localhost
postgresql://user:secret@localhost
postgresql://localhost?dbname=mydb&user=postgres&password=postgres
Example
// URI connection string
let conn = PgConnection::connect("postgres://localhost/mydb").await?;
// Manually-constructed options
let conn = PgConnectOptions::new()
.host("secret-host")
.port(2525)
.username("secret-user")
.password("secret-password")
.ssl_mode(PgSslMode::Require)
.connect().await?;
Implementations
Creates a new, default set of options ready for configuration.
By default, this reads the following environment variables and sets their equivalent options.
PGHOST
PGPORT
PGUSER
PGPASSWORD
PGDATABASE
PGSSLROOTCERT
PGSSLMODE
PGAPPNAME
Example
let options = PgConnectOptions::new();
Sets the name of the host to connect to.
If a host name begins with a slash, it specifies Unix-domain communication rather than TCP/IP communication; the value is the name of the directory in which the socket file is stored.
The default behavior when host is not specified, or is empty, is to connect to a Unix-domain socket
Example
let options = PgConnectOptions::new()
.host("localhost");
Sets the port to connect to at the server host.
The default port for PostgreSQL is 5432
.
Example
let options = PgConnectOptions::new()
.port(5432);
Sets a custom path to a directory containing a unix domain socket, switching the connection method from TCP to the corresponding socket.
By default set to None
.
Sets the username to connect as.
Defaults to be the same as the operating system name of the user running the application.
Example
let options = PgConnectOptions::new()
.username("postgres");
Sets the password to use if the server demands password authentication.
Example
let options = PgConnectOptions::new()
.username("root")
.password("safe-and-secure");
Sets the database name. Defaults to be the same as the user name.
Example
let options = PgConnectOptions::new()
.database("postgres");
Sets whether or with what priority a secure SSL TCP/IP connection will be negotiated with the server.
By default, the SSL mode is Prefer
, and the client will
first attempt an SSL connection but fallback to a non-SSL connection on failure.
Ignored for Unix domain socket communication.
Example
let options = PgConnectOptions::new()
.ssl_mode(PgSslMode::Require);
Sets the name of a file containing SSL certificate authority (CA) certificate(s). If the file exists, the serverās certificate will be verified to be signed by one of these authorities.
Example
let options = PgConnectOptions::new()
// Providing a CA certificate with less than VerifyCa is pointless
.ssl_mode(PgSslMode::VerifyCa)
.ssl_root_cert("./ca-certificate.crt");
Sets PEM encoded trusted SSL Certificate Authorities (CA).
Example
let options = PgConnectOptions::new()
// Providing a CA certificate with less than VerifyCa is pointless
.ssl_mode(PgSslMode::VerifyCa)
.ssl_root_cert_from_pem(vec![]);
Sets the capacity of the connectionās statement cache in a number of stored distinct statements. Caching is handled using LRU, meaning when the amount of queries hits the defined limit, the oldest statement will get dropped.
The default cache capacity is 100 statements.
Sets the application name. Defaults to None
Example
let options = PgConnectOptions::new()
.application_name("my-app");
pub fn options<K, V, I>(self, options: I) -> PgConnectOptions where
K: Display,
V: Display,
I: IntoIterator<Item = (K, V)>,
pub fn options<K, V, I>(self, options: I) -> PgConnectOptions where
K: Display,
V: Display,
I: IntoIterator<Item = (K, V)>,
Set additional startup options for the connection as a list of key-value pairs.
Example
let options = PgConnectOptions::new()
.options([("geqo", "off"), ("statement_timeout", "5min")]);
Trait Implementations
type Connection = PgConnection
pub fn connect(
&self
) -> Pin<Box<dyn Future<Output = Result<<PgConnectOptions as ConnectOptions>::Connection, Error>> + Send, Global>> where
<PgConnectOptions as ConnectOptions>::Connection: Sized,
pub fn connect(
&self
) -> Pin<Box<dyn Future<Output = Result<<PgConnectOptions as ConnectOptions>::Connection, Error>> + Send, Global>> where
<PgConnectOptions as ConnectOptions>::Connection: Sized,
Establish a new database connection with the options specified by self
.
Log executed statements with the specified level
pub fn log_slow_statements(
&mut self,
level: LevelFilter,
duration: Duration
) -> &mut PgConnectOptions
pub fn log_slow_statements(
&mut self,
level: LevelFilter,
duration: Duration
) -> &mut PgConnectOptions
Log executed statements with a duration above the specified duration
at the specified level
. Read more
Entirely disables statement logging (both slow and regular).
Returns the ādefault valueā for a type. Read more
Performs the conversion.
Auto Trait Implementations
impl RefUnwindSafe for PgConnectOptions
impl Send for PgConnectOptions
impl Sync for PgConnectOptions
impl Unpin for PgConnectOptions
impl UnwindSafe for PgConnectOptions
Blanket Implementations
Mutably borrows from an owned value. Read more