Struct Orm 

pub struct Orm;

Orm configuration structure

Implementations

impl Orm

pub async fn begin_transaction() -> Result<Transaction<'static>, Error>

Opens a transaction under a secret-free tracing span.

pub async fn transaction<F, R, E>(f: F) -> Result<R, Error>

where F: FnOnce(Arc<Mutex<Option<Transaction<'static>>>>) -> Pin<Box<dyn Future<Output = Result<R, E>> + Send>> + Send, E: Display,

Executes a closure inside an isolated transaction and records its final commit or rollback outcome without recording SQL, bindings, or errors.

Called while another managed transaction is active on the same task, the closure joins that transaction through a savepoint and receives the same shared handle: an Err rolls back only the nested work, while a success releases the savepoint so the work commits (or rolls back) with the outer transaction. after_commit callbacks registered inside it are promoted to the outer commit boundary on success and discarded on failure. Do not hold the shared handle’s lock across a nested call.

Sibling nested calls (for example futures joined on one task) take turns: each opens its savepoint only after the previous sibling’s savepoint was released or rolled back. A savepoint left open, for example by a nested future cancelled while another operation held the connection, makes the enclosing level fail closed: the managed transaction then rolls back and returns an error instead of committing.

The returned future is Send when R and E are, so the call can be nested in another transaction closure or run in a spawned task.

impl Orm

pub async fn init(database_url: &str) -> Result<(), Error>

Initialize the global database connection pool using an agnostic URI

pub async fn init_with_options( database_url: &str, max_connections: u32, acquire_timeout_secs: u64, ) -> Result<(), Error>

Initialize the global database connection pool with specific pool options

pub async fn init_with_replicas( primary_url: &str, replica_urls: Vec<&str>, ) -> Result<(), Error>

Initialize the global database connection pool and its read replicas

pub fn pool() -> Result<&'static RullstPool, Error>

Retrieve the global database connection pool (strictly for writes).

pub fn try_pool() -> Result<&'static RullstPool, Error>

Fallible variant of Orm::pool: returns Err instead of panicking when the ORM has not been initialized yet.

pub fn read_pool() -> Result<&'static RullstPool, Error>

Retrieve the connection pool for read operations. Performs a round-robin load balancing over replicas if configured.

pub fn try_read_pool() -> Result<&'static RullstPool, Error>

Fallible variant of Orm::read_pool.

pub fn driver() -> Result<&'static str, Error>

Retrieve the active driver string.

pub fn try_driver() -> Result<&'static str, Error>

Fallible variant of Orm::driver.

pub fn raw(sql: impl Into<String>) -> RawQueryBuilder

Create a raw SQL query builder.

pub async fn seed(seeders: Vec<Box<dyn Seeder>>) -> Result<(), Error>

Run an array of seeders sequentially

pub fn enable_query_log()

Enable query logging to print all queries to the terminal

pub fn disable_query_log()

Disable query logging

pub fn set_max_query_limit(limit: usize)

Set a global maximum limit for all queries without an explicit limit override

pub fn set_query_timeout(secs: u64)

Set a global maximum execution timeout for all queries