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
Catalog and schema version providers
Applies to ✅ Open Source Edition ✅ Express Edition ✅ Professional Edition ✅ Enterprise Edition
For continuous integration reasons, users often like to version their database schemas, e.g. with tools like Flyway. In these cases, it is usually beneficial if the catalog and/or schema version can be placed with generated jOOQ code for documentation purposes and to prevent unnecessary re-generation of a catalog and/or schema.
For this reason, jOOQ allows for implementing a simple code generation SPI which tells jOOQ what the user-defined version of any given catalog or schema is.
There are three possible ways to implement this SPI:
- By providing a fully qualified class name that implements any of
org.jooq.meta.CatalogVersionProviderororg.jooq.meta.SchemaVersionProviderrespectively for programmatic version providing. - By providing a
SELECTstatement returning one row with one column containing the version string. TheSELECTstatement may contain a named variable called:catalog_nameor:schema_namerespectively. - By providing a constant, such as a Maven property, for instance.
These schema versions will be generated into the javax.annotation.Generated annotation on generated artefacts.
Example: fully qualified class name
This example is assuming that you have version provider classes on your code generation classpath available:
<configuration>
<generator>
<database>
<catalogVersionProvider>com.example.MyCatalogVersionProvider</catalogVersionProvider>
<schemaVersionProvider>com.example.MySchemaVersionProvider</schemaVersionProvider>
</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()
.withCatalogVersionProvider("com.example.MyCatalogVersionProvider")
.withSchemaVersionProvider("com.example.MySchemaVersionProvider")
)
)
See the configuration XSD and programmatic code generation for more details.
import org.jooq.meta.jaxb.*
configuration {
generator {
database {
catalogVersionProvider = "com.example.MyCatalogVersionProvider"
schemaVersionProvider = "com.example.MySchemaVersionProvider"
}
}
}
See the configuration XSD and gradle code generation for more details.
configuration {
generator {
database {
catalogVersionProvider = "com.example.MyCatalogVersionProvider"
schemaVersionProvider = "com.example.MySchemaVersionProvider"
}
}
}
See the configuration XSD and gradle code generation for more details.
generationTool {
generator {
database {
catalogVersionProvider = "com.example.MyCatalogVersionProvider"
schemaVersionProvider = "com.example.MySchemaVersionProvider"
}
}
}
See the configuration XSD and gradle code generation for more details.
Make sure your custom version providers are available to the code generator as a code generator dependency
<configuration>
<generator>
<database>
<catalogVersionProvider>SELECT :catalog_name || '_' || MAX("version") FROM "schema_version"</catalogVersionProvider>
<schemaVersionProvider>SELECT :schema_name || '_' || MAX("version") FROM "schema_version"</schemaVersionProvider>
</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()
.withCatalogVersionProvider("SELECT :catalog_name || '_' || MAX(\"version\") FROM \"schema_version\"")
.withSchemaVersionProvider("SELECT :schema_name || '_' || MAX(\"version\") FROM \"schema_version\"")
)
)
See the configuration XSD and programmatic code generation for more details.
import org.jooq.meta.jaxb.*
configuration {
generator {
database {
catalogVersionProvider = "SELECT :catalog_name || '_' || MAX(\"version\") FROM \"schema_version\""
schemaVersionProvider = "SELECT :schema_name || '_' || MAX(\"version\") FROM \"schema_version\""
}
}
}
See the configuration XSD and gradle code generation for more details.
configuration {
generator {
database {
catalogVersionProvider = "SELECT :catalog_name || '_' || MAX(\"version\") FROM \"schema_version\""
schemaVersionProvider = "SELECT :schema_name || '_' || MAX(\"version\") FROM \"schema_version\""
}
}
}
See the configuration XSD and gradle code generation for more details.
generationTool {
generator {
database {
catalogVersionProvider = "SELECT :catalog_name || '_' || MAX(\"version\") FROM \"schema_version\""
schemaVersionProvider = "SELECT :schema_name || '_' || MAX(\"version\") FROM \"schema_version\""
}
}
}
See the configuration XSD and gradle code generation for more details.
Example: A constant
Instead of supplying the constant directly in your configuration, you can also use your build system's property expression, or some other mechanism to produce this constant.
<configuration>
<generator>
<database>
<catalogVersionProvider>1</catalogVersionProvider>
<schemaVersionProvider>2</schemaVersionProvider>
</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()
.withCatalogVersionProvider(1)
.withSchemaVersionProvider(2)
)
)
See the configuration XSD and programmatic code generation for more details.
import org.jooq.meta.jaxb.*
configuration {
generator {
database {
catalogVersionProvider = 1
schemaVersionProvider = 2
}
}
}
See the configuration XSD and gradle code generation for more details.
configuration {
generator {
database {
catalogVersionProvider = 1
schemaVersionProvider = 2
}
}
}
See the configuration XSD and gradle code generation for more details.
generationTool {
generator {
database {
catalogVersionProvider = 1
schemaVersionProvider = 2
}
}
}
See the configuration XSD and gradle code generation for more details.
Feedback
Do you have any feedback about this page? We'd love to hear it!