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()	Set the migration baseline to to().
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 Queries	revertUntracked()	The queries that revert the untracked schema objects.
@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

Method Details

from

@NotNull
@NotNull Commit from()

The version that is being migrated from.

fromSnapshot

@Nullable
@Nullable Commit fromSnapshot()

The last ContentType.SNAPSHOT commit that is being migrated from, or null if there's no snapshot.

This API is part of a commercial only feature. To use this feature, please use the jOOQ Professional Edition or the jOOQ Enterprise Edition.

to

@NotNull
@NotNull Commit to()

The version that is being migrated to.

queries

@NotNull
@NotNull Queries queries()

The queries that are executed by the migration.

untracked

@NotNull
@NotNull Queries untracked()

The queries that describe the untracked schema objects.

revertUntracked

@NotNull
@NotNull Queries revertUntracked()

The queries that revert the untracked schema objects.

logHistory

void logHistory()
         throws DataMigrationVerificationException

Log the most recent versions from the migration history to the configured logger.

Throws:

DataMigrationVerificationException

logPending

void logPending()
         throws DataMigrationVerificationException

Log the pending migration to the configured logger.

Throws:

DataMigrationVerificationException

logUntracked

void logUntracked()
           throws DataMigrationVerificationException

Log the untracked database changes of the migration schemas.

Throws:

DataMigrationVerificationException

verify

void verify()
     throws DataMigrationVerificationException

Verify the correctness of a migration.

Throws:

DataMigrationVerificationException - When something went wrong during the verification of the migration.

baseline

void baseline()
       throws DataMigrationVerificationException

Set the migration baseline to to().

Throws:

DataMigrationVerificationException - When something went wrong during the creation of the baseline.

execute

@Blocking
void execute()
      throws DataMigrationException

Apply the migration.

Throws:

DataMigrationException - When something went wrong during the application of the migration.