Skip to main content

Database Connection

To obtain a database connection, use the Database interface:

let db: DatabaseConnection = Database::connect("mssql://username:password@host/database").await?;

host is usually localhost, a domain name or an IP address.

tip

If you can't get localhost to work, try putting in an IP address and port number, e.g. 127.0.0.1:1433 or even 192.168.x.x.

Under the hood, a sqlz::Pool is created and owned by DatabaseConnection.

Each time you call execute or query_one/all on it, a connection will be acquired and released from the pool.

Multiple queries will execute in parallel as you await on them.

Connection String​

Specify a Schema​

If the schema is dbo (the default), simply write:

mssql://username:password@host/database

To use a non-default schema, provide a currentSchema query param. SeaORM X will automatically prefix every outgoing statement with that schema (see Schema Rewriting):

mssql://username:password@host/database?currentSchema=my_schema

Trust Peer Certificate​

Trust the server's certificate (useful for development with self-signed certs):

mssql://username:password@host/database?trustCertificate=true

Connect Options​

To configure the connection, use the ConnectOptions interface:

let mut opt = ConnectOptions::new("mssql://username:password@host/database");
opt.max_connections(100)
    .min_connections(5)
    .connect_timeout(Duration::from_secs(8))
    .acquire_timeout(Duration::from_secs(8))
    .idle_timeout(Duration::from_secs(8))
    .max_lifetime(Duration::from_secs(8))
    .sqlx_logging(true)
    .sqlx_logging_level(log::LevelFilter::Info);

let db = Database::connect(opt).await?;

Pool Lifecycle Hooks​

The SQLz pool supports the same lifecycle hooks as SQLx:

  • after_connect — initialize a freshly opened connection
  • before_acquire — validate an idle connection before handing it out
  • after_release — clean up before returning a connection to the pool

Checking Connection is Valid​

Checks if a connection to the database is still valid.

|db: DatabaseConnection| {
    assert!(db.ping().await.is_ok());
    db.clone().close().await;
    assert!(matches!(db.ping().await, Err(DbErr::ConnectionAcquire)));
}

Closing Connection​

The connection will be automatically closed on drop. To close the connection explicitly, call the close method.

let db = Database::connect(url).await?;

// Closing connection here
db.close().await?;