Class QueryBuilder<T>

QueryBuilder - fluent API for building JSON-serializable CTEs that can be compiled

Type Parameters

Implements

IQueryBuilder<T>

Index

Constructors

constructor

Properties

_cte _joins

Constructors

constructor

new QueryBuilder<T>(): QueryBuilder<T>
Type Parameters
- T
Returns QueryBuilder<T>
- Defined in query/queryBuilder.ts:381

Properties

`Protected`_cte

_cte: CTE<T>

`Protected`_joins

_joins: JoinConfig<T>[] = []

Methods

and

and(...filters: CTEFilter<T>[]): IQueryBuilder<T>
Add logical AND filter over provided filters.
Parameters
- ...filters: CTEFilter<T>[]
Returns IQueryBuilder<T>
Implementation of IQueryBuilder.and
- Defined in query/queryBuilder.ts:449

compare

compare(
    field: T extends object
        ? | Extract<keyof T, string>
        | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
            ?
                | Extract<keyof NonNullable<T[Extract<keyof (...), string>]>, string>
                | `${Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>}.${NonNullable<
                    NonNullable<(...)[(...)]>[Extract<keyof (...), string>],
                > extends object
                    ?
                        | Extract<keyof NonNullable<(...)>, string>
                        | `${Extract<keyof (...), string>}.${Extract<keyof (...), string>}`
                    : never}`
            : never}`
        : never,
    operator: CTEComparisonOperator,
    value: unknown,
): IQueryBuilder<T>
Add a comparison filter with full operator control.
Parameters
- field: T extends object
      ? | Extract<keyof T, string>
      | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
          ?
              | Extract<keyof NonNullable<T[Extract<keyof (...), string>]>, string>
              | `${Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>}.${NonNullable<
                  NonNullable<(...)[(...)]>[Extract<keyof (...), string>],
              > extends object
                  ?
                      | Extract<keyof NonNullable<(...)>, string>
                      | `${Extract<keyof (...), string>}.${Extract<keyof (...), string>}`
                  : never}`
          : never}`
      : never
- operator: CTEComparisonOperator
- value: unknown
Returns IQueryBuilder<T>
Implementation of IQueryBuilder.compare
- Defined in query/queryBuilder.ts:397

compileToFunction

compileToFunction(): (docs: T[]) => T[]
Compile CTE to executable filter function

Returns (docs: T[]) => T[]
Implementation of IQueryBuilder.compileToFunction
- Defined in query/queryBuilder.ts:558

contains

contains(
    field: T extends object
        ? | Extract<keyof T, string>
        | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
            ?
                | Extract<keyof NonNullable<T[Extract<keyof (...), string>]>, string>
                | `${Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>}.${NonNullable<
                    NonNullable<(...)[(...)]>[Extract<keyof (...), string>],
                > extends object
                    ?
                        | Extract<keyof NonNullable<(...)>, string>
                        | `${Extract<keyof (...), string>}.${Extract<keyof (...), string>}`
                    : never}`
            : never}`
        : never,
    value: unknown,
): IQueryBuilder<T>
Add contains filter.
Parameters
- field: T extends object
      ? | Extract<keyof T, string>
      | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
          ?
              | Extract<keyof NonNullable<T[Extract<keyof (...), string>]>, string>
              | `${Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>}.${NonNullable<
                  NonNullable<(...)[(...)]>[Extract<keyof (...), string>],
              > extends object
                  ?
                      | Extract<keyof NonNullable<(...)>, string>
                      | `${Extract<keyof (...), string>}.${Extract<keyof (...), string>}`
                  : never}`
          : never}`
      : never
- value: unknown
Returns IQueryBuilder<T>
Implementation of IQueryBuilder.contains
- Defined in query/queryBuilder.ts:433

containsIgnoreCase

containsIgnoreCase(
    field: T extends object
        ? | Extract<keyof T, string>
        | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
            ?
                | Extract<keyof NonNullable<T[Extract<keyof (...), string>]>, string>
                | `${Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>}.${NonNullable<
                    NonNullable<(...)[(...)]>[Extract<keyof (...), string>],
                > extends object
                    ?
                        | Extract<keyof NonNullable<(...)>, string>
                        | `${Extract<keyof (...), string>}.${Extract<keyof (...), string>}`
                    : never}`
            : never}`
        : never,
    value: unknown,
): IQueryBuilder<T>
Add case-insensitive contains filter.
Parameters
- field: T extends object
      ? | Extract<keyof T, string>
      | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
          ?
              | Extract<keyof NonNullable<T[Extract<keyof (...), string>]>, string>
              | `${Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>}.${NonNullable<
                  NonNullable<(...)[(...)]>[Extract<keyof (...), string>],
              > extends object
                  ?
                      | Extract<keyof NonNullable<(...)>, string>
                      | `${Extract<keyof (...), string>}.${Extract<keyof (...), string>}`
                  : never}`
          : never}`
      : never
- value: unknown
Returns IQueryBuilder<T>
Implementation of IQueryBuilder.containsIgnoreCase
- Defined in query/queryBuilder.ts:437

`Protected`createSubBuilder

createSubBuilder(): QueryBuilder<T>
Returns QueryBuilder<T>
- Defined in query/queryBuilder.ts:385

equal

equal(
    field: T extends object
        ? | Extract<keyof T, string>
        | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
            ?
                | Extract<keyof NonNullable<T[Extract<keyof (...), string>]>, string>
                | `${Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>}.${NonNullable<
                    NonNullable<(...)[(...)]>[Extract<keyof (...), string>],
                > extends object
                    ?
                        | Extract<keyof NonNullable<(...)>, string>
                        | `${Extract<keyof (...), string>}.${Extract<keyof (...), string>}`
                    : never}`
            : never}`
        : never,
    value: unknown,
): IQueryBuilder<T>
Add equality filter.
Parameters
- field: T extends object
      ? | Extract<keyof T, string>
      | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
          ?
              | Extract<keyof NonNullable<T[Extract<keyof (...), string>]>, string>
              | `${Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>}.${NonNullable<
                  NonNullable<(...)[(...)]>[Extract<keyof (...), string>],
              > extends object
                  ?
                      | Extract<keyof NonNullable<(...)>, string>
                      | `${Extract<keyof (...), string>}.${Extract<keyof (...), string>}`
                  : never}`
          : never}`
      : never
- value: unknown
Returns IQueryBuilder<T>
Implementation of IQueryBuilder.equal
- Defined in query/queryBuilder.ts:405

fuzzyContains

fuzzyContains(
    field: T extends object
        ? | Extract<keyof T, string>
        | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
            ?
                | Extract<keyof NonNullable<T[Extract<keyof (...), string>]>, string>
                | `${Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>}.${NonNullable<
                    NonNullable<(...)[(...)]>[Extract<keyof (...), string>],
                > extends object
                    ?
                        | Extract<keyof NonNullable<(...)>, string>
                        | `${Extract<keyof (...), string>}.${Extract<keyof (...), string>}`
                    : never}`
            : never}`
        : never,
    value: unknown,
): IQueryBuilder<T>
Add fuzzy contains filter.
Parameters
- field: T extends object
      ? | Extract<keyof T, string>
      | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
          ?
              | Extract<keyof NonNullable<T[Extract<keyof (...), string>]>, string>
              | `${Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>}.${NonNullable<
                  NonNullable<(...)[(...)]>[Extract<keyof (...), string>],
              > extends object
                  ?
                      | Extract<keyof NonNullable<(...)>, string>
                      | `${Extract<keyof (...), string>}.${Extract<keyof (...), string>}`
                  : never}`
          : never}`
      : never
- value: unknown
Returns IQueryBuilder<T>
Implementation of IQueryBuilder.fuzzyContains
- Defined in query/queryBuilder.ts:441

greaterThan

greaterThan(
    field: T extends object
        ? | Extract<keyof T, string>
        | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
            ?
                | Extract<keyof NonNullable<T[Extract<keyof (...), string>]>, string>
                | `${Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>}.${NonNullable<
                    NonNullable<(...)[(...)]>[Extract<keyof (...), string>],
                > extends object
                    ?
                        | Extract<keyof NonNullable<(...)>, string>
                        | `${Extract<keyof (...), string>}.${Extract<keyof (...), string>}`
                    : never}`
            : never}`
        : never,
    value: unknown,
): IQueryBuilder<T>
Add greater-than filter.
Parameters
- field: T extends object
      ? | Extract<keyof T, string>
      | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
          ?
              | Extract<keyof NonNullable<T[Extract<keyof (...), string>]>, string>
              | `${Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>}.${NonNullable<
                  NonNullable<(...)[(...)]>[Extract<keyof (...), string>],
              > extends object
                  ?
                      | Extract<keyof NonNullable<(...)>, string>
                      | `${Extract<keyof (...), string>}.${Extract<keyof (...), string>}`
                  : never}`
          : never}`
      : never
- value: unknown
Returns IQueryBuilder<T>
Implementation of IQueryBuilder.greaterThan
- Defined in query/queryBuilder.ts:413

greaterThanOrEqual

greaterThanOrEqual(
    field: T extends object
        ? | Extract<keyof T, string>
        | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
            ?
                | Extract<keyof NonNullable<T[Extract<keyof (...), string>]>, string>
                | `${Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>}.${NonNullable<
                    NonNullable<(...)[(...)]>[Extract<keyof (...), string>],
                > extends object
                    ?
                        | Extract<keyof NonNullable<(...)>, string>
                        | `${Extract<keyof (...), string>}.${Extract<keyof (...), string>}`
                    : never}`
            : never}`
        : never,
    value: unknown,
): IQueryBuilder<T>
Add greater-than-or-equal filter.
Parameters
- field: T extends object
      ? | Extract<keyof T, string>
      | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
          ?
              | Extract<keyof NonNullable<T[Extract<keyof (...), string>]>, string>
              | `${Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>}.${NonNullable<
                  NonNullable<(...)[(...)]>[Extract<keyof (...), string>],
              > extends object
                  ?
                      | Extract<keyof NonNullable<(...)>, string>
                      | `${Extract<keyof (...), string>}.${Extract<keyof (...), string>}`
                  : never}`
          : never}`
      : never
- value: unknown
Returns IQueryBuilder<T>
Implementation of IQueryBuilder.greaterThanOrEqual
- Defined in query/queryBuilder.ts:421

in

in(
    field: T extends object
        ? | Extract<keyof T, string>
        | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
            ?
                | Extract<keyof NonNullable<T[Extract<keyof (...), string>]>, string>
                | `${Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>}.${NonNullable<
                    NonNullable<(...)[(...)]>[Extract<keyof (...), string>],
                > extends object
                    ?
                        | Extract<keyof NonNullable<(...)>, string>
                        | `${Extract<keyof (...), string>}.${Extract<keyof (...), string>}`
                    : never}`
            : never}`
        : never,
    value: unknown,
): IQueryBuilder<T>
Add inclusion filter.
Parameters
- field: T extends object
      ? | Extract<keyof T, string>
      | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
          ?
              | Extract<keyof NonNullable<T[Extract<keyof (...), string>]>, string>
              | `${Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>}.${NonNullable<
                  NonNullable<(...)[(...)]>[Extract<keyof (...), string>],
              > extends object
                  ?
                      | Extract<keyof NonNullable<(...)>, string>
                      | `${Extract<keyof (...), string>}.${Extract<keyof (...), string>}`
                  : never}`
          : never}`
      : never
- value: unknown
Returns IQueryBuilder<T>
Implementation of IQueryBuilder.in
- Defined in query/queryBuilder.ts:429

includes

includes(
    field: T extends object
        ? | Extract<keyof T, string>
        | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
            ?
                | Extract<keyof NonNullable<T[Extract<keyof (...), string>]>, string>
                | `${Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>}.${NonNullable<
                    NonNullable<(...)[(...)]>[Extract<keyof (...), string>],
                > extends object
                    ?
                        | Extract<keyof NonNullable<(...)>, string>
                        | `${Extract<keyof (...), string>}.${Extract<keyof (...), string>}`
                    : never}`
            : never}`
        : never,
    value: unknown,
): IQueryBuilder<T>
Add includes filter.
Parameters
- field: T extends object
      ? | Extract<keyof T, string>
      | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
          ?
              | Extract<keyof NonNullable<T[Extract<keyof (...), string>]>, string>
              | `${Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>}.${NonNullable<
                  NonNullable<(...)[(...)]>[Extract<keyof (...), string>],
              > extends object
                  ?
                      | Extract<keyof NonNullable<(...)>, string>
                      | `${Extract<keyof (...), string>}.${Extract<keyof (...), string>}`
                  : never}`
          : never}`
      : never
- value: unknown
Returns IQueryBuilder<T>
Implementation of IQueryBuilder.includes
- Defined in query/queryBuilder.ts:445

join

join<Right>(
    rightCollection: ICollection<Right>,
    leftField: T extends object
        ? | Extract<keyof T, string>
        | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
            ?
                | Extract<keyof NonNullable<T[Extract<keyof (...), string>]>, string>
                | `${Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>}.${NonNullable<
                    NonNullable<(...)[(...)]>[Extract<keyof (...), string>],
                > extends object
                    ?
                        | Extract<keyof NonNullable<(...)>, string>
                        | `${Extract<keyof (...), string>}.${Extract<keyof (...), string>}`
                    : never}`
            : never}`
        : never,
    rightField?: Right extends object
        ? | Extract<keyof Right, string>
        | `${Extract<keyof Right, string>}.${NonNullable<
            Right[Extract<keyof Right, string>],
        > extends object
            ?
                | Extract<keyof NonNullable<Right[Extract<(...), (...)>]>, string>
                | `${Extract<keyof NonNullable<(...)[(...)]>, string>}.${NonNullable<
                    NonNullable<(...)>[Extract<(...), (...)>],
                > extends object
                    ?
                        | Extract<keyof (...), string>
                        | `${Extract<(...), (...)>}.${Extract<(...), (...)>}`
                    : never}`
            : never}`
        : never,
    type?: JoinType,
): IQueryBuilder<T & JoinResult<Right>>
Join another collection to the root query.

The left-side field is required. The right-side field is optional when the joined collection exposes a keyField.
Type Parameters
- Right
Parameters
- rightCollection: ICollection<Right>
- leftField: T extends object
      ? | Extract<keyof T, string>
      | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
          ?
              | Extract<keyof NonNullable<T[Extract<keyof (...), string>]>, string>
              | `${Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>}.${NonNullable<
                  NonNullable<(...)[(...)]>[Extract<keyof (...), string>],
              > extends object
                  ?
                      | Extract<keyof NonNullable<(...)>, string>
                      | `${Extract<keyof (...), string>}.${Extract<keyof (...), string>}`
                  : never}`
          : never}`
      : never
- OptionalrightField: Right extends object
      ? | Extract<keyof Right, string>
      | `${Extract<keyof Right, string>}.${NonNullable<
          Right[Extract<keyof Right, string>],
      > extends object
          ?
              | Extract<keyof NonNullable<Right[Extract<(...), (...)>]>, string>
              | `${Extract<keyof NonNullable<(...)[(...)]>, string>}.${NonNullable<
                  NonNullable<(...)>[Extract<(...), (...)>],
              > extends object
                  ?
                      | Extract<keyof (...), string>
                      | `${Extract<(...), (...)>}.${Extract<(...), (...)>}`
                  : never}`
          : never}`
      : never
- type: JoinType = "inner"
Returns IQueryBuilder<T & JoinResult<Right>>
Implementation of IQueryBuilder.join
- Defined in query/queryBuilder.ts:457

lessThan

lessThan(
    field: T extends object
        ? | Extract<keyof T, string>
        | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
            ?
                | Extract<keyof NonNullable<T[Extract<keyof (...), string>]>, string>
                | `${Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>}.${NonNullable<
                    NonNullable<(...)[(...)]>[Extract<keyof (...), string>],
                > extends object
                    ?
                        | Extract<keyof NonNullable<(...)>, string>
                        | `${Extract<keyof (...), string>}.${Extract<keyof (...), string>}`
                    : never}`
            : never}`
        : never,
    value: unknown,
): IQueryBuilder<T>
Add less-than filter.
Parameters
- field: T extends object
      ? | Extract<keyof T, string>
      | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
          ?
              | Extract<keyof NonNullable<T[Extract<keyof (...), string>]>, string>
              | `${Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>}.${NonNullable<
                  NonNullable<(...)[(...)]>[Extract<keyof (...), string>],
              > extends object
                  ?
                      | Extract<keyof NonNullable<(...)>, string>
                      | `${Extract<keyof (...), string>}.${Extract<keyof (...), string>}`
                  : never}`
          : never}`
      : never
- value: unknown
Returns IQueryBuilder<T>
Implementation of IQueryBuilder.lessThan
- Defined in query/queryBuilder.ts:417

lessThanOrEqual

lessThanOrEqual(
    field: T extends object
        ? | Extract<keyof T, string>
        | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
            ?
                | Extract<keyof NonNullable<T[Extract<keyof (...), string>]>, string>
                | `${Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>}.${NonNullable<
                    NonNullable<(...)[(...)]>[Extract<keyof (...), string>],
                > extends object
                    ?
                        | Extract<keyof NonNullable<(...)>, string>
                        | `${Extract<keyof (...), string>}.${Extract<keyof (...), string>}`
                    : never}`
            : never}`
        : never,
    value: unknown,
): IQueryBuilder<T>
Add less-than-or-equal filter.
Parameters
- field: T extends object
      ? | Extract<keyof T, string>
      | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
          ?
              | Extract<keyof NonNullable<T[Extract<keyof (...), string>]>, string>
              | `${Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>}.${NonNullable<
                  NonNullable<(...)[(...)]>[Extract<keyof (...), string>],
              > extends object
                  ?
                      | Extract<keyof NonNullable<(...)>, string>
                      | `${Extract<keyof (...), string>}.${Extract<keyof (...), string>}`
                  : never}`
          : never}`
      : never
- value: unknown
Returns IQueryBuilder<T>
Implementation of IQueryBuilder.lessThanOrEqual
- Defined in query/queryBuilder.ts:425

limit

limit(n: number): IQueryBuilder<T>
Limit number of results
Parameters
- n: number
Returns IQueryBuilder<T>
Implementation of IQueryBuilder.limit
- Defined in query/queryBuilder.ts:502

notEqual

notEqual(
    field: T extends object
        ? | Extract<keyof T, string>
        | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
            ?
                | Extract<keyof NonNullable<T[Extract<keyof (...), string>]>, string>
                | `${Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>}.${NonNullable<
                    NonNullable<(...)[(...)]>[Extract<keyof (...), string>],
                > extends object
                    ?
                        | Extract<keyof NonNullable<(...)>, string>
                        | `${Extract<keyof (...), string>}.${Extract<keyof (...), string>}`
                    : never}`
            : never}`
        : never,
    value: unknown,
): IQueryBuilder<T>
Add not-equal filter.
Parameters
- field: T extends object
      ? | Extract<keyof T, string>
      | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
          ?
              | Extract<keyof NonNullable<T[Extract<keyof (...), string>]>, string>
              | `${Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>}.${NonNullable<
                  NonNullable<(...)[(...)]>[Extract<keyof (...), string>],
              > extends object
                  ?
                      | Extract<keyof NonNullable<(...)>, string>
                      | `${Extract<keyof (...), string>}.${Extract<keyof (...), string>}`
                  : never}`
          : never}`
      : never
- value: unknown
Returns IQueryBuilder<T>
Implementation of IQueryBuilder.notEqual
- Defined in query/queryBuilder.ts:409

offset

offset(n: number): IQueryBuilder<T>
Skip first n results
Parameters
- n: number
Returns IQueryBuilder<T>
Implementation of IQueryBuilder.offset
- Defined in query/queryBuilder.ts:510

or

or(...filters: CTEFilter<T>[]): IQueryBuilder<T>
Add logical OR filter over provided filters.
Parameters
- ...filters: CTEFilter<T>[]
Returns IQueryBuilder<T>
Implementation of IQueryBuilder.or
- Defined in query/queryBuilder.ts:453

orderBy

orderBy(
    field: T extends object
        ? | Extract<keyof T, string>
        | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
            ?
                | Extract<keyof NonNullable<T[Extract<keyof (...), string>]>, string>
                | `${Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>}.${NonNullable<
                    NonNullable<(...)[(...)]>[Extract<keyof (...), string>],
                > extends object
                    ?
                        | Extract<keyof NonNullable<(...)>, string>
                        | `${Extract<keyof (...), string>}.${Extract<keyof (...), string>}`
                    : never}`
            : never}`
        : never,
    direction?: OrderDirection,
): IQueryBuilder<T>
Order results by field

Supports both top-level fields and nested paths using dot notation.
Parameters
- field: T extends object
      ? | Extract<keyof T, string>
      | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
          ?
              | Extract<keyof NonNullable<T[Extract<keyof (...), string>]>, string>
              | `${Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>}.${NonNullable<
                  NonNullable<(...)[(...)]>[Extract<keyof (...), string>],
              > extends object
                  ?
                      | Extract<keyof NonNullable<(...)>, string>
                      | `${Extract<keyof (...), string>}.${Extract<keyof (...), string>}`
                  : never}`
          : never}`
      : never
  Field name or nested path (e.g., 'name' or 'user.profile.name')
- direction: OrderDirection = "asc"
  Sort direction ('asc' or 'desc', default: 'asc')
Returns IQueryBuilder<T>
Example
```
collection.query().orderBy('name', 'asc')
collection.query().orderBy('user.profile.age', 'desc')
```
Implementation of IQueryBuilder.orderBy
- Defined in query/queryBuilder.ts:491

paginate

paginate(page: number, pageSize?: number): IQueryBuilder<T>
Paginate results by page number and page size
Parameters
- page: number
  Page number (0-indexed)
- pageSize: number = 10
  Number of results per page (default: 10)
Returns IQueryBuilder<T>
Query builder with offset and limit applied
Implementation of IQueryBuilder.paginate
- Defined in query/queryBuilder.ts:518

subscribe(
onUpdate: (docs: T[]) => void,
onError?: (error: Error) => void,
): UnsubscribeFn
Subscribe to query results

Establishes a subscription to documents matching the query. The subscription begins immediately and will emit results as they change. Errors thrown in the onUpdate callback are caught and passed to onError if provided.
Parameters
- onUpdate: (docs: T[]) => void
  Called with documents matching the query. Errors thrown here are caught and sent to onError.
- OptionalonError: (error: Error) => void
  Optional callback for errors. Called with adapter errors, filter evaluation errors, or subscriber callback errors. Non-recoverable: unsubscribe is recommended. To retry, create a new subscription.
Returns UnsubscribeFn
Unsubscribe function to clean up subscription and stop receiving updates
Implementation of IQueryBuilder.subscribe
- Defined in query/queryBuilder.ts:545

toCTE

toCTE(): CTE<T>
Export query as JSON-serializable CTE

Returns CTE<T>
Implementation of IQueryBuilder.toCTE
- Defined in query/queryBuilder.ts:554

where

where(filter: CTEFilter<T>): IQueryBuilder<T>
Add a filter condition to the CTE
Parameters
- filter: CTEFilter<T>
Returns IQueryBuilder<T>
Implementation of IQueryBuilder.where
- Defined in query/queryBuilder.ts:389

with

with(
name: string,
fn: (q: IQueryBuilder<T>) => IQueryBuilder<T>,
): IQueryBuilder<T>
Define a reusable CTE subquery
Parameters
- name: string
- fn: (q: IQueryBuilder<T>) => IQueryBuilder<T>
Returns IQueryBuilder<T>
Implementation of IQueryBuilder.with
- Defined in query/queryBuilder.ts:530

Class QueryBuilder<T>

Type Parameters

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Returns QueryBuilder<T>

Properties

Protected_cte

Protected_joins

Methods

and

Parameters

Returns IQueryBuilder<T>

compare

Parameters

Returns IQueryBuilder<T>

compileToFunction

Returns (docs: T[]) => T[]

contains

Parameters

Returns IQueryBuilder<T>

containsIgnoreCase

Parameters

Returns IQueryBuilder<T>

ProtectedcreateSubBuilder

Returns QueryBuilder<T>

equal

Parameters

Returns IQueryBuilder<T>

fuzzyContains

Parameters

Returns IQueryBuilder<T>

greaterThan

Parameters

Returns IQueryBuilder<T>

greaterThanOrEqual

Parameters

Returns IQueryBuilder<T>

in

Parameters

Returns IQueryBuilder<T>

includes

Parameters

Returns IQueryBuilder<T>

join

Type Parameters

Parameters

Returns IQueryBuilder<T & JoinResult<Right>>

lessThan

Parameters

Returns IQueryBuilder<T>

lessThanOrEqual

Parameters

Returns IQueryBuilder<T>

limit

Parameters

Returns IQueryBuilder<T>

notEqual

Parameters

Returns IQueryBuilder<T>

offset

Parameters

Returns IQueryBuilder<T>

or

Parameters

Returns IQueryBuilder<T>

orderBy

Parameters

Returns IQueryBuilder<T>

Example

paginate

Parameters

Returns IQueryBuilder<T>

subscribe

Parameters

`Protected`_cte

`Protected`_joins

`Protected`createSubBuilder