com.googlecode.flyway.core.api

Enum MigrationState

java.lang.Object

java.lang.Enum<MigrationState>

com.googlecode.flyway.core.api.MigrationState

All Implemented Interfaces:

Serializable, Comparable<MigrationState>

public enum MigrationState
extends Enum<MigrationState>

The state of a migration.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABOVE_TARGET This migration has not been applied yet, and won't be applied because target is set to a lower version.
FAILED This migration failed.
FUTURE_FAILED This migration failed.
FUTURE_SUCCESS This migration succeeded.
IGNORED This usually indicates a problem.
MISSING_FAILED This migration failed.
MISSING_SUCCESS This migration succeeded.
OUT_OF_ORDER This migration succeeded.
PENDING This migration has not been applied yet.
PREINIT This migration was not applied against this DB, because the metadata table was initialized with a higher version.
SUCCESS This migration succeeded.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDisplayName()
boolean	isApplied()
boolean	isFailed()
boolean	isResolved()
static MigrationState	valueOf(String name) Returns the enum constant of this type with the specified name.
static MigrationState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PENDING

public static final MigrationState PENDING

This migration has not been applied yet.

ABOVE_TARGET

public static final MigrationState ABOVE_TARGET

This migration has not been applied yet, and won't be applied because target is set to a lower version.

PREINIT

public static final MigrationState PREINIT

This migration was not applied against this DB, because the metadata table was initialized with a higher version.

IGNORED

public static final MigrationState IGNORED

This usually indicates a problem.

This migration was not applied against this DB, because a migration with a higher version has already been applied. This probably means some checkins happened out of order.

Fix by increasing the version number, run clean and migrate again or rerun migration with outOfOrder enabled.

MISSING_SUCCESS

public static final MigrationState MISSING_SUCCESS

This migration succeeded.

This migration was applied against this DB, but it is not available locally. This usually results from multiple older migration files being consolidated into a single one.

MISSING_FAILED

public static final MigrationState MISSING_FAILED

This migration failed.

This migration was applied against this DB, but it is not available locally. This usually results from multiple older migration files being consolidated into a single one.

This should rarely, if ever, occur in practice.

SUCCESS

public static final MigrationState SUCCESS

This migration succeeded.

FAILED

public static final MigrationState FAILED

This migration failed.

OUT_OF_ORDER

public static final MigrationState OUT_OF_ORDER

This migration succeeded.

This migration succeeded, but it was applied out of order. Rerunning the entire migration history might produce different results!

FUTURE_SUCCESS

public static final MigrationState FUTURE_SUCCESS

This migration succeeded.

This migration has been applied against the DB, but it is not available locally. Its version is higher than the highest version available locally. It was most likely successfully installed by a future version of this deployable.

FUTURE_FAILED

public static final MigrationState FUTURE_FAILED

This migration failed.

This migration has been applied against the DB, but it is not available locally. Its version is higher than the highest version available locally. It most likely failed during the installation of a future version of this deployable.

Method Detail

values

public static MigrationState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MigrationState c : MigrationState.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MigrationState valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getDisplayName

public String getDisplayName()

Returns:

The name suitable for display to the end-user.

isApplied

public boolean isApplied()

Returns:

Flag indicating if this migration has been applied or not.

isResolved

public boolean isResolved()

Returns:

Flag indicating if this migration has been resolved or not.

isFailed

public boolean isFailed()

Returns:

Flag indicating if this migration has failed or not.