Powerful SQL migration toolkit for Rust.
refinery
makes running migrations for different databases as easy as possible.
it works by running your migrations on a provided database connection, either by embedding them on your Rust code, or via refinery_cli
.
currently Postgres
, Rusqlite
and Mysql
are supported.
refinery
works best with Barrel
but you can also have your migrations on .sql files or use any other Rust crate for schema generation.
Usage
- Migrations can be defined in .sql files or Rust modules that must have a function called
migration
that returns aString
- Migrations, both .sql files and Rust modules must be named in the format
V{1}__{2}.rs
where{1}
represents the migration version and{2}
the name. - Migrations can be run either by embedding them on your Rust code with
embedded_migrations
andinclude_migration_mods
macros, or viarefinery_cli
.
Example
use Connection;
for more examples refer to the examples
Compatibility
Refinery aims to support stable Rust, the previous Rust version, and nightly
Contributing
:balloon: Thanks for your help improving the project! No contribution is too small and all contributions are valued, feel free to open Issues and submit Pull Requests
License
This project is licensed under the MIT license.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Refinery by you, shall be licensed as MIT, without any additional terms or conditions.