Struct rusqlite_migration::Migrations [−][src]
pub struct Migrations<'m> { /* fields omitted */ }
Set of migrations
Implementations
impl<'m> Migrations<'m>
[src]
pub fn new(ms: Vec<M<'m>>) -> Self
[src]
Create a set of migrations.
Example
use rusqlite_migration::{Migrations, M}; let migrations = Migrations::new(vec![ M::up("CREATE TABLE animals (name TEXT);"), M::up("CREATE TABLE food (name TEXT);"), ]);
pub fn new_iter<I: IntoIterator<Item = M<'m>>>(ms: I) -> Self
[src]
Performs allocations transparently.
pub fn current_version(&self, conn: &Connection) -> Result<SchemaVersion>
[src]
Get the current schema version
Example
use rusqlite_migration::{Migrations, M, SchemaVersion}; use std::num::NonZeroUsize; let mut conn = rusqlite::Connection::open_in_memory().unwrap(); let migrations = Migrations::new(vec![ M::up("CREATE TABLE animals (name TEXT);"), M::up("CREATE TABLE food (name TEXT);"), ]); assert_eq!(SchemaVersion::NoneSet, migrations.current_version(&conn).unwrap()); // Go to the latest version migrations.to_latest(&mut conn).unwrap(); assert_eq!(SchemaVersion::Inside(NonZeroUsize::new(2).unwrap()), migrations.current_version(&conn).unwrap());
pub fn latest(&self, conn: &mut Connection) -> Result<()>
[src]
Renammed to “to_latest”
Migrate the database to latest schema version. The migrations are applied atomically.
pub fn to_latest(&self, conn: &mut Connection) -> Result<()>
[src]
Migrate the database to latest schema version. The migrations are applied atomically.
Example
use rusqlite_migration::{Migrations, M}; let mut conn = rusqlite::Connection::open_in_memory().unwrap(); let migrations = Migrations::new(vec![ M::up("CREATE TABLE animals (name TEXT);"), M::up("CREATE TABLE food (name TEXT);"), ]); // Go to the latest version migrations.to_latest(&mut conn).unwrap(); // You can then insert values in the database conn.execute("INSERT INTO animals (name) VALUES ('dog')", []).unwrap(); conn.execute("INSERT INTO food (name) VALUES ('carrot')", []).unwrap();
pub fn to_version(&self, conn: &mut Connection, version: usize) -> Result<()>
[src]
Migrate the database to a given schema version. The migrations are applied atomically.
Specifying versions
- Empty database (no migrations run yet) has version
0
. - The version increases after each migration, so after the first migration has run, the schema version is
1
. For instance, if there are 3 migrations, version3
is after all migrations have run.
Note: As a result, the version is the index in the migrations vector starting from 1.
Example
use rusqlite_migration::{Migrations, M}; let mut conn = rusqlite::Connection::open_in_memory().unwrap(); let migrations = Migrations::new(vec![ // 0: version 0, before having run any migration M::up("CREATE TABLE animals (name TEXT);").down("DROP TABLE animals;"), // 1: version 1, after having created the “animals” table M::up("CREATE TABLE food (name TEXT);").down("DROP TABLE food;"), // 2: version 2, after having created the food table ]); migrations.to_latest(&mut conn).unwrap(); // Create all tables // Go back to version 1, i.e. after running the first migration migrations.to_version(&mut conn, 1); conn.execute("INSERT INTO animals (name) VALUES ('dog')", []).unwrap(); conn.execute("INSERT INTO food (name) VALUES ('carrot')", []).unwrap_err(); // Go back to an empty database migrations.to_version(&mut conn, 0); conn.execute("INSERT INTO animals (name) VALUES ('cat')", []).unwrap_err(); conn.execute("INSERT INTO food (name) VALUES ('milk')", []).unwrap_err();
Errors
Attempts to migrate to a higher version than is supported will result in an error.
When migrating downwards, all the reversed migrations must have a .down()
variant,
otherwise no migrations are run and the function returns an error.
pub fn validate(&self) -> Result<()>
[src]
Run migrations on a temporary in-memory database from first to last, one by one. Convenience method for testing.
Example
#[cfg(test)] mod tests { // … Other tests … #[test] fn migrations_test() { assert!(migrations.validate().is_ok()); } }
Trait Implementations
impl<'m> Clone for Migrations<'m>
[src]
fn clone(&self) -> Migrations<'m>
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<'m> Debug for Migrations<'m>
[src]
impl<'m> PartialEq<Migrations<'m>> for Migrations<'m>
[src]
fn eq(&self, other: &Migrations<'m>) -> bool
[src]
fn ne(&self, other: &Migrations<'m>) -> bool
[src]
impl<'m> StructuralPartialEq for Migrations<'m>
[src]
Auto Trait Implementations
impl<'m> RefUnwindSafe for Migrations<'m>
impl<'m> Send for Migrations<'m>
impl<'m> Sync for Migrations<'m>
impl<'m> Unpin for Migrations<'m>
impl<'m> UnwindSafe for Migrations<'m>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,