Struct rbatis_core::postgres::PgConnection

pub struct PgConnection { /* fields omitted */ }

An asynchronous connection to a Postgres database.

The connection string expected by Connect::connect should be a PostgreSQL connection string, as documented at https://www.postgresql.org/docs/12/libpq-connect.html#LIBPQ-CONNSTRING

TLS Support (requires tls feature)

This connection type supports the same sslmode query parameter that libpq does in connection strings: https://www.postgresql.org/docs/12/libpq-ssl.html

postgresql://<user>[:<password>]@<host>[:<port>]/<database>[?sslmode=<ssl-mode>[&sslcrootcert=<path>]]

where

ssl-mode = disable | allow | prefer | require | verify-ca | verify-full
path = percent (URL) encoded path on the local machine

If the tls feature is not enabled, disable, allow and prefer are no-ops and require, verify-ca and verify-full are forbidden (attempting to connect with these will return an error).

If the tls feature is enabled, an upgrade to TLS is attempted on every connection by default (equivalent to sslmode=prefer). If the server does not support TLS (because it was not started with a valid certificate and key, see https://www.postgresql.org/docs/12/ssl-tcp.html) then it falls back to an unsecured connection and logs a warning.

Add sslmode=require to your connection string to emit an error if the TLS upgrade fails.

If you're running Postgres locally, your connection string might look like this:

postgresql://root:password@localhost/my_database?sslmode=require

However, like with libpq the server certificate is not checked for validity by default.

Specifying sslmode=verify-ca will cause the TLS upgrade to verify the server's SSL certificate against a local CA root certificate; this is not the system root certificate but is instead expected to be specified in one of a few ways:

• The path to the certificate can be specified by adding the sslrootcert query parameter to the connection string. (Remember to percent-encode it!)

• The path may also be specified via the PGSSLROOTCERT environment variable (which should not be percent-encoded.)

• Otherwise, the library will look for the Postgres global root CA certificate in the default location:

  • $HOME/.postgresql/root.crt on POSIX systems
  • %APPDATA%\postgresql\root.crt on Windows

These locations are documented here: https://www.postgresql.org/docs/12/libpq-ssl.html#LIBQ-SSL-CERTIFICATES If the root certificate cannot be found by any of these means then the TLS upgrade will fail.

If sslmode=verify-full is specified, in addition to checking the certificate as with sslmode=verify-ca, the hostname in the connection string will be verified against the hostname in the server certificate, so they must be the same for the TLS upgrade to succeed.

Trait Implementations

impl Connect for PgConnection

fn connect<T>(url: T) -> BoxFuture<'static, Result<PgConnection>> where
    T: TryInto<Url, Error = ParseError>,
    Self: Sized, 

Establish a new database connection.

impl Connection for PgConnection

fn close(self) -> BoxFuture<'static, Result<()>>

Explicitly close this database connection.

fn ping(&mut self) -> BoxFuture<'_, Result<()>>

Checks if a connection to the database is still valid.

fn begin(self) -> BoxFuture<'static, Result<Transaction<Self>>> where
    Self: Sized, 

Starts a new transaction. 从conn启动一个事务，因为conn的所有权移动给了Transaction,直到Transaction commit 或者 rollback完成时返回原来的conn连接

impl Executor for PgConnection

type Database = Postgres

The specific database that this type is implemented for.

fn execute<'e, 'q: 'e, 'c: 'e, E: 'e>(
    &'c mut self,
    query: E
) -> BoxFuture<'e, Result<u64>> where
    E: Execute<'q, Self::Database>, 

Executes the query for its side-effects and discarding any potential result rows.

fn cursor<'q, E>(&mut self, query: E) -> PgCursor<'_, 'q> where
    E: Execute<'q, Self::Database>, 

Executes a query for its result.

impl<'c> RefExecutor<'c> for &'c mut PgConnection

type Database = Postgres

fn fetch_by_ref<'q, E>(self, query: E) -> PgCursor<'c, 'q> where
    E: Execute<'q, Self::Database>,