Command-line: migrate

Migrates the schema to the latest version. Flyway will create the metadata table automatically if it doesn't
exist.

Usage

> flyway [options] migrate

Options

Option

Required

Default

Description

url

YES

The jdbc url to use to connect to the database

driver

NO

Auto-detected based on url

The fully qualified classname of the jdbc driver to use
to connect to the database

user

NO

The user to use to connect to the database

password

NO

The password to use to connect to the database

schemas

NO

default schema of the connection

Comma-separated case-sensitive list of schemas managed by Flyway.
The first schema in the list will be automatically set as the default one during
the migration. It will also be the one containing the metadata table.

table

NO

schema_version

The name of Flyway's metadata table.By
default (single-schema mode) the metadata table is placed in the default schema for the connection
provided by the datasource.When the flyway.schemas property is set (multi-schema mode),
the metadata table is placed in the first schema of the list.

locations

NO

filesystem:<install-dir>/sql

Comma-separated list of locations to scan recursively for migrations. The location type is determined by its prefix.
Unprefixed locations or locations starting with classpath: point to a package on the classpath and may contain both sql and java-based migrations.
Locations starting with filesystem: point to a directory on the filesystem and may only contain sql migrations.

Comma-separated list of fully qualified class names of custom
MigrationResolver
implementations to be used in addition to the built-in ones for resolving Migrations to apply.

skipDefaultResolvers

NO

false

Whether default built-in resolvers (sql, jdbc and spring-jdbc) should be skipped. If true, only custom resolvers are used.

callbacks

NO

Comma-separated list of fully qualified class names of
FlywayCallback
implementations to use to hook into the Flyway lifecycle.

skipDefaultCallbacks

NO

false

Whether default built-in callbacks (sql) should be skipped. If true, only custom callbacks are used.

target

NO

latest version

The target version up to which Flyway should consider migrations. Migrations with a higher version number will be ignored. The special value current designates the current version of the schema.

outOfOrder

NO

false

Allows migrations to be run "out of order".

If you already have versions 1 and 3 applied, and now a version 2 is found,
it will be applied too instead of being ignored.

validateOnMigrate

NO

true

Whether to automatically call validate or not when running migrate.
For each sql migration a CRC32 checksum is calculated
when the sql script is executed. The validate mechanism checks if the sql migration in the classpath
still has the same checksum as the sql migration already executed in the database.

cleanOnValidationError

NO

false

Whether to automatically call clean or not when a validation error occurs.

This is exclusively intended as a convenience for development. Even tough we
strongly recommend not to change migration scripts once they have been checked into SCM and run, this
provides a way of dealing with this case in a smooth manner. The database will be wiped clean
automatically, ensuring that the next migration will bring you back to the state checked into
SCM.

Warning ! Do not enable in production !

ignoreFutureMigrations

NO

true

Ignore future migrations when reading the metadata table. These are migrations that were performed by a
newer deployment of the application that are not yet available in this version. For example: we have migrations
available on the classpath up to version 3.0. The metadata table indicates that a migration to version 4.0
(unknown to us) has already been applied. Instead of bombing out (fail fast) with an exception, a
warning is logged and Flyway continues normally. This is useful for situations where one must be able to redeploy
an older version of the application after the database has been migrated by a newer one.

cleanDisabled

NO

false

Whether to disable clean. This is especially useful for production environments where running clean can be quite a career limiting move.

baselineOnMigrate

NO

false

Whether to automatically call baseline when migrate is executed against a non-empty schema with no metadata
table.
This schema will then be baselined with the baselineVersion before executing the migrations.
Only migrations above baselineVersion will then be applied.

This is useful for initial Flyway production deployments on projects with an existing DB.

Be careful when enabling this as it removes the safety net that ensures Flyway does not migrate the wrong
database in case of a configuration mistake!

baselineVersion

NO

1

The version to tag an existing schema with when executing baseline

baselineDescription

NO

<< Flyway Baseline >>

The description to tag an existing schema with when executing baseline