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 242 243 244 245 246 247 248 249 250 251 252
use std::marker::PhantomData;
use std::path::Path;
use crate::wal::{ffi::make_wal_manager, Wal, WalManager};
#[cfg(not(feature = "rusqlite"))]
type RawConnection = *mut crate::ffi::sqlite3;
#[cfg(feature = "rusqlite")]
type RawConnection = rusqlite::Connection;
#[cfg(not(feature = "rusqlite"))]
type OpenFlags = std::ffi::c_int;
#[cfg(feature = "rusqlite")]
type OpenFlags = rusqlite::OpenFlags;
#[cfg(feature = "rusqlite")]
type Error = rusqlite::Error;
#[cfg(not(feature = "rusqlite"))]
type Error = crate::Error;
#[derive(Debug)]
pub struct Connection<W> {
conn: RawConnection,
_pth: PhantomData<W>,
}
#[cfg(feature = "rusqlite")]
impl<W> std::ops::Deref for Connection<W> {
type Target = rusqlite::Connection;
fn deref(&self) -> &Self::Target {
&self.conn
}
}
#[cfg(feature = "rusqlite")]
impl<W> std::ops::DerefMut for Connection<W> {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.conn
}
}
#[cfg(feature = "rusqlite")]
impl Connection<crate::wal::Sqlite3Wal> {
/// returns a dummy, in-memory connection. For testing purposes only
pub fn test() -> Self {
let conn = rusqlite::Connection::open_in_memory().unwrap();
Self {
conn,
_pth: PhantomData,
}
}
}
impl<W: Wal> Connection<W> {
/// Opens a database with the regular wal methods in the directory pointed to by path
pub fn open<T>(
path: impl AsRef<Path>,
flags: OpenFlags,
wal_manager: T,
auto_checkpoint: u32,
) -> Result<Self, Error>
where
T: WalManager<Wal = W>,
{
tracing::trace!(
"Opening a connection with regular WAL at {}",
path.as_ref().display()
);
#[cfg(feature = "rusqlite")]
let conn = {
let conn = if cfg!(feature = "unix-excl-vfs") {
rusqlite::Connection::open_with_flags_vfs_and_wal(
path,
flags,
"unix-excl",
make_wal_manager(wal_manager),
)
} else {
rusqlite::Connection::open_with_flags_and_wal(
path,
flags,
make_wal_manager(wal_manager),
)
}?;
conn.pragma_update(None, "journal_mode", "WAL")?;
unsafe {
let rc =
rusqlite::ffi::sqlite3_wal_autocheckpoint(conn.handle(), auto_checkpoint as _);
if rc != 0 {
return Err(rusqlite::Error::SqliteFailure(
rusqlite::ffi::Error::new(rc),
Some("failed to set auto_checkpoint".into()),
));
}
}
conn.busy_timeout(std::time::Duration::from_secs(5000))?;
conn
};
#[cfg(not(feature = "rusqlite"))]
let conn = unsafe {
use std::os::unix::ffi::OsStrExt;
let path = std::ffi::CString::new(path.as_ref().as_os_str().as_bytes())
.map_err(|_| crate::error::Error::Bug("invalid database path"))?;
let mut conn: *mut crate::ffi::sqlite3 = std::ptr::null_mut();
// We pass a pointer to the WAL methods data to the database connection. This means
// that the reference must outlive the connection. This is guaranteed by the marker in
// the returned connection.
let vfs = if cfg!(feature = "unix-excl-vfs") {
"unix-excl\0".as_ptr() as *const _
} else {
std::ptr::null_mut()
};
let mut rc = libsql_ffi::libsql_open_v3(
path.as_ptr(),
&mut conn as *mut _,
flags,
vfs,
make_wal_manager(wal_manager),
);
if rc == 0 {
rc = libsql_ffi::sqlite3_wal_autocheckpoint(conn, auto_checkpoint as _);
}
if rc != 0 {
libsql_ffi::sqlite3_close(conn);
return Err(crate::Error::from(rc));
}
assert!(!conn.is_null());
crate::ffi::sqlite3_busy_timeout(conn, 5000);
conn
};
Ok(Connection {
conn,
_pth: PhantomData,
})
}
/// Returns the raw sqlite handle
///
/// # Safety
/// The caller is responsible for the returned pointer.
pub unsafe fn handle(&self) -> *mut libsql_ffi::sqlite3 {
#[cfg(feature = "rusqlite")]
{
self.conn.handle()
}
#[cfg(not(feature = "rusqlite"))]
{
self.conn
}
}
}
// pub struct Connection<'a> {
// pub conn: *mut crate::ffi::sqlite3,
// _pth: PhantomData<&'a mut ()>,
// }
//
// /// The `Connection` struct is `Send` because `sqlite3` is thread-safe.
// unsafe impl<'a> Send for Connection<'a> {}
// unsafe impl<'a> Sync for Connection<'a> {}
//
// impl<'a> Connection<'a> {
// /// returns a dummy, in-memory connection. For testing purposes only
// pub fn test(_: &mut ()) -> Self {
// let mut conn: *mut crate::ffi::sqlite3 = std::ptr::null_mut();
// let rc = unsafe {
// crate::ffi::sqlite3_open(":memory:\0".as_ptr() as *const _, &mut conn as *mut _)
// };
// assert_eq!(rc, 0);
// assert!(!conn.is_null());
// Self {
// conn,
// _pth: PhantomData,
// }
// }
//
// /// Opens a database with the regular wal methods, given a path to the database file.
// pub fn open<W: Wal>(
// path: impl AsRef<std::path::Path>,
// flags: c_int,
// // we technically _only_ need to know about W, but requiring a static ref to the wal_hook ensures that
// // it has been instantiated and lives for long enough
// _wal_hook: &'static WalMethodsHook<W>,
// hook_ctx: &'a mut W::Context,
// ) -> Result<Self, crate::Error> {
// let path = path.as_ref();
// tracing::trace!(
// "Opening a connection with regular WAL at {}",
// path.display()
// );
//
// let conn_str = format!("file:{}?_journal_mode=WAL", path.display());
// let filename = CString::new(conn_str).unwrap();
// let mut conn: *mut crate::ffi::sqlite3 = std::ptr::null_mut();
//
// unsafe {
// // We pass a pointer to the WAL methods data to the database connection. This means
// // that the reference must outlive the connection. This is guaranteed by the marker in
// // the returned connection.
// let rc = crate::ffi::libsql_open_v2(
// filename.as_ptr(),
// &mut conn as *mut _,
// flags,
// std::ptr::null_mut(),
// W::name().as_ptr(),
// hook_ctx as *mut _ as *mut _,
// );
//
// if rc != 0 {
// crate::ffi::sqlite3_close(conn);
// return Err(crate::Error::LibError(rc));
// }
//
// assert!(!conn.is_null());
// };
//
// unsafe {
// crate::ffi::sqlite3_busy_timeout(conn, 5000);
// }
//
// Ok(Connection {
// conn,
// _pth: PhantomData,
// })
// }
//
// pub fn is_autocommit(&self) -> bool {
// unsafe { crate::ffi::sqlite3_get_autocommit(self.conn) != 0 }
// }
// }
//
// impl Drop for Connection<'_> {
// fn drop(&mut self) {
// if self.conn.is_null() {
// tracing::debug!("Trying to close a null connection");
// return;
// }
// unsafe {
// crate::ffi::sqlite3_close(self.conn as *mut _);
// }
// }
// }