Class FilterWhereBuilder<TData, TVirtual, TInstance, TRelations>

Typed facade around the legacy QueryBuilder. It injects default revision-aware predicates, exposes the fluent DAL surface, and keeps the PromiseLike contract so await Model.filterWhere(...) call sites work without forcing .run().

Type Parameters

TData extends JsonObject
TVirtual extends JsonObject
TInstance extends ModelInstance<TData, TVirtual>
TRelations extends string

Implements

FilterWhereQueryBuilder<TData, TVirtual, TInstance, TRelations>

Constructors

constructor

new FilterWhereBuilder<
    TData extends JsonObject,
    TVirtual extends JsonObject,
    TInstance extends JsonObject & ModelInstanceCore<TData, TVirtual>,
    TRelations extends string,
>(
    builder: QueryBuilder<TData, TVirtual, TInstance, TRelations>,
    hasRevisions: boolean,
): FilterWhereBuilder<TData, TVirtual, TInstance, TRelations>
Type Parameters
- TData extends JsonObject
- TVirtual extends JsonObject
- TInstance extends JsonObject & ModelInstanceCore<TData, TVirtual>
- TRelations extends string
Parameters
- builder: QueryBuilder<TData, TVirtual, TInstance, TRelations>
- hasRevisions: boolean
Returns FilterWhereBuilder<TData, TVirtual, TInstance, TRelations>
- Defined in dal/lib/filter-where.ts:438

Methods

and

and(
    literal: Partial<
        {
            [K in string
            | number
            | symbol]:
                | TData[K]
                | OperatorResultForKey<FilterWhereOperators<TData>, K>
        },
    >,
): this
Parameters
- literal: Partial<
      {
          [K in string
          | number
          | symbol]: TData[K] | OperatorResultForKey<FilterWhereOperators<TData>, K>
      },
  >
Returns this
Implementation of FilterWhereQueryBuilder.and
- Defined in dal/lib/filter-where.ts:544

average

average(field: Extract<keyof TData, string>): Promise<number>
Parameters
- field: Extract<keyof TData, string>
Returns Promise<number>
Implementation of FilterWhereQueryBuilder.average
- Defined in dal/lib/filter-where.ts:723

catch

catch<TResult = never>(
onRejected?: (reason: unknown) => TResult | PromiseLike<TResult>,
): Promise<TInstance[] | TResult>
Type Parameters
- TResult = never
Parameters
- OptionalonRejected: (reason: unknown) => TResult | PromiseLike<TResult>
Returns Promise<TInstance[] | TResult>
- Defined in dal/lib/filter-where.ts:793

chronologicalFeed

chronologicalFeed<K extends string>(
options: ChronologicalFeedOptions<TData, K>,
): Promise<ChronologicalFeedPage<NonNullable<TData[K]>, TInstance>>
Run a chronological feed query against a date-backed field using limit+1 cursor pagination.
Type Parameters
- K extends string
Parameters
- options: ChronologicalFeedOptions<TData, K>
  Cursor pagination options.
Returns Promise<ChronologicalFeedPage<NonNullable<TData[K]>, TInstance>>
Implementation of FilterWhereQueryBuilder.chronologicalFeed
- Defined in dal/lib/filter-where.ts:631

count

count(): Promise<number>
Returns Promise<number>
Implementation of FilterWhereQueryBuilder.count
- Defined in dal/lib/filter-where.ts:718

decrement

decrement<K extends string, R extends string = K>(
field: K,
options?: { by?: number; returning?: R[] },
): Promise<{ rowCount: number; rows: Pick<TData, R>[] }>
Atomically decrement a numeric column scoped by the current predicates.
Type Parameters
- K extends string
- R extends string = K
Parameters
- field: K
  Numeric model field to decrement
- options: { by?: number; returning?: R[] } = {}
  Configure the decrement step and returned columns
Returns Promise<{ rowCount: number; rows: Pick<TData, R>[] }>
Implementation of FilterWhereQueryBuilder.decrement
- Defined in dal/lib/filter-where.ts:762

delete

delete(): Promise<number>
Returns Promise<number>
Implementation of FilterWhereQueryBuilder.delete
- Defined in dal/lib/filter-where.ts:776

deleteById

deleteById(id: string): Promise<number>
Parameters
- id: string
Returns Promise<number>
Implementation of FilterWhereQueryBuilder.deleteById
- Defined in dal/lib/filter-where.ts:781

finally

finally(onFinally?: () => void): Promise<TInstance[]>
Parameters
- OptionalonFinally: () => void
Returns Promise<TInstance[]>
- Defined in dal/lib/filter-where.ts:799

first

first(): Promise<TInstance>
Returns Promise<TInstance>
Implementation of FilterWhereQueryBuilder.first
- Defined in dal/lib/filter-where.ts:712

getJoin

getJoin(joinSpec: Partial<Record<TRelations, boolean | JsonObject>>): this
Include related records. Use true for all relations - the system automatically selects inline join for one-to-one or batch loader for one-to-many based on the relation's cardinality in the manifest.
Parameters
- joinSpec: Partial<Record<TRelations, boolean | JsonObject>>
Returns this
Implementation of FilterWhereQueryBuilder.getJoin
- Defined in dal/lib/filter-where.ts:682

includeDeleted

includeDeleted(): this
Returns this
Implementation of FilterWhereQueryBuilder.includeDeleted
- Defined in dal/lib/filter-where.ts:552

includeSensitive

includeSensitive(fields: string | string[]): this
Parameters
- fields: string | string[]
Returns this
Implementation of FilterWhereQueryBuilder.includeSensitive
- Defined in dal/lib/filter-where.ts:562

includeStale

includeStale(): this
Returns this
Implementation of FilterWhereQueryBuilder.includeStale
- Defined in dal/lib/filter-where.ts:557

increment

increment<K extends string, R extends string = K>(
field: K,
options?: { by?: number; returning?: R[] },
): Promise<{ rowCount: number; rows: Pick<TData, R>[] }>
Atomically increment a numeric column scoped by the current predicates.
Type Parameters
- K extends string
- R extends string = K
Parameters
- field: K
  Numeric model field to increment
- options: { by?: number; returning?: R[] } = {}
  Configure the increment step and returned columns
Returns Promise<{ rowCount: number; rows: Pick<TData, R>[] }>
Implementation of FilterWhereQueryBuilder.increment
- Defined in dal/lib/filter-where.ts:739

limit

limit(count: number): this
Parameters
- count: number
Returns this
Implementation of FilterWhereQueryBuilder.limit
- Defined in dal/lib/filter-where.ts:610

offset

offset(count: number): this
Parameters
- count: number
Returns this
Implementation of FilterWhereQueryBuilder.offset
- Defined in dal/lib/filter-where.ts:621

or

or(
    literal: Partial<
        {
            [K in string
            | number
            | symbol]:
                | TData[K]
                | OperatorResultForKey<FilterWhereOperators<TData>, K>
        },
    >,
): this
Parameters
- literal: Partial<
      {
          [K in string
          | number
          | symbol]: TData[K] | OperatorResultForKey<FilterWhereOperators<TData>, K>
      },
  >
Returns this
Implementation of FilterWhereQueryBuilder.or
- Defined in dal/lib/filter-where.ts:548

orderBy

orderBy(
field: string | Extract<keyof TData, string>,
direction?: "ASC" | "DESC",
): this
Order results by a model column.
Parameters
- field: string | Extract<keyof TData, string>
  Field to sort by (camelCase or qualified string)
- direction: "ASC" | "DESC" = 'ASC'
  Sort direction
Returns this
Implementation of FilterWhereQueryBuilder.orderBy
- Defined in dal/lib/filter-where.ts:588

orderByRelation

orderByRelation(
    relation: TRelations,
    field: string,
    direction?: "ASC" | "DESC",
): this
Order results using a column on a joined relation (through metadata).
Parameters
- relation: TRelations
  Relation key from the manifest
- field: string
  Column on the related table (camelCase)
- direction: "ASC" | "DESC" = 'ASC'
  Sort direction
Returns this
Implementation of FilterWhereQueryBuilder.orderByRelation
- Defined in dal/lib/filter-where.ts:605

revisionData

revisionData(literal: Partial): this
Parameters
- literal: Partial
Returns this
Implementation of FilterWhereQueryBuilder.revisionData
- Defined in dal/lib/filter-where.ts:567

run

run(): Promise<TInstance[]>
Returns Promise<TInstance[]>
Implementation of FilterWhereQueryBuilder.run
- Defined in dal/lib/filter-where.ts:706

sample

sample(count?: number): Promise<TInstance[]>
Parameters
- count: number = 1
Returns Promise<TInstance[]>
Implementation of FilterWhereQueryBuilder.sample
- Defined in dal/lib/filter-where.ts:615

then

then<TResult1 = TInstance[], TResult2 = never>(
onFulfilled?: (value: TInstance[]) => TResult1 | PromiseLike<TResult1>,
onRejected?: (reason: unknown) => TResult2 | PromiseLike<TResult2>,
): Promise<TResult1 | TResult2>
Attaches callbacks for the resolution and/or rejection of the Promise.
Type Parameters
- TResult1 = TInstance[]
- TResult2 = never
Parameters
- OptionalonFulfilled: (value: TInstance[]) => TResult1 | PromiseLike<TResult1>
- OptionalonRejected: (reason: unknown) => TResult2 | PromiseLike<TResult2>
Returns Promise<TResult1 | TResult2>
A Promise for the completion of which ever callback is executed.
Implementation of FilterWhereQueryBuilder.then
- Defined in dal/lib/filter-where.ts:786

whereIn

whereIn(
    field: Extract<keyof TData, string>,
    values: unknown[],
    options?: { cast?: string },
): this
Parameters
- field: Extract<keyof TData, string>
- values: unknown[]
- options: { cast?: string } = {}
Returns this
Implementation of FilterWhereQueryBuilder.whereIn
- Defined in dal/lib/filter-where.ts:687

whereRelated

whereRelated(
    relation: TRelations,
    field: string,
    value: unknown,
    operator?: string,
): this
Parameters
- relation: TRelations
- field: string
- value: unknown
- operator: string = '='
Returns this
Implementation of FilterWhereQueryBuilder.whereRelated
- Defined in dal/lib/filter-where.ts:701

Class FilterWhereBuilder<TData, TVirtual, TInstance, TRelations>

Type Parameters

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns FilterWhereBuilder<TData, TVirtual, TInstance, TRelations>

Methods

and

Parameters

Returns this

average

Parameters

Returns Promise<number>

catch

Type Parameters

Parameters

Returns Promise<TInstance[] | TResult>

chronologicalFeed

Type Parameters

Parameters

Returns Promise<ChronologicalFeedPage<NonNullable<TData[K]>, TInstance>>

count

Returns Promise<number>

decrement

Type Parameters

Parameters

Returns Promise<{ rowCount: number; rows: Pick<TData, R>[] }>

delete

Returns Promise<number>

deleteById

Parameters

Returns Promise<number>

finally

Parameters

Returns Promise<TInstance[]>

first

Returns Promise<TInstance>

getJoin

Parameters

Returns this

includeDeleted

Returns this

includeSensitive

Parameters

Returns this

includeStale

Returns this

increment

Type Parameters

Parameters

Returns Promise<{ rowCount: number; rows: Pick<TData, R>[] }>

limit

Parameters

Returns this

offset

Parameters

Returns this

or

Parameters

Returns this

orderBy

Parameters

Returns this

orderByRelation

Parameters

Returns this

revisionData

Parameters

Returns this

run

Returns Promise<TInstance[]>

sample

Parameters

Returns Promise<TInstance[]>

then