[jOOQ/jOOQ#9684] Make Version and Migration APIs Internal for now

This commit is contained in:
Lukas Eder 2020-01-14 10:41:04 +01:00
parent 6f6c623831
commit 1d22290407
9 changed files with 42 additions and 1 deletions

View File

@ -250,12 +250,20 @@ public interface DSLContext extends Scope , AutoCloseable {
/**
* Initialise a {@link Version}.
* <p>
* This is EXPERIMENTAL functionality and subject to change in future jOOQ
* versions.
*/
@Internal
Version version(String id);
/**
* Create a migration from the currently installed version to a new version.
* <p>
* This is EXPERIMENTAL functionality and subject to change in future jOOQ
* versions.
*/
@Internal
Migration migrateTo(Version to);
/**

View File

@ -42,9 +42,13 @@ import org.jooq.exception.DataMigrationValidationException;
/**
* An executable migration between two {@link Version} instances.
* <p>
* This is EXPERIMENTAL functionality and subject to change in future jOOQ
* versions.
*
* @author Lukas Eder
*/
@Internal
public interface Migration extends Scope {
/**

View File

@ -40,9 +40,13 @@ package org.jooq;
/**
* A configuration type for use with the various {@link Meta#migrateTo(Meta)}
* methods.
* <p>
* This is EXPERIMENTAL functionality and subject to change in future jOOQ
* versions.
*
* @author Lukas Eder
*/
@Internal
public final class MigrationConfiguration {
private final boolean alterTableAddMultiple;

View File

@ -39,10 +39,14 @@ package org.jooq;
/**
* 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 {
/**

View File

@ -41,9 +41,13 @@ import java.util.EventListener;
/**
* A listener for {@link Migration} lifecycles.
* <p>
* This is EXPERIMENTAL functionality and subject to change in future jOOQ
* versions.
*
* @author Lukas Eder
*/
@Internal
public interface MigrationListener extends EventListener {
/**

View File

@ -37,6 +37,8 @@
*/
package org.jooq;
import org.jooq.impl.DefaultMigrationListenerProvider;
/**
* A provider for {@link MigrationListener} instances.
* <p>
@ -45,6 +47,9 @@ package org.jooq;
* {@link Configuration}, clients can implement this API. To jOOQ, it is thus
* irrelevant, if migration listeners are stateful or stateless, local to an
* execution, or global to an application.
* <p>
* This is EXPERIMENTAL functionality and subject to change in future jOOQ
* versions.
*
* @author Lukas Eder
* @see MigrationListener
@ -53,6 +58,7 @@ package org.jooq;
@FunctionalInterface
@Internal
public interface MigrationListenerProvider {
/**

View File

@ -44,9 +44,13 @@ import org.jooq.conf.Settings;
/**
* A version ID attached to a {@link Meta} description of a database.
* <p>
* This is EXPERIMENTAL functionality and subject to change in future jOOQ
* versions.
*
* @author Lukas Eder
*/
@Internal
public interface Version {
/**

View File

@ -39,10 +39,13 @@ package org.jooq;
/**
* An SPI that allows for providing a graph of versions.
* <p>
* This is EXPERIMENTAL functionality and subject to change in future jOOQ
* versions.
*
* @author Lukas Eder
*/
@Internal // TODO This SPI is still being worked on and might change incompatibly
@Internal
public interface VersionProvider {
/**

View File

@ -41,9 +41,13 @@ package org.jooq;
* A directed, acyclic graph of {@link Version} objects.
* <p>
* The graph is exposed as {@link Iterable} in no defined iteration order.
* <p>
* This is EXPERIMENTAL functionality and subject to change in future jOOQ
* versions.
*
* @author Lukas Eder
*/
@Internal
public interface Versions extends Iterable<Version> {
/**