Struct rusqlite_migration::Migrations
source · [−]pub struct Migrations<'m> { /* private fields */ }
Expand description
Set of migrations
Implementations
sourceimpl<'m> Migrations<'m>
impl<'m> Migrations<'m>
sourcepub fn new(ms: Vec<M<'m>>) -> Self
pub fn new(ms: Vec<M<'m>>) -> Self
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);"),
]);
sourcepub fn new_iter<I: IntoIterator<Item = M<'m>>>(ms: I) -> Self
pub fn new_iter<I: IntoIterator<Item = M<'m>>>(ms: I) -> Self
Performs allocations transparently.
sourcepub fn current_version(&self, conn: &Connection) -> Result<SchemaVersion>
pub fn current_version(&self, conn: &Connection) -> Result<SchemaVersion>
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());
sourcepub fn to_latest(&self, conn: &mut Connection) -> Result<()>
pub fn to_latest(&self, conn: &mut Connection) -> Result<()>
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();
sourcepub fn to_version(&self, conn: &mut Connection, version: usize) -> Result<()>
pub fn to_version(&self, conn: &mut Connection, version: usize) -> Result<()>
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.
Trait Implementations
sourceimpl<'m> Clone for Migrations<'m>
impl<'m> Clone for Migrations<'m>
sourcefn clone(&self) -> Migrations<'m>
fn clone(&self) -> Migrations<'m>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<'m> Debug for Migrations<'m>
impl<'m> Debug for Migrations<'m>
sourceimpl<'m> PartialEq<Migrations<'m>> for Migrations<'m>
impl<'m> PartialEq<Migrations<'m>> for Migrations<'m>
sourcefn eq(&self, other: &Migrations<'m>) -> bool
fn eq(&self, other: &Migrations<'m>) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &Migrations<'m>) -> bool
fn ne(&self, other: &Migrations<'m>) -> bool
This method tests for !=
.
impl<'m> StructuralPartialEq for Migrations<'m>
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more