Struct sqlx_core::mysql::MySqlConnectOptions

pub struct MySqlConnectOptions { /* private fields */ }

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]

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

// 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?;

Implementations

impl MySqlConnectOptions

pub fn new() -> Self

Creates a new, default set of options ready for configuration

pub fn host(self, host: &str) -> Self

Sets the name of the host to connect to.

The default behavior when the host is not specified, is to connect to localhost.

pub fn port(self, port: u16) -> Self

Sets the port to connect to at the server host.

The default port for MySQL is 3306.

pub fn socket(self, path: impl AsRef<Path>) -> Self

Pass a path to a Unix socket. This changes the connection stream from TCP to UDS.

By default set to None.

pub fn username(self, username: &str) -> Self

Sets the username to connect as.

pub fn password(self, password: &str) -> Self

Sets the password to connect with.

pub fn database(self, database: &str) -> Self

Sets the database name.

pub fn ssl_mode(self, mode: MySqlSslMode) -> Self

Sets whether or with what priority a secure SSL TCP/IP connection will be negotiated with the server.

By default, the SSL mode is Preferred, and the client will first attempt an SSL connection but fallback to a non-SSL connection on failure.

Example

let options = MySqlConnectOptions::new()
    .ssl_mode(MySqlSslMode::Required);

pub fn ssl_ca(self, file_name: impl AsRef<Path>) -> Self

Sets the name of a file containing a list of trusted SSL Certificate Authorities.

Example

let options = MySqlConnectOptions::new()
    .ssl_mode(MySqlSslMode::VerifyCa)
    .ssl_ca("path/to/ca.crt");

pub fn ssl_ca_from_pem(self, pem_certificate: Vec<u8>) -> Self

Sets PEM encoded list of trusted SSL Certificate Authorities.

Example

let options = MySqlConnectOptions::new()
    .ssl_mode(MySqlSslMode::VerifyCa)
    .ssl_ca_from_pem(vec![]);

pub fn statement_cache_capacity(self, capacity: usize) -> Self

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.

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

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.

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

Sets the collation for the connection.

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

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

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.

Trait Implementations

impl Clone for MySqlConnectOptions

fn clone(&self) -> MySqlConnectOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConnectOptions for MySqlConnectOptions

type Connection = MySqlConnection

fn connect(&self) -> BoxFuture<'_, Result<Self::Connection, Error>>where Self::Connection: Sized,

Establish a new database connection with the options specified by self.

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

Log executed statements with the specified level

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

Log executed statements with a duration above the specified duration at the specified level.

fn disable_statement_logging(&mut self) -> &mut Self

Entirely disables statement logging (both slow and regular).

impl Debug for MySqlConnectOptions

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

Formats the value using the given formatter.

impl Default for MySqlConnectOptions

fn default() -> Self

Returns the “default value” for a type.

impl From<MySqlConnectOptions> for AnyConnectOptions

fn from(options: MySqlConnectOptions) -> Self

Converts to this type from the input type.

impl FromStr for MySqlConnectOptions

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Error>

Parses a string s to return a value of this type.

impl TryFrom<AnyConnectOptions> for MySqlConnectOptions

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AnyConnectOptions) -> Result<Self, Self::Error>

Performs the conversion.