New versions: Dev (3.14) | Latest (3.13) | 3.12 | 3.11 | 3.10 | 3.9

Include object types

Applies to ✅ Open Source Edition   ✅ Express Edition   ✅ Professional Edition   ✅ Enterprise Edition

Sometimes, you want to generate only tables. Or only routines. Or you want to exclude them from being generated. Whatever the use-case, there's a way to do this with the following, additional includes flags:

XML configuration (standalone and Maven)

<configuration xmlns="http://www.jooq.org/xsd/jooq-codegen-3.13.0.xsd">
  <generator>
    <database>
      <includeTables>true</includeTables>
      <includeInvisibleColumns>true</includeInvisibleColumns>
      <includeEmbeddables>true</includeEmbeddables>
      <includeRoutines>true</includeRoutines>
      <includePackages>true</includePackages>
      <includePackageRoutines>true</includePackageRoutines>
      <includePackageUDTs>true</includePackageUDTs>
      <includePackageConstants>true</includePackageConstants>
      <includeUDTs>true</includeUDTs>
      <includeSequences>false</includeSequences>
      <includePrimaryKeys>false</includePrimaryKeys>
      <includeUniqueKeys>false</includeUniqueKeys>
      <includeForeignKeys>false</includeForeignKeys>
      <includeCheckConstraints>false</includeCheckConstraints>
      <includeSystemCheckConstraints>false</includeSystemCheckConstraints>
      <includeIndexes>false</includeIndexes>
      <includeSystemIndexes>false</includeSystemIndexes>
    </database>
  </generator>
</configuration>

Programmatic configuration

new org.jooq.meta.jaxb.Configuration()
  .withGenerator(new Generator(
    .withDatabase(new Database()
      .withIncludeTables(true)
      .withIncludeInvisibleColumns(true)
      .withIncludeEmbeddables(true)
      .withIncludeRoutines(true)
      .withIncludePackages(true)
      .withIncludePackageRoutines(true)
      .withIncludePackageUDTs(true)
      .withIncludePackageConstants(true)
      .withIncludeUDTs(true)
      .withIncludeSequences(false)
      .withIncludePrimaryKeys(false)
      .withIncludeUniqueKeys(false)
      .withIncludeForeignKeys(false)
      .withIncludeCheckConstraints(false)
      .withIncludeSystemCheckConstraints(false)
      .withIncludeIndexes(false)
      .withIncludeSystemIndexes(false))));

Gradle configuration

myConfigurationName(sourceSets.main) {
  generator {
    database {
      includeTables = true
      includeInvisibleColumns = true
      includeEmbeddables = true
      includeRoutines = true
      includeTriggerRoutines = false
      includePackages = true
      includePackageRoutines = true
      includePackageUDTs = true
      includePackageConstants = true
      includeUDTs = true
      includeSequences = false
      includePrimaryKeys = false
      includeUniqueKeys = false
      includeForeignKeys = false
      includeCheckConstraints = false
      includeSystemCheckConstraints = false
      includeIndexes = false
      includeSystemIndexes = false
    }
  }
}

By default, most of these flags are set to true, with the exception of:

  • includeTriggerRoutines: Some databases store triggers as special ROUTINE types in the schema. These routines are not meant to be called directly, by clients, which is why their inclusion in code generation is undesirable.
  • includeSystemCheckConstraints: Some databases produce auxiliary CHECK constraints for other constraints like NOT NULL constraints. The redundant information is usually undesirable, which is why these are turned off by default.
  • includeSystemIndexes: Some databases produce auxiliary INDEX objects for other constraints like FOREIGN KEY constraints. These indexes are not independent from the key, and the redundant information is usually undesirable, which is why these are turned off by default.
The jOOQ Logo