Skip to main content

PostgresBackend

Struct PostgresBackend 

Source
pub struct PostgresBackend<K = String, V = String, C = StringCodec> { /* private fields */ }
Expand description

A PostgreSQL-backed cache adapter.

Implementations§

Source§

impl<K, V> PostgresBackend<K, V>

Source

pub fn new(pool: PgPool) -> Self

Creates an adapter using the application-owned kape_entries table.

Source§

impl<K, V, C> PostgresBackend<K, V, C>

Source

pub fn with_codec<D>(self, codec: D) -> PostgresBackend<K, V, D>
where D: PostgresCodec<K, V>,

Replaces the key/value codec.

Source

pub fn with_table(self, table: &str) -> KapeResult<Self>

Selects a validated table or schema.table identifier.

§Errors

Returns an error for unsafe or unsupported identifiers.

Source

pub fn namespace(self, namespace: impl Into<String>) -> Self

Sets the caller-owned namespace.

Source§

impl<K, V, C> PostgresBackend<K, V, C>
where C: PostgresCodec<K, V>,

Source

pub async fn purge_expired(&self) -> KapeResult<u64>

Deletes expired rows owned by this namespace.

The application remains responsible for scheduling this operation and for table-wide maintenance.

§Errors

Returns a backend error when PostgreSQL rejects the operation.

Trait Implementations§

Source§

impl<K, V, C> CacheBackend<K, V> for PostgresBackend<K, V, C>
where K: Send + Sync, V: Send + Sync, C: PostgresCodec<K, V>,

Source§

fn get<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 K, ) -> Pin<Box<dyn Future<Output = KapeResult<Option<CacheEntry<V>>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Queries one key.
Source§

fn set<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 K, value: Arc<V>, ttl: i64, ) -> Pin<Box<dyn Future<Output = KapeResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Stores or immediately invalidates one key using a millisecond TTL.
Source§

fn remove<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 K, ) -> Pin<Box<dyn Future<Output = KapeResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Removes one key.
Source§

fn get_many<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, keys: &'life1 [&'life2 K], ) -> Pin<Box<dyn Future<Output = KapeResult<Vec<Option<CacheEntry<V>>>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Queries multiple keys while preserving input order and duplicates.
Source§

fn set_many<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, items: &'life1 [SetItem<&'life2 K, V>], ) -> Pin<Box<dyn Future<Output = KapeResult<()>> + Send + 'async_trait>>
where K: Eq + Hash, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Writes multiple uniquely keyed items in input order.
Source§

fn remove_many<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, keys: &'life1 [&'life2 K], ) -> Pin<Box<dyn Future<Output = KapeResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Removes multiple keys in input order.
Source§

fn clear<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = KapeResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Clears entries owned by this backend instance.
Source§

impl<K, V, C> Clone for PostgresBackend<K, V, C>
where C: Clone,

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

Auto Trait Implementations§

§

impl<K = String, V = String, C = StringCodec> !RefUnwindSafe for PostgresBackend<K, V, C>

§

impl<K = String, V = String, C = StringCodec> !UnwindSafe for PostgresBackend<K, V, C>

§

impl<K, V, C> Freeze for PostgresBackend<K, V, C>
where C: Freeze, PhantomData<fn(K, V)>: Freeze,

§

impl<K, V, C> Send for PostgresBackend<K, V, C>
where C: Send, PhantomData<fn(K, V)>: Send,

§

impl<K, V, C> Sync for PostgresBackend<K, V, C>
where C: Sync, PhantomData<fn(K, V)>: Sync,

§

impl<K, V, C> Unpin for PostgresBackend<K, V, C>
where C: Unpin, PhantomData<fn(K, V)>: Unpin,

§

impl<K, V, C> UnsafeUnpin for PostgresBackend<K, V, 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> 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> 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> 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<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