data-jdbc-maven-plugin

---

A Maven plugin designed to generate Java Records for use with Spring Data JDBC, reverse-engineered directly from a database schema.

Example of usage within a pom.xml using default parameters

• Environment variables: Database credentials loaded from a .env file located in the project root.

• Built-in template: Uses the standard table-record.hbs template bundled with the plugin.

• Default mappings: Automatically processes all tables within the specified schema.

<plugin>
    <groupId>net.guarnie</groupId>
    <artifactId>data-jdbc-maven-plugin</artifactId>
    <version>0.0.4</version>
    <executions>
        <execution>
            <goals>
                <goal>generate-records</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <packageName>com.xyz.project.dao</packageName>
    </configuration>
    <dependencies>
        <dependency>
            <groupId>org.postgresql</groupId>
            <artifactId>postgresql</artifactId>
            <version>42.7.2</version>
        </dependency>
    </dependencies>
</plugin>

The following customizations can be added inside the configuration block:

• Custom Database configuration path:

<envPath>${project.basedir}/config/.env</envPath>

• Custom mappings file path:

<mappingsPath>${project.basedir}/config/mappings.yml</mappingsPath>

• Custom templates directory path (to provide a custom version of table-record.hbs):

<templatesPath>${project.basedir}/config/templates</templatesPath>

• Custom output directory path (default: ${project.build.directory}/generated-sources/jdbc-records):

<outputPath>${project.basedir}/out/records</outputPath>

• To map TIMESTAMP fields with TIMEZONE use OffsetDateTime instead of Instant (default):

<useOffsetDateTime>true</useOffsetDateTime>

Custom File Examples

Example .env file for database access:

jdbc.driver=org.postgresql.Driver
jdbc.url=jdbc:postgresql://localhost:5417/atms
jdbc.schema=master

jdbc.user=master
jdbc.pass=*******

Example mappings.yml file:

filters:
  include: ["auth_.*"]
  exclude: ["flyway_schema_history", "temp_.*"]

mappings:
  tables:
    auth_users: "AllUsers"
  columns:
    auth_users:
      email: "emailAddress"

Both include and exclude are lists and support regular expressions.

• If include is not provided, all tables in the schema will be included by default.
• If exclude is not provided, no tables will be excluded.