Struct tower_sessions::PostgresStore

pub struct PostgresStore { /* private fields */ }

Available on crate feature postgres-store only.

A PostgreSQL session store.

Implementations

impl PostgresStore

pub fn new(pool: Pool<Postgres>) -> PostgresStore

Create a new PostgreSQL store with the provided connection pool.

Examples

use tower_sessions::{sqlx::PgPool, PostgresStore};

let database_url = std::option_env!("DATABASE_URL").unwrap();
let pool = PgPool::connect(database_url).await.unwrap();
let session_store = PostgresStore::new(pool);

pub fn with_schema_name( self, schema_name: impl AsRef<str> ) -> Result<PostgresStore, String>

Set the session table schema name with the provided name.

pub fn with_table_name( self, table_name: impl AsRef<str> ) -> Result<PostgresStore, String>

Set the session table name with the provided name.

pub async fn migrate(&self) -> Result<(), Error>

Migrate the session schema.

Examples

use tower_sessions::{sqlx::PgPool, PostgresStore};

let database_url = std::option_env!("DATABASE_URL").unwrap();
let pool = PgPool::connect(database_url).await.unwrap();
let session_store = PostgresStore::new(pool);
session_store.migrate().await.unwrap();

Trait Implementations

impl Clone for PostgresStore

fn clone(&self) -> PostgresStore

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PostgresStore

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

Formats the value using the given formatter.

impl ExpiredDeletion for PostgresStore

fn delete_expired<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, PostgresStore: 'async_trait,

A method for deleting expired sessions from the store.

fn continuously_delete_expired<'async_trait>( self, period: Duration ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: Send + 'async_trait,

This function will keep running indefinitely, deleting expired rows and then waiting for the specified period before deleting again.

impl SessionStore for PostgresStore

fn save<'life0, 'life1, 'async_trait>( &'life0 self, record: &'life1 Record ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, PostgresStore: 'async_trait,

A method for saving a session in a store.

fn load<'life0, 'life1, 'async_trait>( &'life0 self, session_id: &'life1 Id ) -> Pin<Box<dyn Future<Output = Result<Option<Record>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, PostgresStore: 'async_trait,

A method for loading a session from a store.

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

where 'life0: 'async_trait, 'life1: 'async_trait, PostgresStore: 'async_trait,

A method for deleting a session from a store.