Class MigrationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

com.codename1.migration.MigrationException

public class MigrationException
extends IOException

A migration run that was refused or failed. getCode() says which, so a caller can tell a database that is newer than the application from a script that did not run.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CLEAN_DISABLED	Migrator.clean() was called while clean is disabled.
static final int	FAILED_MIGRATION_PRESENT	A previous run left a migration marked failed; call Migrator.repair() after cleaning up.
static final int	FUTURE_SCHEMA	The database was migrated by a newer build than this one.
static final int	INVALID_SET	The migration set itself is wrong: a duplicate version, a script missing for this engine.
static final int	LOCK_TIMEOUT	Another process held the migration lock for longer than this run was willing to wait.
static final int	NON_EMPTY_SCHEMA	The database has tables and no history, and no baseline was requested.
static final int	SCRIPT_FAILED	A migration script or Java migration threw.
static final int	VALIDATE_FAILED	The applied history does not match the migrations this build carries.

Constructor Summary

Constructors

Constructor	Description
MigrationException(int code, String message)	Creates a failure of the given kind.
MigrationException(int code, String message, Throwable cause)	Creates a failure of the given kind, keeping the database error that caused it.

Method Summary

Modifier and Type	Method	Description
int	getCode()	The kind of failure.

Methods inherited from class Throwable

addSuppressed, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

VALIDATE_FAILED

public static final int VALIDATE_FAILED

The applied history does not match the migrations this build carries.

See Also:

• Constant Field Values

FAILED_MIGRATION_PRESENT

public static final int FAILED_MIGRATION_PRESENT

A previous run left a migration marked failed; call Migrator.repair() after cleaning up.

See Also:

• Constant Field Values

FUTURE_SCHEMA

public static final int FUTURE_SCHEMA

The database was migrated by a newer build than this one.

See Also:

• Constant Field Values

CLEAN_DISABLED

public static final int CLEAN_DISABLED

Migrator.clean() was called while clean is disabled.

See Also:

• Constant Field Values

LOCK_TIMEOUT

public static final int LOCK_TIMEOUT

Another process held the migration lock for longer than this run was willing to wait.

See Also:

• Constant Field Values

SCRIPT_FAILED

public static final int SCRIPT_FAILED

A migration script or Java migration threw.

See Also:

• Constant Field Values

NON_EMPTY_SCHEMA

public static final int NON_EMPTY_SCHEMA

The database has tables and no history, and no baseline was requested.

See Also:

• Constant Field Values

INVALID_SET

public static final int INVALID_SET

The migration set itself is wrong: a duplicate version, a script missing for this engine.

See Also:

• Constant Field Values

Constructor Details

MigrationException

public MigrationException(int code,
 String message)

Creates a failure of the given kind.

Parameters:

code - one of the constants of this class

message - what was refused and what to do about it

MigrationException

public MigrationException(int code,
 String message,
 Throwable cause)

Creates a failure of the given kind, keeping the database error that caused it.

Parameters:

code - one of the constants of this class

message - what was refused and what to do about it

cause - the underlying failure

Method Details

getCode

public int getCode()

The kind of failure.

Returns:

one of the constants of this class