1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
use std::{
num::NonZeroUsize,
path::{Path, PathBuf},
sync::{
atomic::{AtomicU64, Ordering::Relaxed},
Arc,
},
thread::available_parallelism,
};
use crate::{Client, ClientBuilder, Error, JournalMode};
use futures_util::future::join_all;
use rusqlite::{Connection, OpenFlags};
/// A `PoolBuilder` can be used to create a [`Pool`] with custom
/// configuration.
///
/// See [`Client`] for more information.
///
/// # Examples
///
/// ```rust
/// # use async_sqlite::PoolBuilder;
/// # async fn run() -> Result<(), async_sqlite::Error> {
/// let pool = PoolBuilder::new().path("path/to/db.sqlite3").open().await?;
///
/// // ...
///
/// pool.close().await?;
/// # Ok(())
/// # }
/// ```
#[derive(Clone, Debug, Default)]
pub struct PoolBuilder {
path: Option<PathBuf>,
flags: OpenFlags,
journal_mode: Option<JournalMode>,
vfs: Option<String>,
num_conns: Option<usize>,
}
impl PoolBuilder {
/// Returns a new [`PoolBuilder`] with the default settings.
pub fn new() -> Self {
Self::default()
}
/// Specify the path of the sqlite3 database to open.
///
/// By default, an in-memory database is used.
pub fn path<P: AsRef<Path>>(mut self, path: P) -> Self {
self.path = Some(path.as_ref().into());
self
}
/// Specify the [`OpenFlags`] to use when opening a new connection.
///
/// By default, [`OpenFlags::default()`] is used.
pub fn flags(mut self, flags: OpenFlags) -> Self {
self.flags = flags;
self
}
/// Specify the [`JournalMode`] to set when opening a new connection.
///
/// By default, no `journal_mode` is explicity set.
pub fn journal_mode(mut self, journal_mode: JournalMode) -> Self {
self.journal_mode = Some(journal_mode);
self
}
/// Specify the name of the [vfs](https://www.sqlite.org/vfs.html) to use.
pub fn vfs(mut self, vfs: &str) -> Self {
self.vfs = Some(vfs.to_owned());
self
}
/// Specify the number of sqlite connections to open as part of the pool.
///
/// Defaults to the number of logical CPUs of the current system.
pub fn num_conns(mut self, num_conns: usize) -> Self {
self.num_conns = Some(num_conns);
self
}
/// Returns a new [`Pool`] that uses the `PoolBuilder` configuration.
///
/// # Examples
///
/// ```rust
/// # use async_sqlite::PoolBuilder;
/// # async fn run() -> Result<(), async_sqlite::Error> {
/// let pool = PoolBuilder::new().open().await?;
/// # Ok(())
/// # }
/// ```
pub async fn open(self) -> Result<Pool, Error> {
let num_conns = self.get_num_conns();
let opens = (0..num_conns).map(|_| {
ClientBuilder {
path: self.path.clone(),
flags: self.flags,
journal_mode: self.journal_mode,
vfs: self.vfs.clone(),
}
.open()
});
let clients = join_all(opens)
.await
.into_iter()
.collect::<Result<Vec<Client>, Error>>()?;
Ok(Pool {
state: Arc::new(State {
clients,
counter: AtomicU64::new(0),
}),
})
}
/// Returns a new [`Pool`] that uses the `PoolBuilder` configuration,
/// blocking the current thread.
///
/// # Examples
///
/// ```rust
/// # use async_sqlite::PoolBuilder;
/// # fn run() -> Result<(), async_sqlite::Error> {
/// let pool = PoolBuilder::new().open_blocking()?;
/// # Ok(())
/// # }
/// ```
pub fn open_blocking(self) -> Result<Pool, Error> {
let num_conns = self.get_num_conns();
let clients = (0..num_conns)
.map(|_| {
ClientBuilder {
path: self.path.clone(),
flags: self.flags,
journal_mode: self.journal_mode,
vfs: self.vfs.clone(),
}
.open_blocking()
})
.collect::<Result<Vec<Client>, Error>>()?;
Ok(Pool {
state: Arc::new(State {
clients,
counter: AtomicU64::new(0),
}),
})
}
fn get_num_conns(&self) -> usize {
self.num_conns.unwrap_or_else(|| {
available_parallelism()
.unwrap_or_else(|_| NonZeroUsize::new(1).unwrap())
.into()
})
}
}
/// A simple Pool of sqlite connections.
///
/// A Pool has the same API as an individual [`Client`].
#[derive(Clone)]
pub struct Pool {
state: Arc<State>,
}
struct State {
clients: Vec<Client>,
counter: AtomicU64,
}
impl Pool {
/// Invokes the provided function with a [`rusqlite::Connection`].
pub async fn conn<F, T>(&self, func: F) -> Result<T, Error>
where
F: FnOnce(&Connection) -> Result<T, rusqlite::Error> + Send + 'static,
T: Send + 'static,
{
self.get().conn(func).await
}
/// Invokes the provided function with a mutable [`rusqlite::Connection`].
pub async fn conn_mut<F, T>(&self, func: F) -> Result<T, Error>
where
F: FnOnce(&mut Connection) -> Result<T, rusqlite::Error> + Send + 'static,
T: Send + 'static,
{
self.get().conn_mut(func).await
}
/// Closes the underlying sqlite connections.
///
/// After this method returns, all calls to `self::conn()` or
/// `self::conn_mut()` will return an [`Error::Closed`] error.
pub async fn close(&self) -> Result<(), Error> {
for client in self.state.clients.iter() {
client.close().await?;
}
Ok(())
}
/// Invokes the provided function with a [`rusqlite::Connection`], blocking
/// the current thread.
pub fn conn_blocking<F, T>(&self, func: F) -> Result<T, Error>
where
F: FnOnce(&Connection) -> Result<T, rusqlite::Error> + Send + 'static,
T: Send + 'static,
{
self.get().conn_blocking(func)
}
/// Invokes the provided function with a mutable [`rusqlite::Connection`],
/// blocking the current thread.
pub fn conn_mut_blocking<F, T>(&self, func: F) -> Result<T, Error>
where
F: FnOnce(&mut Connection) -> Result<T, rusqlite::Error> + Send + 'static,
T: Send + 'static,
{
self.get().conn_mut_blocking(func)
}
/// Closes the underlying sqlite connections, blocking the current thread.
///
/// After this method returns, all calls to `self::conn_blocking()` or
/// `self::conn_mut_blocking()` will return an [`Error::Closed`] error.
pub fn close_blocking(&self) -> Result<(), Error> {
self.state
.clients
.iter()
.try_for_each(|client| client.close_blocking())
}
fn get(&self) -> &Client {
let n = self.state.counter.fetch_add(1, Relaxed);
&self.state.clients[n as usize % self.state.clients.len()]
}
}