Struct OdbcConnectOptions 

pub struct OdbcConnectOptions { /* private fields */ }

Available on crate feature odbc only.

Implementations

impl OdbcConnectOptions

pub fn connection_string(&self) -> &str

pub fn buffer_settings( &mut self, settings: OdbcBufferSettings, ) -> &mut OdbcConnectOptions

Sets the buffer configuration for this connection.

The buffer settings control memory usage and performance characteristics when fetching data from ODBC data sources.

Example

use std::str::FromStr;
use sqlx_core_oldapi::odbc::{OdbcConnectOptions, OdbcBufferSettings};

let mut opts = OdbcConnectOptions::from_str("DSN=MyDataSource")?;

// Configure for high-throughput buffered mode
opts.buffer_settings(OdbcBufferSettings {
    batch_size: 256,
    max_column_size: Some(2048),
});

// Or configure for unbuffered mode
opts.buffer_settings(OdbcBufferSettings {
    batch_size: 128,  // batch_size is ignored in unbuffered mode
    max_column_size: None,
});

pub fn batch_size(&mut self, batch_size: usize) -> &mut OdbcConnectOptions

Sets the batch size for bulk fetch operations.

This controls how many rows are fetched at once during query execution. Higher values can improve performance for large result sets but use more memory. Only used when max_column_size is Some(value) (buffered mode).

Panics

Panics if batch_size is 0.

pub fn max_column_size( &mut self, max_column_size: Option<usize>, ) -> &mut OdbcConnectOptions

Sets the maximum column size for text and binary data.

This controls the buffer size allocated for columns when the database doesn’t specify a maximum length. Larger values ensure complete data capture but increase memory usage.

• When set to Some(value): Enables buffered mode with batch fetching
• When set to None: Enables unbuffered mode with row-by-row processing

Panics

Panics if max_column_size is less than 0.

pub fn buffer_settings_ref(&self) -> &OdbcBufferSettings

Returns the current buffer settings for this connection.

Trait Implementations

impl Clone for OdbcConnectOptions

fn clone(&self) -> OdbcConnectOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConnectOptions for OdbcConnectOptions

type Connection = OdbcConnection

fn connect( &self, ) -> Pin<Box<dyn Future<Output = Result<<OdbcConnectOptions as ConnectOptions>::Connection, Error>> + Send + '_>>

where <OdbcConnectOptions as ConnectOptions>::Connection: Sized,

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

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

Log executed statements with the specified level

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

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 OdbcConnectOptions

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

Formats the value using the given formatter.

impl From<OdbcConnectOptions> for AnyConnectOptions

fn from(options: OdbcConnectOptions) -> AnyConnectOptions

Converts to this type from the input type.

impl FromStr for OdbcConnectOptions

type Err = Error

The associated error which can be returned from parsing.

fn from_str( s: &str, ) -> Result<OdbcConnectOptions, <OdbcConnectOptions as FromStr>::Err>

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

impl TryFrom<AnyConnectOptions> for OdbcConnectOptions

type Error = Error

The type returned in the event of a conversion error.

fn try_from( value: AnyConnectOptions, ) -> Result<OdbcConnectOptions, <OdbcConnectOptions as TryFrom<AnyConnectOptions>>::Error>

Performs the conversion.