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
Input catalogs and schemas
Supported by ✅ Open Source Edition ✅ Express Edition ✅ Professional Edition ✅ Enterprise Edition
By default, the code generator will access all catalogs and all schemas that are available to it via the system catalog / information schema / dictionary views, or whatever it's called in your target RDBMS. This may produce too many unwanted generated objects, including unwanted system objects. To reduce generation scope, it is possible to specify input catalogs and input schemas.
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.
// 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 {
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.
// 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 {
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.
// 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 {
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.
// 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 {
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.
// 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 {
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.
// 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 {
catalogs {
catalog {
inputCatalog = "catalog"
schemata {
schema {
inputSchema = "schema1"
}
schema {
inputSchema = "schema2"
}
}
}
}
}
}
}
See the configuration XSD and gradle code generation for more details.
All of these input schemas and catalogs can be mapped to alternative names, or to defaults. For more information about this, please refer to the section about code generation catalog and schema mapping.
Feedback
Do you have any feedback about this page? We'd love to hear it!