1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
/*! 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`](https://crates.io/crates/postgres), [`Rusqlite`](https://crates.io/crates/rusqlite) and [`Mysql`](https://crates.io/crates/mysql) are supported.\ `refinery` works best with [`Barrel`](https://crates.io/crates/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 a [`String`](https://doc.rust-lang.org/std/string/struct.String.html) - 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`](../refinery_macros/macro.embed_migrations.html) and [`include_migration_mods`](../refinery_macros/macro.include_migration_mods.html) macros, or via `refinery_cli`. ### Example ```rust,no_run use ttrusqlite::Connection; mod embedded { use refinery::embed_migrations; embed_migrations!("refinery/tests/sql_migrations"); } let mut conn = Connection::open_in_memory().unwrap(); embedded::migrations::runner().run(&mut conn).unwrap(); ``` for more examples refer to the [`examples`](https://github.com/rust-db/refinery/tree/master/examples) */ pub use refinery_macros::{embed_migrations, include_migration_mods}; #[doc(hidden)] pub use refinery_migrations::Error; pub use refinery_migrations::{Migration, Runner}; pub use refinery_migrations::{Config, ConfigDbType}; #[cfg(any(feature = "mysql_async", feature = "tokio-postgres"))] pub use refinery_migrations::{migrate_from_config_async, AsyncMigrate}; #[cfg(any( feature = "mysql", feature = "postgres", feature = "postgres-previous", feature = "rusqlite" ))] pub use refinery_migrations::{migrate_from_config, Migrate};