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 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.
Custom ordering of generated code
Applies to ✅ Open Source Edition ✅ Express Edition ✅ Professional Edition ✅ Enterprise Edition
By default, the jOOQ code generator maintains the following ordering of objects:
- Catalogs, schemas, tables, user-defined types, packages, routines, sequences, constraints are ordered alphabetically
- Table columns, user-defined type attributes, routine parameters are ordered in their order of definition
Sometimes, it may be desireable to override this default ordering to a custom ordering. In particular, the default ordering may be case-sensitive, when case-insensitive ordering is really more desireable at times. Users may define an order provider by specifying a fully qualified class on the code generator's class path, which must implement java.util.Comparator<org.jooq.meta.Definition> as follows:
<configuration>
<generator>
<database>
<orderProvider>com.example.CaseInsensitiveOrderProvider</orderProvider>
</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()
.withOrderProvider("com.example.CaseInsensitiveOrderProvider")
)
)
See the configuration XSD and programmatic code generation for more details.
import org.jooq.meta.jaxb.*
configuration {
generator {
database {
orderProvider = "com.example.CaseInsensitiveOrderProvider"
}
}
}
See the configuration XSD and gradle code generation for more details.
configuration {
generator {
database {
orderProvider = "com.example.CaseInsensitiveOrderProvider"
}
}
}
See the configuration XSD and gradle code generation for more details.
generationTool {
generator {
database {
orderProvider = "com.example.CaseInsensitiveOrderProvider"
}
}
}
See the configuration XSD and gradle code generation for more details.
Make sure your custom order provider is available to the code generator as a code generator dependency
This order provider may then look as follows:
package com.example;
import java.util.Comparator;
import org.jooq.meta.Definition;
public class CaseInsensitiveOrderProvider implements Comparator<Definition> {
@Override
public int compare(Definition o1, Definition o2) {
return o1.getQualifiedInputName().compareToIgnoreCase(o2.getQualifiedInputName());
}
}
While changing the order of "top level types" (like tables) is irrelevant to the jOOQ runtime, there may be some side-effects to changing the order of table columns, user-defined type attributes, routine parameters, as the database might expect the exact same order as is defined in the database. In order to only change the ordering for tables, the following order provider can be implemented instead:
package com.example;
import java.util.Comparator;
import org.jooq.meta.Definition;
import org.jooq.meta.TableDefinition;
public class CaseInsensitiveOrderProvider implements Comparator<Definition> {
@Override
public int compare(Definition o1, Definition o2) {
if (o1 instanceof TableDefinition && o2 instanceof TableDefinition)
return o1.getQualifiedInputName().compareToIgnoreCase(o2.getQualifiedInputName());
else
return 0; // Retain input ordering
}
}
Feedback
Do you have any feedback about this page? We'd love to hear it!