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.
Catalog and schema mapping
Applies to ✅ Open Source Edition ✅ Express Edition ✅ Professional Edition ✅ Enterprise Edition
These configuration elements combine two features in one:
- They allow for specifying one or more catalogs (default: all catalogs) as well as one or more schemas (default: all schemas) for inclusion in the code generator. This works in a similar fashion as the includes and excludes elements, but it is applied on an earlier stage.
- Once all "input" catalogs and schemas are specified, they can each be associated with a matching "output" catalog or schema, in case of which the "input" will be mapped to the "output" by the code generator. For more details about this, please refer to the manual section about schema mapping.
There are two ways to operate "input" and "output" catalogs and schemas configurations: "top level" and "nested". Note that catalogs are only supported in very few databases, so usually, users will only use the "input" and "output" schema feature.
Top level configurations
This mode is preferrable for small projects or quick tutorials, where only a single catalog and a/or a single schema need to be generated. In this case, the following "top level" configuration elements can be applied:
Read only a single schema (from all catalogs, but in most databases, there is only one "default catalog")
<configuration>
<generator>
<database>
<inputSchema>my_schema</inputSchema>
</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()
.withInputSchema("my_schema")
)
)
See the configuration XSD and programmatic code generation for more details.
import org.jooq.meta.jaxb.*
configuration {
generator {
database {
inputSchema = "my_schema"
}
}
}
See the configuration XSD and gradle code generation for more details.
configuration {
generator {
database {
inputSchema = "my_schema"
}
}
}
See the configuration XSD and gradle code generation for more details.
generationTool {
generator {
database {
inputSchema = "my_schema"
}
}
}
See the configuration XSD and gradle code generation for more details.
Read only a single catalog and all its schemas
<configuration>
<generator>
<database>
<inputCatalog>my_catalog</inputCatalog>
</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()
.withInputCatalog("my_catalog")
)
)
See the configuration XSD and programmatic code generation for more details.
import org.jooq.meta.jaxb.*
configuration {
generator {
database {
inputCatalog = "my_catalog"
}
}
}
See the configuration XSD and gradle code generation for more details.
configuration {
generator {
database {
inputCatalog = "my_catalog"
}
}
}
See the configuration XSD and gradle code generation for more details.
generationTool {
generator {
database {
inputCatalog = "my_catalog"
}
}
}
See the configuration XSD and gradle code generation for more details.
Read only a single catalog and only a single schema
<configuration>
<generator>
<database>
<inputCatalog>my_catalog</inputCatalog>
<inputSchema>my_schema</inputSchema>
</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()
.withInputCatalog("my_catalog")
.withInputSchema("my_schema")
)
)
See the configuration XSD and programmatic code generation for more details.
import org.jooq.meta.jaxb.*
configuration {
generator {
database {
inputCatalog = "my_catalog"
inputSchema = "my_schema"
}
}
}
See the configuration XSD and gradle code generation for more details.
configuration {
generator {
database {
inputCatalog = "my_catalog"
inputSchema = "my_schema"
}
}
}
See the configuration XSD and gradle code generation for more details.
generationTool {
generator {
database {
inputCatalog = "my_catalog"
inputSchema = "my_schema"
}
}
}
See the configuration XSD and gradle code generation for more details.
Nested configurations
This mode is preferrable for larger projects where several catalogs and/or schemas need to be included. The following examples show different possible configurations:
Read two or more schemas (from all catalogs, but in most databases, there is only one "default catalog")
<configuration>
<generator>
<database>
<schemata>
<schema>
<inputSchema>schema1</inputSchema>
</schema>
<schema>
<inputSchema>schema2</inputSchema>
</schema>
</schemata>
</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()
.withSchemata(
new SchemaMappingType()
.withInputSchema("schema1"),
new SchemaMappingType()
.withInputSchema("schema2")
)
)
)
See the configuration XSD and programmatic code generation for more details.
import org.jooq.meta.jaxb.*
configuration {
generator {
database {
schemata {
schema {
inputSchema = "schema1"
}
schema {
inputSchema = "schema2"
}
}
}
}
}
See the configuration XSD and gradle code generation for more details.
configuration {
generator {
database {
schemata {
schema {
inputSchema = "schema1"
}
schema {
inputSchema = "schema2"
}
}
}
}
}
See the configuration XSD and gradle code generation for more details.
generationTool {
generator {
database {
schemata {
schema {
inputSchema = "schema1"
}
schema {
inputSchema = "schema2"
}
}
}
}
}
See the configuration XSD and gradle code generation for more details.
Read two or more catalogs and all their schemas
<configuration>
<generator>
<database>
<catalogs>
<catalog>
<inputCatalog>catalog1</inputCatalog>
</catalog>
<catalog>
<inputCatalog>catalog2</inputCatalog>
</catalog>
</catalogs>
</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()
.withCatalogs(
new CatalogMappingType()
.withInputCatalog("catalog1"),
new CatalogMappingType()
.withInputCatalog("catalog2")
)
)
)
See the configuration XSD and programmatic code generation for more details.
import org.jooq.meta.jaxb.*
configuration {
generator {
database {
catalogs {
catalog {
inputCatalog = "catalog1"
}
catalog {
inputCatalog = "catalog2"
}
}
}
}
}
See the configuration XSD and gradle code generation for more details.
configuration {
generator {
database {
catalogs {
catalog {
inputCatalog = "catalog1"
}
catalog {
inputCatalog = "catalog2"
}
}
}
}
}
See the configuration XSD and gradle code generation for more details.
generationTool {
generator {
database {
catalogs {
catalog {
inputCatalog = "catalog1"
}
catalog {
inputCatalog = "catalog2"
}
}
}
}
}
See the configuration XSD and gradle code generation for more details.
Read two or more schemas from one or more specific catalogs
<configuration>
<generator>
<database>
<catalogs>
<catalog>
<inputCatalog>catalog</inputCatalog>
<schemata>
<schema>
<inputSchema>schema1</inputSchema>
</schema>
<schema>
<inputSchema>schema2</inputSchema>
</schema>
</schemata>
</catalog>
</catalogs>
</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()
.withCatalogs(
new CatalogMappingType()
.withInputCatalog("catalog")
.withSchemata(
new SchemaMappingType()
.withInputSchema("schema1"),
new SchemaMappingType()
.withInputSchema("schema2")
)
)
)
)
See the configuration XSD and programmatic code generation for more details.
import org.jooq.meta.jaxb.*
configuration {
generator {
database {
catalogs {
catalog {
inputCatalog = "catalog"
schemata {
schema {
inputSchema = "schema1"
}
schema {
inputSchema = "schema2"
}
}
}
}
}
}
}
See the configuration XSD and gradle code generation for more details.
configuration {
generator {
database {
catalogs {
catalog {
inputCatalog = "catalog"
schemata {
schema {
inputSchema = "schema1"
}
schema {
inputSchema = "schema2"
}
}
}
}
}
}
}
See the configuration XSD and gradle code generation for more details.
generationTool {
generator {
database {
catalogs {
catalog {
inputCatalog = "catalog"
schemata {
schema {
inputSchema = "schema1"
}
schema {
inputSchema = "schema2"
}
}
}
}
}
}
}
See the configuration XSD and gradle code generation for more details.
Catalog and schema mapping
Wherever you can place an inputCatalog or inputSchema element (top level or nested), you can also put a matching mapping instruction, if you wish to profit from the catalog and schema mapping feature. The following configurations are possible:
Map input names to a specific output name
<configuration>
<generator>
<database>
<inputCatalog>my_input_catalog</inputCatalog>
<outputCatalog>my_output_catalog</outputCatalog>
<inputSchema>my_input_schema</inputSchema>
<outputSchema>my_output_schema</outputSchema>
</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()
.withInputCatalog("my_input_catalog")
.withOutputCatalog("my_output_catalog")
.withInputSchema("my_input_schema")
.withOutputSchema("my_output_schema")
)
)
See the configuration XSD and programmatic code generation for more details.
import org.jooq.meta.jaxb.*
configuration {
generator {
database {
inputCatalog = "my_input_catalog"
outputCatalog = "my_output_catalog"
inputSchema = "my_input_schema"
outputSchema = "my_output_schema"
}
}
}
See the configuration XSD and gradle code generation for more details.
configuration {
generator {
database {
inputCatalog = "my_input_catalog"
outputCatalog = "my_output_catalog"
inputSchema = "my_input_schema"
outputSchema = "my_output_schema"
}
}
}
See the configuration XSD and gradle code generation for more details.
generationTool {
generator {
database {
inputCatalog = "my_input_catalog"
outputCatalog = "my_output_catalog"
inputSchema = "my_input_schema"
outputSchema = "my_output_schema"
}
}
}
See the configuration XSD and gradle code generation for more details.
Map input names to the "default" catalog or schema (i.e. no name)
<configuration>
<generator>
<database>
<inputCatalog>my_input_catalog</inputCatalog>
<outputCatalogToDefault>true</outputCatalogToDefault>
<inputSchema>my_input_schema</inputSchema>
<outputSchemaToDefault>true</outputSchemaToDefault>
</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()
.withInputCatalog("my_input_catalog")
.withOutputCatalogToDefault(true)
.withInputSchema("my_input_schema")
.withOutputSchemaToDefault(true)
)
)
See the configuration XSD and programmatic code generation for more details.
import org.jooq.meta.jaxb.*
configuration {
generator {
database {
inputCatalog = "my_input_catalog"
isOutputCatalogToDefault = true
inputSchema = "my_input_schema"
isOutputSchemaToDefault = true
}
}
}
See the configuration XSD and gradle code generation for more details.
configuration {
generator {
database {
inputCatalog = "my_input_catalog"
outputCatalogToDefault = true
inputSchema = "my_input_schema"
outputSchemaToDefault = true
}
}
}
See the configuration XSD and gradle code generation for more details.
generationTool {
generator {
database {
inputCatalog = "my_input_catalog"
outputCatalogToDefault = true
inputSchema = "my_input_schema"
outputSchemaToDefault = true
}
}
}
See the configuration XSD and gradle code generation for more details.
For more information about the catalog and schema mapping feature, please refer to the relevant section of the manual.
Feedback
Do you have any feedback about this page? We'd love to hear it!