Struct rusqlite_migration::M

pub struct M<'u> { /* private fields */ }

One migration

Implementations

impl<'u> M<'u>

pub fn up(sql: &'u str) -> Self

Create a schema update. The SQL command will be executed only when the migration has not been executed on the underlying database.

Please note

• PRAGMA statements are discouraged here. They are often better applied outside of migrations, because:
  • a PRAGMA executed this way may not be applied consistently. For instance:
    • foreign_keys needs to be executed for each sqlite connection, not just once per database as a migration,
    • journal_mode has no effect when executed inside transactions (that will be the case for the SQL written in up).
  • Multiple SQL commands contaning PRAGMA are not working with the extra_check feature of rusqlite.
• SQL commands should end with a “;”.

Example

use rusqlite_migration::M;

M::up("CREATE TABLE animals (name TEXT);");

pub fn down(self, sql: &'u str) -> Self

Define a down-migration. This SQL statement should exactly reverse the changes performed in up().

A call to this method is not required.

Example

use rusqlite_migration::M;

M::up("CREATE TABLE animals (name TEXT);")
    .down("DROP TABLE animals;");

Trait Implementations

impl<'u> Clone for M<'u>

fn clone(&self) -> M<'u>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'u> Debug for M<'u>

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

Formats the value using the given formatter.

impl<'u> PartialEq<M<'u>> for M<'u>

fn eq(&self, other: &M<'u>) -> bool

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

fn ne(&self, other: &M<'u>) -> bool

This method tests for !=.

impl<'u> StructuralPartialEq for M<'u>