Skip to content

Commit

Permalink
Support the immutable option on SQLite connections
Browse files Browse the repository at this point in the history
  • Loading branch information
djmarcin committed Aug 31, 2021
1 parent 135d16a commit 74dfaef
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 2 deletions.
9 changes: 7 additions & 2 deletions sqlx-core/src/sqlite/connection/establish.rs
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,6 @@ pub(crate) async fn establish(options: &SqliteConnectOptions) -> Result<SqliteCo
})?
.to_owned();

filename.push('\0');

// By default, we connect to an in-memory database.
// [SQLITE_OPEN_NOMUTEX] will instruct [sqlite3_open_v2] to return an error if it
// cannot satisfy our wish for a thread-safe, lock-free connection object
Expand All @@ -55,6 +53,13 @@ pub(crate) async fn establish(options: &SqliteConnectOptions) -> Result<SqliteCo
SQLITE_OPEN_PRIVATECACHE
};

if options.immutable {
filename = format!("file:{}?immutable=true", filename);
flags |= libsqlite3_sys::SQLITE_OPEN_URI;
}

filename.push('\0');

let busy_timeout = options.busy_timeout;

let handle = blocking!({
Expand Down
7 changes: 7 additions & 0 deletions sqlx-core/src/sqlite/options/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ pub struct SqliteConnectOptions {
pub(crate) synchronous: SqliteSynchronous,
pub(crate) auto_vacuum: SqliteAutoVacuum,
pub(crate) page_size: u32,
pub(crate) immutable: bool,
}

impl Default for SqliteConnectOptions {
Expand All @@ -88,6 +89,7 @@ impl SqliteConnectOptions {
synchronous: SqliteSynchronous::Full,
auto_vacuum: Default::default(),
page_size: 4096,
immutable: false,
}
}

Expand Down Expand Up @@ -190,4 +192,9 @@ impl SqliteConnectOptions {
self.page_size = page_size;
self
}

pub fn immutable(mut self, immutable: bool) -> Self {
self.immutable = immutable;
self
}
}
14 changes: 14 additions & 0 deletions sqlx-core/src/sqlite/options/parse.rs
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,20 @@ impl FromStr for SqliteConnectOptions {
}
},

"immutable" => match &*value {
"true" | "1" => {
options.immutable = true;
}
"false" | "0" => {
options.immutable = false;
}
_ => {
return Err(Error::Configuration(
format!("unknown value {:?} for `immutable`", value).into(),
));
}
},

_ => {
return Err(Error::Configuration(
format!(
Expand Down

0 comments on commit 74dfaef

Please sign in to comment.