Struct Config

pub struct Config { /* private fields */ }

The Config struct contains all configuration information required for connecting to the database with a Client. It also provides the server address when connecting to a TcpStream via the get_addr method.

When using an ADO.NET connection string, it can be constructed using the from_ado_string function.

Implementations

impl Config

pub fn new() -> Self

Create a new Config with the default settings.

pub fn host(&mut self, host: impl ToString)

A host or ip address to connect to.

• Defaults to localhost.

pub fn port(&mut self, port: u16)

The server port.

• Defaults to 1433.

pub fn database(&mut self, database: impl ToString)

The database to connect to.

• Defaults to master.

pub fn instance_name(&mut self, name: impl ToString)

The instance name as defined in the SQL Browser. Only available on Windows platforms.

If specified, the port is replaced with the value returned from the browser.

• Defaults to no name specified.

pub fn application_name(&mut self, name: impl ToString)

Sets the application name to the connection, queryable with the APP_NAME() command.

• Defaults to no name specified.

pub fn encryption(&mut self, encryption: EncryptionLevel)

Set the preferred encryption level.

• With tls feature, defaults to Required.
• Without tls feature, defaults to NotSupported.

pub fn trust_cert(&mut self)

If set, the server certificate will not be validated and it is accepted as-is.

On production setting, the certificate should be added to the local key storage (or use trust_cert_ca instead), using this setting is potentially dangerous.

Panics

Will panic in case trust_cert_ca was called before.

• Defaults to default, meaning server certificate is validated against system-truststore.

pub fn trust_cert_ca(&mut self, path: impl ToString)

If set, the server certificate will be validated against the given CA certificate in in addition to the system-truststore. Useful when using self-signed certificates on the server without having to disable the trust-chain.

Panics

Will panic in case trust_cert was called before.

• Defaults to validating the server certificate is validated against system’s certificate storage.

pub fn authentication(&mut self, auth: AuthMethod)

Sets the authentication method.

• Defaults to None.

pub fn get_addr(&self) -> String

Get the host address including port

pub fn from_ado_string(s: &str) -> Result<Self>

Creates a new Config from an ADO.NET connection string.

Supported parameters

All parameter keys are handled case-insensitive.

Parameter	Allowed values	Description
server	<string>	The name or network address of the instance of SQL Server to which to connect. The port number can be specified after the server name. The correct form of this parameter is either tcp:host,port or tcp:host\\instance
IntegratedSecurity	true,false,yes,no	Toggle between Windows/Kerberos authentication and SQL authentication.
uid,username,user,user id	<string>	The SQL Server login account.
password,pwd	<string>	The password for the SQL Server account logging on.
database	<string>	The name of the database.
TrustServerCertificate	true,false,yes,no	Specifies whether the driver trusts the server certificate when connecting using TLS. Cannot be used toghether with TrustServerCertificateCA
TrustServerCertificateCA	<path>	Path to a pem, crt or der certificate file. Cannot be used together with TrustServerCertificate
encrypt	true,false,yes,no,DANGER_PLAINTEXT	Specifies whether the driver uses TLS to encrypt communication.
Application Name, ApplicationName	<string>	Sets the application name for the connection.

pub fn from_jdbc_string(s: &str) -> Result<Self>

Creates a new Config from a JDBC connection string.

See from_ado_string method for supported parameters.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.