Skip to main content

DatabasePool

Struct DatabasePool 

Source
pub struct DatabasePool { /* private fields */ }
Expand description

Multi-database connection pool with lazy shard opening.

Wraps a default Database (the main database) plus a sharded cache of lazily-opened shard databases. All shards share the same PRAGMAs and migrations from the parent Config.

Cloning is cheap (reference count increment via Arc).

§Examples

use modo::db::{self, ConnExt, ConnQueryExt, DatabasePool};

let pool = DatabasePool::new(&config).await?;

// Default database:
let user: User = pool.conn(None).await?
    .conn()
    .query_one("SELECT id, name FROM users WHERE id = ?1", libsql::params!["u1"])
    .await?;

// Tenant shard (lazy open + cache):
let user: User = pool.conn(tenant.db_shard.as_deref()).await?
    .conn()
    .query_one("SELECT id, name FROM users WHERE id = ?1", libsql::params!["u1"])
    .await?;

Implementations§

Source§

impl DatabasePool

Source

pub async fn new(config: &Config) -> Result<Self>

Create a new pool from the given config.

Opens the default database immediately. Shard databases are opened lazily on first conn call.

§Errors

Returns an error if config.pool is None or the default database fails to open.

Source

pub async fn conn(&self, shard: Option<&str>) -> Result<Database>

Get a database connection by shard name.

  • None — returns the default database (instant, no lock).
  • Some("name") — returns the cached shard database, opening it on first access at {base_path}/{name}.db.

Concurrent first-access to the same shard may open duplicate connections; the last writer wins and the extra connection is dropped. This is benign because connect is idempotent (PRAGMAs are re-applied, migrations use checksum tracking).

§Errors

Returns an error if the shard name is invalid (empty, starts with ., or contains path separators or a null byte) or if the shard database fails to open.

Trait Implementations§

Source§

impl Clone for DatabasePool

Source§

fn clone(&self) -> DatabasePool

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,