Showcase of Flyway (Teams Edition) usage with postgres

Table of contents

• General info
• Technologies
• Screenshots
• Setup
• Usage
• Project Status
• To Do
• About Owner
• Reference Documentation
• License

General info

Showcase of Flyway (Teams Edition) with Migration and Undo (rollback) usage examples.

Technologies

Project is created with technology:version

• Docker-compose: 3.8
• Flyway Teams Edition:9.8.1
• Postgresql: 15
• Maven: 3.9.0
• Shell Scripting

Screenshots

Setup

• Run postgres server using docker compose:
  • docker compose up -d
• Setup FLYWAY_LICENSE_KEY environment variable with your teams or enterprise flyway license key.
  • If you don't have one, you can get a free trial on redgate webpage
  • export FLYWAY_LICENSE_KEY="XXXXXXXXXXXXXXXXXXXXXXXXXXXX"
• Run example script using to initialize flyway migration and undo example:
  • ./runFlywayExample.sh

Usage

Run flyway maven plugin to migrate, undo, set baseline, get info...

Use flyway maven plugin documentation for more information.

Flyway database configuration is set for postgresql by default using maven profiles functionality.

You can also add additional maven profiles with other database providers (h2, mysql, oracle) or new database migration scripts.

Database scripts should be added under db.migration.[database].

If you want to add rollback functionality it's necessary to add an "undo" script for each versioned (migration) script.

Project Status

In Progress

To Do

1. Java API usage showcase

About Owner

Created by:

• @javierddn

  • Github: https://github.com/javierddn
  • LinkedIn: https://www.linkedin.com/in/javierdediegonavarro
  • DockerHub: https://hub.docker.com/u/javierddn
  • Bitbucket: https://bitbucket.org/javierddn
  • Gitlab: https://gitlab.com/javierddn
  • TravisCI: https://app.travis-ci.com/github/javierddn
  • CircleCI: https://app.circleci.com/pipelines/github/javierddn

• @eagerminds

  • Github: https://github.com/eager-minds
  • LinkedIn: https://www.linkedin.com/company/eager-minds
  • DockerHub: https://hub.docker.com/u/eagerminds
  • Bitbucket: https://bitbucket.org/eagerminds
  • TravisCI: https://app.travis-ci.com/github/eagerminds-javier
  • CircleCI: https://app.circleci.com/pipelines/github/eagerminds-javier

📩 Feel free to contact me! 📩

Reference Documentation

For further reference, please consider the following sections:

• Official Apache Maven documentation
• Spring Boot Maven Plugin Reference Guide
  • 6. Create an OCI image
  • 18.9.5. Flyway Migration
• Flyway Configuration
• Docker Documentation

License

APACHE LICENSE, VERSION 2.0