Hibernate ORM - hibernate-core 6.4.4.Final · org.hibernate.annotations.Generated

Specifies that the value of the annotated property is generated by the database. The generated value will be automatically retrieved using a SQL select after it is generated.

@Generated relieves the program of the need to explicitly call refresh() to synchronize state held in memory with state generated by the database when a SQL insert or update is executed.

This is most useful when:

a database table has a column value populated by a database trigger,
a mapped column has a default value defined in DDL, in which case @Generated is used in conjunction with ColumnDefault,
a SQL expression is used to compute the value of a mapped column, or
when a custom SQL insert or update statement specified by an entity assigns a value to the annotated property of the entity, or transforms the value currently assigned to the annotated property.

On the other hand:

for identity/autoincrement columns mapped to an identifier property, use jakarta.persistence.GeneratedValue, and
for columns with a generated always as clause, prefer the GeneratedColumn annotation, so that Hibernate automatically generates the correct DDL.

Method Summary

Modifier and Type	Method and Description
public EventType[]	event() Specifies the events that cause the value to be generated by the database.
public String	sql() A SQL expression used to generate the value of the column mapped by the annotated property.
public GenerationTime	value() Deprecated since 6.2. use `event()` Specifies the events that cause the value to be generated by the database.
public boolean	Returns: `true` if the current value should be included in SQL `insert` and `update` statements. writable() Determines if the value currently assigned to the annotated property is included in SQL `insert` and `update` statements.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

event back to summary

event	back to summary
public EventType[] event() Specifies the events that cause the value to be generated by the database. If `EventType#INSERT` is included, the generated value will be selected after each SQL `insert` statement is executed. If `EventType#UPDATE` is included, the generated value will be selected after each SQL `update` statement is executed.

public EventType[] event()

Specifies the events that cause the value to be generated by the database.

If EventType#INSERT is included, the generated value will be selected after each SQL insert statement is executed.
If EventType#UPDATE is included, the generated value will be selected after each SQL update statement is executed.

sql	back to summary
public String sql() A SQL expression used to generate the value of the column mapped by the annotated property. The expression is included in generated SQL `insert` and `update` statements.

value back to summary

value	back to summary
public GenerationTime value() Deprecated since 6.2. use `event()` Specifies the events that cause the value to be generated by the database. If `GenerationTime#INSERT`, the generated value will be selected after each SQL `insert` statement is executed. If `GenerationTime#UPDATE`, the generated value will be selected after each SQL `update` statement is executed. If `GenerationTime#ALWAYS`, the generated value will be selected after each SQL `insert` or `update` statement is executed. Annotations @Deprecated since:6.2

public GenerationTime value()

Deprecated

since 6.2.

use event()

Specifies the events that cause the value to be generated by the database.

If GenerationTime#INSERT, the generated value will be selected after each SQL insert statement is executed.
If GenerationTime#UPDATE, the generated value will be selected after each SQL update statement is executed.
If GenerationTime#ALWAYS, the generated value will be selected after each SQL insert or update statement is executed.

Annotations

@Deprecated
since:6.2

writable back to summary

writable	back to summary
public boolean writable() Determines if the value currently assigned to the annotated property is included in SQL `insert` and `update` statements. This is useful if the generated value is obtained by transforming the assigned property value as it is being written. Often used in combination with `SQLInsert`, `SQLUpdate`, or `ColumnTransformer#write()`. Returns:boolean `true` if the current value should be included in SQL `insert` and `update` statements.

public boolean writable()

Determines if the value currently assigned to the annotated property is included in SQL insert and update statements. This is useful if the generated value is obtained by transforming the assigned property value as it is being written.

Often used in combination with SQLInsert, SQLUpdate, or ColumnTransformer#write().

Returns:boolean: true if the current value should be included in SQL insert and update statements.

public @Interface Generated

Method Summary

Method Detail