Home » JDO » Annotations » Mapping (ORM) » ForeignKey

Note: This ORM/SQL annotation is silently ignored by ObjectDB

javax.jdo.annotations.ForeignKey - JDO annotation

javax.jdo.annotations
Annotation ForeignKey

Target:
Classes and fields (including property get methods)
Annotation for a database foreign-key. Corresponds to the xml element "foreign-key".
Since:
JDO 2.1
Columns that compose this foreign key.
Columns that compose this foreign key.
Returns:
the columns that compose this foreign key
Default value:
{}
Since:
JDO 2.1
String deferred
Whether this foreign key is deferred (constraint is checked only at commit).
Whether this foreign key is deferred (constraint is checked only at commit).
Returns:
whether this foreign key is deferred
Default value:
""
Since:
JDO 2.1
The delete action of this foreign key.
The delete action of this foreign key.
Returns:
the delete action of this foreign key
Default value:
javax.jdo.annotations.ForeignKeyAction.RESTRICT
Since:
JDO 2.1
String[] members
Member (field and property) names that compose this foreign key.
Member (field and property) names that compose this foreign key.
Returns:
the member names that compose this foreign key
Default value:
{}
Since:
JDO 2.1
String name
Name of the foreign key.
Name of the foreign key.
Returns:
the name of the foreign key
Default value:
""
Since:
JDO 2.1
String table
Table for the foreign key.
Table for the foreign key. This is needed iff annotating a type where the foreign key is not defined on the primary table for the type.
Returns:
the table on which the foreign key is defined
Default value:
""
Since:
JDO 2.1
String unique
Whether this foreign key is unique.
Whether this foreign key is unique.
Returns:
whether this foreign key is unique
Default value:
""
Since:
JDO 2.1
The update action of this foreign key.
The update action of this foreign key.
Returns:
the update action of this foreign key
Default value:
javax.jdo.annotations.ForeignKeyAction.RESTRICT
Since:
JDO 2.1

This documentation page is derived (with some adjustments) from the JDO 2.2 API
and is available under the terms of the Apache License, v. 2.0.