Migrates the schema to the latest version. Flyway will create the schema history table automatically if it doesn’t exist.
> flyway [options] migrate
| 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 | |
| connectRetries | NO | 0 | The maximum number of retries when attempting to connect to the database. After each failed attempt, Flyway will wait 1 second before attempting to connect again, up to the maximum number of times specified by connectRetries. |
| initSql | NO | none | The SQL statements to run to initialize a new database connection immediately after opening it. |
| defaultSchema | NO | The default schema for the database connection | The default schema managed by Flyway. This schema name is case-sensitive.
Consequences:
|
| schemas | NO | The default schema for the database connection | Comma-separated list of schemas managed by Flyway. These schema names are case-sensitive.
Consequences:
|
| createSchemas | NO | true | Whether Flyway should attempt to create the schemas specified in the schemas property. See this page for more details |
| table | NO | flyway_schema_history | The name of Flyway's schema history table. By default (single-schema mode) the schema history 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 schema history table is placed in the first schema of the list. |
| tablespace | NO | default for connection | The tablespace where to create the schema history table that will be used by Flyway. This setting is only relevant for databases that do support the notion of tablespaces. It's value is simply ignored for all others. |
| locations | NO | 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, may only
contain SQL migrations and are only scanned recursively down non-hidden directories.Locations can contain wildcards. This allows matching against a path pattern instead of a single path. Supported wildcards:
|
|
| color | NO | n/a | (Command line flag only) Whether to colorize output. If set to 'auto', will print color if a console is detected. Defaults to 'auto'. (always, never, or auto) |
| jarDirs | NO | Comma-separated list of directories containing JDBC drivers and Java-based migrations | |
| sqlMigrationPrefix | NO | V | The file name prefix for versioned SQL migrations. Versioned SQL migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix , which using the defaults translates to V1.1__My_description.sql |
| undoSqlMigrationPrefix Flyway Teams | NO | U | The file name prefix for undo SQL migrations. Undo SQL migrations are responsible for undoing the effects of the versioned migration with the same version. They have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix , which using the defaults translates to U1.1__My_description.sql |
| repeatableSqlMigrationPrefix | NO | R | The file name prefix for repeatable SQL migrations. Repeatable SQL migrations have the following file name structure: prefixSeparatorDESCRIPTIONsuffix , which using the defaults translates to R__My_description.sql |
| sqlMigrationSeparator | NO | __ | The file name separator for Sql migrations |
| sqlMigrationSuffixes | NO | .sql | Comma-separated list of file name suffixes for SQL migrations. SQL migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix , which using the defaults translates to V1_1__My_description.sql Multiple suffixes (like .sql,.pkg,.pkb) can be specified for easier compatibility with other tools such as editors with specific file associations. |
| validateMigrationNaming | NO | false | Whether to ignore migration files whose names do not match the naming conventions. If false, files with invalid names are ignored and Flyway continues normally. If true, Flyway fails fast and lists the offending files. |
| stream Flyway Teams | NO | false | Whether to stream SQL migrations when executing them. Streaming doesn't load the entire migration in memory at once. Instead each statement is loaded individually. This is particularly useful for very large SQL migrations composed of multiple MB or even GB of reference data, as this dramatically reduces Flyway's memory consumption. |
| batch Flyway Teams | NO | false | Whether to batch SQL statements when executing them. Batching can save up to 99 percent of network roundtrips by sending up to 100 statements at once over the network to the database, instead of sending each statement individually. This is particularly useful for very large SQL migrations composed of multiple MB or even GB of reference data, as this can dramatically reduce the network overhead. This is supported for INSERT, UPDATE, DELETE, MERGE and UPSERT statements. All other statements are automatically executed without batching. |
| mixed | NO | false | Whether to allow mixing transactional and non-transactional statements within the same migration. Enabling this automatically causes the entire affected migration to be run without a transaction. Note that this is only applicable for PostgreSQL, Aurora PostgreSQL, SQL Server and SQLite which all have statements that do not run at all within a transaction. This is not to be confused with implicit transaction, as they occur in MySQL or Oracle, where even though a DDL statement was run within within a transaction, the database will issue an implicit commit before and after its execution. |
| group | NO | false | Whether to group all pending migrations together in the same transaction when applying them (only recommended for databases with support for DDL transactions) |
| encoding | NO | UTF-8 | The encoding of Sql migrations |
| placeholderReplacement | NO | true | Whether placeholders should be replaced |
| placeholders.name | NO | Placeholders to replace in Sql migrations | |
| placeholderPrefix | NO | ${ | The prefix of every placeholder |
| placeholderSuffix | NO | } | The suffix of every placeholder |
| resolvers | NO | 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 Callback 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 | The target version up to which Flyway should consider migrations. Migrations with a higher version number will be ignored. Special values:
|
| 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. |
| outputQueryResults | NO | true | Whether Flyway should output a table with the results of queries when executing migrations. |
| 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 though 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 ! |
| ignoreMissingMigrations | NO | false | Ignore missing migrations when reading the schema history table. These are migrations that were performed by an older deployment of the application that are no longer available in this version. For example: we have migrations available on the classpath with versions 1.0 and 3.0. The schema history table indicates that a migration with version 2.0 (unknown to us) has also 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 deploy a newer version of the application even though it doesn't contain migrations included with an older one anymore. Note that if the most recently applied migration is removed, Flyway has no way to know it is missing and will mark it as future instead. |
| ignoreIgnoredMigrations | NO | false | Ignore ignored migrations when reading the schema history table. These are migrations that were added in between already migrated migrations in this version. For example: we have migrations available on the classpath with versions from 1.0 to 3.0. The schema history table indicates that version 1 was finished on 1.0.15, and the next one was 2.0.0. But with the next release a new migration was added to version 1: 1.0.16. Such scenario is ignored by migrate command, but by default is rejected by validate. When ignoreIgnoredMigrations is enabled, such case will not be reported by validate command. This is useful for situations where one must be able to deliver complete set of migrations in a delivery package for multiple versions of the product, and allows for further development of older versions. |
| ignoreFutureMigrations | NO | true | Ignore future migrations when reading the schema history 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 schema history 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 |
|
The description to tag an existing schema with when executing baseline |
| installedBy | NO | Current database user | The username that will be recorded in the schema history table as having applied the migration |
| errorOverrides | NO | none | Comma-sparated list of rules for the built-in error handler that let you override specific SQL states and errors codes in order to force specific errors or warnings to be treated as debug messages, info messages, warnings or errors.
Each error override has the following format: The following behaviors are accepted:
Example 1: to force Oracle stored procedure compilation issues to produce errors instead of warnings, the following errorOverride can be used: Example 2: to force SQL Server PRINT messages to be displayed as info messages (without SQL state and error code details) instead of warnings, the following errorOverride can be used: Example 3: to force all errors with SQL error code 123 to be treated as warnings instead, the following errorOverride can be used: |
| dryRunOutput Flyway Teams | NO | Execute directly against the database | The file where to output the SQL statements of a migration dry run. If the file specified is in a non-existent directory, Flyway will create all directories and parent directories as needed. Omit to use the default mode of executing the SQL statements directly against the database. |
| oracle.sqlplus | NO | false | Enable Flyway's support for Oracle SQL*Plus commands |
| oracle.sqlplusWarn | NO | false | Whether Flyway should issue a warning instead of an error whenever it encounters an Oracle SQL*Plus statement it doesn't yet support. |
| workingDirectory | NO | default for client | The working directory to consider when dealing with relative paths for both config files and locations. |
| licenseKey | NO | none | Your Flyway license key (FL01...). Not yet a Flyway Pro or Enterprise Edition customer? Request your Flyway trial license key to try out Flyway Pro and Enterprise Edition features free for 30 days. |
flyway.driver=org.hsqldb.jdbcDriver
flyway.url=jdbc:hsqldb:file:/db/flyway_sample
flyway.user=SA
flyway.password=mySecretPwd
flyway.connectRetries=10
flyway.initSql=SET ROLE 'myuser'
flyway.defaultSchema=schema1
flyway.schemas=schema1,schema2,schema3
flyway.createSchemas=true
flyway.table=schema_history
flyway.tablespace=my_tablespace
flyway.locations=classpath:com.mycomp.migration,database/migrations,filesystem:/sql-migrations
flyway.sqlMigrationPrefix=Migration-
flyway.undoSqlMigrationPrefix=downgrade
flyway.repeatableSqlMigrationPrefix=RRR
flyway.sqlMigrationSeparator=__
flyway.sqlMigrationSuffixes=.sql,.pkg,.pkb
flyway.stream=true
flyway.batch=true
flyway.encoding=ISO-8859-1
flyway.placeholderReplacement=true
flyway.placeholders.aplaceholder=value
flyway.placeholders.otherplaceholder=value123
flyway.placeholderPrefix=#[
flyway.placeholderSuffix=]
flyway.resolvers=com.mycomp.project.CustomResolver,com.mycomp.project.AnotherResolver
flyway.skipDefaultCallResolvers=false
flyway.callbacks=com.mycomp.project.CustomCallback,com.mycomp.project.AnotherCallback
flyway.skipDefaultCallbacks=false
flyway.target=5.1
flyway.outOfOrder=false
flyway.outputQueryResults=false
flyway.validateOnMigrate=true
flyway.cleanOnValidationError=false
flyway.mixed=false
flyway.group=false
flyway.ignoreMissingMigrations=false
flyway.ignoreIgnoredMigrations=false
flyway.ignoreFutureMigrations=false
flyway.cleanDisabled=false
flyway.baselineOnMigrate=false
flyway.installedBy=my-user
flyway.errorOverrides=99999:17110:E,42001:42001:W
flyway.dryRunOutput=/my/sql/dryrun-outputfile.sql
flyway.oracle.sqlplus=true
flyway.oracle.sqlplusWarn=true
flyway.workingDirectory=C:/myProject
> flyway migrate Flyway 7.5.0 by Redgate Database: jdbc:h2:file:flyway.db (H2 1.3) Successfully validated 5 migrations (execution time 00:00.010s) Creating Schema History table: "PUBLIC"."flyway_schema_history" Current version of schema "PUBLIC": << Empty Schema >> Migrating schema "PUBLIC" to version 1 - First Migrating schema "PUBLIC" to version 1.1 - View Successfully applied 2 migrations to schema "PUBLIC" (execution time 00:00.030s).