Top Description Methods
jakarta.persistence

public @Interface JoinColumn

extends Annotation
Annotations
@Repeatable:JoinColumns
@Target:METHOD, FIELD
@Retention:RUNTIME
Imports
java.lang.annotation.Repeatable, .Target, .Retention
Specifies a column for joining an entity association or element collection. If the JoinColumn annotation itself is defaulted, a single join column is assumed and the default values apply.

Example:

@ManyToOne @JoinColumn(name = "ADDR_ID") public Address getAddress() { return address; } 
@ManyToOne
@JoinColumn(name = "ADDR_ID")
public Address getAddress() { return address; }

Example: unidirectional one-to-many association using a foreign key mapping

// In Customer class @OneToMany @JoinColumn(name = "CUST_ID") // join column is in the table for Order public Set<Order> getOrders() { return orders; } 
// In Customer class
@OneToMany
@JoinColumn(name = "CUST_ID") // join column is in the table for Order
public Set<Order> getOrders() { return orders; }
Since
1.0
See Also
ManyToOne, OneToMany, OneToOne, JoinTable, CollectionTable, ForeignKey

Method Summary

Modifier and TypeMethod and Description
public CheckConstraint[]
check()

(Optional) Check constraints to be applied to the column.

public String
columnDefinition()

(Optional) The SQL fragment that is used when generating the DDL for the column.

public String
comment()

(Optional) A comment to be applied to the column.

public ForeignKey
foreignKey()

(Optional) Used to specify or control the generation of a foreign key constraint when table generation is in effect.

public boolean
insertable()

(Optional) Whether the column is included in SQL INSERT statements generated by the persistence provider.

public String
name()

(Optional) The name of the foreign key column.

public boolean
nullable()

(Optional) Whether the foreign key column is nullable.

public String
options()

(Optional) A SQL fragment appended to the generated DDL which declares this column.

public String
referencedColumnName()

(Optional) The name of the column referenced by this foreign key column.

public String
table()

(Optional) The name of the table that contains the column.

public boolean
unique()

(Optional) Whether the property is a unique key.

public boolean
updatable()

(Optional) Whether the column is included in SQL UPDATE statements generated by the persistence provider.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

checkback to summary
public CheckConstraint[] check()

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

Since
3.2
columnDefinitionback to summary
public String columnDefinition()

(Optional) The SQL fragment that is used when generating the DDL for the column.

Defaults to the generated SQL for the column.

commentback to summary
public String comment()

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

Since
3.2
foreignKeyback to summary
public ForeignKey foreignKey()

(Optional) Used to specify or control the generation of a foreign key constraint when table generation is in effect. If this element is not specified, a default foreign key strategy is selected by the persistence provider.

Since
2.1
insertableback to summary
public boolean insertable()

(Optional) Whether the column is included in SQL INSERT statements generated by the persistence provider.

nameback to summary
public String name()

(Optional) The name of the foreign key column.

The table in which this column is found depends on the context.

  • If the join is for a OneToOne or ManyToOne mapping using a foreign key mapping strategy, the foreign key column is in the table of the source entity or embeddable.
  • If the join is for a unidirectional OneToMany mapping using a foreign key mapping strategy, the foreign key is in the table of the target entity.
  • If the join is for a ManyToMany mapping or for a OneToOne or bidirectional ManyToOne/OneToMany mapping using a join table, the foreign key is in a join table.
  • If the join is for an ElementCollection, the foreign key is in a collection table.

Default (only applies if a single join column is used): The concatenation of the following: the name of the referencing relationship property or field of the referencing entity or embeddable class; "_"; the name of the referenced primary key column. If there is no such referencing relationship property or field in the entity, or if the join is for an element collection, the join column name is formed as the concatenation of the following: the name of the entity; "_"; the name of the referenced primary key column.

nullableback to summary
public boolean nullable()

(Optional) Whether the foreign key column is nullable.

optionsback to summary
public String options()

(Optional) A SQL fragment appended to the generated DDL which declares this column. May not be used in conjunction with columnDefinition().

Since
3.2
referencedColumnNameback to summary
public String referencedColumnName()

(Optional) The name of the column referenced by this foreign key column.

  • When used with entity relationship mappings other than the cases described here, the referenced column is in the table of the target entity.
  • When used with a unidirectional OneToMany foreign key mapping, the referenced column is in the table of the source entity.
  • When used inside a JoinTable annotation, the referenced key column is in the entity table of the owning entity, or inverse entity if the join is part of the inverse join definition.
  • When used in a CollectionTable mapping, the referenced column is in the table of the entity containing the collection.

Default (only applies if single join column is being used): The same name as the primary key column of the referenced table.

tableback to summary
public String table()

(Optional) The name of the table that contains the column. If a table is not specified, the column is assumed to be in the primary table of the applicable entity.

Default:

  • If the join is for a OneToOne or ManyToOne mapping using a foreign key mapping strategy, the name of the table of the source entity or embeddable.
  • If the join is for a unidirectional OneToMany mapping using a foreign key mapping strategy, the name of the table of the target entity.
  • If the join is for a ManyToMany mapping or for a OneToOne or bidirectional ManyToOne/OneToMany mapping using a join table, the name of the join table.
  • If the join is for an element collection, the name of the collection table.
uniqueback to summary
public boolean unique()

(Optional) Whether the property is a unique key. This is a shortcut for the UniqueConstraint annotation at the table level and is useful for when the unique key constraint is only a single field. It is not necessary to explicitly specify this for a join column that corresponds to a primary key that is part of a foreign key.

updatableback to summary
public boolean updatable()

(Optional) Whether the column is included in SQL UPDATE statements generated by the persistence provider.