Jakarta Persistence (JPA) Annotation Type

jakarta.persistence.JoinTable

Implemented Interfaces:
Annotation
Target:
Method, Field
Specifies the mapping of an association to an intermediate join table. It is applied to the owning side of an association.

A join table is typically used in the mapping of many-to-many and unidirectional one-to-many associations. It may also be used to map bidirectional many-to-one/one-to-many associations, unidirectional many-to-one relationships, and one-to-one associations (both bidirectional and unidirectional).

When a join table is used in mapping a relationship with an embeddable class on the owning side of the relationship, the containing entity rather than the embeddable class is considered the owner of the relationship.

If the JoinTable annotation is missing, the default values of the annotation elements apply. The name of the join table is assumed to be the table names of the associated primary tables concatenated together (owning side first) using an underscore.

Example: 

 @JoinTable(
     name = "CUST_PHONE",
     joinColumns = @JoinColumn(name = "CUST_ID", referencedColumnName = "ID"),
     inverseJoinColumns = @JoinColumn(name = "PHONE_ID", referencedColumnName = "ID"))

This annotation may not be applied to a persistent field or property not annotated ManyToOne, OneToOne, ManyToMany, or OneToMany.

See Also:
Since:
Jakarta Persistence (JPA) 1.0

Annotation Elements

String name
(Optional) The name of the join table.

Defaults to the concatenated names of the two associated primary entity tables, separated by an underscore.

Default:
""
Since:
Jakarta Persistence (JPA) 1.0
String catalog
(Optional) The catalog of the table.

Defaults to the default catalog.

Default:
""
Since:
Jakarta Persistence (JPA) 1.0
String schema
(Optional) The schema of the table.

Defaults to the default schema for user.

Default:
""
Since:
Jakarta Persistence (JPA) 1.0
JoinColumn[] joinColumns
(Optional) The foreign key columns of the join table which reference the primary table of the entity owning the association.
(I.e. the owning side of the association).

Uses the same defaults as for JoinColumn.

Default:
{}
Since:
Jakarta Persistence (JPA) 1.0
JoinColumn[] inverseJoinColumns
(Optional) The foreign key columns of the join table which reference the primary table of the entity that does not own the association.
(I.e. the inverse side of the association).

Uses the same defaults as for JoinColumn.

Default:
{}
Since:
Jakarta Persistence (JPA) 1.0
ForeignKey foreignKey
(Optional) Used to specify or control the generation of a foreign key constraint for the columns corresponding to the joinColumns element when table generation is in effect.
If both this element and the foreignKey element of any of the joinColumns elements are specified, the behavior is undefined. If no foreign key annotation element is specified in either location, a default foreign key strategy is selected by the persistence provider.
Default:
@ForeignKey(ConstraintMode.PROVIDER_DEFAULT)
Since:
Jakarta Persistence (JPA) 2.1
ForeignKey inverseForeignKey
(Optional) Used to specify or control the generation of a foreign key constraint for the columns corresponding to the inverseJoinColumns element when table generation is in effect.
If both this element and the foreignKey element of any of the inverseJoinColumns elements are specified, the behavior is undefined. If no foreign key annotation element is specified in either location, a default foreign key strategy is selected by the persistence provider.
Default:
@ForeignKey(ConstraintMode.PROVIDER_DEFAULT)
Since:
Jakarta Persistence (JPA) 2.1
UniqueConstraint[] uniqueConstraints
(Optional) Unique constraints to be placed on the table.
These are only used if table generation is in effect.

Defaults to no additional constraints.

Default:
{}
Since:
Jakarta Persistence (JPA) 1.0
Index[] indexes
(Optional) Indexes for the table.
These are only used if table generation is in effect.
Default:
{}
Since:
Jakarta Persistence (JPA) 2.1
CheckConstraint[] check
(Optional) Check constraints to be applied to the table.
These are only used if table generation is in effect.
Default:
{}
Since:
Jakarta Persistence (JPA) 3.2
String comment
(Optional) A comment to be applied to the table.
This is only used if table generation is in effect.
Default:
""
Since:
Jakarta Persistence (JPA) 3.2
String options
(Optional) A SQL fragment appended to the generated DDL statement which creates this table.
This is only used if table generation is in effect.
Default:
""
Since:
Jakarta Persistence (JPA) 3.2

Additional JDK methods inherited from java.lang.annotation.Annotation

annotationType(), equals(Object), hashCode(), toString()