1.5 KiB
Diesel setup
Disclaimer
The barrel crate is still in an early state of development and should not be considered "stable".
Old migrations might break because the API was changed. Features might be removed or replaced! Before 1.0 this crate is not stable and should not be used in production – just wanted to make that loud and clear :)
Using rust migrations (via barrel) with diesel is really simple.
First make sure that you installed the diesel_cli with the barrel-migrations feature flag:
~ cargo install diesel_cli --features="barrel-migrations"
Important: you can only select one (1) backend with diesel. Whichever you select will determine the migration files that are generated later.
[dependencies]
diesel = { version = "1.3", features = ["sqlite3"] }
# ...
From this point using diesel is very similar to how you normally use it. The only difference is that you should provide a --format flag when letting diesel generate a migration for you. Running migrations doesn't change.
~ diesel migration generate <name> --format="barrel"
~ diesel migration run
A migration file generated by diesel will look as follows
/// Handle up migrations
fn up(migr: &mut Migration) {}
/// Handle down migrations
fn down(migr: &mut Migration) {}
The object provided as a function parameter is a mutable Migration object which you can operate on.
Please refer to the docs for API specifics.