http://www.jooq.org/jooq: jOOQ effectively combines complex SQL, typesafety, source code generation, active records,
stored procedures, advanced data types, and Java in a fluent, intuitive DSL.
/*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Other licenses:
* -----------------------------------------------------------------------------
* Commercial licenses for this work are available. These replace the above
* ASL 2.0 and offer limited warranties, support, maintenance, and commercial
* database integrations.
*
* For more information, please visit: http://www.jooq.org/licenses
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*/
package org.jooq;
import org.jetbrains.annotations.NotNull;
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:
/**
* The context in which a {@link Migration} is executed.
* <p>
* This is EXPERIMENTAL functionality and subject to change in future jOOQ
* versions.
*
* @see MigrationListener
* @author Lukas Eder
*/
@Internal
public interface MigrationContext extends Scope {
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.
/**
* The {@link Version} from which a {@link Migration} has started.
* <p>
* {@link #migrationFrom()} and {@link #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.
* <p>
* This is available on all {@link MigrationListener} events.
*/
@NotNull
Version migrationFrom();
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.
/**
* The {@link Version} to which a {@link Migration} is headed.
* <p>
* {@link #migrationFrom()} and {@link #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.
* <p>
* This is available on all {@link MigrationListener} events.
*/
@NotNull
Version migrationTo();
The complete set of Queries that are executed between migrationFrom() and migrationTo(). This is available on all MigrationListener events.
/**
* The complete set of {@link Queries} that are executed between
* {@link #migrationFrom()} and {@link #migrationTo()}.
* <p>
* This is available on all {@link MigrationListener} events.
*/
@NotNull
Queries migrationQueries();
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:
/**
* The {@link Version} from which an individual set of {@link Queries} has
* started.
* <p>
* {@link #queriesFrom()} and {@link #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:
* <p>
* <ul>
* <li>{@link MigrationListener#queriesStart(MigrationContext)}</li>
* <li>{@link MigrationListener#queriesEnd(MigrationContext)}</li>
* <li>{@link MigrationListener#queryStart(MigrationContext)}</li>
* <li>{@link MigrationListener#queryEnd(MigrationContext)}</li>
* </ul>
*/
@NotNull
Version queriesFrom();
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:
/**
* The {@link Version} to which an individual set of {@link Queries} is
* headed.
* <p>
* {@link #queriesFrom()} and {@link #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:
* <p>
* <ul>
* <li>{@link MigrationListener#queriesStart(MigrationContext)}</li>
* <li>{@link MigrationListener#queriesEnd(MigrationContext)}</li>
* <li>{@link MigrationListener#queryStart(MigrationContext)}</li>
* <li>{@link MigrationListener#queryEnd(MigrationContext)}</li>
* </ul>
*/
@NotNull
Version queriesTo();
The complete set of Queries that are executed between queriesFrom() and queriesTo(). This is available on the same MigrationListener events as queriesFrom() and queriesTo().
/**
* The complete set of {@link Queries} that are executed between
* {@link #queriesFrom()} and {@link #queriesTo()}.
* <p>
* This is available on the same {@link MigrationListener} events as
* {@link #queriesFrom()} and {@link #queriesTo()}.
*/
@NotNull
Queries queries();
The current Query that is being executed. This is available on MigrationListener.queryStart(MigrationContext) and MigrationListener.queryEnd(MigrationContext).
/**
* The current {@link Query} that is being executed.
* <p>
* This is available on
* {@link MigrationListener#queryStart(MigrationContext)} and
* {@link MigrationListener#queryEnd(MigrationContext)}.
*/
@NotNull
Query query();
}