quarkus-flyway-demo

This project uses Quarkus, the Supersonic Subatomic Java Framework.

If you want to learn more about Quarkus, please visit its website: https://quarkus.io/.

Setup

Create a .env file at project root directory and ensure it has the following env vars:

POSTGRES_USER=<insert_value>
POSTGRES_PW=<insert_value>
POSTGRES_DB=<insert_value>
PGADMIN_MAIL=<insert_value>
PGADMIN_PW=<insert_value>

Run docker compose up -d to start PostgreSQL & pgadmin. Once started you can access pgadmin at http://localhost:5050/. Add and save a new DB server with following details:

Name: flyway_demo_db
Host name/address: host.docker.internal
Port: 5432
Username: <insert_env_var_value>
Password: <insert_env_var_value>

Running the application in dev mode

You can run your application in dev mode that enables live coding using:

./gradlew quarkusDev

NOTE: Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/.

Packaging and running the application

The application can be packaged using:

./gradlew build

It produces the quarkus-run.jar file in the build/quarkus-app/ directory. Be aware that it’s not an über-jar as the dependencies are copied into the build/quarkus-app/lib/ directory.

The application is now runnable using java -jar build/quarkus-app/quarkus-run.jar.

If you want to build an über-jar, execute the following command:

./gradlew build -Dquarkus.package.jar.type=uber-jar

The application, packaged as an über-jar, is now runnable using java -jar build/*-runner.jar.

Creating a native executable

You can create a native executable using:

./gradlew build -Dquarkus.native.enabled=true

Or, if you don't have GraalVM installed, you can run the native executable build in a container using:

./gradlew build -Dquarkus.native.enabled=true -Dquarkus.native.container-build=true

You can then execute your native executable with: ./build/quarkus-jooq-flyway-demo-1.0.0-SNAPSHOT-runner

If you want to learn more about building native executables, please consult https://quarkus.io/guides/gradle-tooling.

Related Guides

• REST (guide): A Jakarta REST implementation utilizing build time processing and Vert.x. This extension is not compatible with the quarkus-resteasy extension, or any of the extensions that depend on it.
• Flyway (guide): Handle your database schema migrations
• JDBC Driver - PostgreSQL (guide): Connect to the PostgreSQL database via JDBC

Provided Code

REST

Easily start your REST Web Services

Related guide section...

Post-startup

Open pgadmin and check if the migrations were performed and flyway_schema_history table has recorded the migrations.