Available in versions: Dev (3.20) | Latest (3.19) | 3.18 | 3.17 | 3.16 | 3.15 | 3.14 | 3.13 | 3.12 | 3.11 | 3.10
This is experimental functionality, and as such subject to change. Use at your own risk!
This documentation is for the unreleased development version of jOOQ. Click on the above version links to get this documentation for a supported version of jOOQ.
Running the code generator with Gradle
Applies to ✅ Open Source Edition ✅ Express Edition ✅ Professional Edition ✅ Enterprise Edition
Starting with jOOQ 3.19, there's out of the box gradle support for jOOQ's code generator, which is documented below.
There is no substantial difference between running the code generator with Gradle or in standalone mode. Both modes use the exact same <configuration/> element. The Gradle plugin configuration adds some additional boilerplate around that:
plugins {
// Use org.jooq for the Open Source Edition
// org.jooq.pro for commercial editions with Java 21 support,
// org.jooq.pro-java-17 for commercial editions with Java 17 support,
// org.jooq.pro-java-11 for commercial editions with Java 11 support,
// org.jooq.pro-java-8 for commercial editions with Java 8 support,
// org.jooq.trial for the free trial edition with Java 21 support,
// org.jooq.trial-java-17 for the free trial edition with Java 17 support,
// org.jooq.trial-java-11 for the free trial edition with Java 11 support,
// org.jooq.trial-java-8 for the free trial edition with Java 8 support
//
// Note: Only the Open Source Edition is hosted on Maven Central.
// Install the others locally using the provided scripts, or access them from here: https://repo.jooq.org
// See the JDK version support matrix here: https://www.jooq.org/download/support-matrix-jdk
id("org.jooq.jooq-codegen-gradle") version "3.20.0-SNAPSHOT"
}
dependencies {
// Code generation specific dependencies, like JDBC drivers, codegen extensions, etc.
jooqCodegen("...")
}
jooq {
configuration {
// ...
}
}
See the configuration XSD or the manual's various sections about code generation for more details.
plugins {
// Use org.jooq for the Open Source Edition
// org.jooq.pro for commercial editions with Java 21 support,
// org.jooq.pro-java-17 for commercial editions with Java 17 support,
// org.jooq.pro-java-11 for commercial editions with Java 11 support,
// org.jooq.pro-java-8 for commercial editions with Java 8 support,
// org.jooq.trial for the free trial edition with Java 21 support,
// org.jooq.trial-java-17 for the free trial edition with Java 17 support,
// org.jooq.trial-java-11 for the free trial edition with Java 11 support,
// org.jooq.trial-java-8 for the free trial edition with Java 8 support
//
// Note: Only the Open Source Edition is hosted on Maven Central.
// Install the others locally using the provided scripts, or access them from here: https://repo.jooq.org
// See the JDK version support matrix here: https://www.jooq.org/download/support-matrix-jdk
id "org.jooq.jooq-codegen-gradle" version "3.20.0-SNAPSHOT"
}
dependencies {
// Code generation specific dependencies, like JDBC drivers, codegen extensions, etc.
jooqCodegen "..."
}
jooq {
configuration {
// ...
}
}
See the configuration XSD or the manual's various sections about code generation for more details.
With the above configuration, a single execution is implicit.
Feedback
Do you have any feedback about this page? We'd love to hear it!