Flyway - Yash-777/MyWorld GitHub Wiki

1. Command-line arguments

   You can specify Flyway configuration properties directly in the command-line using -D flags. This is useful when you want to override configuration files or set properties for a single migration run.

   Default Configuration Behavior: Flyway will look for the following default properties:

   mvn --non-recursive 
   	-Dflyway.url=jdbc:mysql://localhost:3306/ \
   	-Dflyway.user=databaseUser \
   	-Dflyway.password=databasePassword \
   	-Dflyway.schemas=schemaName \
   	flyway:clean flyway:migrate

   • flyway.url: The JDBC connection URL to the database.
   • flyway.user: The username for database authentication.
   • flyway.password: The password for database authentication.
   • flyway.schemas: The default schemas Flyway will use

2. Environment variables

   You can configure Flyway using environment variables, which is useful for keeping sensitive data (like passwords) out of the command line or configuration files. Flyway automatically detects certain environment variables for configuration.

   export FLYWAY_URL=jdbc:mysql://localhost:3306/mydb
   export FLYWAY_USER=root
   export FLYWAY_PASSWORD=root
   export FLYWAY_SCHEMAS=mydb

   After setting these variables, you can run Flyway commands without specifying them explicitly:

   flyway migrate
   

   Alternatively, if you're running the migrations with Maven, you can set environment variables before the Maven command to pass them to Flyway:

   export FLYWAY_URL=jdbc:mysql://localhost:3306/mydb
   mvn flyway:migrate

3. Custom config files Flyway allows you to specify custom configuration files for more advanced and persistent configuration management. A custom config file lets you keep your Flyway settings in a separate file that Flyway will read at runtime.

   Example of flyway.conf File: You can create a custom configuration file (e.g., flyway.conf or any other name you specify) and set the necessary properties inside that file:

   flyway.url=jdbc:mysql://localhost:3306/
   flyway.user=root
   flyway.password=root
   flyway.schemas=mydb
   flyway.locations=filesystem:db/migrations

   You can tell Flyway to use this file by specifying it in the command:

   mvn flyway:migrate -Dflyway.configFiles=resources/config/flyway.conf

4. Flyway command-line defaults

   Flyway has built-in defaults for many properties. If no value is provided for a specific property, Flyway will fall back on default values.

This means that if flyway.url is both present in a config file and passed as -url= from the command-line, the command-line argument will take precedence and be used.