Module jakarta.persistence

Package jakarta.persistence

Annotation Interface UniqueConstraint

@Target({})
@Retention(RUNTIME)
public @interface UniqueConstraint

Specifies that a unique constraint is to be included in the generated DDL for a primary or secondary table.

Example:

@Entity
@Table(
    name = "EMPLOYEE",
    uniqueConstraints = @UniqueConstraint(columnNames = {"EMP_ID", "EMP_NAME"})
)
public class Employee { ... }

Since:

1.0

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String[]	columnNames	(Required) The names of the column which make up the constraint.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	name	(Optional) The name of the constraint.
String	options	(Optional) A SQL fragment appended to the generated DDL which creates this constraint.

Element Details

name

String name

(Optional) The name of the constraint.

Defaults to a provider-generated name.

Since:

2.0

Default:

""

columnNames

String[] columnNames

(Required) The names of the column which make up the constraint.

options

String options

(Optional) A SQL fragment appended to the generated DDL which creates this constraint.

Since:

3.2

Default:

""