Struct ConnectOptions 

pub struct ConnectOptions { /* private fields */ }

Defines the configuration options of a database

Implementations

impl ConnectOptions

pub fn new<T>(url: T) -> Self

where T: Into<String>,

Create new ConnectOptions for a Database by passing in a URI string

pub fn get_url(&self) -> &str

Get the database URL of the pool

pub fn max_connections(&mut self, value: u32) -> &mut Self

Set the maximum number of connections of the pool

pub fn get_max_connections(&self) -> Option<u32>

Get the maximum number of connections of the pool, if set

pub fn min_connections(&mut self, value: u32) -> &mut Self

Set the minimum number of connections of the pool

pub fn get_min_connections(&self) -> Option<u32>

Get the minimum number of connections of the pool, if set

pub fn connect_timeout(&mut self, value: Duration) -> &mut Self

Set the timeout duration when acquiring a connection

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

Get the timeout duration when acquiring a connection, if set

pub fn idle_timeout<T>(&mut self, value: T) -> &mut Self

where T: Into<Option<Duration>>,

Set the idle duration before closing a connection.

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

Get the idle duration before closing a connection, if set

pub fn acquire_timeout(&mut self, value: Duration) -> &mut Self

Set the maximum amount of time to spend waiting for acquiring a connection

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

Get the maximum amount of time to spend waiting for acquiring a connection

pub fn max_lifetime<T>(&mut self, lifetime: T) -> &mut Self

where T: Into<Option<Duration>>,

Set the maximum lifetime of individual connections.

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

Get the maximum lifetime of individual connections, if set

pub fn sqlx_logging(&mut self, value: bool) -> &mut Self

Enable SQLx statement logging (default true)

pub fn get_sqlx_logging(&self) -> bool

Get whether SQLx statement logging is enabled

pub fn sqlx_logging_level(&mut self, level: LevelFilter) -> &mut Self

Set SQLx statement logging level (default INFO). (ignored if sqlx_logging is false)

pub fn sqlx_slow_statements_logging_settings( &mut self, level: LevelFilter, duration: Duration, ) -> &mut Self

Set SQLx slow statements logging level and duration threshold (default LevelFilter::Off). (ignored if sqlx_logging is false)

pub fn get_sqlx_logging_level(&self) -> LevelFilter

Get the level of SQLx statement logging

pub fn get_sqlx_slow_statements_logging_settings( &self, ) -> (LevelFilter, Duration)

Get the SQLx slow statements logging settings

pub fn sqlcipher_key<T>(&mut self, value: T) -> &mut Self

where T: Into<Cow<'static, str>>,

set key for sqlcipher

pub fn set_schema_search_path<T>(&mut self, schema_search_path: T) -> &mut Self

where T: Into<String>,

Set schema search path (PostgreSQL only)

pub fn set_application_name<T>(&mut self, application_name: T) -> &mut Self

where T: Into<String>,

Set application name (PostgreSQL only)

pub fn test_before_acquire(&mut self, value: bool) -> &mut Self

If true, the connection will be pinged upon acquiring from the pool (default true).

pub fn connect_lazy(&mut self, value: bool) -> &mut Self

If set to true, the db connection pool will be created using SQLx’s connect_lazy method.

pub fn get_connect_lazy(&self) -> bool

Get whether DB connections will be established when the pool is created or only as needed.

pub fn after_connect<F>(&mut self, f: F) -> &mut Self

where F: Fn(DatabaseConnection) -> BoxFuture<'static, Result<(), DbErr>> + Send + Sync + 'static,

Set a callback function that will be called after a new connection is established.

pub fn map_sqlx_mysql_opts<F>(&mut self, f: F) -> &mut Self

where F: Fn(MySqlConnectOptions) -> MySqlConnectOptions + Send + Sync + 'static,

Apply a function to modify the underlying MySqlConnectOptions before creating the connection pool.

pub fn map_sqlx_postgres_opts<F>(&mut self, f: F) -> &mut Self

where F: Fn(PgConnectOptions) -> PgConnectOptions + Send + Sync + 'static,

Apply a function to modify the underlying PgConnectOptions before creating the connection pool.

pub fn map_sqlx_sqlite_opts<F>(&mut self, f: F) -> &mut Self

where F: Fn(SqliteConnectOptions) -> SqliteConnectOptions + Send + Sync + 'static,

Apply a function to modify the underlying SqliteConnectOptions before creating the connection pool.

impl ConnectOptions

pub fn sqlx_pool_options<DB>(self) -> PoolOptions<DB>

where DB: Database,

Convert ConnectOptions into sqlx::pool::PoolOptions

impl ConnectOptions

pub fn sqlz_pool_options<DB>(self) -> PoolOptions<DB>

where DB: Database,

Convert ConnectOptions into sqlz::pool::PoolOptions

Trait Implementations

impl Clone for ConnectOptions

fn clone(&self) -> ConnectOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectOptions

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

Formats the value using the given formatter.

impl<T> From<T> for ConnectOptions

where T: Into<String>,

fn from(s: T) -> ConnectOptions

Converts to this type from the input type.