Package org.flywaydb.core.api

Interface MigrationInfo

All Superinterfaces:
Comparable<MigrationInfo>
All Known Subinterfaces:
LoadableMigrationInfo
public interface MigrationInfo extends Comparable<MigrationInfo>
Info about a migration.

  • Method Details

    • getType

      org.flywaydb.core.extensibility.MigrationType getType()
      Returns:
      The type of migration (BASELINE, SQL, JDBC, ...)

    • getChecksum

      Integer getChecksum()
      Returns:
      The target version of this migration.

    • isVersioned

      default boolean isVersioned()

    • getVersion

      MigrationVersion getVersion()
      Returns:
      The schema version after the migration is complete.

    • getDescription

      String getDescription()
      Returns:
      The description of the migration.

    • getScript

      String getScript()
      Returns:
      The name of the script to execute for this migration, relative to its classpath or filesystem location.

    • getState

      MigrationState getState()
      Returns:
      The state of the migration (PENDING, SUCCESS, ...)

    • getInstalledOn

      Date getInstalledOn()
      Returns:
      The timestamp when this migration was installed. (Only for applied migrations)

    • getInstalledBy

      String getInstalledBy()
      Returns:
      The user that installed this migration. (Only for applied migrations)

    • getInstalledRank

      Integer getInstalledRank()
      Returns:
      The rank of this installed migration. This is the most precise way to sort applied migrations by installation order. Migrations that were applied later have a higher rank. (Only for applied migrations)

    • getExecutionTime

      Integer getExecutionTime()
      Returns:
      The execution time (in millis) of this migration. (Only for applied migrations)

    • getPhysicalLocation

      String getPhysicalLocation()
      Returns:
      The physical location of the migration on disk.

    • compareVersion

      int compareVersion(MigrationInfo o)
      Returns:
      The result between a comparison of these MigrationInfo's versions.

    • getShouldExecuteExpression

      default String getShouldExecuteExpression()
      Returns:
      The shouldExecute expression if present and supported by the migration type. Otherwise null.

    • isShouldExecute

      default boolean isShouldExecute()

    • isRepeatable

      default boolean isRepeatable()

    • isChecksumMatching

      default boolean isChecksumMatching()

    • isDescriptionMatching

      default boolean isDescriptionMatching()

    • isTypeMatching

      default boolean isTypeMatching()

    • isPlaceholderReplacement

      default Boolean isPlaceholderReplacement()

    • getResolvedChecksum

      default Integer getResolvedChecksum()

    • getAppliedChecksum

      default Integer getAppliedChecksum()

    • getResolvedDescription

      default String getResolvedDescription()

    • getAppliedDescription

      default String getAppliedDescription()

    • getResolvedType

      default org.flywaydb.core.extensibility.MigrationType getResolvedType()

    • getAppliedType

      default org.flywaydb.core.extensibility.MigrationType getAppliedType()

    • isApplied

      default boolean isApplied()