Struct Config 

pub struct Config {
    pub host: String,
    pub port: u16,
    pub service: ServiceMethod,
    pub username: String,
    pub tls_mode: TlsMode,
    pub tls_config: Option<TlsConfig>,
    pub connect_timeout: Duration,
    pub sdu: u32,
    pub charset_id: u16,
    pub ncharset_id: u16,
    pub stmtcachesize: usize,
    /* private fields */
}

Connection configuration for Oracle databases.

This struct holds all the parameters needed to establish a connection to an Oracle database, including host, port, credentials, TLS settings, and more.

Examples

Basic connection

use oracle_rs::Config;

let config = Config::new("localhost", 1521, "FREEPDB1", "user", "password");

TLS connection with system certificates

use oracle_rs::Config;

let config = Config::new("hostname", 2484, "service", "user", "password")
    .with_tls()
    .expect("TLS configuration failed");

TLS connection with Oracle wallet

use oracle_rs::Config;

let config = Config::new("hostname", 2484, "service", "user", "password")
    .with_wallet("/path/to/wallet", Some("wallet_password"))
    .expect("Wallet configuration failed");

With custom options

use oracle_rs::Config;
use std::time::Duration;

let config = Config::new("localhost", 1521, "FREEPDB1", "user", "password")
    .connect_timeout(Duration::from_secs(30))
    .stmtcachesize(50);

Fields

host: String

Host to connect to

port: u16

Port to connect to

service: ServiceMethod

Service name or SID

username: String

Username for authentication

tls_mode: TlsMode

TLS mode

tls_config: Option<TlsConfig>

TLS configuration (certificates, wallet, etc.)

connect_timeout: Duration

Connection timeout

sdu: u32

SDU (Session Data Unit) size

charset_id: u16

Client charset ID

ncharset_id: u16

National charset ID

stmtcachesize: usize

Statement cache size (0 = disabled)

Implementations

impl Config

pub fn new( host: impl Into<String>, port: u16, service_name: impl Into<String>, username: impl Into<String>, password: impl Into<String>, ) -> Self

Create a new configuration with service name

pub fn with_sid( host: impl Into<String>, port: u16, sid: impl Into<String>, username: impl Into<String>, password: impl Into<String>, ) -> Self

Create a new configuration with SID

pub fn tls(self, mode: TlsMode) -> Self

Set TLS mode

pub fn tls_config(self, config: TlsConfig) -> Self

Set TLS configuration

pub fn is_tls_enabled(&self) -> bool

Check if TLS is enabled

pub fn with_tls(self) -> Result<Self>

Enable TLS with system root certificates.

This configures the connection to use TLS (TCPS protocol) with the system’s trusted root certificate store for server verification.

Example

use oracle_rs::Config;

let config = Config::new("hostname", 2484, "service", "user", "password")
    .with_tls()
    .expect("TLS configuration failed");

pub fn with_wallet( self, wallet_path: impl Into<String>, wallet_password: Option<&str>, ) -> Result<Self>

Enable TLS with an Oracle wallet.

Oracle wallets (ewallet.p12 or ewallet.pem files) contain certificates and keys for secure connections. This is the standard way to configure TLS for Oracle Cloud and enterprise deployments.

Arguments

• wallet_path - Path to the wallet directory containing ewallet.pem
• wallet_password - Optional password for encrypted wallets

Example

use oracle_rs::Config;

let config = Config::new("hostname", 2484, "service", "user", "password")
    .with_wallet("/path/to/wallet", Some("wallet_password"))
    .expect("Wallet configuration failed");

pub fn with_drcp(self, _connection_class: &str, _purity: &str) -> Self

Configure DRCP (Database Resident Connection Pooling).

DRCP allows the database server to maintain a pool of connections that can be shared across multiple client processes, reducing server resource usage.

Arguments

• connection_class - Name identifying this class of connections
• purity - Either “self” (dedicated) or “new” (can share with others)

Example

use oracle_rs::Config;

let config = Config::new("hostname", 1521, "service", "user", "password")
    .with_drcp("my_app", "self");

pub fn with_statement_cache_size(self, size: usize) -> Self

Set the statement cache size.

Statement caching improves performance by reusing parsed SQL statements. Set to 0 to disable caching.

Default is 20 (matches python-oracledb default).

Example

use oracle_rs::Config;

let config = Config::new("localhost", 1521, "FREEPDB1", "user", "password")
    .with_statement_cache_size(100);

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

Set connection timeout

pub fn sdu(self, sdu: u32) -> Self

Set SDU size

pub fn stmtcachesize(self, size: usize) -> Self

Set statement cache size

Set to 0 to disable statement caching. Default is 20 (matches python-oracledb default).

pub fn set_password(&mut self, password: impl Into<String>)

Set the password

pub fn set_username(&mut self, username: impl Into<String>)

Set the username

pub fn build_connect_string(&self) -> String

Build a TNS connect descriptor string

pub fn socket_addr(&self) -> String

Get the socket address string

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.

impl Display for Config

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

Formats the value using the given formatter.

impl FromStr for Config

Parse an EZConnect-style connection string

Formats supported:

• host:port/service_name
• host/service_name
• host:port:sid
• //host:port/service_name (with optional leading slashes)

type Err = Error

The associated error which can be returned from parsing.

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

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