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
XMLDatabase: Code generation from XML files
Applies to ✅ Open Source Edition ✅ Express Edition ✅ Professional Edition ✅ Enterprise Edition
By default, jOOQ's code generator takes live database connections as a database meta data source. In many project setups, this might not be optimal, as the live database is not always available.
One way to circumvent this issue is by providing jOOQ with a database meta definition file in XML format and by passing this XML file to jOOQ's XMLDatabase.
The XMLDatabase can read a standardised XML file that implements the https://www.jooq.org/xsd/jooq-meta-3.12.0.xsd schema. Essentially, this schema is an XML representation of the SQL standard INFORMATION_SCHEMA, as implemented by databases like H2, HSQLDB, MySQL, PostgreSQL, or SQL Server.
An example schema definition containing simple schema, table, column definitions can be seen below:
<?xml version="1.0"?>
<information_schema xmlns="http://www.jooq.org/xsd/jooq-meta-3.12.0.xsd">
<schemata>
<schema>
<schema_name>TEST</schema_name>
</schema>
</schemata>
<tables>
<table>
<table_schema>TEST</table_schema>
<table_name>AUTHOR</table_name>
</table>
<table>
<table_schema>TEST</table_schema>
<table_name>BOOK</table_name>
</table>
</tables>
<columns>
<column>
<table_schema>PUBLIC</table_schema>
<table_name>AUTHOR</table_name>
<column_name>ID</column_name>
<data_type>NUMBER</data_type>
<numeric_precision>7</numeric_precision>
<ordinal_position>1</ordinal_position>
<is_nullable>false</is_nullable>
</column>
<!-- ... -->
</columns>
</information_schema>
Constraints can be defined with the following elements:
<?xml version="1.0"?>
<information_schema xmlns="http://www.jooq.org/xsd/jooq-meta-3.12.0.xsd">
<table_constraints>
<table_constraint>
<constraint_schema>TEST</constraint_schema>
<constraint_name>PK_AUTHOR</constraint_name>
<constraint_type>PRIMARY KEY</constraint_type>
<table_schema>TEST</table_schema>
<table_name>AUTHOR</table_name>
</table_constraint>
<!-- ... -->
</table_constraints>
<key_column_usages>
<key_column_usage>
<constraint_schema>TEST</constraint_schema>
<constraint_name>PK_AUTHOR</constraint_name>
<table_schema>TEST</table_schema>
<table_name>AUTHOR</table_name>
<column_name>ID</column_name>
<ordinal_position>1</ordinal_position>
</key_column_usage>
<!-- ... -->
</key_column_usages>
<referential_constraints>
<referential_constraint>
<constraint_schema>TEST</constraint_schema>
<constraint_name>FK_BOOK_AUTHOR_ID</constraint_name>
<unique_constraint_schema>TEST</unique_constraint_schema>
<unique_constraint_name>PK_AUTHOR</unique_constraint_name>
</referential_constraint>
<!-- ... -->
</referential_constraints>
</information_schema>
The above file can be made available to the code generator configuration by using the XMLDatabase as follows:
<configuration>
<generator>
<database>
<name>org.jooq.meta.xml.XMLDatabase</name>
<properties>
<!-- Use any of the SQLDialect values here -->
<property>
<key>dialect</key>
<value>ORACLE</value>
</property>
<!-- Specify the location of your database file -->
<property>
<key>xmlFile</key>
<value>src/main/resources/database.xml</value>
</property>
</properties>
</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()
.withName("org.jooq.meta.xml.XMLDatabase")
.withProperties(
// Use any of the SQLDialect values here
new Property()
.withKey("dialect")
.withValue("ORACLE"),
// Specify the location of your database file
new Property()
.withKey("xmlFile")
.withValue("src/main/resources/database.xml")
)
)
)
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 {
generator {
database {
name = "org.jooq.meta.xml.XMLDatabase"
properties {
// Use any of the SQLDialect values here
property {
key = "dialect"
value = "ORACLE"
}
// Specify the location of your database file
property {
key = "xmlFile"
value = "src/main/resources/database.xml"
}
}
}
}
}
See the configuration XSD and gradle code generation for more details.
If you already have a different XML format for your database, you can either XSL transform your own format into the one above via an additional Maven plugin, or pass the location of an XSL file to the XMLDatabase by providing an additional property:
<configuration>
<generator>
<database>
<name>org.jooq.meta.xml.XMLDatabase</name>
<properties>
<!-- Specify the location of your xsl file -->
<property>
<key>xslFile</key>
<value>src/main/resources/transform-to-jooq-format.xsl</value>
</property>
</properties>
</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()
.withName("org.jooq.meta.xml.XMLDatabase")
.withProperties(
// Specify the location of your xsl file
new Property()
.withKey("xslFile")
.withValue("src/main/resources/transform-to-jooq-format.xsl")
)
)
)
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 {
generator {
database {
name = "org.jooq.meta.xml.XMLDatabase"
properties {
// Specify the location of your xsl file
property {
key = "xslFile"
value = "src/main/resources/transform-to-jooq-format.xsl"
}
}
}
}
}
See the configuration XSD and gradle code generation for more details.
This XML configuration can now be checked in and versioned, and modified independently from your live database schema.
Feedback
Do you have any feedback about this page? We'd love to hear it!