Struct Migration 

pub struct Migration {
    pub version: String,
    pub up_sql: String,
    pub transactional: bool,
}

A single migration with up SQL.

Fields

version: String

Stable version identifier — for system migrations __forge_vNNN, for user migrations the file stem like 0001_create_users.

up_sql: String

SQL to execute for upgrade.

transactional: bool

Wrap the migration in a transaction. Defaults to true. Set to false for statements PostgreSQL refuses to run inside a tx (CREATE INDEX CONCURRENTLY, ALTER TYPE ... ADD VALUE, VACUUM, REINDEX CONCURRENTLY) via the -- @transactional false directive.

Implementations

impl Migration

pub fn new(version: impl Into<String>, sql: impl Into<String>) -> Self

Create a migration.

pub fn parse(version: impl Into<String>, content: &str) -> Self

Parse migration content.

Recognized directives in the leading comment block (first 20 lines):

• -- @up (legacy marker, stripped if present)
• -- @transactional false opts out of the wrapping transaction

The @ prefix is required so plain English comments (-- transactional design ...) don’t accidentally trigger directives.

Trait Implementations

impl Clone for Migration

fn clone(&self) -> Migration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Migration

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

Formats the value using the given formatter.