~cjoly/rusqlite_migration

↕️ Simple database schema migration library for rusqlite, written with performance in mind.

a647864 doc: remove a badge from README

1 year, 25 days ago

7cc8b45 doc: make sure the README is displayed on sr.ht

1 year, 25 days ago

#Rusqlite Migration

docs.rs Crates.io unsafe forbidden dependency status Coveralls

Rusqlite Migration is a simple and performant schema migration library for rusqlite.

  • Performance:
    • Fast database opening: to keep track of the current migration state, most tools create one or more tables in the database. These tables require parsing by SQLite and are queried with SQL statements. This library uses the user_version value instead. It’s much lighter as it is just an integer at a fixed offset in the SQLite file.
    • Fast compilation: this crate is very small and does not use macros to define the migrations.
  • Simplicity: this crate strives for simplicity. Just define a set of SQL statements as strings in your Rust code. Add more SQL statements over time as needed. No external CLI required. Additionally, rusqlite_migration works especially well with other small libraries complementing rusqlite, like serde_rusqlite.

#Example

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 file
  • migrations with multiple SQL statements (using for instance r#"…" or include_str!(…))
  • use of lazy_static
  • migrations to previous versions (downward migrations)

I’ve also made a cheatsheet of SQLite pragma for improved performance and consistency.

#Built-in tests

To test that the migrations are working, you can add this in your test module:

#[test]
fn migrations_test() {
    assert!(MIGRATIONS.validate().is_ok());
}

#Contributing

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.

#Acknowledgments

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.