Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/suppierk/jooq-java-class-generator
Generates jOOQ Java classes from the database launched in Docker container after Flyway migrations were applied
https://github.com/suppierk/jooq-java-class-generator
database docker flyway generator jooq
Last synced: 5 days ago
JSON representation
Generates jOOQ Java classes from the database launched in Docker container after Flyway migrations were applied
- Host: GitHub
- URL: https://github.com/suppierk/jooq-java-class-generator
- Owner: SuppieRK
- License: mit
- Created: 2024-09-22T09:54:46.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2024-12-28T20:05:32.000Z (9 days ago)
- Last Synced: 2024-12-28T20:26:58.738Z (9 days ago)
- Topics: database, docker, flyway, generator, jooq
- Language: Java
- Homepage:
- Size: 136 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[jOOQ Java Class Generator](https://plugins.gradle.org/plugin/io.github.suppierk.jooq-java-class-generator)
=========================
> The work on this software project is in no way associated with my employer nor with the role I'm having at my
> employer.
>
> I maintain this project alone and as much or as little as my **spare time** permits using my **personal** equipment.
# Overview
[](https://app.fossa.com/projects/git%2Bgithub.com%2FSuppieRK%2Fjooq-java-class-generator?ref=badge_shield)
This Gradle plugin acts as a glue between (and **exposes**) two other great plugins available:
- [Flyway official Gradle plugin](https://plugins.gradle.org/plugin/org.flywaydb.flyway)
- [jOOQ code generation plugin](https://github.com/etiennestuder/gradle-jooq-plugin) made
by [Etienne Studer](https://github.com/etiennestuder)
This plugin adds a small missing part between those two plugins: [Testcontainers](https://testcontainers.com/) to create
a database during the Gradle `build` stage:
- This allows running Flyway migration scripts against a real database instance.
- And limits the scope of jOOQ code generation to only those made by specific codebase.
# Usage
## Using plugins DSL
```groovy
plugins {
id 'io.github.suppierk.jooq-java-class-generator' version '1.0.1'
}
```
## Using legacy plugin application
```groovy
buildscript {
repositories {
maven {
url 'https://plugins.gradle.org/m2/'
}
}
dependencies {
classpath 'io.github.suppierk:plugin:1.0.1'
}
}
apply plugin: 'io.github.suppierk.jooq-java-class-generator'
```
> You can also check `example-project` in this repo
# Configuration
Because this plugin represents a glue between other plugins, please consult with their documentation first:
- [Flyway official Gradle plugin documentation](https://documentation.red-gate.com/fd/gradle-task-184127407.html)
- [jOOQ code generation plugin configuration](https://github.com/etiennestuder/gradle-jooq-plugin?tab=readme-ov-file#configuration)
This plugin will simply set certain configurations for those plugins during Gradle `build` stage.
The only configurable thing this plugin offers is to set a specific Docker image to be used by Testcontainers via:
```groovy
jooqDockerImages {
// These are default values that can be overridden
postgres = 'postgres:16-alpine'
}
```
> This configuration has been made to support jOOQ behavior when it comes to restricting code generation based on the
> database version or other dependencies within your project restricting your
> options, [see the following comment](https://github.com/jOOQ/jOOQ/issues/12985#issuecomment-1030621355)
>
> Arguably, this can also be automated based on [jOOQ version support matrix](https://www.jooq.org/download/support-matrix),
> however I do not want to take away the ability to define your own Docker image.
## License
[](https://app.fossa.com/projects/git%2Bgithub.com%2FSuppieRK%2Fjooq-java-class-generator?ref=badge_large)