Struct Database 

pub struct Database { /* private fields */ }

A database handle: a shared Connection, cheap to clone.

Lives as a container singleton and is cloned into repositories, jobs and console commands freely.

Implementations

impl Database

pub fn new(connection: impl Connection) -> Self

Wrap a concrete connection.

pub fn from_arc(connection: Arc<dyn Connection>) -> Self

Wrap an already-shared connection.

pub fn connection(&self) -> &Arc<dyn Connection>

The underlying connection.

pub fn dialect(&self) -> Dialect

The dialect the backend speaks.

pub fn is_sharded(&self) -> bool

Whether the backend is a sharded fleet.

pub fn shard_family(&self) -> Option<String>

The shard family, if any.

pub async fn fetch( &self, prepared: Prepared, columns: Vec<ColumnRequest>, ) -> Result<Vec<OwnedRow>>

Run a prepared query, reading back the named columns.

pub async fn fetch_all<E: Entity>(&self, prepared: Prepared) -> Result<Vec<E>>

Run a prepared query and decode every row into E.

pub async fn fetch_one<E: Entity>( &self, prepared: Prepared, ) -> Result<Option<E>>

Run a prepared query and decode the first row into E.

pub async fn fetch_count(&self, prepared: Prepared) -> Result<u64>

Run a prepared COUNT(*) AS cnt and read the total.

pub async fn execute(&self, prepared: Prepared) -> Result<ExecOutcome>

Run a prepared write.

pub async fn statement(&self, sql: &str) -> Result<ExecOutcome>

Run a raw statement with no bindings — for DDL.

impl Database

pub fn query(&self, sql: impl Into<String>) -> RawQuery<'_>

Start a raw statement.

database.query("UPDATE posts SET views = views + 1 WHERE id = ?")
    .bind(post_id)
    .execute()
    .await?;

See the module docs for what is and is not safe to put in the statement itself.

Trait Implementations

impl Clone for Database

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Database

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

Formats the value using the given formatter.

impl Executor for Database

Implementing Executor is what keeps Rainier ORM’s whole surface available.

repo::insert, repo::query::<E>(), Cursor and Migrator::run are all generic over X: Executor, so they accept a Database directly. Their futures are !Send (see the module docs), so use them from a console command, a migration, or a Worker — not from a request handler, which needs the Send path above.

fn dialect(&self) -> Dialect

The SQL dialect this backend speaks, so callers render matching SQL.

fn shard_family(&self) -> Option<&str>

The shard family this connector routes within, or None for a single, unsharded database.

fn is_sharded(&self) -> bool

true when this connector is sharded — sugar for shard_family().is_some().

fn allocate_id(&self, shard_key: u64) -> Option<u64>

Mint a shard-encoded primary key for a row whose shard-key value is shard_key (e.g. the owning user_id). repo::insert calls this when an entity’s primary key is itself a shard key, is not auto-increment, and is unset — so id assignment for the sharded data tier happens here, in the connector, transparently, not in the service. The default is None (no allocation: the caller’s id or the DB’s auto-increment stands) so single, unsharded executors are unaffected.

async fn fetch_all( &self, sql: &str, params: Vec<Value>, ) -> Result<Vec<Box<dyn Row>>>

Run a query and return every row. Parameters are bound positionally in the order sea-query emitted them.

async fn execute(&self, sql: &str, params: Vec<Value>) -> Result<ExecOutcome>

Run a write and report its ExecOutcome.

async fn fetch_all_routed( &self, route: ShardRoute, sql: &str, params: Vec<Value>, ) -> Result<Vec<Box<dyn Row>>>

Run a query against the physical database the ShardRoute selects.

async fn execute_routed( &self, route: ShardRoute, sql: &str, params: Vec<Value>, ) -> Result<ExecOutcome>

Routed counterpart of execute. Defaults to ignoring the route — see fetch_all_routed.