Available in versions: Dev (3.21) | Latest (3.20) | 3.19 | 3.18 | 3.17 | 3.16 | 3.15 | 3.14 | 3.13 | 3.12 | 3.11
Data type rewriting
Applies to ✅ Open Source Edition ✅ Express Edition ✅ Professional Edition ✅ Enterprise Edition
Sometimes, the actual database data type does not match the SQL data type that you would like to use in Java. This is often the case for ill-supported SQL data types, such as BOOLEAN, UUID, or INSTANT. jOOQ's code generator allows you to apply simple data type rewriting. The following configuration will rewrite IS_VALID columns in all tables to be of type BOOLEAN.
<configuration>
<generator>
<database>
<forcedTypes>
<forcedType>
<!-- Specify any data type that is supported in your database, or if unsupported,
a type from org.jooq.impl.SQLDataType -->
<name>BOOLEAN</name>
<!-- A Java regex matching fully-qualified columns, attributes, parameters. Use the pipe to separate several expressions. -->
<includeExpression>.*\.IS_VALID</includeExpression>
</forcedType>
</forcedTypes>
</database>
</generator>
</configuration>
See the configuration XSD, standalone code generation, and maven code generation for more details.
new org.jooq.meta.jaxb.Configuration()
.withGenerator(new Generator()
.withDatabase(new Database()
.withForcedTypes(
new ForcedType()
// Specify any data type that is supported in your database, or if unsupported,
// a type from org.jooq.impl.SQLDataType
.withName("BOOLEAN")
// A Java regex matching fully-qualified columns, attributes, parameters. Use the pipe to separate several expressions.
.withIncludeExpression(".*\\.IS_VALID")
)
)
)
See the configuration XSD and programmatic code generation for more details.
import org.jooq.meta.jaxb.*
configuration {
generator {
database {
forcedTypes {
forcedType {
// Specify any data type that is supported in your database, or if unsupported,
// a type from org.jooq.impl.SQLDataType
name = "BOOLEAN"
// A Java regex matching fully-qualified columns, attributes, parameters. Use the pipe to separate several expressions.
includeExpression = ".*\\.IS_VALID"
}
}
}
}
}
See the configuration XSD and gradle code generation for more details.
configuration {
generator {
database {
forcedTypes {
forcedType {
// Specify any data type that is supported in your database, or if unsupported,
// a type from org.jooq.impl.SQLDataType
name = "BOOLEAN"
// A Java regex matching fully-qualified columns, attributes, parameters. Use the pipe to separate several expressions.
includeExpression = ".*\\.IS_VALID"
}
}
}
}
}
See the configuration XSD and gradle code generation for more details.
// The jOOQ-codegen-gradle plugin has been introduced in version 3.19. // Please use the official plugin instead of the third party plugin that was recommended before.
After such a data type rewrite, neither jOOQ's code generator, nor the runtime have any information about the original data type that your column may have had. Hence, this approach works best when the original data type (e.g. INTEGER), and the configured data type (e.g. BIGINT) are reasonably compatible. If you wish to "rewrite" your user type, but keeping the backing type information available, an actual Converter, including an AutoConverter might be a better choice.
For more details about how to match columns, please refer to the section about matching columns for forced types.
References to this page
Feedback
Do you have any feedback about this page? We'd love to hear it!