Struct PostgresStateStore 

pub struct PostgresStateStore { /* private fields */ }

Available on crate feature state-postgres only.

A StateStore that persists each entry as a row in a single Postgres table.

The table layout is:

CREATE TABLE faucet_state (
    key        TEXT        PRIMARY KEY,
    value      JSONB       NOT NULL,
    updated_at TIMESTAMPTZ NOT NULL DEFAULT NOW()
);

Calling PostgresStateStore::ensure_table creates the table if it does not exist; integrators that manage schema separately can skip this call.

Implementations

impl PostgresStateStore

pub async fn connect( connection_url: &str, ) -> Result<PostgresStateStore, FaucetError>

Connect to a PostgreSQL server with the default faucet_state table.

pub async fn connect_with( connection_url: &str, max_connections: u32, table: &str, ) -> Result<PostgresStateStore, FaucetError>

Connect with explicit pool size and table name.

pub fn from_pool( pool: Pool<Postgres>, table: impl Into<String>, ) -> Result<PostgresStateStore, FaucetError>

Construct from an existing pool. Useful when integrators already manage a shared PgPool.

pub fn table(&self) -> &str

Returns the table name in use.

pub async fn ensure_table(&self) -> Result<(), FaucetError>

Create the state-store table if it does not already exist.

Trait Implementations

impl StateStore for PostgresStateStore

fn get<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<Value>, FaucetError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, PostgresStateStore: 'async_trait,

Return the value stored under key, or None if no entry exists.

fn put<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, key: &'life1 str, value: &'life2 Value, ) -> Pin<Box<dyn Future<Output = Result<(), FaucetError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, PostgresStateStore: 'async_trait,

Store value under key, replacing any previous entry.

fn delete<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), FaucetError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, PostgresStateStore: 'async_trait,

Remove the entry for key. A missing key is not an error.

fn check<'life0, 'life1, 'async_trait>( &'life0 self, ctx: &'life1 CheckContext, ) -> Pin<Box<dyn Future<Output = Result<CheckReport, FaucetError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, PostgresStateStore: 'async_trait,

Run a fast, non-mutating preflight probe (used by faucet doctor).