Skip to main content

PostgresConfig

Struct PostgresConfig 

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

Runtime bounds for PostgreSQL admission work.

With the serde feature, this is an object containing maximum_rows_per_shard, max_batch_size, pool_acquire_timeout, and operation_timeout. Durations use Serde’s exact { "secs": ..., "nanos": ... } representation. Every field may be omitted when deserializing to use the constructor defaults.

Implementations§

Source§

impl PostgresConfig

Source

pub const DEFAULT_MAXIMUM_ROWS_PER_SHARD: u32 = 4_096

Default configured row limit for each of the 256 capacity shards.

Source

pub const DEFAULT_MAX_BATCH_SIZE: usize = 32

Default maximum number of checks in one atomic batch.

Source

pub const DEFAULT_POOL_ACQUIRE_TIMEOUT: Duration

Default budget for acquiring a connection from the pool.

Source

pub const DEFAULT_OPERATION_TIMEOUT: Duration

Default deadline for database work after acquiring a connection.

Source

pub const MAXIMUM_POOL_ACQUIRE_TIMEOUT: Duration

Largest accepted pool-acquisition budget.

Source

pub const MAXIMUM_OPERATION_TIMEOUT: Duration

Largest accepted database-operation deadline.

Source

pub const fn new() -> Self

Returns the conservative defaults suitable for an online admission path.

Source

pub fn with_maximum_rows_per_shard( self, maximum: u32, ) -> Result<Self, PostgresConfigError>

Sets the configured admission limit for one capacity shard.

The database migration independently enforces HARD_MAX_ROWS_PER_SHARD for compatibility with older replicas. Configuring a lower value makes this limiter deny new keys sooner. Existing keys remain usable, including when the ledger is already above the newly configured value.

§Errors

Returns an error if maximum is zero or exceeds the database-enforced hard maximum.

Source

pub fn with_max_batch_size( self, maximum: usize, ) -> Result<Self, PostgresConfigError>

Sets the maximum number of checks that may retain locks in one batch.

§Errors

Returns an error if maximum is zero.

Source

pub fn with_pool_acquire_timeout( self, timeout: Duration, ) -> Result<Self, PostgresConfigError>

Sets the budget for acquiring a connection from the pool.

A successful acquisition receives a fresh Self::operation_timeout budget. This timeout is intentionally not applied to schema migrations.

§Errors

Returns an error if timeout is zero or exceeds 60 seconds.

Source

pub fn with_operation_timeout( self, timeout: Duration, ) -> Result<Self, PostgresConfigError>

Sets the deadline for database work after acquiring a connection.

The fresh deadline covers transaction begin, lock waits, statements, rollback, and commit. Server-side timeouts are refreshed from the remaining budget before each statement and commit, so an earlier lock wait cannot give a later statement a fresh full-length timeout. It is intentionally not applied to pool acquisition or schema migrations.

§Errors

Returns an error if timeout is zero or exceeds 60 seconds.

Source

pub const fn max_batch_size(&self) -> usize

Returns the maximum accepted batch length.

Source

pub const fn maximum_rows_per_shard(self) -> u32

Returns the configured admission limit for one capacity shard.

Source

pub const fn pool_acquire_timeout(self) -> Duration

Returns the budget for acquiring a connection from the pool.

Source

pub const fn operation_timeout(self) -> Duration

Returns the deadline applied after a connection is acquired.

Trait Implementations§

Source§

impl Clone for PostgresConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for PostgresConfig

Source§

impl Debug for PostgresConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for PostgresConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for PostgresConfig

Available on crate feature serde only.
Source§

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for PostgresConfig

Source§

impl PartialEq for PostgresConfig

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for PostgresConfig

Available on crate feature serde only.
Source§

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for PostgresConfig

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. 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: 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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