Struct rqlite_client::migration::Migration

pub struct Migration<'a, T>
where
    T: RequestBuilder<NoLevelMulti>,
{ /* private fields */ }

Migration and rollback of database definition with SQL

Requires feature migration.

Feature migration_embed provides macro embed_migrations! to embed a directory structure with SQL-files from filesystem into the application binary.

Usage

Constructing Migration from code

use rqlite_client::migration::{Downgrade, Migration, Upgrade, M};
use rqlite_client::Connection;

#[cfg(feature = "ureq")]
{
    let migration = Migration::default().push(M(
        Upgrade::from("CREATE TEMP TABLE tmp"),
        Some(Downgrade::from("DROP TABLE temp.tmp")),
    ));

    let con = Connection::new("http://localhost:4001");
    #[cfg(feature = "url")]
    let con = con.unwrap();

    let version = migration.migrate(&con).expect("migration fail");
    let version = migration
        .rollback_to(&con, &(version - 1))
        .expect("rollback fail");
}

If you prefer to provide some SQL-files for upgrade and downgrade steps with your application there is Migration::from_path().

And you can also include these files in your application with the combination of embed_migrations! and Migration::from_embed().

It is allowed to put single-line comments with #, ;;, //, -- at the start of the line (after whitespaces) in your SQL data.
It is also possible to insert line-breaks in SQL statements with \ at the line end.

Implementations

impl<'a, T> Migration<'a, T>

where T: RequestBuilder<NoLevelMulti>,

pub fn max(&self) -> SchemaVersion

Maximum of available SchemaVersion

pub fn migrate( &self, connection: &Connection ) -> Result<SchemaVersion, MigrationError>

Migrate provided Migration

Return

SchemaVersion after Migration

Errors

MigrationError on failed Migration

Panics

If there is no RequestBuilder provided with Migration::set_request_builder

pub fn migrate_to( &self, connection: &Connection, to_version: Option<&SchemaVersion> ) -> Result<SchemaVersion, MigrationError>

Migrate provided Migration to provided SchemaVersion

Return

SchemaVersion after Migration

Errors

MigrationError on failed Migration

Panics

If there is no RequestBuilder provided with Migration::set_request_builder

pub fn pop(self) -> Option<M<'a>>

Removes the last migration and returns it, or None if there is no migration.

pub fn push(self, migration: M<'a>) -> Self

Add single migration M

pub fn rollback_to( &self, connection: &Connection, to_version: &SchemaVersion ) -> Result<SchemaVersion, MigrationError>

Rollback provided Migration to provided SchemaVersion

Return

SchemaVersion after Migration rollback

Errors

MigrationError on failed Migration rollback

Panics

If there is no RequestBuilder provided with Migration::set_request_builder

pub fn truncate(self, len: usize) -> Self

Shortens the migrations, keeping the first len elements and dropping the rest.

If len is greater than the vector’s current length, this has no effect.

impl<'a> Migration<'a, Request<Post>>

pub fn from_embed<S>() -> Self

where S: RustEmbed,

Create Migration from rust_embed::RustEmbed

The migrations are ordered like the sorted sub-directories in path. So one possibility is to start dir-names with fixed length numbers.

In sub-directories you have to provide a file upgrade.sql (case sensitive). And optional a file downgrade.sql (case sensitive).

All files and directories need to have correct permissions to be readable during build of the crate.

See Migration documentation how to embed the data.

Requires feature migration_embed.

pub fn from_path<'p, P>(path: P) -> Self

where P: Into<&'p Path>,

Create Migration with migrations from directory structure in path

The migrations are ordered like the sorted sub-directories in path. So one possibility is to start dir-names with fixed length numbers.

In sub-directories you have to provide a file upgrade.sql (case sensitive). And optional a file downgrade.sql (case sensitive).

All files and directories need to have correct permissions or Migration will fail with MigrationError.

pub fn new<S>(migrations: S) -> Self

where S: Into<Vec<M<'a>>>,

Create Migration with Into<Vec<M>>

Trait Implementations

impl<'a, T> Add for Migration<'a, T>

where T: RequestBuilder<NoLevelMulti> + Clone,

type Output = Migration<'a, T>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl<T> AddAssign for Migration<'_, T>

where T: RequestBuilder<NoLevelMulti>,

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<'a, T> Clone for Migration<'a, T>

where T: RequestBuilder<NoLevelMulti> + Clone,

fn clone(&self) -> Migration<'a, T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, T> Debug for Migration<'a, T>

where T: RequestBuilder<NoLevelMulti> + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Migration<'_, Request<Post>>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> From<&'a M<'a>> for Migration<'a, Request<Post>>

Create Migration from single M reference

fn from(value: &'a M<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<M<'a>> for Migration<'a, Request<Post>>

Create Migration from single M

fn from(value: M<'a>) -> Self

Converts to this type from the input type.

impl<'p, P> From<P> for Migration<'_, Request<Post>>

where P: Into<&'p Path>,

Create Migration with migrations from directory structure in path

The migrations are ordered like the sorted sub-directories in path. So one possibility is to start dir-names with fixed length numbers.

In sub-directories you have to provide a file upgrade.sql (case sensitive). And optional a file downgrade.sql (case sensitive).

All files and directories need to have correct permissions or Migration will fail with MigrationError.

fn from(path: P) -> Self

Converts to this type from the input type.

impl<'a, T> PartialEq for Migration<'a, T>

where T: RequestBuilder<NoLevelMulti> + PartialEq,

fn eq(&self, other: &Migration<'a, T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, T> Eq for Migration<'a, T>

where T: RequestBuilder<NoLevelMulti> + Eq,

impl<'a, T> StructuralPartialEq for Migration<'a, T>

where T: RequestBuilder<NoLevelMulti>,