Quickstart - Flyway Desktop (pipelines)
Published 12 July 2024
1. Enable the service
- Configure your Flyway project by setting publishResult = true and checkDriftOnMigrate = true
in the [flyway] section of your project's flyway.toml file. The flyway.toml can be found in your Flyway project folder. - Save the file.
2. Configure environments
The Flyway Service shows project pipelines as a set of named environments. If you have not defined environments in your project yet, select Manage target databases from the Migration scripts screen to configure them.
3. Publishing insights to the Flyway Service
- Open a command prompt and type flyway auth -IAgreeToTheEula
- Now we deploy a migration script to a target of your choice.
- From the Migration scripts screen, select an environment using the Target database dropdown.
- Ensure that you have at least one pending migration script and select Run migrate
4. Viewing your deployments in the Flyway Service
The flyway migrate operation has now published its results to the Flyway Service. Simply visit https://flyway.red-gate.com/ to open the pipeline dashboard view.
You can drill down to to view any environments that have deployments registered against them for a specific Flyway project.
Use show more to view the detailed deployment history for an environment.