Struct Migration 

#[non_exhaustive]
pub struct Migration { /* private fields */ }

One migration: SQL to apply it and, optionally, SQL to undo it.

Usually generated from migrations/*.up.sql and *.down.sql by renox::migrations!(). Names start with a timestamp and run in name order.

When SQL differs between databases, NAME.postgres.up.sql (and .postgres.down.sql) or NAME.sqlite.up.sql replace the plain files on that database; the plain file may then be left out if both are given.

By hand (in tests, say), it’s built with const methods:

use renox::db::Migration;

const NOTES: Migration = Migration::new(
    "20300101000000_notes",
    "CREATE TABLE notes (id INTEGER PRIMARY KEY AUTOINCREMENT, body TEXT NOT NULL)",
    Some("DROP TABLE notes"),
)
.postgres(
    "CREATE TABLE notes (id BIGINT GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY, body TEXT NOT NULL)",
    None, // the plain `down` above
);

Implementations

impl Migration

pub const fn new( name: &'static str, up: &'static str, down: Option<&'static str>, ) -> Self

A migration with the same SQL on every database (up may be empty when each database gets its own with sqlite and postgres); down: None makes it irreversible.

pub const fn sqlite(self, up: &'static str, down: Option<&'static str>) -> Self

SQLite’s own SQL, used instead of the plain up; down: None falls back to the plain down.

pub const fn postgres( self, up: &'static str, down: Option<&'static str>, ) -> Self

PostgreSQL’s own SQL, used instead of the plain up; down: None falls back to the plain down.

pub const fn name(&self) -> &'static str

The migration’s name, e.g. 20260101000000_create_products_table; names sort the runs.

pub fn up_for(&self, dialect: Dialect) -> &'static str

The SQL that applies this migration on dialect.

pub fn down_for(&self, dialect: Dialect) -> Option<&'static str>

The SQL that undoes this migration on dialect, if any.

Trait Implementations

impl Clone for Migration

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Migration

impl Debug for Migration

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

Formats the value using the given formatter.