javax.persistence

Annotation Type ForeignKey

@Target(value={})
@Retention(value=RUNTIME)
public @interface ForeignKey

The ForeignKey annotation is used in schema generation. It is used to define a foreign key constraint or to override or disable the persistence provider’s default foreign key definition.

Since:

JPA 2.1

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	disableForeignKey (Optional) Whether the provider should not generate a foreign key constraint.
java.lang.String	foreignKeyDefinition (Optional) The foreign key constraint definition.
java.lang.String	name (Optional) The name of the foreign key constraint.

Element Detail

name

public abstract java.lang.String name

(Optional) The name of the foreign key constraint. Defaults to a provider-generated name.

Returns:

The foreign key name

Default:

""

foreignKeyDefinition

public abstract java.lang.String foreignKeyDefinition

(Optional) The foreign key constraint definition. Default is provider defined. If the value of disableForeignKey is true, the provider must not generate a foreign key constraint.

Returns:

The foreign key definition

Default:

""

disableForeignKey

public abstract boolean disableForeignKey

(Optional) Whether the provider should not generate a foreign key constraint. Defaults to false

Returns:

Should the provider generate a foreign key?

Default:

false