Struct mysql::Opts

pub struct Opts(/* private fields */);

Mysql connection options.

Build one with OptsBuilder.

Implementations

impl Opts

pub fn from_url(url: &str) -> Result<Opts, UrlError>

pub fn get_ip_or_hostname(&self) -> Cow<'_, str>

Address of mysql server (defaults to 127.0.0.1). Host names should also work.

pub fn get_tcp_port(&self) -> u16

TCP port of mysql server (defaults to 3306).

pub fn get_socket(&self) -> Option<&str>

Socket path on unix or pipe name on windows (defaults to None).

pub fn get_max_allowed_packet(&self) -> Option<usize>

Client side max_allowed_packet value (defaults to None).

By default Conn will query this value from the server. One can avoid this step by explicitly specifying it. Server side default is 4MB.

Available in connection URL via max_allowed_packet parameter.

pub fn get_user(&self) -> Option<&str>

User (defaults to None).

pub fn get_pass(&self) -> Option<&str>

Password (defaults to None).

pub fn get_db_name(&self) -> Option<&str>

Database name (defaults to None).

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

The timeout for each attempt to write to the server.

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

The timeout for each attempt to write to the server.

pub fn get_prefer_socket(&self) -> bool

Prefer socket connection (defaults to true).

Will reconnect via socket (or named pipe on windows) after TCP connection to 127.0.0.1 if true.

Will fall back to TCP on error. Use socket option to enforce socket connection.

pub fn get_init(&self) -> Vec<String>

Commands to execute on each new database connection.

pub fn get_ssl_opts(&self) -> Option<&SslOpts>

Driver will require SSL connection if this option isn’t None (default to None).

pub fn get_pool_opts(&self) -> &PoolOpts

Connection pool options (defaults to Default::default).

pub fn get_tcp_nodelay(&self) -> bool

Whether TCP_NODELAY will be set for mysql connection.

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

TCP keep alive time for mysql connection.

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

TCP keep alive interval between subsequent probes for mysql connection.

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

TCP keep alive probe count for mysql connection.

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

TCP_USER_TIMEOUT time for mysql connection.

pub fn get_local_infile_handler(&self) -> Option<&LocalInfileHandler>

Callback to handle requests for local files.

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

Tcp connect timeout (defaults to None).

pub fn bind_address(&self) -> Option<&SocketAddr>

Bind address for a client (defaults to None).

Use carefully. Will probably make pool unusable because of address already in use errors.

pub fn get_stmt_cache_size(&self) -> usize

Number of prepared statements cached on the client side (per connection). Defaults to DEFAULT_STMT_CACHE_SIZE.

Can be defined using stmt_cache_size connection url parameter.

pub fn get_compress(&self) -> Option<Compression>

If not None, then client will ask for compression if server supports it (defaults to None).

Can be defined using compress connection url parameter with values:

• true - library defined default compression level;
• fast - library defined fast compression level;
• best - library defined best compression level;
• 0, 1, …, 9 - explicitly defined compression level where 0 stands for “no compression”;

Note that compression level defined here will affect only outgoing packets.

pub fn get_additional_capabilities(&self) -> CapabilityFlags

Additional client capabilities to set (defaults to empty).

This value will be OR’ed with other client capabilities during connection initialization.

Note

It is a good way to set something like CLIENT_FOUND_ROWS but you should note that it won’t let you to interfere with capabilities managed by other options (like CLIENT_SSL or CLIENT_COMPRESS). Also note that some capabilities are reserved, pointless or may broke the connection, so this option should be used with caution.

pub fn get_connect_attrs(&self) -> Option<&HashMap<String, String>>

Connect attributes (the default connect attributes are sent by default).

This value is sent to the server as custom name-value attributes. You can see them from performance_schema tables: session_account_connect_attrs and session_connect_attrs when all of the following conditions are met.

• The server is MySQL 5.6 or later, or MariaDB 10.0 or later.
• performance_schema is on.
• performance_schema_session_connect_attrs_size is -1 or big enough to store specified attributes.

Note

• set connect_attrs to None to completely remove connect attributes
• set connect_attrs to an empty map to send only the default attributes

Warning

There is a bug in MySql 5.6 that kills COM_CHANGE_USER in the presence of connection attributes so it’s better to stick to None for mysql < 5.7.

Attribute names that begin with an underscore (_) are not set by application programs because they are reserved for internal use.

The following default attributes are sent in addition to ones set by programs.

name	value
_client_name	The client library name (rust-mysql-simple)
_client_version	The client library version
_os	The operation system (target_os cfg feature)
_pid	The client process ID
_platform	The machine platform (target_arch cfg feature)
program_name	The first element of std::env::args if program_name isn’t set by programs.

pub fn get_secure_auth(&self) -> bool

Disables mysql_old_password plugin (defaults to true).

Available via secure_auth connection url parameter.

pub fn get_enable_cleartext_plugin(&self) -> bool

Returns true if mysql_clear_password plugin support is enabled (defaults to false).

mysql_clear_password enables client to send passwords to the server as cleartext, without hashing or encryption (consult MySql documentation for more info).

Security Notes

Sending passwords as cleartext may be a security problem in some configurations. Please consider using TLS or encrypted tunnels for server connection.

Connection URL

Use enable_cleartext_plugin URL parameter to set this value. E.g.

let opts = Opts::from_url("mysql://localhost/db?enable_cleartext_plugin=true")?;
assert!(opts.get_enable_cleartext_plugin());

Trait Implementations

impl Clone for Opts

fn clone(&self) -> Opts

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Opts

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

Formats the value using the given formatter.

impl Default for Opts

fn default() -> Opts

Returns the “default value” for a type.

impl From<OptsBuilder> for Opts

fn from(builder: OptsBuilder) -> Opts

Converts to this type from the input type.

impl PartialEq for Opts

fn eq(&self, other: &Opts) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&str> for Opts

type Error = UrlError

The type returned in the event of a conversion error.

fn try_from(url: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Opts

impl StructuralPartialEq for Opts