Libraries v5.0.0
    Preparing search index...

    Interface ValidatedJoinOneSpec

    Normalized one-object relation specification with resolved SQL names and an executable foreign query.

    interface ValidatedJoinOneSpec {
        as: string;
        foreignColumn: string;
        foreignQuery: QueryBuilder;
        localColumn: string;
        mappers?: Record<string, string | ((value: any) => any)>;
        required: boolean;
    }
    Index
    as foreignColumn foreignQuery localColumn mappers? required
    as: string

    Result property receiving the nested related object.

    foreignColumn: string

    Resolved SQL join column on the related table.

    foreignQuery: QueryBuilder

    Prepared Knex query describing eligible related rows.

    localColumn: string

    Resolved SQL join column on the parent table.

    mappers?: Record<string, string | ((value: any) => any)>

    Optional related-field conversions applied after SQL returns.

    required: boolean

    Whether unmatched parent rows are excluded by an inner join.

    Settings
    Member Visibility

    On This Page
    Properties