Skip to main content

ReplicaPool

Struct ReplicaPool 

Source
pub struct ReplicaPool<C: Connection> { /* private fields */ }
Expand description

A pool that routes reads to replicas and writes to a primary.

§Example

let primary = Pool::new(primary_config);
let replica1 = Pool::new(replica1_config);
let replica2 = Pool::new(replica2_config);

let pool = ReplicaPool::new(primary, vec![replica1, replica2]);

// Reads go to replicas (factory provided at acquire time)
let conn = pool.acquire_read(&cx, || connect_replica()).await?;

// Writes go to primary
let conn = pool.acquire_write(&cx, || connect_primary()).await?;

Implementations§

Source§

impl<C: Connection> ReplicaPool<C>

Source

pub fn new(primary: Pool<C>, replicas: Vec<Pool<C>>) -> Self

Create a new replica pool with round-robin strategy.

Source

pub fn with_strategy( primary: Pool<C>, replicas: Vec<Pool<C>>, strategy: ReplicaStrategy, ) -> Self

Create a new replica pool with a specific strategy.

Source

pub async fn acquire_read<F, Fut>( &self, cx: &Cx, factory: F, ) -> Outcome<PooledConnection<C>, Error>
where F: Fn() -> Fut, Fut: Future<Output = Outcome<C, Error>>,

Acquire a connection for read operations.

If replicas are available, selects one based on the configured strategy. Falls back to the primary if no replicas are configured.

Source

pub async fn acquire_write<F, Fut>( &self, cx: &Cx, factory: F, ) -> Outcome<PooledConnection<C>, Error>
where F: Fn() -> Fut, Fut: Future<Output = Outcome<C, Error>>,

Acquire a connection for write operations (always uses primary).

Source

pub async fn acquire_primary<F, Fut>( &self, cx: &Cx, factory: F, ) -> Outcome<PooledConnection<C>, Error>
where F: Fn() -> Fut, Fut: Future<Output = Outcome<C, Error>>,

Acquire a connection from the primary (for read-after-write consistency).

Source

pub fn primary(&self) -> &Pool<C>

Get a reference to the primary pool.

Source

pub fn replicas(&self) -> &[Pool<C>]

Get the replica pools.

Source

pub fn replica_count(&self) -> usize

Get the number of replicas.

Source

pub fn strategy(&self) -> ReplicaStrategy

Get the current strategy.

Trait Implementations§

Source§

impl<C: Connection> Debug for ReplicaPool<C>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<C> !Freeze for ReplicaPool<C>

§

impl<C> RefUnwindSafe for ReplicaPool<C>

§

impl<C> Send for ReplicaPool<C>

§

impl<C> Sync for ReplicaPool<C>

§

impl<C> Unpin for ReplicaPool<C>

§

impl<C> UnwindSafe for ReplicaPool<C>

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, _span: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
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, 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<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