Struct Migration 

pub struct Migration { /* private fields */ }

Available on crate feature std only.

A migration with its SQL content

Represents a single migration that can be applied to the database. The hash field is used to track which migrations have been applied.

Implementations

impl Migration

pub fn new(tag: &str, sql: &str) -> Migration

Create a new migration from embedded SQL

The hash is computed from the SQL content. SQL is split on "--> statement-breakpoint" markers.

pub fn with_hash( tag: impl Into<String>, hash: impl Into<String>, created_at: i64, sql: Vec<String>, ) -> Migration

Create a migration with explicit hash and timestamp

pub fn tag(&self) -> &str

Get the migration tag (folder name)

pub fn name(&self) -> &str

Get the migration folder name used by drizzle-orm tracking metadata.

pub fn hash(&self) -> &str

Get the migration hash (used for tracking)

pub const fn created_at(&self) -> i64

Get the creation timestamp

pub fn statements(&self) -> &[String]

Get the raw SQL statements (already split).

SQLite transaction-owning adapters must use Self::sqlite_execution instead so foreign-key suspension sentinels are handled outside the transaction.

pub fn sqlite_execution( &self, ) -> Result<SqliteMigrationExecution<'_>, SqliteMigrationExecutionError>

Validate SQLite foreign-key suspension sentinels and prepare the statement stream for a transaction-owning runtime adapter.

Errors

Returns SqliteMigrationExecutionError when foreign-key suspension pragmas are nested, unbalanced, or use an unsupported assignment form.

pub fn is_empty(&self) -> bool

Check if this migration is empty

pub fn has_postgres_concurrent_index(&self) -> bool

Whether this migration contains a PostgreSQL concurrent-index command.

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<(), Error>

Formats the value using the given formatter.