Interface RelationDefinition

Base relation definition type for manifest relations array.

Either targetTable or target must be provided:

  • targetTable: Explicit table name string
  • target: Function returning model reference (tableName derived at runtime)
interface RelationDefinition {
    cardinality?: "one" | "many";
    hasRevisions?: boolean;
    name: string;
    sourceColumn?: string;
    sourceKey?: string;
    target?: () => unknown;
    targetColumn?: string;
    targetKey?: string;
    targetTable?: string;
    through?: {
        sourceColumn?: string;
        sourceForeignKey?: string;
        table: string;
        targetColumn?: string;
        targetForeignKey?: string;
    };
}

Properties

cardinality? hasRevisions? name sourceColumn? sourceKey? target? targetColumn? targetKey? targetTable? through?

Properties

Optionalcardinality

cardinality?: "one" | "many"

OptionalhasRevisions

hasRevisions?: boolean

name

name: string

OptionalsourceColumn

sourceColumn?: string

OptionalsourceKey

sourceKey?: string

Optionaltarget

target?: () => unknown

Lazy model reference. If provided, targetTable is derived from target().tableName

OptionaltargetColumn

targetColumn?: string

OptionaltargetKey

targetKey?: string

OptionaltargetTable

targetTable?: string

Target table name. Optional if target is provided (derived at runtime).

Optionalthrough

through?: {
    sourceColumn?: string;
    sourceForeignKey?: string;
    table: string;
    targetColumn?: string;
    targetForeignKey?: string;
}

Settings

Member Visibility

On This Page

Properties