Annotation for the join of a relation.
Corresponds to the xml element "join".
- Since:
- 2.1
- Version:
- 2.1
-
Optional Element Summary
Optional Elements
Name of the column in the join table.
Detail definition of the join column(s).
Delete action to be applied to any ForeignKey on this join.
Name for a generated foreign key constraint.
Generate or assume a foreign key constraint exists on the column
or columns associated with this join.
Generate or assume a primary key constraint exists on the column
or columns associated with this join.
The name of the index to generate.
Whether the join column is indexed.
Whether to use an outer join.
Name for a generated primary key constraint.
Table to join to (used when joining to secondary tables).
Whether the join column is unique.
The name of the unique key constraint to generate.
-
Element Details
-
table
Table to join to (used when joining to secondary tables).
- Returns:
- the table
- Default:
""
-
column
Name of the column in the join table.
- Returns:
- the name of the column in the join table
- Default:
""
-
indexed
Whether the join column is indexed.
- Returns:
- whether the join column(s) is(are) indexed
- Default:
""
-
index
The name of the index to generate.
- Returns:
- the name of the index
- Default:
""
-
unique
Whether the join column is unique.
- Returns:
- whether the join column(s) is(are) is unique
- Default:
""
-
uniqueKey
The name of the unique key constraint to generate.
- Returns:
- the name of the unique key constraint
- Default:
""
-
outer
Whether to use an outer join.
- Returns:
- whether to use an outer join
- Default:
""
-
deleteAction
Delete action to be applied to any ForeignKey on this join.
- Returns:
- the delete action
- Default:
UNSPECIFIED
-
columns
Detail definition of the join column(s). This is needed for
more than one join column.
- Returns:
- the join columns
- Default:
{}
-
generatePrimaryKey
Generate or assume a primary key constraint exists on the column
or columns associated with this join. Specify "true" or "false".
- Returns:
- whether to generate or assume a primary key constraint
- Default:
""
-
primaryKey
Name for a generated primary key constraint.
- Returns:
- the name of the generated primary key constraint
- Default:
""
-
generateForeignKey
Generate or assume a foreign key constraint exists on the column
or columns associated with this join. Specify "true" or "false".
- Returns:
- whether to generate or assume a foreign key constraint
- Default:
""
-
foreignKey
Name for a generated foreign key constraint.
- Returns:
- the name of the generated foreign key constraint
- Default:
""
-
extensions
Vendor extensions.
- Returns:
- the vendor extensions
- Default:
{}