Top Description Methods
org.jooq

public Interface Migration

extends Scope
Known Direct Implementers
org.jooq.impl.MigrationImpl
Annotations
@Experimental
Imports
org.jooq.exception.DataMigrationException, .DataMigrationValidationException, org.jetbrains.annotations.Blocking, .NotNull, .ApiStatus.Experimental

An executable migration between two Commit instances.

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

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

Author
Lukas Eder

Method Summary

Modifier and TypeMethod and Description
public void
execute()

Apply the migration.

public Commit
from()

The version that is being migrated from.

public @NotNull Queries
queries()

The queries that are executed by the migration.

public Commit
to()

The version that is being migrated to.

public void
validate()

Validate a migration.

Inherited from org.jooq.Scope:
configurationcreationTimedatadatadatadialectdslfamilysettings

Method Detail

executeback to summary
public void execute() throws DataMigrationException

Apply the migration.

Annotations
@Blocking
Exceptions
DataMigrationException:
When something went wrong during the application of the migration.
fromback to summary
public Commit from()

The version that is being migrated from.

queriesback to summary
public @NotNull Queries queries()

The queries that are executed by the migration.

Annotations
@NotNull
toback to summary
public Commit to()

The version that is being migrated to.

validateback to summary
public void validate() throws DataMigrationValidationException

Validate a migration.

Exceptions
DataMigrationValidationException:
When something went wrong during the validation of the migration.