Libraries v5.0.0
    Preparing search index...

    Interface JoinOneSpec<TLocalSchema, TForeignSchema, TFieldName, TRequired>

    Configure a single nested eager relation, including its join keys, requiredness and foreign query.

    interface JoinOneSpec<
        TLocalSchema extends
            ObjectSchemaBuilder<any, any, any, any, any, any, any>,
        TForeignSchema extends
            ObjectSchemaBuilder<any, any, any, any, any, any, any>,
        TFieldName extends string = string,
        TRequired extends boolean = true,
    > {
        as: TFieldName;
        foreignColumn: ColumnRef<TForeignSchema>;
        foreignQuery?: QueryBuilder<any, any> | { toKnexQuery(): QueryBuilder };
        foreignSchema: TForeignSchema;
        localColumn: ColumnRef<TLocalSchema>;
        mappers?: Partial<
            Record<SchemaKeys<TForeignSchema>, string | ((value: any) => any)>,
        >;
        required?: TRequired;
    }

    Type Parameters

    • TLocalSchema extends ObjectSchemaBuilder<any, any, any, any, any, any, any>
    • TForeignSchema extends ObjectSchemaBuilder<any, any, any, any, any, any, any>
    • TFieldName extends string = string
    • TRequired extends boolean = true
    Index
    as foreignColumn foreignQuery? foreignSchema localColumn mappers? required?
    as: TFieldName

    Name of the field that will hold the loaded object in the result

    foreignColumn: ColumnRef<TForeignSchema>

    Column on the foreign table used for the join (string key or property accessor)

    foreignQuery?: QueryBuilder<any, any> | { toKnexQuery(): QueryBuilder }

    Optional Knex query builder for the foreign table — auto-derived from foreignSchema's tableName if omitted

    foreignSchema: TForeignSchema

    Foreign schema for type inference

    localColumn: ColumnRef<TLocalSchema>

    Column on the local (base) table used for the join (string key or property accessor)

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

    Optional post-load value transformers per foreign column

    required?: TRequired

    If true (default), uses INNER JOIN; if false, uses LEFT JOIN (result may be null)

    Settings
    Member Visibility

    On This Page
    Properties