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	execute()	Apply the migration.
Commit	from()	The version that is being migrated from.
@NotNull Queries	queries()	The queries that are executed by the migration.
Commit	to()	The version that is being migrated to.
void	validate()	Validate a migration.

Methods inherited from interface org.jooq.Scope

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

Method Details

from

Commit from()

The version that is being migrated from.

to

Commit to()

The version that is being migrated to.

queries

@NotNull
@NotNull Queries queries()

The queries that are executed by the migration.

validate

void validate()
       throws DataMigrationValidationException

Validate a migration.

Throws:

DataMigrationValidationException - When something went wrong during the validation of the migration.

execute

@Blocking
void execute()
      throws DataMigrationException

Apply the migration.

Throws:

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