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.
Matching catalogs
Applies to ✅ Open Source Edition ✅ Express Edition ✅ Professional Edition ✅ Enterprise Edition
The following example shows how to define a MatcherStrategy for generated org.jooq.Catalog types and related objects:
<configuration>
<!-- These properties can be added directly to the generator element: -->
<generator>
<strategy>
<matchers>
<!-- Specify 0..n catalog matchers to provide a strategy for naming objects created from catalogs. -->
<catalogs>
<catalog>
<!-- Match unqualified or qualified catalog names. If left empty, this matcher applies to all catalogs. -->
<expression>MY_CATALOG</expression>
<!-- These elements influence the naming of a generated org.jooq.Catalog object. -->
<catalogClass> a MatcherRule specification </catalogClass>
<catalogIdentifier> a MatcherRule specification </catalogIdentifier>
<catalogExtends>com.example.MyOptionalCatalogBaseType</catalogExtends>
<catalogImplements>com.example.MyOptionalCustomInterface</catalogImplements>
</catalog>
</catalogs>
</matchers>
</strategy>
</generator>
</configuration>
See the configuration XSD, standalone code generation, and maven code generation for more details.
new org.jooq.meta.jaxb.Configuration()
// These properties can be added directly to the generator element:
.withGenerator(new Generator()
.withStrategy(new Strategy()
.withMatchers(new Matchers()
// Specify 0..n catalog matchers to provide a strategy for naming objects created from catalogs.
.withCatalogs(
new MatchersCatalogType()
// Match unqualified or qualified catalog names. If left empty, this matcher applies to all catalogs.
.withExpression("MY_CATALOG")
// These elements influence the naming of a generated org.jooq.Catalog object.
.withCatalogClass(MatcherRule. a MatcherRule specification )
.withCatalogIdentifier(MatcherRule. a MatcherRule specification )
.withCatalogExtends("com.example.MyOptionalCatalogBaseType")
.withCatalogImplements("com.example.MyOptionalCustomInterface")
)
)
)
)
See the configuration XSD and programmatic code generation for more details.
import org.jooq.meta.jaxb.*
configuration {
// These properties can be added directly to the generator element:
generator {
strategy {
matchers {
// Specify 0..n catalog matchers to provide a strategy for naming objects created from catalogs.
catalogs {
catalog {
// Match unqualified or qualified catalog names. If left empty, this matcher applies to all catalogs.
expression = "MY_CATALOG"
// These elements influence the naming of a generated org.jooq.Catalog object.
catalogClass = MatcherRule. a MatcherRule specification
catalogIdentifier = MatcherRule. a MatcherRule specification
catalogExtends = "com.example.MyOptionalCatalogBaseType"
catalogImplements = "com.example.MyOptionalCustomInterface"
}
}
}
}
}
}
See the configuration XSD and gradle code generation for more details.
configuration {
// These properties can be added directly to the generator element:
generator {
strategy {
matchers {
// Specify 0..n catalog matchers to provide a strategy for naming objects created from catalogs.
catalogs {
catalog {
// Match unqualified or qualified catalog names. If left empty, this matcher applies to all catalogs.
expression = "MY_CATALOG"
// These elements influence the naming of a generated org.jooq.Catalog object.
catalogClass = " a MatcherRule specification "
catalogIdentifier = " a MatcherRule specification "
catalogExtends = "com.example.MyOptionalCatalogBaseType"
catalogImplements = "com.example.MyOptionalCustomInterface"
}
}
}
}
}
}
See the configuration XSD and gradle code generation for more details.
generationTool {
// These properties can be added directly to the generator element:
generator {
strategy {
matchers {
// Specify 0..n catalog matchers to provide a strategy for naming objects created from catalogs.
catalogs {
catalog {
// Match unqualified or qualified catalog names. If left empty, this matcher applies to all catalogs.
expression = "MY_CATALOG"
// These elements influence the naming of a generated org.jooq.Catalog object.
catalogClass = " a MatcherRule specification "
catalogIdentifier = " a MatcherRule specification "
catalogExtends = "com.example.MyOptionalCatalogBaseType"
catalogImplements = "com.example.MyOptionalCustomInterface"
}
}
}
}
}
}
See the configuration XSD and gradle code generation for more details.
As always, when regular expressions are used, they are regular expressions with default flags.
When using anycatalogExtends, etc. setting, you must make sure to correctly implement the internal jOOQ APIs, which are not documented here for they are internal. In particular, if you're extendingorg.jooq.impl.TableImpl, for example, your custom base class may break between minor versions of jOOQ, as new constructors are added.
See MatcherRule for more information about MatcherRule specifications.
Feedback
Do you have any feedback about this page? We'd love to hear it!