doc: remove a badge from README
doc: explain cargo sync-readme to contributors
doc: make sure the README is displayed on sr.ht
Rusqlite Migration is a simple and performant schema migration library for rusqlite.
user_version
value instead. It’s much lighter as it is just an integer at a fixed offset in the SQLite file.Here, we define SQL statements to run with Migrations::new()
and run these (if necessary) with Migrations::to_latest()
.
use rusqlite::{params, Connection};
use rusqlite_migration::{Migrations, M};
// 1️⃣ Define migrations
let migrations = Migrations::new(vec![
M::up("CREATE TABLE friend(name TEXT NOT NULL);"),
// In the future, add more migrations here:
//M::up("ALTER TABLE friend ADD COLUMN email TEXT;"),
]);
let mut conn = Connection::open_in_memory().unwrap();
// Apply some PRAGMA, often better to do it outside of migrations
conn.pragma_update(None, "journal_mode", &"WAL").unwrap();
// 2️⃣ Update the database schema, atomically
migrations.to_latest(&mut conn).unwrap();
// 3️⃣ Use the database 🥳
conn.execute("INSERT INTO friend (name) VALUES (?1)", params!["John"])
.unwrap();
Please see the examples folder for more, in particular:
async
migrations in the quick_start_async.rs
filer#"…"
or include_str!(…)
)I’ve also made a cheatsheet of SQLite pragma for improved performance and consistency.
To test that the migrations are working, you can add this in your test module:
#[test]
fn migrations_test() {
assert!(MIGRATIONS.validate().is_ok());
}
Contributions (documentation or code improvements in particular) are welcome, see contributing!
Please note that if you want to change something in the main README.md file, you likely need to
edit the top comment in rusqlite_migration/src/lib.rs
and then run cargo sync-readme
from the rusqlite_migration
subdirectory (the one that contain
src
). This command copies the content of the top comment to the README.md
file, keeping
lib.rs
and the README.md
sync. The only exception to this is when you want to edit
something outside of the <!-- cargo-sync-readme start -->
and
<!-- cargo-sync-readme end -->
markers.
I would like to thank all the contributors, as well as the authors of the dependencies this crate uses.
Thanks to Migadu for offering a discounted service to support this project. It is not an endorsement by Migadu though.