Struct mysql::OptsBuilder

pub struct OptsBuilder { /* private fields */ }

Provides a way to build Opts.

let mut ssl_opts = SslOpts::default();
ssl_opts = ssl_opts.with_pkcs12_path(Some(Path::new("/foo/cert.p12")))
        .with_root_ca_path(Some(Path::new("/foo/root_ca.der")));

// You can create new default builder
let mut builder = OptsBuilder::new();
builder = builder.ip_or_hostname(Some("foo"))
       .db_name(Some("bar"))
       .ssl_opts(Some(ssl_opts));

// Or use existing T: Into<Opts>
let builder = OptsBuilder::from_opts(existing_opts)
       .ip_or_hostname(Some("foo"))
       .db_name(Some("bar"));

Connection URL

Opts also could be constructed using connection URL. See docs on OptsBuilder’s methods for the list of options available via URL.

Example:

let connection_opts = mysql::Opts::from_url("mysql://root:password@localhost:3307/mysql?prefer_socket=false").unwrap();
let pool = mysql::Pool::new(connection_opts).unwrap();

Implementations

impl OptsBuilder

pub fn new() -> Self

pub fn from_opts<T: Into<Opts>>(opts: T) -> Self

pub fn from_hash_map( self, client: &HashMap<String, String> ) -> Result<Self, UrlError>

Use a HashMap for creating an OptsBuilder instance:

OptsBuilder::new().from_hash_map(client);

HashMap key,value pairs:

• pool_min = upper bound for PoolConstraints
• pool_max = lower bound for PoolConstraints
• user = Username
• password = Password
• host = Host name or ip address
• port = Port, default is 3306
• socket = Unix socket or pipe name(on windows) defaults to None
• db_name = Database name (defaults to None).
• prefer_socket = Prefer socket connection (defaults to true)
• tcp_keepalive_time_ms = TCP keep alive time for mysql connection (defaults to None)
• tcp_keepalive_probe_interval_secs = TCP keep alive interval between probes for mysql connection (defaults to None)
• tcp_keepalive_probe_count = TCP keep alive probe count for mysql connection (defaults to None)
• tcp_user_timeout_ms = TCP_USER_TIMEOUT time for mysql connection (defaults to None)
• compress = Compression level(defaults to None)
• tcp_connect_timeout_ms = Tcp connect timeout (defaults to None)
• stmt_cache_size = Number of prepared statements cached on the client side (per connection)
• secure_auth = Disable mysql_old_password auth plugin

Login .cnf file parsing lib https://github.com/rjcortese/myloginrs returns a HashMap for client configs

Note: You do not have to use myloginrs lib.

pub fn ip_or_hostname<T: Into<String>>(self, ip_or_hostname: Option<T>) -> Self

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

Note: IPv6 addresses must be given in square brackets, e.g. [::1].

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

TCP port of mysql server (defaults to 3306).

pub fn socket<T: Into<String>>(self, socket: Option<T>) -> Self

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

Can be defined using socket connection url parameter.

pub fn max_allowed_packet(self, max_allowed_packet: Option<usize>) -> Self

Defines max_allowed_packet option. See [Opts::max_allowed_packet].

Note that it’ll saturate to proper minimum and maximum values for this parameter (see MySql documentation).

pub fn user<T: Into<String>>(self, user: Option<T>) -> Self

User (defaults to None).

pub fn pass<T: Into<String>>(self, pass: Option<T>) -> Self

Password (defaults to None).

pub fn db_name<T: Into<String>>(self, db_name: Option<T>) -> Self

Database name (defaults to None).

pub fn read_timeout(self, read_timeout: Option<Duration>) -> Self

The timeout for each attempt to read from the server (defaults to None).

Note that named pipe connection will ignore duration’s nanos, and also note that it is an error to pass the zero Duration to this method.

pub fn write_timeout(self, write_timeout: Option<Duration>) -> Self

The timeout for each attempt to write to the server (defaults to None).

Note that named pipe connection will ignore duration’s nanos, and also note that it is likely error to pass the zero Duration to this method.

pub fn tcp_keepalive_time_ms(self, tcp_keepalive_time_ms: Option<u32>) -> Self

TCP keep alive time for mysql connection (defaults to None). Available as tcp_keepalive_time_ms url parameter.

Can be defined using tcp_keepalive_time_ms connection url parameter.

pub fn tcp_keepalive_probe_interval_secs( self, tcp_keepalive_probe_interval_secs: Option<u32> ) -> Self

TCP keep alive interval between probes for mysql connection (defaults to None). Available as tcp_keepalive_probe_interval_secs url parameter.

Can be defined using tcp_keepalive_probe_interval_secs connection url parameter.

pub fn tcp_keepalive_probe_count( self, tcp_keepalive_probe_count: Option<u32> ) -> Self

TCP keep alive probe count for mysql connection (defaults to None). Available as tcp_keepalive_probe_count url parameter.

Can be defined using tcp_keepalive_probe_count connection url parameter.

pub fn tcp_user_timeout_ms(self, tcp_user_timeout_ms: Option<u32>) -> Self

TCP_USER_TIMEOUT for mysql connection (defaults to None). Available as tcp_user_timeout_ms url parameter.

Can be defined using tcp_user_timeout_ms connection url parameter.

pub fn tcp_nodelay(self, nodelay: bool) -> Self

Set the TCP_NODELAY option for the mysql connection (defaults to true).

Setting this option to false re-enables Nagle’s algorithm, which can cause unusually high latency (~40ms) but may increase maximum throughput. See #132.

pub fn prefer_socket(self, prefer_socket: bool) -> Self

Prefer socket connection (defaults to true). Available as prefer_socket url parameter with value true or false.

Will reconnect via socket (on 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.

Can be defined using prefer_socket connection url parameter.

pub fn init<T: Into<String>>(self, init: Vec<T>) -> Self

Commands to execute on each new database connection.

pub fn ssl_opts<T: Into<Option<SslOpts>>>(self, ssl_opts: T) -> Self

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

pub fn pool_opts<T: Into<Option<PoolOpts>>>(self, pool_opts: T) -> Self

Connection pool options (see Opts::get_pool_opts).

Pass None to reset to default.

pub fn local_infile_handler(self, handler: Option<LocalInfileHandler>) -> Self

Callback to handle requests for local files. These are caused by using LOAD DATA LOCAL INFILE queries. The callback is passed the filename, and a Writeable object to receive the contents of that file. If unset, the default callback will read files relative to the current directory.

pub fn tcp_connect_timeout(self, timeout: Option<Duration>) -> Self

Tcp connect timeout (defaults to None). Available as tcp_connect_timeout_ms url parameter.

Can be defined using tcp_connect_timeout_ms connection url parameter.

pub fn bind_address<T>(self, bind_address: Option<T>) -> Self

where T: Into<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 stmt_cache_size<T>(self, cache_size: T) -> Self

where T: Into<Option<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.

Call with None to reset to default.

pub fn compress(self, compress: Option<Compression>) -> Self

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 additional_capabilities( self, additional_capabilities: CapabilityFlags ) -> Self

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 connect_attrs<T1: Into<String> + Eq + Hash, T2: Into<String>>( self, connect_attrs: Option<HashMap<T1, T2>> ) -> Self

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 secure_auth(self, secure_auth: bool) -> Self

Disables mysql_old_password plugin (defaults to true).

Available via secure_auth connection url parameter.

pub fn enable_cleartext_plugin(self, enable_cleartext_plugin: bool) -> Self

Enables Client-Side Cleartext Pluggable Authentication (defaults to false).

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 OptsBuilder

fn clone(&self) -> OptsBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OptsBuilder

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

Formats the value using the given formatter.

impl Default for OptsBuilder

fn default() -> OptsBuilder

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 OptsBuilder

fn eq(&self, other: &OptsBuilder) -> 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 StructuralPartialEq for OptsBuilder