Module org.jooq
Package org.jooq

Interface Migration

All Superinterfaces:
Scope
@Experimental public interface Migration extends Scope
An executable migration between two Commit instances.

This type is a Scope with independent lifecycle and its own Scope.data() map.

This is EXPERIMENTAL functionality and subject to change in future jOOQ versions.

Author:
Lukas Eder

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    baseline()
    Create a baseline from the current schema using the pending changes, if they match.
    void
    execute()
    Apply the migration.
    @NotNull Commit
    from()
    The version that is being migrated from.
    @Nullable Commit
    fromSnapshot()
    The last ContentType.SNAPSHOT commit that is being migrated from, or null if there's no snapshot.
    void
    logHistory()
    Log the most recent versions from the migration history to the configured logger.
    void
    logPending()
    Log the pending migration to the configured logger.
    void
    logUntracked()
    Log the untracked database changes of the migration schemas.
    @NotNull Queries
    queries()
    The queries that are executed by the migration.
    @NotNull Commit
    to()
    The version that is being migrated to.
    @NotNull Queries
    untracked()
    The queries that describe the untracked schema objects.
    void
    verify()
    Verify the correctness of a migration.

    Methods inherited from interface org.jooq.Scope

    configuration, creationTime, data, data, data, dialect, dsl, family, settings