Interface IForeignField

Foreign key field establishing a relationship to another model.

interface IForeignField {
    description: string;
    name: string & SnakeCasePattern;
    nullable: boolean;
    relation: IRelation;
    type: "uuid";
    unique: boolean;
}

Properties

description: string

Describe the relationship purpose and semantics of this foreign key.

Format: summary sentence first, \n\n, then paragraphs grouped by topic. Use {@\link ModelName} for cross-references.

MUST be written in English.

MUST use snake_case. Convention: "{target_model}_id".

nullable: boolean

True if the relationship is optional.

relation: IRelation

Prisma relation configuration.

type: "uuid"

unique: boolean

True for 1:1 relationships, false for 1:N.