Member Junction
    Preparing search index...

    Information about the link between two records

    Index

    Constructors

    Properties

    EntityIDFieldName?: string

    For a soft link (IsSoftLink), the name of the sibling discriminator column that says which entity FieldName points at - the value of EntityIDFieldName on the payload field. Undefined for hard foreign keys.

    EntityName: string

    The name of the entity that is the "parent" in the relationship

    FieldName: string

    The name of the field in the related entity that is the foreign key field back to the primary key of the "parent" entity

    IsSoftLink?: boolean

    True when this dependency is a polymorphic (soft) link rather than a hard foreign key - that is, when FieldName is the RecordID-shaped payload column of an EntityID/RecordID pair declared via EntityFieldInfo.EntityIDFieldName.

    The distinction matters because the two kinds of link store the target differently: a hard foreign key holds the bare primary key value, while a polymorphic link holds the canonical CompositeKey.ToRecordID() encoding (ID|<guid>). Anything that rewrites the link - record merge, most importantly - has to write the right one, so this flag is what tells it which.

    Optional, and absent/false means "hard foreign key", so callers written before polymorphic links were detected keep their existing behavior.

    PrimaryKey: CompositeKey

    The value of the primary key field in the parent record. MemberJunction supports composite(multi-field) primary keys. However, foreign keys only support links to single-valued primary keys in their linked entity.

    RelatedEntityName: string

    The name of the entity that is the "child" in the relationship