Struct Config 

#[non_exhaustive]
pub struct Config {

    pub host: String,
    pub port: u16,
    pub database: Option<String>,
    pub credentials: Credentials,
    pub tls: TlsConfig,
    pub application_name: String,
    pub connect_timeout: Duration,
    pub command_timeout: Duration,
    pub packet_size: u16,
    pub strict_mode: bool,
    pub trust_server_certificate: bool,
    pub instance: Option<String>,
    pub mars: bool,
    pub encrypt: bool,
    pub redirect: RedirectConfig,
    pub retry: RetryPolicy,
    pub timeouts: TimeoutConfig,
    pub tds_version: TdsVersion,
}

Configuration for connecting to SQL Server.

This struct is marked #[non_exhaustive] to allow adding new fields in future releases without breaking semver. Use Config::default() or Config::from_connection_string() to construct instances.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

host: String

Server hostname or IP address.

port: u16

Server port (default: 1433).

database: Option<String>

Database name.

credentials: Credentials

Authentication credentials.

tls: TlsConfig

TLS configuration.

application_name: String

Application name (shown in SQL Server management tools).

connect_timeout: Duration

Connection timeout.

command_timeout: Duration

Command timeout.

packet_size: u16

TDS packet size.

strict_mode: bool

Whether to use TDS 8.0 strict mode.

trust_server_certificate: bool

Whether to trust the server certificate.

instance: Option<String>

Instance name (for named instances).

mars: bool

Whether to enable MARS (Multiple Active Result Sets).

encrypt: bool

Whether to require encryption (TLS). When true, the connection will use TLS even if the server doesn’t require it. When false, encryption is used only if the server requires it.

redirect: RedirectConfig

Redirect handling configuration (for Azure SQL).

retry: RetryPolicy

Retry policy for transient error handling.

timeouts: TimeoutConfig

Timeout configuration for various connection phases.

tds_version: TdsVersion

Requested TDS protocol version.

This specifies which TDS protocol version to request during connection. The server may negotiate a lower version if it doesn’t support the requested version.

Supported versions:

• TdsVersion::V7_3A - SQL Server 2008
• TdsVersion::V7_3B - SQL Server 2008 R2
• TdsVersion::V7_4 - SQL Server 2012+ (default)
• TdsVersion::V8_0 - SQL Server 2022+ strict mode (requires strict_mode = true)

Note: When strict_mode is enabled, this is ignored and TDS 8.0 is used.

Implementations

impl Config

pub fn new() -> Self

Create a new configuration with default values.

pub fn from_connection_string(conn_str: &str) -> Result<Self, Error>

Parse a connection string into configuration.

Supports ADO.NET-style connection strings:

Server=localhost;Database=mydb;User Id=sa;Password=secret;

pub fn host(self, host: impl Into<String>) -> Self

Set the server host.

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

Set the server port.

pub fn database(self, database: impl Into<String>) -> Self

Set the database name.

pub fn credentials(self, credentials: Credentials) -> Self

Set the credentials.

pub fn application_name(self, name: impl Into<String>) -> Self

Set the application name.

pub fn connect_timeout(self, timeout: Duration) -> Self

Set the connect timeout.

pub fn trust_server_certificate(self, trust: bool) -> Self

Set trust server certificate option.

pub fn strict_mode(self, enabled: bool) -> Self

Enable TDS 8.0 strict mode.

pub fn tds_version(self, version: TdsVersion) -> Self

Set the TDS protocol version.

This specifies which TDS protocol version to request during connection. The server may negotiate a lower version if it doesn’t support the requested version.

Examples

use mssql_client::Config;
use tds_protocol::version::TdsVersion;

// Connect to SQL Server 2008
let config = Config::new()
    .host("legacy-server")
    .tds_version(TdsVersion::V7_3A);

// Connect to SQL Server 2008 R2
let config = Config::new()
    .host("legacy-server")
    .tds_version(TdsVersion::V7_3B);

Note: When strict_mode is enabled, this is ignored and TDS 8.0 is used.

pub fn encrypt(self, enabled: bool) -> Self

Enable or disable TLS encryption.

When true (default), the connection will use TLS encryption. When false, encryption is used only if the server requires it.

Warning: Disabling encryption is insecure and should only be used for development/testing on trusted networks.

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

Create a new configuration with a different host (for routing).

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

Create a new configuration with a different port (for routing).

pub fn redirect(self, redirect: RedirectConfig) -> Self

Set the redirect handling configuration.

pub fn max_redirects(self, max: u8) -> Self

Set the maximum number of redirect attempts.

pub fn retry(self, retry: RetryPolicy) -> Self

Set the retry policy for transient error handling.

pub fn max_retries(self, max: u32) -> Self

Set the maximum number of retry attempts.

pub fn timeouts(self, timeouts: TimeoutConfig) -> Self

Set the timeout configuration.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate 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.