Interface QueryScope<S>

Shape-preserving immutable API supplied to named and default scopes.

interface QueryScope<S extends ReadObject> {
    "[PARAMETER_READER]": ScopeParameterReader;
    "[PARAMETER_STATE]": [];
    addReadPredicate(predicate: ReadPredicate): any;
    andWhere<
        G extends
            ReadPredicateBuilder<ReadColumns<S, keyof ReadRelations<S>>, any>,
    >(
        group: ReadPredicateGroup<
            ReadColumns<S, keyof ReadRelations<S>>,
            G & CheckParameterState<
                AppendOrigins<[], ParametersOf<NoInfer<G>>, "root">,
            >,
        >,
    ): QueryScope<S>;
    andWhere<
        const V extends
            Partial<Record<keyof ReadColumns<S, keyof ReadRelations<S>>, unknown>>,
    >(
        values: V & WithoutParameters<NoInfer<V>>,
    ): QueryScope<S>;
    andWhere<S extends string | ((columns: C) => AliasedColumn<any>), const A>(
        column: S,
        value: A & CheckScalarParameter<
            [],
            NoInfer<A>,
            PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
        >,
    ): QueryScope<S>;
    andWhere<S extends string | ((columns: C) => AliasedColumn<any>), const A>(
        column: S,
        operator: string,
        value: A & CheckScalarParameter<
            [],
            NoInfer<A>,
            PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
        >,
    ): QueryScope<S>;
    limit(count: number): this;
    offset(count: number): this;
    orderBy(
        column: ReadPredicateSelector<ReadColumns<S, keyof ReadRelations<S>>>,
        direction?: "desc" | "asc",
    ): this;
    orderByRaw(sql: string, bindings?: readonly RawBinding[]): this;
    orWhere<
        G extends
            ReadPredicateBuilder<ReadColumns<S, keyof ReadRelations<S>>, any>,
    >(
        group: ReadPredicateGroup<
            ReadColumns<S, keyof ReadRelations<S>>,
            G & CheckParameterState<
                AppendOrigins<[], ParametersOf<NoInfer<G>>, "root">,
            >,
        >,
    ): QueryScope<S>;
    orWhere<
        const V extends
            Partial<Record<keyof ReadColumns<S, keyof ReadRelations<S>>, unknown>>,
    >(
        values: V & WithoutParameters<NoInfer<V>>,
    ): QueryScope<S>;
    orWhere<S extends string | ((columns: C) => AliasedColumn<any>), const A>(
        column: S,
        value: A & CheckScalarParameter<
            [],
            NoInfer<A>,
            PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
        >,
    ): QueryScope<S>;
    orWhere<S extends string | ((columns: C) => AliasedColumn<any>), const A>(
        column: S,
        operator: string,
        value: A & CheckScalarParameter<
            [],
            NoInfer<A>,
            PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
        >,
    ): QueryScope<S>;
    orWhereExists(query: QueryBuilder): QueryScope<S>;
    orWhereIn<
        S extends string
        | ((columns: C) => AliasedColumn<any>),
        const A extends ReadMembership,
    >(
        column: S,
        values: A & CheckParameterValue<
            [],
            NoInfer<A>,
            PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
        >,
    ): QueryScope<S>;
    orWhereNotExists(query: QueryBuilder): QueryScope<S>;
    orWhereNotIn<
        S extends string
        | ((columns: C) => AliasedColumn<any>),
        const A extends ReadMembership,
    >(
        column: S,
        values: A & CheckParameterValue<
            [],
            NoInfer<A>,
            PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
        >,
    ): QueryScope<S>;
    orWhereNotNull(
        column: ReadPredicateSelector<ReadColumns<S, keyof ReadRelations<S>>>,
    ): QueryScope<S>;
    orWhereNull(
        column: ReadPredicateSelector<ReadColumns<S, keyof ReadRelations<S>>>,
    ): QueryScope<S>;
    orWhereRaw<const A extends readonly RawBinding[]>(
        sql: string,
        bindings: A & WithoutParameters<NoInfer<A>>,
    ): QueryScope<S>;
    orWhereRaw(sql: string): QueryScope<S>;
    readPredicateContext(): ReadPredicateContext<
        ReadColumns<S, keyof ReadRelations<S>>,
    >;
    ref(
        selector: ReadPredicateSelector<ReadColumns<S, keyof ReadRelations<S>>>,
    ): Raw<any> | Ref<string, {}>;
    where<
        G extends
            ReadPredicateBuilder<ReadColumns<S, keyof ReadRelations<S>>, any>,
    >(
        group: ReadPredicateGroup<
            ReadColumns<S, keyof ReadRelations<S>>,
            G & CheckParameterState<
                AppendOrigins<[], ParametersOf<NoInfer<G>>, "root">,
            >,
        >,
    ): QueryScope<S>;
    where<
        const V extends
            Partial<Record<keyof ReadColumns<S, keyof ReadRelations<S>>, unknown>>,
    >(
        values: V & WithoutParameters<NoInfer<V>>,
    ): QueryScope<S>;
    where<S extends string | ((columns: C) => AliasedColumn<any>), const A>(
        column: S,
        value: A & CheckScalarParameter<
            [],
            NoInfer<A>,
            PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
        >,
    ): QueryScope<S>;
    where<S extends string | ((columns: C) => AliasedColumn<any>), const A>(
        column: S,
        operator: string,
        value: A & CheckScalarParameter<
            [],
            NoInfer<A>,
            PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
        >,
    ): QueryScope<S>;
    whereBetween<
        S extends string
        | ((columns: C) => AliasedColumn<any>),
        const A extends readonly [unknown, unknown],
    >(
        column: S,
        range: A & CheckParameterValue<
            [],
            NoInfer<A>,
            PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
        >,
    ): QueryScope<S>;
    whereExists(query: QueryBuilder): QueryScope<S>;
    whereILike<
        S extends string
        | ((columns: C) => AliasedColumn<any>),
        const A,
    >(
        column: S,
        value: A & (
            A extends QueryParameter<string>
                ? CheckParameterValue<
                    [],
                    NoInfer<A>,
                    PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
                >
                : string
        ),
    ): QueryScope<S>;
    whereIn<
        S extends string
        | ((columns: C) => AliasedColumn<any>),
        const A extends ReadMembership,
    >(
        column: S,
        values: A & CheckParameterValue<
            [],
            NoInfer<A>,
            PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
        >,
    ): QueryScope<S>;
    whereJsonPath<A>(
        column: ReadPredicateSelector<ReadColumns<S, keyof ReadRelations<S>>>,
        path: string,
        operator?: string,
        value?: A & WithoutParameters<NoInfer<A>>,
    ): QueryScope<S>;
    whereLike<S extends string | ((columns: C) => AliasedColumn<any>), const A>(
        column: S,
        value: A & (
            A extends QueryParameter<string>
                ? CheckParameterValue<
                    [],
                    NoInfer<A>,
                    PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
                >
                : string
        ),
    ): QueryScope<S>;
    whereNot<S extends string | ((columns: C) => AliasedColumn<any>), const A>(
        column: S,
        value: A & CheckScalarParameter<
            [],
            NoInfer<A>,
            PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
        >,
    ): QueryScope<S>;
    whereNotBetween<
        S extends string
        | ((columns: C) => AliasedColumn<any>),
        const A extends readonly [unknown, unknown],
    >(
        column: S,
        range: A & CheckParameterValue<
            [],
            NoInfer<A>,
            PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
        >,
    ): QueryScope<S>;
    whereNotExists(query: QueryBuilder): QueryScope<S>;
    whereNotIn<
        S extends string
        | ((columns: C) => AliasedColumn<any>),
        const A extends ReadMembership,
    >(
        column: S,
        values: A & CheckParameterValue<
            [],
            NoInfer<A>,
            PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
        >,
    ): QueryScope<S>;
    whereNotNull(
        column: ReadPredicateSelector<ReadColumns<S, keyof ReadRelations<S>>>,
    ): QueryScope<S>;
    whereNull(
        column: ReadPredicateSelector<ReadColumns<S, keyof ReadRelations<S>>>,
    ): QueryScope<S>;
    whereRaw<const A extends readonly RawBinding[]>(
        sql: string,
        bindings: A & WithoutParameters<NoInfer<A>>,
    ): QueryScope<S>;
    whereRaw(sql: string): QueryScope<S>;
}

Type Parameters

S extends ReadObject

Hierarchy

ReadPredicates<
    ReadColumns<S, keyof ReadRelations<S>>,
    [],
    ScopeParameterReader<S>,
>
- QueryScope

Properties

`Readonly` `Internal`[PARAMETER_READER]

"[PARAMETER_READER]": ScopeParameterReader

Type-only fluent return constructor.

`Readonly` `Internal`[PARAMETER_STATE]

"[PARAMETER_STATE]": []

Type-only ordered argument contract.

Methods

`Protected` `Abstract`addReadPredicate

addReadPredicate(predicate: ReadPredicate): any
Parameters
- predicate: ReadPredicate
Returns any
Inherited from ReadPredicates.addReadPredicate
- Defined in libs/knex-schema/dist/read-predicates.d.ts:48

andWhere

andWhere<
    G extends
        ReadPredicateBuilder<ReadColumns<S, keyof ReadRelations<S>>, any>,
>(
    group: ReadPredicateGroup<
        ReadColumns<S, keyof ReadRelations<S>>,
        G & CheckParameterState<
            AppendOrigins<[], ParametersOf<NoInfer<G>>, "root">,
        >,
    >,
): QueryScope<S>
Explicit AND spelling of where(), including groups and typed parameters.
Type Parameters
- G extends ReadPredicateBuilder<ReadColumns<S, keyof ReadRelations<S>>, any>
Parameters
- group: ReadPredicateGroup<
      ReadColumns<S, keyof ReadRelations<S>>,
      G & CheckParameterState<
          AppendOrigins<[], ParametersOf<NoInfer<G>>, "root">,
      >,
  >
Returns QueryScope<S>
Inherited from ReadPredicates.andWhere
- Defined in libs/knex-schema/dist/read-predicates.d.ts:60
andWhere<
    const V extends
        Partial<Record<keyof ReadColumns<S, keyof ReadRelations<S>>, unknown>>,
>(
    values: V & WithoutParameters<NoInfer<V>>,
): QueryScope<S>
Explicit AND spelling of where(), including groups and typed parameters.
Type Parameters
- const V extends Partial<Record<keyof ReadColumns<S, keyof ReadRelations<S>>, unknown>>
Parameters
- values: V & WithoutParameters<NoInfer<V>>
Returns QueryScope<S>
Inherited from ReadPredicates.andWhere
- Defined in libs/knex-schema/dist/read-predicates.d.ts:61
andWhere<S extends string | ((columns: C) => AliasedColumn<any>), const A>(
    column: S,
    value: A & CheckScalarParameter<
        [],
        NoInfer<A>,
        PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
    >,
): QueryScope<S>
Explicit AND spelling of where(), including groups and typed parameters.
Type Parameters
- S extends string | ((columns: C) => AliasedColumn<any>)
- const A
Parameters
- column: S
- value: A & CheckScalarParameter<
      [],
      NoInfer<A>,
      PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
  >
Returns QueryScope<S>
Inherited from ReadPredicates.andWhere
- Defined in libs/knex-schema/dist/read-predicates.d.ts:62
andWhere<S extends string | ((columns: C) => AliasedColumn<any>), const A>(
    column: S,
    operator: string,
    value: A & CheckScalarParameter<
        [],
        NoInfer<A>,
        PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
    >,
): QueryScope<S>
Explicit AND spelling of where(), including groups and typed parameters.
Type Parameters
- S extends string | ((columns: C) => AliasedColumn<any>)
- const A
Parameters
- column: S
- operator: string
- value: A & CheckScalarParameter<
      [],
      NoInfer<A>,
      PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
  >
Returns QueryScope<S>
Inherited from ReadPredicates.andWhere
- Defined in libs/knex-schema/dist/read-predicates.d.ts:63

limit

limit(count: number): this
Limit a new query without changing its row shape.
Parameters
- count: number
Returns this
- Defined in libs/knex-schema/dist/query-scope.d.ts:15

offset

offset(count: number): this
Offset a new query without changing its row shape.
Parameters
- count: number
Returns this
- Defined in libs/knex-schema/dist/query-scope.d.ts:17

orderBy

orderBy(
column: ReadPredicateSelector<ReadColumns<S, keyof ReadRelations<S>>>,
direction?: "desc" | "asc",
): this
Append native column ordering. Return the new query.
Parameters
- column: ReadPredicateSelector<ReadColumns<S, keyof ReadRelations<S>>>
- Optionaldirection: "desc" | "asc"
Returns this
- Defined in libs/knex-schema/dist/query-scope.d.ts:11

orderByRaw

orderByRaw(sql: string, bindings?: readonly RawBinding[]): this
Append trusted ordering with captured bindings.
Parameters
- sql: string
- Optionalbindings: readonly RawBinding[]
Returns this
- Defined in libs/knex-schema/dist/query-scope.d.ts:13

orWhere

orWhere<
    G extends
        ReadPredicateBuilder<ReadColumns<S, keyof ReadRelations<S>>, any>,
>(
    group: ReadPredicateGroup<
        ReadColumns<S, keyof ReadRelations<S>>,
        G & CheckParameterState<
            AppendOrigins<[], ParametersOf<NoInfer<G>>, "root">,
        >,
    >,
): QueryScope<S>
Add an OR comparison or parenthesized group.
Type Parameters
- G extends ReadPredicateBuilder<ReadColumns<S, keyof ReadRelations<S>>, any>
Parameters
- group: ReadPredicateGroup<
      ReadColumns<S, keyof ReadRelations<S>>,
      G & CheckParameterState<
          AppendOrigins<[], ParametersOf<NoInfer<G>>, "root">,
      >,
  >
Returns QueryScope<S>
Inherited from ReadPredicates.orWhere
- Defined in libs/knex-schema/dist/read-predicates.d.ts:65
orWhere<
    const V extends
        Partial<Record<keyof ReadColumns<S, keyof ReadRelations<S>>, unknown>>,
>(
    values: V & WithoutParameters<NoInfer<V>>,
): QueryScope<S>
Add an OR comparison or parenthesized group.
Type Parameters
- const V extends Partial<Record<keyof ReadColumns<S, keyof ReadRelations<S>>, unknown>>
Parameters
- values: V & WithoutParameters<NoInfer<V>>
Returns QueryScope<S>
Inherited from ReadPredicates.orWhere
- Defined in libs/knex-schema/dist/read-predicates.d.ts:66
orWhere<S extends string | ((columns: C) => AliasedColumn<any>), const A>(
    column: S,
    value: A & CheckScalarParameter<
        [],
        NoInfer<A>,
        PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
    >,
): QueryScope<S>
Add an OR comparison or parenthesized group.
Type Parameters
- S extends string | ((columns: C) => AliasedColumn<any>)
- const A
Parameters
- column: S
- value: A & CheckScalarParameter<
      [],
      NoInfer<A>,
      PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
  >
Returns QueryScope<S>
Inherited from ReadPredicates.orWhere
- Defined in libs/knex-schema/dist/read-predicates.d.ts:67
orWhere<S extends string | ((columns: C) => AliasedColumn<any>), const A>(
    column: S,
    operator: string,
    value: A & CheckScalarParameter<
        [],
        NoInfer<A>,
        PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
    >,
): QueryScope<S>
Add an OR comparison or parenthesized group.
Type Parameters
- S extends string | ((columns: C) => AliasedColumn<any>)
- const A
Parameters
- column: S
- operator: string
- value: A & CheckScalarParameter<
      [],
      NoInfer<A>,
      PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
  >
Returns QueryScope<S>
Inherited from ReadPredicates.orWhere
- Defined in libs/knex-schema/dist/read-predicates.d.ts:68

orWhereExists

orWhereExists(query: QueryBuilder): QueryScope<S>
Parameters
- query: QueryBuilder
Returns QueryScope<S>
Inherited from ReadPredicates.orWhereExists
- Defined in libs/knex-schema/dist/read-predicates.d.ts:85

orWhereIn

orWhereIn<
    S extends string
    | ((columns: C) => AliasedColumn<any>),
    const A extends ReadMembership,
>(
    column: S,
    values: A & CheckParameterValue<
        [],
        NoInfer<A>,
        PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
    >,
): QueryScope<S>
Type Parameters
- S extends string | ((columns: C) => AliasedColumn<any>)
- const A extends ReadMembership
Parameters
- column: S
- values: A & CheckParameterValue<
      [],
      NoInfer<A>,
      PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
  >
Returns QueryScope<S>
Inherited from ReadPredicates.orWhereIn
- Defined in libs/knex-schema/dist/read-predicates.d.ts:80

orWhereNotExists

orWhereNotExists(query: QueryBuilder): QueryScope<S>
Parameters
- query: QueryBuilder
Returns QueryScope<S>
Inherited from ReadPredicates.orWhereNotExists
- Defined in libs/knex-schema/dist/read-predicates.d.ts:86

orWhereNotIn

orWhereNotIn<
    S extends string
    | ((columns: C) => AliasedColumn<any>),
    const A extends ReadMembership,
>(
    column: S,
    values: A & CheckParameterValue<
        [],
        NoInfer<A>,
        PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
    >,
): QueryScope<S>
Type Parameters
- S extends string | ((columns: C) => AliasedColumn<any>)
- const A extends ReadMembership
Parameters
- column: S
- values: A & CheckParameterValue<
      [],
      NoInfer<A>,
      PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
  >
Returns QueryScope<S>
Inherited from ReadPredicates.orWhereNotIn
- Defined in libs/knex-schema/dist/read-predicates.d.ts:81

orWhereNotNull

orWhereNotNull(
column: ReadPredicateSelector<ReadColumns<S, keyof ReadRelations<S>>>,
): QueryScope<S>
Parameters
- column: ReadPredicateSelector<ReadColumns<S, keyof ReadRelations<S>>>
Returns QueryScope<S>
Inherited from ReadPredicates.orWhereNotNull
- Defined in libs/knex-schema/dist/read-predicates.d.ts:75

orWhereNull

orWhereNull(
column: ReadPredicateSelector<ReadColumns<S, keyof ReadRelations<S>>>,
): QueryScope<S>
Parameters
- column: ReadPredicateSelector<ReadColumns<S, keyof ReadRelations<S>>>
Returns QueryScope<S>
Inherited from ReadPredicates.orWhereNull
- Defined in libs/knex-schema/dist/read-predicates.d.ts:74

orWhereRaw

orWhereRaw<const A extends readonly RawBinding[]>(
sql: string,
bindings: A & WithoutParameters<NoInfer<A>>,
): QueryScope<S>
Type Parameters
- const A extends readonly RawBinding[]
Parameters
- sql: string
- bindings: A & WithoutParameters<NoInfer<A>>
Returns QueryScope<S>
Inherited from ReadPredicates.orWhereRaw
- Defined in libs/knex-schema/dist/read-predicates.d.ts:90
orWhereRaw(sql: string): QueryScope<S>
Parameters
- sql: string
Returns QueryScope<S>
Inherited from ReadPredicates.orWhereRaw
- Defined in libs/knex-schema/dist/read-predicates.d.ts:91

`Protected` `Abstract`readPredicateContext

readPredicateContext(): ReadPredicateContext<
ReadColumns<S, keyof ReadRelations<S>>,
>
Returns ReadPredicateContext<ReadColumns<S, keyof ReadRelations<S>>>
Inherited from ReadPredicates.readPredicateContext
- Defined in libs/knex-schema/dist/read-predicates.d.ts:47

ref

ref(
selector: ReadPredicateSelector<ReadColumns<S, keyof ReadRelations<S>>>,
): Raw<any> | Ref<string, {}>
Quote a mapped column for trusted raw SQL or correlated subqueries.
Parameters
- selector: ReadPredicateSelector<ReadColumns<S, keyof ReadRelations<S>>>
Returns Raw<any> | Ref<string, {}>
Inherited from ReadPredicates.ref
- Defined in libs/knex-schema/dist/read-predicates.d.ts:50

where

where<
    G extends
        ReadPredicateBuilder<ReadColumns<S, keyof ReadRelations<S>>, any>,
>(
    group: ReadPredicateGroup<
        ReadColumns<S, keyof ReadRelations<S>>,
        G & CheckParameterState<
            AppendOrigins<[], ParametersOf<NoInfer<G>>, "root">,
        >,
    >,
): QueryScope<S>
Add a synchronous group, retaining the group's inferred named parameters.
Type Parameters
- G extends ReadPredicateBuilder<ReadColumns<S, keyof ReadRelations<S>>, any>
Parameters
- group: ReadPredicateGroup<
      ReadColumns<S, keyof ReadRelations<S>>,
      G & CheckParameterState<
          AppendOrigins<[], ParametersOf<NoInfer<G>>, "root">,
      >,
  >
Returns QueryScope<S>
Inherited from ReadPredicates.where
- Defined in libs/knex-schema/dist/read-predicates.d.ts:52
where<
    const V extends
        Partial<Record<keyof ReadColumns<S, keyof ReadRelations<S>>, unknown>>,
>(
    values: V & WithoutParameters<NoInfer<V>>,
): QueryScope<S>
Match a record of concrete equality values. Use selectors for parameters.
Type Parameters
- const V extends Partial<Record<keyof ReadColumns<S, keyof ReadRelations<S>>, unknown>>
Parameters
- values: V & WithoutParameters<NoInfer<V>>
Returns QueryScope<S>
Inherited from ReadPredicates.where
- Defined in libs/knex-schema/dist/read-predicates.d.ts:54
where<S extends string | ((columns: C) => AliasedColumn<any>), const A>(
    column: S,
    value: A & CheckScalarParameter<
        [],
        NoInfer<A>,
        PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
    >,
): QueryScope<S>
Match a column and infer a named parameter's storage type.
Type Parameters
- S extends string | ((columns: C) => AliasedColumn<any>)
- const A
Parameters
- column: S
- value: A & CheckScalarParameter<
      [],
      NoInfer<A>,
      PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
  >
Returns QueryScope<S>
Inherited from ReadPredicates.where
- Defined in libs/knex-schema/dist/read-predicates.d.ts:56
where<S extends string | ((columns: C) => AliasedColumn<any>), const A>(
    column: S,
    operator: string,
    value: A & CheckScalarParameter<
        [],
        NoInfer<A>,
        PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
    >,
): QueryScope<S>
Add a bound comparison using a supported SQL operator.
Type Parameters
- S extends string | ((columns: C) => AliasedColumn<any>)
- const A
Parameters
- column: S
- operator: string
- value: A & CheckScalarParameter<
      [],
      NoInfer<A>,
      PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
  >
Returns QueryScope<S>
Inherited from ReadPredicates.where
- Defined in libs/knex-schema/dist/read-predicates.d.ts:58

whereBetween

whereBetween<
    S extends string
    | ((columns: C) => AliasedColumn<any>),
    const A extends readonly [unknown, unknown],
>(
    column: S,
    range: A & CheckParameterValue<
        [],
        NoInfer<A>,
        PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
    >,
): QueryScope<S>
Type Parameters
- S extends string | ((columns: C) => AliasedColumn<any>)
- const A extends readonly [unknown, unknown]
Parameters
- column: S
- range: A & CheckParameterValue<
      [],
      NoInfer<A>,
      PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
  >
Returns QueryScope<S>
Inherited from ReadPredicates.whereBetween
- Defined in libs/knex-schema/dist/read-predicates.d.ts:94

whereExists

whereExists(query: QueryBuilder): QueryScope<S>
Parameters
- query: QueryBuilder
Returns QueryScope<S>
Inherited from ReadPredicates.whereExists
- Defined in libs/knex-schema/dist/read-predicates.d.ts:83

whereILike

whereILike<S extends string | ((columns: C) => AliasedColumn<any>), const A>(
    column: S,
    value: A & (
        A extends QueryParameter<string>
            ? CheckParameterValue<
                [],
                NoInfer<A>,
                PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
            >
            : string
    ),
): QueryScope<S>
Type Parameters
- S extends string | ((columns: C) => AliasedColumn<any>)
- const A
Parameters
- column: S
- value: A & (
      A extends QueryParameter<string>
          ? CheckParameterValue<
              [],
              NoInfer<A>,
              PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
          >
          : string
  )
Returns QueryScope<S>
Inherited from ReadPredicates.whereILike
- Defined in libs/knex-schema/dist/read-predicates.d.ts:98

whereIn

whereIn<
    S extends string
    | ((columns: C) => AliasedColumn<any>),
    const A extends ReadMembership,
>(
    column: S,
    values: A & CheckParameterValue<
        [],
        NoInfer<A>,
        PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
    >,
): QueryScope<S>
Match a fixed value tuple or captured SELECT subquery.
Type Parameters
- S extends string | ((columns: C) => AliasedColumn<any>)
- const A extends ReadMembership
Parameters
- column: S
- values: A & CheckParameterValue<
      [],
      NoInfer<A>,
      PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
  >
Returns QueryScope<S>
Inherited from ReadPredicates.whereIn
- Defined in libs/knex-schema/dist/read-predicates.d.ts:78

whereJsonPath

whereJsonPath<A>(
    column: ReadPredicateSelector<ReadColumns<S, keyof ReadRelations<S>>>,
    path: string,
    operator?: string,
    value?: A & WithoutParameters<NoInfer<A>>,
): QueryScope<S>
JSON-path strings do not provide a schema-derived parameter type.
Type Parameters
- A
Parameters
- column: ReadPredicateSelector<ReadColumns<S, keyof ReadRelations<S>>>
- path: string
- Optionaloperator: string
- Optionalvalue: A & WithoutParameters<NoInfer<A>>
Returns QueryScope<S>
Inherited from ReadPredicates.whereJsonPath
- Defined in libs/knex-schema/dist/read-predicates.d.ts:100

whereLike

whereLike<S extends string | ((columns: C) => AliasedColumn<any>), const A>(
    column: S,
    value: A & (
        A extends QueryParameter<string>
            ? CheckParameterValue<
                [],
                NoInfer<A>,
                PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
            >
            : string
    ),
): QueryScope<S>
Type Parameters
- S extends string | ((columns: C) => AliasedColumn<any>)
- const A
Parameters
- column: S
- value: A & (
      A extends QueryParameter<string>
          ? CheckParameterValue<
              [],
              NoInfer<A>,
              PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
          >
          : string
  )
Returns QueryScope<S>
Inherited from ReadPredicates.whereLike
- Defined in libs/knex-schema/dist/read-predicates.d.ts:97

whereNot

whereNot<S extends string | ((columns: C) => AliasedColumn<any>), const A>(
    column: S,
    value: A & CheckScalarParameter<
        [],
        NoInfer<A>,
        PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
    >,
): QueryScope<S>
Negate equality while preserving ordinary SQL null semantics.
Type Parameters
- S extends string | ((columns: C) => AliasedColumn<any>)
- const A
Parameters
- column: S
- value: A & CheckScalarParameter<
      [],
      NoInfer<A>,
      PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
  >
Returns QueryScope<S>
Inherited from ReadPredicates.whereNot
- Defined in libs/knex-schema/dist/read-predicates.d.ts:93

whereNotBetween

whereNotBetween<
    S extends string
    | ((columns: C) => AliasedColumn<any>),
    const A extends readonly [unknown, unknown],
>(
    column: S,
    range: A & CheckParameterValue<
        [],
        NoInfer<A>,
        PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
    >,
): QueryScope<S>
Type Parameters
- S extends string | ((columns: C) => AliasedColumn<any>)
- const A extends readonly [unknown, unknown]
Parameters
- column: S
- range: A & CheckParameterValue<
      [],
      NoInfer<A>,
      PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
  >
Returns QueryScope<S>
Inherited from ReadPredicates.whereNotBetween
- Defined in libs/knex-schema/dist/read-predicates.d.ts:95

whereNotExists

whereNotExists(query: QueryBuilder): QueryScope<S>
Parameters
- query: QueryBuilder
Returns QueryScope<S>
Inherited from ReadPredicates.whereNotExists
- Defined in libs/knex-schema/dist/read-predicates.d.ts:84

whereNotIn

whereNotIn<
    S extends string
    | ((columns: C) => AliasedColumn<any>),
    const A extends ReadMembership,
>(
    column: S,
    values: A & CheckParameterValue<
        [],
        NoInfer<A>,
        PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
    >,
): QueryScope<S>
Type Parameters
- S extends string | ((columns: C) => AliasedColumn<any>)
- const A extends ReadMembership
Parameters
- column: S
- values: A & CheckParameterValue<
      [],
      NoInfer<A>,
      PredicateValue<ReadColumns<S, keyof ReadRelations<S>>, S>,
  >
Returns QueryScope<S>
Inherited from ReadPredicates.whereNotIn
- Defined in libs/knex-schema/dist/read-predicates.d.ts:79

whereNotNull

whereNotNull(
column: ReadPredicateSelector<ReadColumns<S, keyof ReadRelations<S>>>,
): QueryScope<S>
Parameters
- column: ReadPredicateSelector<ReadColumns<S, keyof ReadRelations<S>>>
Returns QueryScope<S>
Inherited from ReadPredicates.whereNotNull
- Defined in libs/knex-schema/dist/read-predicates.d.ts:73

whereNull

whereNull(
column: ReadPredicateSelector<ReadColumns<S, keyof ReadRelations<S>>>,
): QueryScope<S>
Match SQL null without changing the declared result type.
Parameters
- column: ReadPredicateSelector<ReadColumns<S, keyof ReadRelations<S>>>
Returns QueryScope<S>
Inherited from ReadPredicates.whereNull
- Defined in libs/knex-schema/dist/read-predicates.d.ts:72

whereRaw

whereRaw<const A extends readonly RawBinding[]>(
sql: string,
bindings: A & WithoutParameters<NoInfer<A>>,
): QueryScope<S>
Trusted SQL with concrete bindings; use a typed predicate for placeholders.
Type Parameters
- const A extends readonly RawBinding[]
Parameters
- sql: string
- bindings: A & WithoutParameters<NoInfer<A>>
Returns QueryScope<S>
Inherited from ReadPredicates.whereRaw
- Defined in libs/knex-schema/dist/read-predicates.d.ts:88
whereRaw(sql: string): QueryScope<S>
Trusted SQL with concrete bindings; use a typed predicate for placeholders.
Parameters
- sql: string
Returns QueryScope<S>
Inherited from ReadPredicates.whereRaw
- Defined in libs/knex-schema/dist/read-predicates.d.ts:89

Interface QueryScope<S>

Type Parameters

Hierarchy

Index

Properties

Methods

Properties

Readonly Internal[PARAMETER_READER]

Readonly Internal[PARAMETER_STATE]

Methods

Protected AbstractaddReadPredicate

Parameters

Returns any

andWhere

Type Parameters

Parameters

Returns QueryScope<S>

Type Parameters

Parameters

Returns QueryScope<S>

Type Parameters

Parameters

Returns QueryScope<S>

Type Parameters

Parameters

Returns QueryScope<S>

limit

Parameters

Returns this

offset

Parameters

Returns this

orderBy

Parameters

Returns this

orderByRaw

Parameters

Returns this

orWhere

Type Parameters

Parameters

Returns QueryScope<S>

Type Parameters

Parameters

Returns QueryScope<S>

Type Parameters

Parameters

Returns QueryScope<S>

Type Parameters

Parameters

Returns QueryScope<S>

orWhereExists

Parameters

Returns QueryScope<S>

orWhereIn

Type Parameters

Parameters

Returns QueryScope<S>

orWhereNotExists

Parameters

Returns QueryScope<S>

orWhereNotIn

Type Parameters

Parameters

Returns QueryScope<S>

orWhereNotNull

Parameters

Returns QueryScope<S>

orWhereNull

Parameters

Returns QueryScope<S>

orWhereRaw

Type Parameters

Parameters

Returns QueryScope<S>

Parameters

Returns QueryScope<S>

Protected AbstractreadPredicateContext

Returns ReadPredicateContext<ReadColumns<S, keyof ReadRelations<S>>>

ref

`Readonly` `Internal`[PARAMETER_READER]

`Readonly` `Internal`[PARAMETER_STATE]

`Protected` `Abstract`addReadPredicate

`Protected` `Abstract`readPredicateContext