Jakarta EE 11.0.0 · jakarta.persistence.JoinTable · APIdia, the JavaDoc alternative

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.

Method Summary

Modifier and Type	Method and Description
public String	catalog() (Optional) The catalog of the table.
public CheckConstraint[]	check() (Optional) Check constraints to be applied to the table.
public String	comment() (Optional) A comment to be applied to the table.
public 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.
public Index[]	indexes() (Optional) Indexes for the table.
public 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.
public 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.
public JoinColumn[]	joinColumns() (Optional) The foreign key columns of the join table which reference the primary table of the entity owning the association.
public String	name() (Optional) The name of the join table.
public String	options() (Optional) A SQL fragment appended to the generated DDL statement which creates this table.
public String	schema() (Optional) The schema of the table.
public UniqueConstraint[]	uniqueConstraints() (Optional) Unique constraints to be placed on the table.

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

Method Detail

catalog	back to summary
public String catalog() (Optional) The catalog of the table. Defaults to the default catalog.

catalog

back to summary

public String catalog()

(Optional) The catalog of the table.

Defaults to the default catalog.

check	back to summary
public CheckConstraint[] check() (Optional) Check constraints to be applied to the table. These are only used if table generation is in effect. Since 3.2

check

back to summary

public CheckConstraint[] check()

(Optional) Check constraints to be applied to the table. These are only used if table generation is in effect.

Since: 3.2

comment	back to summary
public String comment() (Optional) A comment to be applied to the table. This is only used if table generation is in effect. Since 3.2

comment

back to summary

public String comment()

(Optional) A comment to be applied to the table. This is only used if table generation is in effect.

Since: 3.2

foreignKey back to summary

foreignKey	back to summary
public 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. Since 2.1

public 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.

Since: 2.1

indexes	back to summary
public Index[] indexes() (Optional) Indexes for the table. These are only used if table generation is in effect. Since 2.1

indexes

back to summary

public Index[] indexes()

(Optional) Indexes for the table. These are only used if table generation is in effect.

Since: 2.1

inverseForeignKey back to summary

inverseForeignKey	back to summary
public 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. Since 2.1

public 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.

Since: 2.1

inverseJoinColumns back to summary

inverseJoinColumns	back to summary
public 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`.

public 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.

joinColumns back to summary

joinColumns	back to summary
public 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`.

public 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.

name	back to summary
public 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.

name

back to summary

public 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.

options	back to summary
public 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. Since 3.2

options

back to summary

public 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.

Since: 3.2

schema	back to summary
public String schema() (Optional) The schema of the table. Defaults to the default schema for user.

schema

back to summary

public String schema()

(Optional) The schema of the table.

Defaults to the default schema for user.

uniqueConstraints	back to summary
public 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.

uniqueConstraints

back to summary

public 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.

public @Interface JoinTable

Method Summary

Method Detail