Package migratedb.v1.core.api

Enum Class MigrationState

java.lang.Object

java.lang.Enum<MigrationState>

migratedb.v1.core.api.MigrationState

All Implemented Interfaces:

Serializable, Comparable<MigrationState>, java.lang.constant.Constable

public enum MigrationState
extends Enum<MigrationState>

The state of a migration.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MigrationState.Category

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ABOVE_TARGET	This migration has not been applied yet, and won't be applied because target is set to a lower version.
BASELINE	The current DB state was accepted as the corresponding version without making any changes.
BELOW_BASELINE	This migration was not applied against this DB, because the schema history table was baselined with a higher version.
DELETED	This is a migration that has been marked as deleted.
FAILED	This migration failed.
FUTURE_FAILED	This migration failed.
FUTURE_SUCCESS	This migration succeeded.
IGNORED	When using cherryPick, this indicates a migration that was not in the cherry picked list.
MISSING_FAILED	This migration failed.
MISSING_SUCCESS	This migration succeeded.
OUT_OF_ORDER	This migration succeeded.
OUTDATED	This is a repeatable migration that has been applied, but is outdated and should be re-applied.
PENDING	This migration has not been applied, yet.
SUCCESS	This migration succeeded.
SUPERSEDED	This is a repeatable migration that is outdated and has already been superseded by a newer run.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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.

BELOW_BASELINE

public static final MigrationState BELOW_BASELINE

This migration was not applied against this DB, because the schema history table was baselined with a higher version.

BASELINE

public static final MigrationState BASELINE

The current DB state was accepted as the corresponding version without making any changes.

IGNORED

public static final MigrationState IGNORED

When using cherryPick, this indicates a migration that was not in the cherry picked list. When not using cherryPick, this usually indicates a problem: The migration was ignored because a higher version has already been applied.

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.

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.

OUTDATED

public static final MigrationState OUTDATED

This is a repeatable migration that has been applied, but is outdated and should be re-applied.

SUPERSEDED

public static final MigrationState SUPERSEDED

This is a repeatable migration that is outdated and has already been superseded by a newer run.

DELETED

public static final MigrationState DELETED

This is a migration that has been marked as deleted.

Method Details

values

public static MigrationState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static MigrationState valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getDisplayName

public String getDisplayName()

is

public boolean is(MigrationState.Category category)