Libraries v5.0.0
    Preparing search index...

    Interface ValidatedJoinManySpec

    Normalized collection relation specification consumed by the eager-loading compiler.

    interface ValidatedJoinManySpec {
        as: string;
        foreignColumn: string;
        foreignQuery: QueryBuilder;
        limit: number | null;
        localColumn: string;
        mappers?: Record<string, string | ((value: any) => any)>;
        offset: number | null;
        orderBy: { column: string; direction: "desc" | "asc" } | null;
    }
    Index
    as foreignColumn foreignQuery limit localColumn mappers? offset orderBy
    as: string

    Result property receiving the array of related rows.

    foreignColumn: string

    Resolved child SQL column used to group related rows.

    foreignQuery: QueryBuilder

    Prepared Knex query describing eligible children.

    limit: number | null

    Maximum children per parent, or null for no child limit.

    localColumn: string

    Resolved parent SQL column matched to each child group.

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

    Optional child-field conversions applied after SQL returns.

    offset: number | null

    Children skipped per parent, or null for no offset.

    orderBy: { column: string; direction: "desc" | "asc" } | null

    Resolved child ordering, or null to leave child order unspecified.

    Settings
    Member Visibility

    On This Page
    Properties