Struct sqlx::mysql::MySqlConnectOptions

source ·

pub struct MySqlConnectOptions { /* private fields */ }

Available on crate feature mysql only.

Expand description

Options and flags which can be used to configure a MySQL connection.

A value of MySqlConnectOptions can be parsed from a connection URL, as described by MySQL.

The generic format of the connection URL:

mysql://[host][/database][?properties]

This type also implements FromStr so you can parse it from a string containing a connection URL and then further adjust options if necessary (see example below).

Properties

Parameter	Default	Description
`ssl-mode`	`PREFERRED`	Determines whether or with what priority a secure SSL TCP/IP connection will be negotiated. See `MySqlSslMode`.
`ssl-ca`	`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.
`socket`	`None`	Path to the unix domain socket, which will be used instead of TCP if set.

Example

use sqlx::{Connection, ConnectOptions};
use sqlx::mysql::{MySqlConnectOptions, MySqlConnection, MySqlPool, MySqlSslMode};

// URL connection string
let conn = MySqlConnection::connect("mysql://root:password@localhost/db").await?;

// Manually-constructed options
let conn = MySqlConnectOptions::new()
    .host("localhost")
    .username("root")
    .password("password")
    .database("db")
    .connect().await?;

// Modifying options parsed from a string
let mut opts: MySqlConnectOptions = "mysql://root:password@localhost/db".parse()?;

// Change the log verbosity level for queries.
// Information about SQL queries is logged at `DEBUG` level by default.
opts.log_statements(log::LevelFilter::Trace);

let pool = MySqlPool::connect_with(&opts).await?;

Implementations§

source §

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.

source

pub fn charset(self, charset: &str) -> MySqlConnectOptions

Sets the character set for the connection.

The default character set is utf8mb4. This is supported from MySQL 5.5.3. If you need to connect to an older version, we recommend you to change this to utf8.

source

pub fn collation(self, collation: &str) -> MySqlConnectOptions

Sets the collation for the connection.

The default collation is derived from the charset. Normally, you should only have to set the charset.

source

pub fn pipes_as_concat(self, flag_val: bool) -> MySqlConnectOptions

Sets the flag that enables or disables the PIPES_AS_CONCAT connection setting

The default value is set to true, but some MySql databases such as PlanetScale error out with this connection setting so it needs to be set false in such cases.

source

pub fn enable_cleartext_plugin(self, flag_val: bool) -> MySqlConnectOptions

Enables mysql_clear_password plugin support.

Security Note: Sending passwords as cleartext may be a security problem in some configurations. Without additional defensive configuration like ssl-mode=VERIFY_IDENTITY, an attacker can compromise a router and trick the application into divulging its credentials.

It is strongly recommended to set .ssl_mode to Required, VerifyCa, or VerifyIdentity when enabling cleartext plugin.