Interface JoinApplyBuilder

Builder interface passed to _apply callbacks in join options.

Supports a subset of query operations that can be analyzed and applied to related record queries:

filterWhere / filter - add WHERE conditions
without - exclude fields from results
limit - cap number of related records
orderBy / asc / desc - sort related records

interface JoinApplyBuilder {
    asc(field: string): JoinApplyBuilder;
    desc(field: string): JoinApplyBuilder;
    filter(literal: Record<string, unknown>): JoinApplyBuilder;
    filterWhere(literal: Record<string, unknown>): JoinApplyBuilder;
    limit(count: number): JoinApplyBuilder;
    orderBy(field: string, direction?: "ASC" | "DESC"): JoinApplyBuilder;
    without(fields: string | string[]): JoinApplyBuilder;
}

Index

Methods

asc desc filter filterWhere limit orderBy without

Methods

asc

asc(field: string): JoinApplyBuilder
Parameters
- field: string
Returns JoinApplyBuilder
- Defined in dal/lib/query-builder.ts:129

desc

desc(field: string): JoinApplyBuilder
Parameters
- field: string
Returns JoinApplyBuilder
- Defined in dal/lib/query-builder.ts:130

filter

filter(literal: Record<string, unknown>): JoinApplyBuilder
Parameters
- literal: Record<string, unknown>
Returns JoinApplyBuilder
- Defined in dal/lib/query-builder.ts:125

filterWhere

filterWhere(literal: Record<string, unknown>): JoinApplyBuilder
Parameters
- literal: Record<string, unknown>
Returns JoinApplyBuilder
- Defined in dal/lib/query-builder.ts:124

limit

limit(count: number): JoinApplyBuilder
Parameters
- count: number
Returns JoinApplyBuilder
- Defined in dal/lib/query-builder.ts:127

orderBy

orderBy(field: string, direction?: "ASC" | "DESC"): JoinApplyBuilder
Parameters
- field: string
- Optionaldirection: "ASC" | "DESC"
Returns JoinApplyBuilder
- Defined in dal/lib/query-builder.ts:128

without

without(fields: string | string[]): JoinApplyBuilder
Parameters
- fields: string | string[]
Returns JoinApplyBuilder
- Defined in dal/lib/query-builder.ts:126