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
Jdbc
Applies to ✅ Open Source Edition ✅ Express Edition ✅ Professional Edition ✅ Enterprise Edition
This optional top level configuration element allows for configuring a JDBC connection. By default, the jOOQ code generator requires an active JDBC connection to reverse engineer your database schema. For example, if you want to connect to a MySQL database, write this:
<configuration>
<jdbc>
<driver>com.mysql.cj.jdbc.Driver</driver>
<url>jdbc:mysql://localhost/testdb</url>
<!-- "username" is a valid synonym for "user" -->
<user>root</user>
<password>secret</password>
</jdbc>
</configuration>
See the configuration XSD, standalone code generation, and maven code generation for more details.
new org.jooq.meta.jaxb.Configuration()
.withJdbc(new Jdbc()
.withDriver("com.mysql.cj.jdbc.Driver")
.withUrl("jdbc:mysql://localhost/testdb")
// "username" is a valid synonym for "user"
.withUser("root")
.withPassword("secret")
)
See the configuration XSD and programmatic code generation for more details.
// The jOOQ-codegen-gradle plugin has been introduced in version 3.19 only.
// The jOOQ-codegen-gradle plugin has been introduced in version 3.19 only.
generationTool {
jdbc {
driver = "com.mysql.cj.jdbc.Driver"
url = "jdbc:mysql://localhost/testdb"
// "username" is a valid synonym for "user"
user = "root"
password = "secret"
}
}
See the configuration XSD and gradle code generation for more details.
Note that when using the programmatic configuration API through the GenerationTool, you can also pass a pre-existing JDBC connection to the GenerationTool and leave this configuration element alone.
Make sure the JDBC driver is available to the code generator as a code generator dependency
Now, run the code generation with the JDBC URL specified as -Dcom.example.myproperty=jdbc:mysql://localhost/testdb, for example.
Optional JDBC properties
JDBC drivers allow for passing java.util.Properties to the JDBC driver when creating a connection. This is also supported in the code generator configuration with a list of key/value pairs as follows:
<configuration>
<jdbc>
<driver>com.mysql.cj.jdbc.Driver</driver>
<url>jdbc:mysql://localhost/testdb</url>
<properties>
<property>
<key>user</key>
<value>root</value>
</property>
<property>
<key>password</key>
<value>secret</value>
</property>
</properties>
</jdbc>
</configuration>
See the configuration XSD, standalone code generation, and maven code generation for more details.
new org.jooq.meta.jaxb.Configuration()
.withJdbc(new Jdbc()
.withDriver("com.mysql.cj.jdbc.Driver")
.withUrl("jdbc:mysql://localhost/testdb")
.withProperties(
new Property()
.withKey("user")
.withValue("root"),
new Property()
.withKey("password")
.withValue("secret")
)
)
See the configuration XSD and programmatic code generation for more details.
// The jOOQ-codegen-gradle plugin has been introduced in version 3.19 only.
// The jOOQ-codegen-gradle plugin has been introduced in version 3.19 only.
generationTool {
jdbc {
driver = "com.mysql.cj.jdbc.Driver"
url = "jdbc:mysql://localhost/testdb"
properties {
property {
key = "user"
value = "root"
}
property {
key = "password"
value = "secret"
}
}
}
}
See the configuration XSD and gradle code generation for more details.
Auto committing
jOOQ's code generator will use the driver's / connection's default auto commit flag. If for some reason you need to override this (e.g. in order to recover from failed transactions in PostgreSQL, by setting it to true), you can specify it here:
<configuration>
<jdbc>
<autoCommit>true</autoCommit>
</jdbc>
</configuration>
See the configuration XSD, standalone code generation, and maven code generation for more details.
new org.jooq.meta.jaxb.Configuration()
.withJdbc(new Jdbc()
.withAutoCommit(true)
)
See the configuration XSD and programmatic code generation for more details.
// The jOOQ-codegen-gradle plugin has been introduced in version 3.19 only.
// The jOOQ-codegen-gradle plugin has been introduced in version 3.19 only.
generationTool {
jdbc {
autoCommit = true
}
}
See the configuration XSD and gradle code generation for more details.
Init scripts
You can optionally provide a script to run after creating the JDBC connection, and before running the code generator.
<configuration>
<jdbc>
<initScript>CREATE SCHEMA X//SET SCHEMA X</initScript>
<!-- The separator between statements, defaulting to ";" -->
<initSeparator>//</initSeparator>
</jdbc>
</configuration>
See the configuration XSD, standalone code generation, and maven code generation for more details.
new org.jooq.meta.jaxb.Configuration()
.withJdbc(new Jdbc()
.withInitScript("CREATE SCHEMA X//SET SCHEMA X")
// The separator between statements, defaulting to ";"
.withInitSeparator("//")
)
See the configuration XSD and programmatic code generation for more details.
// The jOOQ-codegen-gradle plugin has been introduced in version 3.19 only.
// The jOOQ-codegen-gradle plugin has been introduced in version 3.19 only.
generationTool {
jdbc {
initScript = "CREATE SCHEMA X//SET SCHEMA X"
// The separator between statements, defaulting to ";"
initSeparator = "//"
}
}
See the configuration XSD and gradle code generation for more details.
When the JDBC configuration is optional
There are some exceptions, where the JDBC connection does not need to be configured, for instance when using the JPADatabase (to reverse engineer JPA annotated entities) or when using the XMLDatabase (to reverse engineer an XML file). Please refer to the respective sections for more details.
Feedback
Do you have any feedback about this page? We'd love to hear it!