feat(liquibase): integrate Liquibase for database migrations and upda… (#46)

* feat(liquibase): integrate Liquibase for database migrations and update configuration

* feat(liquibase): update Liquibase output changelog path and add version to plugin

* feat(env): update environment variable placeholders for Liquibase configuration

Author: Theo-lbg

.env.template

@@ -1,4 +1,10 @@
 POSTGRES_USER=your_postgres_user
 POSTGRES_PASSWORD=your_postgres_password
 POSTGRES_DB=your_postgres_db
-POSTGRES_PORT=5433
+POSTGRES_PORT=5432
+
+# Liquibase configuration
+LB_CHANGELOG=your_changelog_file.yaml
+LB_OUTPUT_CHANGELOG=your_output_changelog.yaml
+LB_DRIVER=your_jdbc_driver_class
+LB_SCHEMA=your_database_schema

README.md

@@ -207,7 +207,23 @@ src/main/java/com/xpeho/spring_boot_java_random_user/
 | `picture` | VARCHAR(500) | Avatar/picture URL |
 | `nat` | VARCHAR(10) | Nationality code |
 
-**Schema auto-created on startup via `schema.sql`**
+### Liquibase Migrations
+
+Database schema is managed with **Liquibase**. Migrations are applied automatically on application startup.
+
+```
+src/main/resources/db/changelog/
+├── db.changelog-master.yaml          ← Index file
+└── changes/
+    └── 001-create-users-table.yaml   ← Table creation
+```
+
+**CLI Commands:**
+```bash
+./mvnw liquibase:status                              # View pending changes
+./mvnw liquibase:update                              # Apply migrations
+./mvnw liquibase:rollback -Dliquibase.rollbackCount=1  # Rollback last change
+```
 
 ---
 

docker-compose.yml

@@ -12,7 +12,6 @@ services:
       - "${POSTGRES_PORT}:5432"
     volumes:
       - postgres_data:/var/lib/postgresql/data
-      - ./src/main/resources/schema.sql:/docker-entrypoint-initdb.d/01-schema.sql
     healthcheck:
       test: ["CMD-SHELL", "pg_isready -U ${POSTGRES_USER}"]
       interval: 10s

mvnw

@@ -122,7 +122,10 @@
 			<artifactId>spring-boot-starter-test</artifactId>
 			<scope>test</scope>
 		</dependency>
-
+		<dependency>
+			<groupId>org.liquibase</groupId>
+			<artifactId>liquibase-core</artifactId>
+		</dependency>
 	</dependencies>
 
 	<build>
@@ -131,6 +134,20 @@
 				<groupId>org.springframework.boot</groupId>
 				<artifactId>spring-boot-maven-plugin</artifactId>
 			</plugin>
+			<plugin>
+				<groupId>org.liquibase</groupId>
+				<artifactId>liquibase-maven-plugin</artifactId>
+				<version>5.0.0</version>
+				<configuration>
+					<changeLogFile>${env.LB_CHANGELOG}</changeLogFile>
+					<outputChangeLogFile>${env.LB_OUTPUT_CHANGELOG}</outputChangeLogFile>
+					<url>jdbc:postgresql://localhost:${env.POSTGRES_PORT}/${env.POSTGRES_DB}</url>
+					<username>${env.POSTGRES_USER}</username>
+					<password>${env.POSTGRES_PASSWORD}</password>
+					<driver>${env.LB_DRIVER}</driver>
+					<defaultSchemaName>${env.LB_SCHEMA}</defaultSchemaName>
+				</configuration>
+			</plugin>
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-surefire-plugin</artifactId>

pom.xml

@@ -12,10 +12,7 @@ spring.datasource.username=${POSTGRES_USER}
 spring.datasource.password=${POSTGRES_PASSWORD}
 spring.datasource.driver-class-name=org.postgresql.Driver
 
-
-# Spring Data JDBC - Initialize database
-spring.sql.init.mode=always
-spring.sql.init.schema-locations=classpath:schema.sql
-spring.sql.init.data-locations=
-spring.sql.init.platform=postgresql
-spring.sql.init.continue-on-error=true
+# Liquibase configuration
+spring.liquibase.enabled=${SPRING_LIQUIBASE_ENABLED:true}
+spring.liquibase.change-log=classpath:${LB_CHANGELOG}
+spring.liquibase.default-schema=${LB_SCHEMA}

src/main/resources/application.properties

@@ -0,0 +1,42 @@
+databaseChangeLog:
+  - changeSet:
+      id: 001-create-users-table
+      author: xpeho
+      changes:
+        - createTable:
+            tableName: users
+            columns:
+              - column:
+                  name: id
+                  type: SERIAL
+                  autoIncrement: true
+                  constraints:
+                    primaryKey: true
+                    nullable: false
+              - column:
+                  name: gender
+                  type: VARCHAR(20)
+              - column:
+                  name: firstname
+                  type: VARCHAR(100)
+              - column:
+                  name: lastname
+                  type: VARCHAR(100)
+              - column:
+                  name: civility
+                  type: VARCHAR(20)
+              - column:
+                  name: email
+                  type: VARCHAR(255)
+              - column:
+                  name: phone
+                  type: VARCHAR(50)
+              - column:
+                  name: picture
+                  type: VARCHAR(500)
+              - column:
+                  name: nationality
+                  type: VARCHAR(10)
+      rollback:
+        - dropTable:
+            tableName: users

src/main/resources/db/changelog/changes/001-create-users-table.yaml

@@ -0,0 +1,3 @@
+databaseChangeLog:
+  - include:
+      file: db/changelog/changes/001-create-users-table.yaml