Package org.flywaydb.core.api.migration

Class BaseJavaMigration

java.lang.Object

org.flywaydb.core.api.migration.BaseJavaMigration

All Implemented Interfaces:

JavaMigration

Direct Known Subclasses:

BaselineJavaMigration

public abstract class BaseJavaMigration
extends Object
implements JavaMigration

This is the recommended class to extend for implementing Java-based Migrations.

Subclasses should follow the default Flyway naming convention of having a class name with the following structure:

• Versioned Migrations: V2__Add_new_table
• Undo Migrations: U2__Add_new_table
• Repeatable Migrations: R__Add_new_table

The file name consists of the following parts:

• Prefix: V for versioned migrations, U for undo migrations, R for repeatable migrations
• Version: Underscores (automatically replaced by dots at runtime) separate as many parts as you like (Not for repeatable migrations)
• Separator: __ (two underscores)
• Description: Underscores (automatically replaced by spaces at runtime) separate the words

If you need more control over the class name, you can override the default convention by implementing the JavaMigration interface directly. This will allow you to name your class as you wish. Version, description and migration category are provided by implementing the respective methods.

Constructor Summary

Constructors

Constructor	Description
BaseJavaMigration()	Creates a new instance of a Java-based migration following Flyway's default naming convention.

Method Summary

Modifier and Type	Method	Description
boolean	canExecuteInTransaction()	Whether the execution should take place inside a transaction.
protected void	extractVersionAndDescription(String shortName, String prefix, boolean repeatable)
Integer	getChecksum()
String	getDescription()
MigrationVersion	getVersion()
protected void	init()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.flywaydb.core.api.migration.JavaMigration

getResolvedMigration, getType, migrate

Constructor Details

BaseJavaMigration

public BaseJavaMigration()

Creates a new instance of a Java-based migration following Flyway's default naming convention.

Method Details

init

protected void init()

extractVersionAndDescription

protected void extractVersionAndDescription(String shortName,
 String prefix,
 boolean repeatable)

getVersion

public MigrationVersion getVersion()

Specified by:

getVersion in interface JavaMigration

Returns:

The version of the schema after the migration is complete. null for repeatable migrations.

getDescription

public String getDescription()

Specified by:

getDescription in interface JavaMigration

Returns:

The description of this migration for the migration history. Never null.

getChecksum

public Integer getChecksum()

Specified by:

getChecksum in interface JavaMigration

Returns:

The checksum of this migration.

canExecuteInTransaction

public boolean canExecuteInTransaction()

Description copied from interface: JavaMigration

Whether the execution should take place inside a transaction. Almost all implementations should return true. This however makes it possible to execute certain migrations outside a transaction. This is useful for databases like PostgreSQL and SQL Server where certain statement can only execute outside a transaction.

Specified by:

canExecuteInTransaction in interface JavaMigration

Returns:

true if a transaction should be used (highly recommended), or false if not.