PropertyRelationship

Interface: PropertyRelationship

Relationship metadata for properties of type relationship. Fully describes how the local aggregate connects to a remote one.

aggregateName: string

Target aggregate name.

avoidConstraint: boolean

If true, the generated SQL does not add a foreign key constraint.

field: string

Field name on the remote aggregate (e.g. the FK column).

optional isDenormalized?: boolean

If true, the target column is denormalized into this aggregate.

optional key?: string

Local column name when it differs from the property name.

modulePath: string

Module path of the target aggregate (e.g. iam/user).

optional packageName?: string

External package when the target lives outside the current bounded context.

optional pivot?: RelationshipPivot

Pivot metadata for many-to-many relationships.

optional singularName?: string

Singular form of the target name (used for foreign key column naming).

type: RelationshipType