Compound keys in JPA

Question

I want to make an entity that has an autogenerated primary key, but also a unique compound key made up of two other fields. How do I do this in JPA?
I want to do this because the primary key should be used as foreign key in another table and making it compound would not be good.

In the following snippet, I need the command and model to be unique. pk is of course the primary key.

@Entity
@Table(name = "dm_action_plan")
public class ActionPlan {
    @Id
    private int pk;
    @Column(name = "command", nullable = false)
    private String command;
    @Column(name = "model", nullable = false)
    String model;
}

What's the problem with using a compound key as a foreign key? — Tom Anderson, Apr 23 '11 at 10:33

score 19 · Accepted Answer · edited Jul 29 '16 at 09:51

19

You can use @UniqueConstraint something like this :

@Entity
@Table(name = "dm_action_plan",
       uniqueConstraints={ @UniqueConstraint(columnNames= "command","model") } )
public class ActionPlan {
    @Id
    private int pk;

    @Column(name = "command", nullable = false)
    private String command;

    @Column(name = "model", nullable = false)
    String model;
}

This will allow your JPA implementation to generate the DDL for the unique constraint.

edited Jul 29 '16 at 09:51

Steve McNail

3
3

answered Sep 18 '08 at 08:30

Michel

2,454
3
20
28

1

The correct form is like this: @Table(name = "dm_action_plan") @UniqueConstraint(columnNames = {"command", "model"}) – homaxto Sep 18 '08 at 09:01
homaxto: According to the EJB3.0 specification, Michel gave the right form. – Nicolas Sep 18 '08 at 09:13

score 1 · Answer 2 · answered Sep 18 '08 at 08:33

1

Use @GeneratedValue to indicate that the key will be generated and @UniqueConstraint to express unicity

@Entity
@Table(name = "dm_action_plan"
       uniqueConstraint = @UniqueConstraint({"command", "model"})
)
public class ActionPlan {
    @Id
    @GeneratedValue
    private int pk;
    @Column(name = "command", nullable = false)
    private String command;
    @Column(name = "model", nullable = false)
    String model;
}

answered Sep 18 '08 at 08:33

Nicolas

24,509
5
60
66

It will not create a compound constraint. It will create two constraints, each one for each column name that you annoted in @UniqueConstraint. – mannysz Jul 29 '11 at 19:38
1

Then your JPA implementation is wrong. JPA2 specification, §11.1.49 columnNames is "An array of the column names that make up the **constraint**" (constraint, not constraints). – Nicolas Jul 30 '11 at 06:43

Compound keys in JPA

2 Answers2

Linked