Struct PoolBuilder 

pub struct PoolBuilder { /* private fields */ }

A PoolBuilder can be used to create a Pool with custom configuration.

See Client for more information.

Examples

let pool = PoolBuilder::new().path("path/to/db.sqlite3").open().await?;

// ...

pool.close().await?;

Implementations

impl PoolBuilder

pub fn new() -> Self

Returns a new PoolBuilder with the default settings.

pub fn path<P: AsRef<Path>>(self, path: P) -> Self

Specify the path of the sqlite3 database to open.

By default, an in-memory database is used.

pub fn shared_memory<N: AsRef<str>>(self, name: N) -> Self

Use a named shared in-memory sqlite database.

This opens connections with a URI of the form file:<name>?mode=memory&cache=shared and enables OpenFlags::SQLITE_OPEN_URI and OpenFlags::SQLITE_OPEN_SHARED_CACHE.

SQLite shared-cache mode has caveats and is discouraged by SQLite for many workloads. Prefer a file-backed database when possible. The in-memory database is deleted after the last connection using this name is closed.

use async_sqlite::PoolBuilder;

let builder = PoolBuilder::new().shared_memory("my-pool").num_conns(2);

pub fn flags(self, flags: OpenFlags) -> Self

Specify the OpenFlags to use when opening a new connection.

By default, OpenFlags::default() is used.

pub fn journal_mode(self, journal_mode: JournalMode) -> Self

Specify the JournalMode to set when opening a new connection.

By default, no journal_mode is explicity set.

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

Specify the name of the vfs to use.

pub fn num_conns(self, num_conns: usize) -> Self

Specify the number of sqlite connections to open as part of the pool.

File-backed and shared-memory pools default to the number of logical CPUs of the current system. Anonymous in-memory pools, including path(":memory:"), default to 1 connection because each sqlite :memory: connection is a separate database. Values less than 1 are clamped to 1.

use async_sqlite::PoolBuilder;

let builder = PoolBuilder::new().num_conns(2);

pub fn queue_capacity(self, queue_capacity: usize) -> Self

Limit the number of commands that may wait in each connection’s worker queue.

By default, each queue is unbounded. If a capacity is configured, calls return Error::QueueFull when a selected connection already has that many commands waiting for its worker thread. A capacity of 0 allows a command to be accepted only when the worker is ready to receive it immediately.

pub async fn open(self) -> Result<Pool, Error>

Returns a new Pool that uses the PoolBuilder configuration.

Examples

let pool = PoolBuilder::new().open().await?;

pub fn open_blocking(self) -> Result<Pool, Error>

Returns a new Pool that uses the PoolBuilder configuration, blocking the current thread.

Examples

let pool = PoolBuilder::new().open_blocking()?;

Trait Implementations

impl Clone for PoolBuilder

fn clone(&self) -> PoolBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PoolBuilder

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

Formats the value using the given formatter.

impl Default for PoolBuilder

fn default() -> PoolBuilder

Returns the “default value” for a type.