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 random_memory_url(self) -> Self

Available on crate features test_utils only.

Assigns a randomly-generated in-memory database URL with private cache.

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