Skip to main content

PgStore

Struct PgStore 

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

PostgreSQL-backed implementation of the Store trait.

Uses a single table with (namespace, key) as the composite primary key and stores values as JSONB. Full-text search is supported through a tsvector generated column indexed with GIN, with a LIKE fallback.

§Example

use sqlx::postgres::PgPoolOptions;
use synaptic_postgres::{PgStore, PgStoreConfig};

let pool = PgPoolOptions::new()
    .max_connections(5)
    .connect("postgres://user:pass@localhost/mydb")
    .await?;

let config = PgStoreConfig::new("synaptic_store");
let store = PgStore::new(pool, config);
store.initialize().await?;

Implementations§

Source§

impl PgStore

Source

pub fn new(pool: PgPool, config: PgStoreConfig) -> Self

Create a new PgStore from an existing connection pool and config.

Source

pub async fn initialize(&self) -> Result<(), SynapticError>

Ensure the backing table and indexes exist.

Creates the key-value table, a namespace index, and a tsvector generated column with a GIN index for full-text search. This is idempotent and safe to call on every application startup.

Source

pub fn pool(&self) -> &PgPool

Return a reference to the underlying connection pool.

Source

pub fn config(&self) -> &PgStoreConfig

Return a reference to the configuration.

Trait Implementations§

Source§

impl Store for PgStore

Source§

fn get<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, namespace: &'life1 [&'life2 str], key: &'life3 str, ) -> Pin<Box<dyn Future<Output = Result<Option<Item>, SynapticError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Get an item by namespace and key.
Source§

fn search<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, namespace: &'life1 [&'life2 str], query: Option<&'life3 str>, limit: usize, ) -> Pin<Box<dyn Future<Output = Result<Vec<Item>, SynapticError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Search items within a namespace.
Source§

fn put<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, namespace: &'life1 [&'life2 str], key: &'life3 str, value: Value, ) -> Pin<Box<dyn Future<Output = Result<(), SynapticError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Put (upsert) an item.
Source§

fn delete<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, namespace: &'life1 [&'life2 str], key: &'life3 str, ) -> Pin<Box<dyn Future<Output = Result<(), SynapticError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Delete an item.
Source§

fn list_namespaces<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, prefix: &'life1 [&'life2 str], ) -> Pin<Box<dyn Future<Output = Result<Vec<Vec<String>>, SynapticError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

List all namespaces, optionally filtered by prefix.

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> 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, 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