Module org.jooq
Package org.jooq

Interface History

All Superinterfaces:
Iterable<HistoryVersion>, Scope
@Experimental public interface History extends Iterable<HistoryVersion>, Scope
The History of Version elements as installed by previous Migrations.

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

Author:
Lukas Eder

  • Method Details

    • available

      @Experimental boolean available()
      Whether any history is available on the current database.

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

    • contains

      @Experimental boolean contains(String id)
      Whether a version is contained in this history.

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

    • root

      @NotNull @Experimental @NotNull HistoryVersion root() throws DataMigrationVerificationException
      The root Version.

      This corresponds to the Configuration.commitProvider()'s Commits.root() if migrations have been initialised on the configured database.

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

      Throws:
      DataMigrationVerificationException - If no root version is available (e.g. because no migration has happened yet). See also available().

    • current

      @NotNull @Experimental @NotNull HistoryVersion current() throws DataMigrationVerificationException
      The currently installed Version.

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

      Throws:
      DataMigrationVerificationException - If no root version is available (e.g. because no migration has happened yet). See also available().

    • resolve

      @Experimental void resolve(String message)
      Resolve any previous failures in the History.

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