Package jakarta.persistence
Annotation Type EmbeddedId
-
@Target({METHOD,FIELD}) @Retention(RUNTIME) public @interface EmbeddedId
Applied to a persistent field or property of an entity class or mapped superclass to denote a composite primary key that is an embeddable class. The embeddable class must be annotated asEmbeddable.There must be only one
EmbeddedIdannotation and noIdannotation when theEmbeddedIdannotation is used.The
AttributeOverrideannotation may be used to override the column mappings declared within the embeddable class.The
MapsIdannotation may be used in conjunction with theEmbeddedIdannotation to specify a derived primary key.If the entity has a derived primary key, the
AttributeOverrideannotation may only be used to override those attributes of the embedded id that do not correspond to the relationship to the parent entity.Relationship mappings defined within an embedded id class are not supported.
Example 1: @EmbeddedId protected EmployeePK empPK; Example 2: @Embeddable public class DependentId { String name; EmployeeId empPK; // corresponds to primary key type of Employee } @Entity public class Dependent { // default column name for "name" attribute is overridden @AttributeOverride(name="name", @Column(name="dep_name")) @EmbeddedId DependentId id; ... @MapsId("empPK") @ManyToOne Employee emp; }- Since:
- 1.0
- See Also:
Embeddable,MapsId