Struct SqlConnector 

pub struct SqlConnector { /* private fields */ }

Available on crate features sqlite or postgres only.

Connector for SQL cold storage (PostgreSQL or SQLite).

Automatically detects the database type from the URL:

• URLs starting with postgres:// or postgresql:// use PostgreSQL
• URLs starting with sqlite: use SQLite

Pool behaviour is configured via builder methods that mirror sqlx::pool::PoolOptions, or by passing a complete PoolOptions via with_pool_options. For in-memory SQLite URLs, max_connections is forced to 1 regardless of the provided options.

Example

use signet_cold_sql::SqlConnector;

// PostgreSQL with custom pool size
let pg = SqlConnector::new("postgres://localhost/signet")
    .with_max_connections(20);
let backend = pg.connect().await?;

// SQLite (defaults)
let sqlite = SqlConnector::new("sqlite::memory:");
let backend = sqlite.connect().await?;

Implementations

impl SqlConnector

pub fn new(url: impl Into<String>) -> Self

Create a new SQL connector with default pool options.

The database type is detected from the URL prefix.

pub fn url(&self) -> &str

Get a reference to the connection URL.

pub fn with_pool_options(self, pool_opts: PoolOptions<Any>) -> Self

Replace the pool options entirely.

For in-memory SQLite URLs, max_connections is forced to 1 regardless of the value set here.

pub fn with_max_connections(self, n: u32) -> Self

Set the maximum number of pool connections.

Ignored for in-memory SQLite URLs, which always use 1.

pub fn with_min_connections(self, n: u32) -> Self

Set the minimum number of connections to maintain at all times.

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

Set the connection acquire timeout.

pub fn with_max_lifetime(self, lifetime: Option<Duration>) -> Self

Set the maximum lifetime of individual connections.

pub fn with_idle_timeout(self, timeout: Option<Duration>) -> Self

Set the idle timeout for connections.

pub fn from_env(env_var: &'static str) -> Result<Self, SqlConnectorError>

Create a connector from environment variables.

Reads the SQL URL from the specified environment variable. Uses default pool settings.

Example

use signet_cold_sql::SqlConnector;

let cold = SqlConnector::from_env("SIGNET_COLD_SQL_URL")?;

Trait Implementations

impl Clone for SqlConnector

fn clone(&self) -> SqlConnector

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ColdConnect for SqlConnector

type Cold = SqlColdBackend

The cold storage type produced by this connector.

type Error = SqlColdError

The error type returned by connection attempts.

fn connect( &self, ) -> impl Future<Output = Result<Self::Cold, Self::Error>> + Send

Connect to the cold storage backend asynchronously.

impl Debug for SqlConnector

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

Formats the value using the given formatter.