javax.persistence

Annotation Type ForeignKey

Contents

  • @Target(value={})
 @Retention(value=RUNTIME)
public @interface ForeignKey
    Used to specify the handling of foreign key constraints when schema generation is in effect. If this annotation is not specified, the persistence provider's default foreign key strategy will be used.

    The ConstraintMode value is used to specify whether foreign key constraints should be generated.

    The syntax used in the foreignKeyDefinition element should follow the SQL syntax used by the target database for foreign key constraints. For example, this may be similar the following: 

     FOREIGN KEY ( <COLUMN expression> {, <COLUMN expression>}... )
 REFERENCES <TABLE identifier> [
     (<COLUMN expression> {, <COLUMN expression>}... ) ]
 [ ON UPDATE <referential action> ]
 [ ON DELETE <referential action> ]
    When the ConstraintMode value is CONSTRAINT, but the foreignKeyDefinition element is not specified, the provider will generate foreign key constraints whose update and delete actions it determines most appropriate for the join column(s) to which the foreign key annotation is applied.
    Since:
    Java Persistence 2.1
    See Also:
    JoinColumn, JoinColumns, MapKeyJoinColumn, MapKeyJoinColumns, PrimaryKeyJoinColumn, JoinTable, CollectionTable, SecondaryTable, AssociationOverride

    • Element Detail

      • name

        public abstract String name
        (Optional) The name of the foreign key constraint. If this is not specified, it defaults to a provider-generated name.
        Default:
        ""

      • value

        public abstract ConstraintMode value
        (Optional) Used to specify whether a foreign key constraint should be generated when schema generation is in effect.

        A value of CONSTRAINT will cause the persistence provider to generate a foreign key constraint. If the foreignKeyDefinition element is not specified, the provider will generate a constraint whose update and delete actions it determines most appropriate for the join column(s) to which the foreign key annotation is applied.

        A value of NO_CONSTRAINT will result in no constraint being generated.

        A value of PROVIDER_DEFAULT will result in the provider's default behavior (which may or may not result in the generation of a constraint for the given join column(s).

        Default:
        javax.persistence.ConstraintMode.CONSTRAINT

      • foreignKeyDefinition

        public abstract String foreignKeyDefinition
        (Optional) The foreign key constraint definition.
        Default:
        ""

Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/persistence/ForeignKey.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com/en/java/, Annotation Type ForeignKey

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.