Struct PoolRegistry 

pub struct PoolRegistry<P: PoolProvider = DbPools> { /* private fields */ }

A registry of database pool providers keyed by name.

PoolRegistry is available with the with-named-pools feature. It stores one homogeneous provider type and defaults to DbPools. Selecting a name returns the provider for that name; the registry itself does not keep a stateful “current” pool and does not implement PoolProvider.

Examples

use sqlx_pool_registry::sqlx::{self, postgres::PgPoolOptions};
use sqlx_pool_registry::{DbPools, PoolProvider, PoolRegistry};

let auth_primary = PgPoolOptions::new()
    .connect_lazy("postgresql://localhost/auth")?;
let auth_replica = PgPoolOptions::new()
    .connect_lazy("postgresql://localhost/auth_replica")?;
let analytics = PgPoolOptions::new()
    .connect_lazy("postgresql://localhost/analytics")?;

let mut pools = PoolRegistry::new();
pools.insert("auth", DbPools::with_replica(auth_primary, auth_replica));
pools.insert("analytics", DbPools::new(analytics));

let auth = pools.try_get("auth")?;
let _primary = auth.primary();
let _replica = auth.replica(); // Option<&PgPool>, with no fallback
let _read = auth.read(); // Replica, or primary when no replica is configured

Implementations

impl<P: PoolProvider> PoolRegistry<P>

pub fn new() -> Self

Create an empty pool registry.

pub fn insert(&mut self, name: impl Into<String>, provider: P) -> Option<P>

Insert a provider under name.

If the name was already registered, the previous provider is replaced and returned.

pub fn get(&self, name: &str) -> Option<&P>

Get a provider by name.

Names are matched exactly and case-sensitively.

pub fn try_get(&self, name: &str) -> Result<&P, UnknownPool>

Get a provider by name, returning UnknownPool when it is absent.

pub fn contains_key(&self, name: &str) -> bool

Return whether a provider is registered under name.

pub fn len(&self) -> usize

Return the number of registered providers.

pub fn is_empty(&self) -> bool

Return whether the registry contains no providers.

pub fn iter(&self) -> impl Iterator<Item = (&str, &P)>

Iterate over registered names and providers in unspecified order.

Trait Implementations

impl<P: Clone + PoolProvider> Clone for PoolRegistry<P>

fn clone(&self) -> PoolRegistry<P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P: Debug + PoolProvider> Debug for PoolRegistry<P>

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

Formats the value using the given formatter.

impl<P: PoolProvider> Default for PoolRegistry<P>

fn default() -> Self

Returns the “default value” for a type.

impl<K, P> Extend<(K, P)> for PoolRegistry<P>

where K: Into<String>, P: PoolProvider,

fn extend<T: IntoIterator<Item = (K, P)>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<K, P> FromIterator<(K, P)> for PoolRegistry<P>

where K: Into<String>, P: PoolProvider,

fn from_iter<T: IntoIterator<Item = (K, P)>>(iter: T) -> Self

Creates a value from an iterator.