Struct Builder 

pub struct Builder { /* private fields */ }

Per-app migration runner config. Lets two rustango apps live in the same Postgres database without colliding on the default __rustango_migrations__ ledger table — each app picks its own ledger name and the runners stay independent.

All verbs are mirrored on the Builder so a custom-ledger app has the same surface as the default free functions:

let mine = Builder::default().ledger("__myapp_migrations__");
mine.migrate(&pool, dir).await?;
mine.applied_set(&pool).await?;

Ledger names must be valid SQL identifiers ([A-Za-z_][A-Za-z0-9_]*, ≤ 63 bytes). .ledger("…") panics if not — this is a programming error caught at config time, not a runtime input.

Implementations

impl Builder

pub fn new() -> Self

Equivalent to Builder::default(). Provided for symmetry with the rest of the workspace’s builder constructors.

pub fn ledger(self, name: &'static str) -> Self

Override the ledger table name. Must be a valid SQL identifier ([A-Za-z_][A-Za-z0-9_]*, ≤ 63 bytes).

Panics

Panics if name isn’t a valid SQL identifier — the ledger name is interpolated into DDL (CREATE TABLE, INSERT INTO, SELECT FROM) so we refuse anything that could escape quoting.

pub fn ledger_name(&self) -> &'static str

The configured ledger table name.

pub async fn migrate( &self, pool: &PgPool, dir: &Path, ) -> Result<Vec<Migration>, MigrateError>

As migrate, with this builder’s ledger.

Errors

As migrate.

pub async fn migrate_to( &self, pool: &PgPool, dir: &Path, target: &str, ) -> Result<Vec<Migration>, MigrateError>

As migrate_to, with this builder’s ledger.

Errors

As migrate_to.

pub async fn migrate_embedded( &self, pool: &PgPool, embedded: &[(&str, &str)], ) -> Result<Vec<Migration>, MigrateError>

As migrate_embedded, with this builder’s ledger.

Errors

As migrate_embedded.

pub async fn migrate_dry_run( &self, pool: &PgPool, dir: &Path, ) -> Result<Vec<MigrationPreview>, MigrateError>

As migrate_dry_run, with this builder’s ledger.

Errors

As migrate_dry_run.

pub async fn downgrade( &self, pool: &PgPool, dir: &Path, steps: usize, ) -> Result<Vec<Migration>, MigrateError>

As downgrade, with this builder’s ledger.

Errors

As downgrade.

pub async fn unapply( &self, pool: &PgPool, dir: &Path, name: &str, ) -> Result<Migration, MigrateError>

As unapply, with this builder’s ledger.

Errors

As unapply.

pub async fn unapply_force( &self, pool: &PgPool, dir: &Path, name: &str, ) -> Result<Migration, MigrateError>

As unapply_force, with this builder’s ledger.

Errors

As unapply_force.

pub async fn applied_set( &self, pool: &PgPool, ) -> Result<HashSet<String>, MigrateError>

As applied_set, with this builder’s ledger.

Errors

As applied_set.

pub async fn ensure_ledger(&self, pool: &PgPool) -> Result<(), MigrateError>

As ensure_ledger, with this builder’s ledger.

Errors

As ensure_ledger.

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.

impl Copy for Builder