Struct SqliteStoreBuilder 

pub struct SqliteStoreBuilder { /* private fields */ }

Available on crate feature sqlite only.

Builder for SqliteStore.

To create the database call SqliteStoreBuilder::build().

By default, the builder configures an in-memory database with a maximum number of 16 connections. The database is created if it doesn’t already exist and migrations are automatically run on start-up.

Implementations

impl SqliteStoreBuilder

pub fn new() -> Self

Creates a new SqliteStoreBuilder using default configuration values.

pub fn memory() -> Self

Creates a new in-memory SqliteStoreBuilder using recommended configuration values.

The configuration values have been chosen to prevent the in-memory database being dropped when there are no active connections and the idle timeout or max lifetime limit is reached.

pub fn database_url(self, url: &str) -> Self

Sets the database URL.

If left unset, the database will use an ephemeral in-memory URL.

pub fn min_connections(self, min_connections: u32) -> Self

Sets the minimum number of connections to be maintained by the database pool.

If left unset, a minimum of 3 connections will be maintained.

pub fn max_connections(self, max_connections: u32) -> Self

Sets the maximum number of connections to be maintained by the database pool.

If left unset, a maximum of 16 connections will be maintained.

pub fn idle_timeout(self, timeout: impl Into<Option<Duration>>) -> Self

Set a maximum idle duration for individual connections.

Any connection that remains in the idle queue longer than this will be closed.

pub fn max_lifetime(self, lifetime: impl Into<Option<Duration>>) -> Self

Set the maximum lifetime of individual connections.

Any connection with a lifetime greater than this will be closed.

When set to None, all connections live until either reaped by [idle_timeout] or explicitly disconnected.

Infinite connections are not recommended due to the unfortunate reality of memory/resource leaks on the database-side. It is better to retire connections periodically (even if only once daily) to allow the database the opportunity to clean up data structures (parse trees, query metadata caches, thread-local storage, etc.) that are associated with a session.

pub fn create_database(self, create_database: bool) -> Self

Creates the database if it doesn’t already exist.

If left unset, the database will be created by default.

pub fn run_default_migrations(self, run_migrations: bool) -> Self

Sets whether pending migrations should be applied when the database is built.

If left unset, the database will apply any pending migrations.

pub async fn build(self) -> Result<SqliteStore, SqliteError>

Builds the SqliteStore.

Trait Implementations

impl Default for SqliteStoreBuilder

fn default() -> Self

Returns the “default value” for a type.