Flyway

IntelliJ IDEA allows you to select the place where to store the generated script: you can choose a file, scratch file in the IDE or clipboard.

Directory and File name fields are responsible for configuring the location of the generated migration. If a migration with the specified name already exists, you will be prompted with a warning, after which the changes will be appended to that migration.

On the left of the window, there is a preview of the actual changes to be generated. You can see what each change is going to look like by clicking on them.

Above the list of changes, you can use the following buttons:

Add Versioned Migration

Create a secondary versioned migration.

Remove from Versioned Migration

Remove the changes and add them to the Ignored section, so they are excluded from future migrations.

Restore from Ignored

Move the changes from Ignored to the migration.

Move to Another Versioned Migration

By default, a single migration script is created on each diff generation with all the changes. This action lets you move a change to another migration file.

Show Other Actions

Interact with a large number of changes in the migration files: Select all, Expand all, and Collapse all.

To combine several changes into one migration file or to ignore them, drag them around.

Java-based migrations are a great fit for all changes that can not easily be expressed using SQL. These migrations represent Java classes that implement the JavaMigration interface or inherit from the BaseJavaMigration class. IntelliJ IDEA follows the second option and generates the class name according to Flyway's default naming convention. This enables Flyway to automatically extract the version and the description from the class name.

To generate java migration, press the plus button in the JPA Structure tab and choose the corresponding item.

public class V1__ extends BaseJavaMigration {

    @Override
    public void migrate(Context context) throws Exception {
        try (PreparedStatement statement = context.getConnection()
                .prepareStatement("")) {
            statement.execute();
        }

    }
}

If you have installed and enabled the JPA Buddy plugin, you can also use the JPA Explorer tool window to access actions described on this page.

While migrations are sufficient for most needs, certain situations require you to execute the same action over and over again. With the help of IntelliJ IDEA, you can generate all events that Flyway supports.

Whenever an empty or differential Flyway migration is created, IntelliJ IDEA generates the file name based on the flyway naming pattern. In the IDE settings (CtrlAlt0S), you can configure values for name generation.

• Migration prefix. The default value is V.

• Version pattern. After the hyphen, an example of the generated sequence is presented.

• Migration separator. The default value is "_".

• Migration description.

The following variables and macros are available in the templates:

• #date([format]) – the current system date in the specified SimpleDateFormat. For example, #date(\"yyyy-MM-dd\") returns the date formatted as 2020-12-31.

• #increment([start], [step], [decimalFormat]) — a number that is used to keep the name unique. start value is used for the first file and is incremented by step for each next file. decimalFormat parameter specifies the DecimalFormat of the number. For example, #increment(1.0, 0.1, \"#.0\") returns the value formatted as 1.1, 1.2, 1.3, etc.

• semVer — semantic version of the project (aka SemVer) is a widely adopted version scheme that uses a sequence of three digits (Major.Minor.Patch), an optional pre-release tag and optional build meta tag. The object contains the following methods (the full version in the examples is 1.2.3-SNAPSHOT+meta):

  • ${semVer.getRawVersion()}: 1.2.3-SNAPSHOT

  • ${semVer.getMajor()}: 1

  • ${semVer.getMinor()}: 2

  • ${semVer.getPatch()}: 3

  • ${semVer.getPreRelease()}: SNAPSHOT

  • ${semVer.getMeta()}: meta