Module org.jooq

Package org.jooq

Interface MigrationContext

All Superinterfaces:

Scope

@Internal
public interface MigrationContext
extends Scope

The context in which a Migration is executed.

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

Author:

Lukas Eder

See Also:

MigrationListener

Method Summary

Modifier and Type	Method	Description
Version	migrationFrom()	The Version from which a Migration has started.
Queries	migrationQueries()	The complete set of Queries that are executed between migrationFrom() and migrationTo().
Version	migrationTo()	The Version to which a Migration is headed.
Queries	queries()	The complete set of Queries that are executed between queriesFrom() and queriesTo().
Version	queriesFrom()	The Version from which an individual set of Queries has started.
Version	queriesTo()	The Version to which an individual set of Queries is headed.
Query	query()	The current Query that is being executed.

Methods inherited from interface org.jooq.Scope

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

Method Detail

migrationFrom

Version migrationFrom()

The Version from which a Migration has started.

migrationFrom() and migrationTo() versions need not be consecutive versions for any given migration. If a migration jumps a few versions, these two methods will only return the endpoints.

This is available on all MigrationListener events.

migrationTo

Version migrationTo()

The Version to which a Migration is headed.

migrationFrom() and migrationTo() versions need not be consecutive versions for any given migration. If a migration jumps a few versions, these two methods will only return the endpoints.

This is available on all MigrationListener events.

migrationQueries

Queries migrationQueries()

The complete set of Queries that are executed between migrationFrom() and migrationTo().

This is available on all MigrationListener events.

queriesFrom

Version queriesFrom()

The Version from which an individual set of Queries has started.

queriesFrom() and queriesTo() versions are consecutive versions in a migration. If a migration jumps a few versions, these two methods might return those intermediate versions on these events:

• MigrationListener.queriesStart(MigrationContext)
• MigrationListener.queriesEnd(MigrationContext)
• MigrationListener.queryStart(MigrationContext)
• MigrationListener.queryEnd(MigrationContext)

queriesTo

Version queriesTo()

The Version to which an individual set of Queries is headed.

queriesFrom() and queriesTo() versions are consecutive versions in a migration. If a migration jumps a few versions, these two methods might return those intermediate versions on these events:

• MigrationListener.queriesStart(MigrationContext)
• MigrationListener.queriesEnd(MigrationContext)
• MigrationListener.queryStart(MigrationContext)
• MigrationListener.queryEnd(MigrationContext)

queries

Queries queries()

The complete set of Queries that are executed between queriesFrom() and queriesTo().

This is available on the same MigrationListener events as queriesFrom() and queriesTo().

query

Query query()

The current Query that is being executed.

This is available on MigrationListener.queryStart(MigrationContext) and MigrationListener.queryEnd(MigrationContext).