Struct ConnectionConfig 

pub struct ConnectionConfig {
    pub db_url: String,
    pub db_ns: String,
    pub db: String,
    pub db_user: Option<String>,
    pub db_pass: Option<String>,
    pub db_timeout: f64,
    pub db_max_connections: u32,
    pub db_retry_max_attempts: u32,
    pub db_retry_min_wait: f64,
    pub db_retry_max_wait: f64,
    pub db_retry_multiplier: f64,
    pub enable_live_queries: bool,
}

Database connection configuration.

Field names follow the Python port (db_url, db_ns, db, …) for wire-compatibility with env-var loading; convenient getters are provided for the shorter aliases (url, namespace, database, …).

Examples

use surql::connection::ConnectionConfig;

let cfg = ConnectionConfig::builder()
    .url("ws://localhost:8000/rpc")
    .namespace("prod")
    .database("app")
    .build()
    .unwrap();
assert_eq!(cfg.url(), "ws://localhost:8000/rpc");
assert_eq!(cfg.namespace(), "prod");
assert_eq!(cfg.database(), "app");

Fields

db_url: String

SurrealDB connection URL. Aliases: url.

db_ns: String

Database namespace. Aliases: namespace.

db: String

Database name. Aliases: database.

db_user: Option<String>

Authentication username. Aliases: username.

db_pass: Option<String>

Authentication password. Aliases: password.

db_timeout: f64

Connection timeout in seconds. Aliases: timeout.

db_max_connections: u32

Maximum number of concurrent connections. Aliases: max_connections.

db_retry_max_attempts: u32

Maximum retry attempts. Aliases: retry_max_attempts.

db_retry_min_wait: f64

Minimum retry wait time in seconds. Aliases: retry_min_wait.

db_retry_max_wait: f64

Maximum retry wait time in seconds. Aliases: retry_max_wait.

db_retry_multiplier: f64

Exponential backoff multiplier. Aliases: retry_multiplier.

enable_live_queries: bool

Enable live query support. Requires WebSocket or embedded URL.

Implementations

impl ConnectionConfig

pub fn builder() -> ConnectionConfigBuilder

Start a builder with the default field values.

pub fn validate(&self) -> Result<()>

Validate the configuration values according to the Python port’s rules.

pub fn protocol(&self) -> Result<Protocol>

Infer the Protocol used by this configuration’s URL.

pub fn from_env() -> Result<Self>

Load configuration from environment variables prefixed SURQL_.

Recognised variables (case-insensitive): SURQL_URL, SURQL_NAMESPACE, SURQL_DATABASE, SURQL_USERNAME, SURQL_PASSWORD, SURQL_TIMEOUT, SURQL_MAX_CONNECTIONS, SURQL_RETRY_MAX_ATTEMPTS, SURQL_RETRY_MIN_WAIT, SURQL_RETRY_MAX_WAIT, SURQL_RETRY_MULTIPLIER, SURQL_ENABLE_LIVE_QUERIES.

Missing values fall back to ConnectionConfig::default; on success, the built config is validated before return.

pub fn from_env_with_prefix(prefix: &str) -> Result<Self>

Load configuration from environment variables with a custom prefix (e.g. SURQL_PRIMARY_ for named connections).

pub fn from_source_with_prefix<F>(prefix: &str, lookup: F) -> Result<Self>

where F: FnMut(&str) -> Option<String>,

Build a config from an arbitrary key lookup (used by Self::from_env and by tests to avoid process-wide env mutation).

lookup is called with the fully-qualified variable name (case preserved). Missing values fall back to defaults.

pub fn from_map_with_prefix( prefix: &str, map: &HashMap<String, String>, ) -> Result<Self>

Convenience: build from a pre-populated map (useful in tests).

pub fn url(&self) -> &str

Alias for Self::db_url.

pub fn namespace(&self) -> &str

Alias for Self::db_ns.

pub fn database(&self) -> &str

Alias for Self::db.

pub fn username(&self) -> Option<&str>

Alias for Self::db_user.

pub fn password(&self) -> Option<&str>

Alias for Self::db_pass.

pub fn timeout(&self) -> f64

Alias for Self::db_timeout.

pub fn max_connections(&self) -> u32

Alias for Self::db_max_connections.

pub fn retry_max_attempts(&self) -> u32

Alias for Self::db_retry_max_attempts.

pub fn retry_min_wait(&self) -> f64

Alias for Self::db_retry_min_wait.

pub fn retry_max_wait(&self) -> f64

Alias for Self::db_retry_max_wait.

pub fn retry_multiplier(&self) -> f64

Alias for Self::db_retry_multiplier.

Trait Implementations

impl Clone for ConnectionConfig

fn clone(&self) -> ConnectionConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectionConfig

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

Formats the value using the given formatter.

impl Default for ConnectionConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ConnectionConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ConnectionConfig

fn eq(&self, other: &ConnectionConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ConnectionConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ConnectionConfig