How zshn-dev/quarkus-flyway-demo works
Project Type and Purpose
• Type: A Java-based microservice (Quarkus) exposing REST endpoints
• Purpose: Demonstrate a Quarkus application with Flyway migrations on PostgreSQL, packaged for JVM or GraalVM native.
Main Components
a. Docker Compose Network
– postgres_db (PostgreSQL container)
– pgadmin (PgAdmin container)
– quarkus_app (our service, runs either in dev, JVM-jar, or native)
b. Quarkus Application
– REST Layer (GreetingResource.java)
– Flyway Migration (src/main/resources/db/migration/*.sql)
– JDBC Datasource (application.properties)
c. Database
– PostgreSQL instance
– flyway_schema_history table & author/book tables
d. External/Dev Tools
– Gradle Wrapper (build scripts, native container build)
– Dev UI (Quarkus Dev UI at /q/dev/)
– Native-test / Integration tests
Relationships & Data Flows
1. On docker compose up:
• Flyway (embedded in Quarkus startup) reads SQL files → applies migrations → updates PostgreSQL schema.
• PgAdmin connects to PostgreSQL for DB management.
2. At runtime:
• Client (e.g., browser, curl) → HTTP request → Quarkus REST endpoint (GreetingResource) → JDBC → PostgreSQL → result → back to client.
3. Build & Deploy:
• Developer runs ./gradlew build → produces JAR/uber-jar/native binary → deployed as Docker image (Dockerfile.jvm or Dockerfile.native) → runs in container.
Architectural Patterns & Design Principles
– Layered Architecture:
• Controller/Resource layer (JAX-RS)
• Migration layer (Flyway) at startup
• Persistence layer (JDBC / DataSource)
– Infrastructure as Code: Dockerfiles + docker-compose
– Twelve-factor principles: externalize configs via env vars (.env)
Inside it, place three containers
– postgres_db (PostgreSQL, port 5432)
– pgadmin (PgAdmin UI, port 5050)
– quarkus_app (Quarkus service, port 8080)
Inside quarkus_app, subdivide into
– Dev UI (only in dev mode)