Field replacement
Applies to ❌ Open Source Edition ✅ Express Edition ✅ Professional Edition ✅ Enterprise Edition
A previous section explained how embeddable types work in general. In most cases, in the presence of an embeddable type, the original fields are no longer interesting in most queries, so you will want to replace them by the embeddable.
Assuming we have again a TRANSACTIONS table like this:
CREATE TABLE transactions ( id BIGINT NOT NULL PRIMARY KEY, create_date TIMESTAMP NOT NULL, modified_date TIMESTAMP, created_by VARCHAR(100) NOT NULL, modified_by VARCHAR(100) NOT NULL, -- Other columns here amount DECIMAL(18, 2) NOT NULL, currency VARCHAR(10) NOT NULL );
With the previous embeddable type definitions, and a <replacesFields/> flag like this:
<configuration>
<generator>
<database>
<embeddables>
<embeddable>
<name>MONETARY_AMOUNT</name>
<fields>
<field><expression>AMOUNT</expression></field>
<field><expression>CURRENCY</expression></field>
</fields>
<replacesFields>true</replacesFields>
</embeddable>
</embeddables>
</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()
.withEmbeddables(
new EmbeddableDefinitionType()
.withName("MONETARY_AMOUNT")
.withFields(
new EmbeddableField()
.withExpression("AMOUNT"),
new EmbeddableField()
.withExpression("CURRENCY")
)
.withReplacesFields(true)
)
)
)
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 {
embeddables {
embeddable {
name = "MONETARY_AMOUNT"
fields {
field {
expression = "AMOUNT"
}
field {
expression = "CURRENCY"
}
}
replacesFields = true
}
}
}
}
}
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.
... we would get a table that looks like this:
public class Transactions extends TableImpl<TransactionsRecord> {
// Field initialisations omitted for simplicity
// The AUDIT embeddable and its physical fields that it represents, but the fields are not accessible
private TableField<TransactionsRecord, Integer> ID;
private TableField<TransactionsRecord, Timestamp> CREATED_AT;
private TableField<TransactionsRecord, Timestamp> MODIFIED_AT;
private TableField<TransactionsRecord, String> CREATED_BY;
private TableField<TransactionsRecord, String> MODIFIED_BY;
public TableField<TransactionsRecord, AuditRecord> AUDIT_REFERENCE;
// The MONETARY_AMOUNT embeddable and its physical fields that it represents , but the fields are not accessible
private TableField<TransactionsRecord, BigDecimal> AMOUNT;
private TableField<DRecord, String> CURRENCY;
public TableField<DRecord, MonetaryAmountRecord> MONETARY_AMOUNT;
Not only are the fields no longer accessible (which means we cannot use them directly, nor do they get in the way with auto completion, etc.), but we also don't get the fields anymore when using SELECT * queries.
This flag is turned on when using embedded keys or embedded domains, where the original field reference is undesired.
Feedback
Do you have any feedback about this page? We'd love to hear it!