Interface ReadPredicateBuilder<C, P>

Predicate-only immutable builder; no execution, projection or ordering methods.

interface ReadPredicateBuilder<C, P extends ParameterState = []> {
    "[PARAMETER_READER]": GroupParameterReader;
    "[PARAMETER_STATE]": P;
    "[finishGroup]"(): readonly ReadPredicate[];
    addReadPredicate(predicate: ReadPredicate): any;
    andWhere<G extends ReadPredicateBuilder<C, any>>(
        group: ReadPredicateGroup<
            C,
            G & CheckParameterState<
                AppendOrigins<P, ParametersOf<NoInfer<G>>, "root">,
            >,
        >,
    ): ReadPredicateBuilder<
        C,
        AppendOrigins<P, ParametersOf<G>, "root"> extends ParameterState
            ? ParameterState & AppendOrigins<P, ParametersOf<G>, "root">
            : never,
    >;
    andWhere<const V extends Partial<Record<keyof C, unknown>>>(
        values: V & WithoutParameters<NoInfer<V>>,
    ): ReadPredicateBuilder<C, P extends ParameterState ? P : never>;
    andWhere<S extends string | ((columns: C) => AliasedColumn<any>), const A>(
        column: S,
        value: A & CheckScalarParameter<P, NoInfer<A>, PredicateValue<C, S>>,
    ): ReadPredicateBuilder<
        C,
        ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
            ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
            : never,
    >;
    andWhere<S extends string | ((columns: C) => AliasedColumn<any>), const A>(
        column: S,
        operator: string,
        value: A & CheckScalarParameter<P, NoInfer<A>, PredicateValue<C, S>>,
    ): ReadPredicateBuilder<
        C,
        ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
            ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
            : never,
    >;
    orWhere<G extends ReadPredicateBuilder<C, any>>(
        group: ReadPredicateGroup<
            C,
            G & CheckParameterState<
                AppendOrigins<P, ParametersOf<NoInfer<G>>, "root">,
            >,
        >,
    ): ReadPredicateBuilder<
        C,
        AppendOrigins<P, ParametersOf<G>, "root"> extends ParameterState
            ? ParameterState & AppendOrigins<P, ParametersOf<G>, "root">
            : never,
    >;
    orWhere<const V extends Partial<Record<keyof C, unknown>>>(
        values: V & WithoutParameters<NoInfer<V>>,
    ): ReadPredicateBuilder<C, P extends ParameterState ? P : never>;
    orWhere<S extends string | ((columns: C) => AliasedColumn<any>), const A>(
        column: S,
        value: A & CheckScalarParameter<P, NoInfer<A>, PredicateValue<C, S>>,
    ): ReadPredicateBuilder<
        C,
        ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
            ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
            : never,
    >;
    orWhere<S extends string | ((columns: C) => AliasedColumn<any>), const A>(
        column: S,
        operator: string,
        value: A & CheckScalarParameter<P, NoInfer<A>, PredicateValue<C, S>>,
    ): ReadPredicateBuilder<
        C,
        ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
            ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
            : never,
    >;
    orWhereExists(
        query: QueryBuilder,
    ): ReadPredicateBuilder<C, P extends ParameterState ? P : never>;
    orWhereIn<
        S extends string
        | ((columns: C) => AliasedColumn<any>),
        const A extends ReadMembership,
    >(
        column: S,
        values: A & CheckParameterValue<P, NoInfer<A>, PredicateValue<C, S>>,
    ): ReadPredicateBuilder<
        C,
        ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
            ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
            : never,
    >;
    orWhereNotExists(
        query: QueryBuilder,
    ): ReadPredicateBuilder<C, P extends ParameterState ? P : never>;
    orWhereNotIn<
        S extends string
        | ((columns: C) => AliasedColumn<any>),
        const A extends ReadMembership,
    >(
        column: S,
        values: A & CheckParameterValue<P, NoInfer<A>, PredicateValue<C, S>>,
    ): ReadPredicateBuilder<
        C,
        ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
            ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
            : never,
    >;
    orWhereNotNull(
        column: ReadPredicateSelector<C>,
    ): ReadPredicateBuilder<C, P extends ParameterState ? P : never>;
    orWhereNull(
        column: ReadPredicateSelector<C>,
    ): ReadPredicateBuilder<C, P extends ParameterState ? P : never>;
    orWhereRaw<const A extends readonly RawBinding[]>(
        sql: string,
        bindings: A & WithoutParameters<NoInfer<A>>,
    ): ReadPredicateBuilder<C, P extends ParameterState ? P : never>;
    orWhereRaw(
        sql: string,
    ): ReadPredicateBuilder<C, P extends ParameterState ? P : never>;
    readPredicateContext(): ReadPredicateContext<C>;
    ref(selector: ReadPredicateSelector<C>): Raw<any> | Ref<string, {}>;
    sameSource(other: ReadPredicateBuilder<C, any>): boolean;
    where<G extends ReadPredicateBuilder<C, any>>(
        group: ReadPredicateGroup<
            C,
            G & CheckParameterState<
                AppendOrigins<P, ParametersOf<NoInfer<G>>, "root">,
            >,
        >,
    ): ReadPredicateBuilder<
        C,
        AppendOrigins<P, ParametersOf<G>, "root"> extends ParameterState
            ? ParameterState & AppendOrigins<P, ParametersOf<G>, "root">
            : never,
    >;
    where<const V extends Partial<Record<keyof C, unknown>>>(
        values: V & WithoutParameters<NoInfer<V>>,
    ): ReadPredicateBuilder<C, P extends ParameterState ? P : never>;
    where<S extends string | ((columns: C) => AliasedColumn<any>), const A>(
        column: S,
        value: A & CheckScalarParameter<P, NoInfer<A>, PredicateValue<C, S>>,
    ): ReadPredicateBuilder<
        C,
        ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
            ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
            : never,
    >;
    where<S extends string | ((columns: C) => AliasedColumn<any>), const A>(
        column: S,
        operator: string,
        value: A & CheckScalarParameter<P, NoInfer<A>, PredicateValue<C, S>>,
    ): ReadPredicateBuilder<
        C,
        ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
            ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
            : never,
    >;
    whereBetween<
        S extends string
        | ((columns: C) => AliasedColumn<any>),
        const A extends readonly [unknown, unknown],
    >(
        column: S,
        range: A & CheckParameterValue<P, NoInfer<A>, PredicateValue<C, S>>,
    ): ReadPredicateBuilder<
        C,
        ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
            ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
            : never,
    >;
    whereExists(
        query: QueryBuilder,
    ): ReadPredicateBuilder<C, P extends ParameterState ? P : never>;
    whereILike<
        S extends string
        | ((columns: C) => AliasedColumn<any>),
        const A,
    >(
        column: S,
        value: A & (
            A extends QueryParameter<string>
                ? CheckParameterValue<P, NoInfer<A>, PredicateValue<C, S>>
                : string
        ),
    ): ReadPredicateBuilder<
        C,
        ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
            ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
            : never,
    >;
    whereIn<
        S extends string
        | ((columns: C) => AliasedColumn<any>),
        const A extends ReadMembership,
    >(
        column: S,
        values: A & CheckParameterValue<P, NoInfer<A>, PredicateValue<C, S>>,
    ): ReadPredicateBuilder<
        C,
        ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
            ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
            : never,
    >;
    whereJsonPath<A>(
        column: ReadPredicateSelector<C>,
        path: string,
        operator?: string,
        value?: A & WithoutParameters<NoInfer<A>>,
    ): ReadPredicateBuilder<C, P extends ParameterState ? P : never>;
    whereLike<S extends string | ((columns: C) => AliasedColumn<any>), const A>(
        column: S,
        value: A & (
            A extends QueryParameter<string>
                ? CheckParameterValue<P, NoInfer<A>, PredicateValue<C, S>>
                : string
        ),
    ): ReadPredicateBuilder<
        C,
        ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
            ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
            : never,
    >;
    whereNot<S extends string | ((columns: C) => AliasedColumn<any>), const A>(
        column: S,
        value: A & CheckScalarParameter<P, NoInfer<A>, PredicateValue<C, S>>,
    ): ReadPredicateBuilder<
        C,
        ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
            ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
            : never,
    >;
    whereNotBetween<
        S extends string
        | ((columns: C) => AliasedColumn<any>),
        const A extends readonly [unknown, unknown],
    >(
        column: S,
        range: A & CheckParameterValue<P, NoInfer<A>, PredicateValue<C, S>>,
    ): ReadPredicateBuilder<
        C,
        ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
            ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
            : never,
    >;
    whereNotExists(
        query: QueryBuilder,
    ): ReadPredicateBuilder<C, P extends ParameterState ? P : never>;
    whereNotIn<
        S extends string
        | ((columns: C) => AliasedColumn<any>),
        const A extends ReadMembership,
    >(
        column: S,
        values: A & CheckParameterValue<P, NoInfer<A>, PredicateValue<C, S>>,
    ): ReadPredicateBuilder<
        C,
        ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
            ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
            : never,
    >;
    whereNotNull(
        column: ReadPredicateSelector<C>,
    ): ReadPredicateBuilder<C, P extends ParameterState ? P : never>;
    whereNull(
        column: ReadPredicateSelector<C>,
    ): ReadPredicateBuilder<C, P extends ParameterState ? P : never>;
    whereRaw<const A extends readonly RawBinding[]>(
        sql: string,
        bindings: A & WithoutParameters<NoInfer<A>>,
    ): ReadPredicateBuilder<C, P extends ParameterState ? P : never>;
    whereRaw(
        sql: string,
    ): ReadPredicateBuilder<C, P extends ParameterState ? P : never>;
}

Type Parameters

C
P extends ParameterState = []

Hierarchy

ReadPredicates<C, P, GroupParameterReader<C>>
- ReadPredicateBuilder

Properties

`Readonly` `Internal`[PARAMETER_READER]

"[PARAMETER_READER]": GroupParameterReader

Type-only fluent return constructor.

`Readonly` `Internal`[PARAMETER_STATE]

"[PARAMETER_STATE]": P

Type-only ordered argument contract.

Methods

[finishGroup]

"[finishGroup]"(): readonly ReadPredicate[]
Internal
Snapshot the configured group without executing its callbacks again.

Returns readonly ReadPredicate[]
- Defined in libs/knex-schema/dist/read-predicates.d.ts:112

`Protected`addReadPredicate

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

andWhere

andWhere<G extends ReadPredicateBuilder<C, any>>(
    group: ReadPredicateGroup<
        C,
        G & CheckParameterState<
            AppendOrigins<P, ParametersOf<NoInfer<G>>, "root">,
        >,
    >,
): ReadPredicateBuilder<
    C,
    AppendOrigins<P, ParametersOf<G>, "root"> extends ParameterState
        ? ParameterState & AppendOrigins<P, ParametersOf<G>, "root">
        : never,
>
Explicit AND spelling of where(), including groups and typed parameters.
Type Parameters
- G extends ReadPredicateBuilder<C, any>
Parameters
- group: ReadPredicateGroup<
  C,
  G & CheckParameterState<AppendOrigins<P, ParametersOf<NoInfer<G>>, "root">>,
  >
Returns ReadPredicateBuilder<
    C,
    AppendOrigins<P, ParametersOf<G>, "root"> extends ParameterState
        ? ParameterState & AppendOrigins<P, ParametersOf<G>, "root">
        : never,
>
Inherited from ReadPredicates.andWhere
- Defined in libs/knex-schema/dist/read-predicates.d.ts:60
andWhere<const V extends Partial<Record<keyof C, unknown>>>(
values: V & WithoutParameters<NoInfer<V>>,
): ReadPredicateBuilder<C, P extends ParameterState ? P : never>
Explicit AND spelling of where(), including groups and typed parameters.
Type Parameters
- const V extends Partial<Record<keyof C, unknown>>
Parameters
- values: V & WithoutParameters<NoInfer<V>>
Returns ReadPredicateBuilder<C, P extends ParameterState ? P : never>
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<P, NoInfer<A>, PredicateValue<C, S>>,
): ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
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<P, NoInfer<A>, PredicateValue<C, S>>
Returns ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
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<P, NoInfer<A>, PredicateValue<C, S>>,
): ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
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<P, NoInfer<A>, PredicateValue<C, S>>
Returns ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
Inherited from ReadPredicates.andWhere
- Defined in libs/knex-schema/dist/read-predicates.d.ts:63

orWhere

orWhere<G extends ReadPredicateBuilder<C, any>>(
    group: ReadPredicateGroup<
        C,
        G & CheckParameterState<
            AppendOrigins<P, ParametersOf<NoInfer<G>>, "root">,
        >,
    >,
): ReadPredicateBuilder<
    C,
    AppendOrigins<P, ParametersOf<G>, "root"> extends ParameterState
        ? ParameterState & AppendOrigins<P, ParametersOf<G>, "root">
        : never,
>
Add an OR comparison or parenthesized group.
Type Parameters
- G extends ReadPredicateBuilder<C, any>
Parameters
- group: ReadPredicateGroup<
  C,
  G & CheckParameterState<AppendOrigins<P, ParametersOf<NoInfer<G>>, "root">>,
  >
Returns ReadPredicateBuilder<
    C,
    AppendOrigins<P, ParametersOf<G>, "root"> extends ParameterState
        ? ParameterState & AppendOrigins<P, ParametersOf<G>, "root">
        : never,
>
Inherited from ReadPredicates.orWhere
- Defined in libs/knex-schema/dist/read-predicates.d.ts:65
orWhere<const V extends Partial<Record<keyof C, unknown>>>(
values: V & WithoutParameters<NoInfer<V>>,
): ReadPredicateBuilder<C, P extends ParameterState ? P : never>
Add an OR comparison or parenthesized group.
Type Parameters
- const V extends Partial<Record<keyof C, unknown>>
Parameters
- values: V & WithoutParameters<NoInfer<V>>
Returns ReadPredicateBuilder<C, P extends ParameterState ? P : never>
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<P, NoInfer<A>, PredicateValue<C, S>>,
): ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
Add an OR comparison or parenthesized group.
Type Parameters
- S extends string | ((columns: C) => AliasedColumn<any>)
- const A
Parameters
- column: S
- value: A & CheckScalarParameter<P, NoInfer<A>, PredicateValue<C, S>>
Returns ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
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<P, NoInfer<A>, PredicateValue<C, S>>,
): ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
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<P, NoInfer<A>, PredicateValue<C, S>>
Returns ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
Inherited from ReadPredicates.orWhere
- Defined in libs/knex-schema/dist/read-predicates.d.ts:68

orWhereExists

orWhereExists(
query: QueryBuilder,
): ReadPredicateBuilder<C, P extends ParameterState ? P : never>
Parameters
- query: QueryBuilder
Returns ReadPredicateBuilder<C, P extends ParameterState ? P : never>
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<P, NoInfer<A>, PredicateValue<C, S>>,
): ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
Type Parameters
- S extends string | ((columns: C) => AliasedColumn<any>)
- const A extends ReadMembership
Parameters
- column: S
- values: A & CheckParameterValue<P, NoInfer<A>, PredicateValue<C, S>>
Returns ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
Inherited from ReadPredicates.orWhereIn
- Defined in libs/knex-schema/dist/read-predicates.d.ts:80

orWhereNotExists

orWhereNotExists(
query: QueryBuilder,
): ReadPredicateBuilder<C, P extends ParameterState ? P : never>
Parameters
- query: QueryBuilder
Returns ReadPredicateBuilder<C, P extends ParameterState ? P : never>
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<P, NoInfer<A>, PredicateValue<C, S>>,
): ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
Type Parameters
- S extends string | ((columns: C) => AliasedColumn<any>)
- const A extends ReadMembership
Parameters
- column: S
- values: A & CheckParameterValue<P, NoInfer<A>, PredicateValue<C, S>>
Returns ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
Inherited from ReadPredicates.orWhereNotIn
- Defined in libs/knex-schema/dist/read-predicates.d.ts:81

orWhereNotNull

orWhereNotNull(
column: ReadPredicateSelector<C>,
): ReadPredicateBuilder<C, P extends ParameterState ? P : never>
Parameters
- column: ReadPredicateSelector<C>
Returns ReadPredicateBuilder<C, P extends ParameterState ? P : never>
Inherited from ReadPredicates.orWhereNotNull
- Defined in libs/knex-schema/dist/read-predicates.d.ts:75

orWhereNull

orWhereNull(
column: ReadPredicateSelector<C>,
): ReadPredicateBuilder<C, P extends ParameterState ? P : never>
Parameters
- column: ReadPredicateSelector<C>
Returns ReadPredicateBuilder<C, P extends ParameterState ? P : never>
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>>,
): ReadPredicateBuilder<C, P extends ParameterState ? P : never>
Type Parameters
- const A extends readonly RawBinding[]
Parameters
- sql: string
- bindings: A & WithoutParameters<NoInfer<A>>
Returns ReadPredicateBuilder<C, P extends ParameterState ? P : never>
Inherited from ReadPredicates.orWhereRaw
- Defined in libs/knex-schema/dist/read-predicates.d.ts:90
orWhereRaw(
sql: string,
): ReadPredicateBuilder<C, P extends ParameterState ? P : never>
Parameters
- sql: string
Returns ReadPredicateBuilder<C, P extends ParameterState ? P : never>
Inherited from ReadPredicates.orWhereRaw
- Defined in libs/knex-schema/dist/read-predicates.d.ts:91

`Protected`readPredicateContext

readPredicateContext(): ReadPredicateContext<C>
Returns ReadPredicateContext<C>
Overrides ReadPredicates.readPredicateContext
- Defined in libs/knex-schema/dist/read-predicates.d.ts:107

ref

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

sameSource

sameSource(other: ReadPredicateBuilder<C, any>): boolean
Internal
Reject builders belonging to another predicate group.
Parameters
- other: ReadPredicateBuilder<C, any>
Returns boolean
- Defined in libs/knex-schema/dist/read-predicates.d.ts:110

where

where<G extends ReadPredicateBuilder<C, any>>(
    group: ReadPredicateGroup<
        C,
        G & CheckParameterState<
            AppendOrigins<P, ParametersOf<NoInfer<G>>, "root">,
        >,
    >,
): ReadPredicateBuilder<
    C,
    AppendOrigins<P, ParametersOf<G>, "root"> extends ParameterState
        ? ParameterState & AppendOrigins<P, ParametersOf<G>, "root">
        : never,
>
Add a synchronous group, retaining the group's inferred named parameters.
Type Parameters
- G extends ReadPredicateBuilder<C, any>
Parameters
- group: ReadPredicateGroup<
  C,
  G & CheckParameterState<AppendOrigins<P, ParametersOf<NoInfer<G>>, "root">>,
  >
Returns ReadPredicateBuilder<
    C,
    AppendOrigins<P, ParametersOf<G>, "root"> extends ParameterState
        ? ParameterState & AppendOrigins<P, ParametersOf<G>, "root">
        : never,
>
Inherited from ReadPredicates.where
- Defined in libs/knex-schema/dist/read-predicates.d.ts:52
where<const V extends Partial<Record<keyof C, unknown>>>(
values: V & WithoutParameters<NoInfer<V>>,
): ReadPredicateBuilder<C, P extends ParameterState ? P : never>
Match a record of concrete equality values. Use selectors for parameters.
Type Parameters
- const V extends Partial<Record<keyof C, unknown>>
Parameters
- values: V & WithoutParameters<NoInfer<V>>
Returns ReadPredicateBuilder<C, P extends ParameterState ? P : never>
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<P, NoInfer<A>, PredicateValue<C, S>>,
): ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
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<P, NoInfer<A>, PredicateValue<C, S>>
Returns ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
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<P, NoInfer<A>, PredicateValue<C, S>>,
): ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
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<P, NoInfer<A>, PredicateValue<C, S>>
Returns ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
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<P, NoInfer<A>, PredicateValue<C, S>>,
): ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
Type Parameters
- S extends string | ((columns: C) => AliasedColumn<any>)
- const A extends readonly [unknown, unknown]
Parameters
- column: S
- range: A & CheckParameterValue<P, NoInfer<A>, PredicateValue<C, S>>
Returns ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
Inherited from ReadPredicates.whereBetween
- Defined in libs/knex-schema/dist/read-predicates.d.ts:94

whereExists

whereExists(
query: QueryBuilder,
): ReadPredicateBuilder<C, P extends ParameterState ? P : never>
Parameters
- query: QueryBuilder
Returns ReadPredicateBuilder<C, P extends ParameterState ? P : never>
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<P, NoInfer<A>, PredicateValue<C, S>>
            : string
    ),
): ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
Type Parameters
- S extends string | ((columns: C) => AliasedColumn<any>)
- const A
Parameters
- column: S
- value: A & (
      A extends QueryParameter<string>
          ? CheckParameterValue<P, NoInfer<A>, PredicateValue<C, S>>
          : string
  )
Returns ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
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<P, NoInfer<A>, PredicateValue<C, S>>,
): ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
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<P, NoInfer<A>, PredicateValue<C, S>>
Returns ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
Inherited from ReadPredicates.whereIn
- Defined in libs/knex-schema/dist/read-predicates.d.ts:78

whereJsonPath

whereJsonPath<A>(
    column: ReadPredicateSelector<C>,
    path: string,
    operator?: string,
    value?: A & WithoutParameters<NoInfer<A>>,
): ReadPredicateBuilder<C, P extends ParameterState ? P : never>
JSON-path strings do not provide a schema-derived parameter type.
Type Parameters
- A
Parameters
- column: ReadPredicateSelector<C>
- path: string
- Optionaloperator: string
- Optionalvalue: A & WithoutParameters<NoInfer<A>>
Returns ReadPredicateBuilder<C, P extends ParameterState ? P : never>
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<P, NoInfer<A>, PredicateValue<C, S>>
            : string
    ),
): ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
Type Parameters
- S extends string | ((columns: C) => AliasedColumn<any>)
- const A
Parameters
- column: S
- value: A & (
      A extends QueryParameter<string>
          ? CheckParameterValue<P, NoInfer<A>, PredicateValue<C, S>>
          : string
  )
Returns ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
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<P, NoInfer<A>, PredicateValue<C, S>>,
): ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
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<P, NoInfer<A>, PredicateValue<C, S>>
Returns ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
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<P, NoInfer<A>, PredicateValue<C, S>>,
): ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
Type Parameters
- S extends string | ((columns: C) => AliasedColumn<any>)
- const A extends readonly [unknown, unknown]
Parameters
- column: S
- range: A & CheckParameterValue<P, NoInfer<A>, PredicateValue<C, S>>
Returns ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
Inherited from ReadPredicates.whereNotBetween
- Defined in libs/knex-schema/dist/read-predicates.d.ts:95

whereNotExists

whereNotExists(
query: QueryBuilder,
): ReadPredicateBuilder<C, P extends ParameterState ? P : never>
Parameters
- query: QueryBuilder
Returns ReadPredicateBuilder<C, P extends ParameterState ? P : never>
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<P, NoInfer<A>, PredicateValue<C, S>>,
): ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
Type Parameters
- S extends string | ((columns: C) => AliasedColumn<any>)
- const A extends ReadMembership
Parameters
- column: S
- values: A & CheckParameterValue<P, NoInfer<A>, PredicateValue<C, S>>
Returns ReadPredicateBuilder<
    C,
    ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
        ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
        : never,
>
Inherited from ReadPredicates.whereNotIn
- Defined in libs/knex-schema/dist/read-predicates.d.ts:79

whereNotNull

whereNotNull(
column: ReadPredicateSelector<C>,
): ReadPredicateBuilder<C, P extends ParameterState ? P : never>
Parameters
- column: ReadPredicateSelector<C>
Returns ReadPredicateBuilder<C, P extends ParameterState ? P : never>
Inherited from ReadPredicates.whereNotNull
- Defined in libs/knex-schema/dist/read-predicates.d.ts:73

whereNull

whereNull(
column: ReadPredicateSelector<C>,
): ReadPredicateBuilder<C, P extends ParameterState ? P : never>
Match SQL null without changing the declared result type.
Parameters
- column: ReadPredicateSelector<C>
Returns ReadPredicateBuilder<C, P extends ParameterState ? P : never>
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>>,
): ReadPredicateBuilder<C, P extends ParameterState ? P : never>
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 ReadPredicateBuilder<C, P extends ParameterState ? P : never>
Inherited from ReadPredicates.whereRaw
- Defined in libs/knex-schema/dist/read-predicates.d.ts:88
whereRaw(
sql: string,
): ReadPredicateBuilder<C, P extends ParameterState ? P : never>
Trusted SQL with concrete bindings; use a typed predicate for placeholders.
Parameters
- sql: string
Returns ReadPredicateBuilder<C, P extends ParameterState ? P : never>
Inherited from ReadPredicates.whereRaw
- Defined in libs/knex-schema/dist/read-predicates.d.ts:89

Interface ReadPredicateBuilder<C, P>

Type Parameters

Hierarchy

Index

Properties

Methods

Properties

Readonly Internal[PARAMETER_READER]

Readonly Internal[PARAMETER_STATE]

Methods

[finishGroup]

Returns readonly ReadPredicate[]

ProtectedaddReadPredicate

Parameters

Returns any

andWhere

Type Parameters

Parameters

Returns ReadPredicateBuilder< C, AppendOrigins<P, ParametersOf<G>, "root"> extends ParameterState ? ParameterState & AppendOrigins<P, ParametersOf<G>, "root"> : never,>

Type Parameters

Parameters

Returns ReadPredicateBuilder<C, P extends ParameterState ? P : never>

Type Parameters

Parameters

Returns ReadPredicateBuilder< C, ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>> : never,>

Type Parameters

Parameters

Returns ReadPredicateBuilder< C, ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>> : never,>

orWhere

Type Parameters

Parameters

Returns ReadPredicateBuilder< C, AppendOrigins<P, ParametersOf<G>, "root"> extends ParameterState ? ParameterState & AppendOrigins<P, ParametersOf<G>, "root"> : never,>

Type Parameters

Parameters

Returns ReadPredicateBuilder<C, P extends ParameterState ? P : never>

Type Parameters

Parameters

Returns ReadPredicateBuilder< C, ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>> : never,>

Type Parameters

Parameters

Returns ReadPredicateBuilder< C, ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>> : never,>

orWhereExists

Parameters

Returns ReadPredicateBuilder<C, P extends ParameterState ? P : never>

orWhereIn

Type Parameters

Parameters

Returns ReadPredicateBuilder< C, ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>> : never,>

orWhereNotExists

Parameters

Returns ReadPredicateBuilder<C, P extends ParameterState ? P : never>

orWhereNotIn

Type Parameters

Parameters

Returns ReadPredicateBuilder< C, ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState ? ParameterState & ValueParameters<P, A, PredicateValue<C, S>> : never,>

orWhereNotNull

Parameters

Returns ReadPredicateBuilder<C, P extends ParameterState ? P : never>

orWhereNull

Parameters

Returns ReadPredicateBuilder<C, P extends ParameterState ? P : never>

orWhereRaw

Type Parameters

Parameters

Returns ReadPredicateBuilder<C, P extends ParameterState ? P : never>

Parameters

Returns ReadPredicateBuilder<C, P extends ParameterState ? P : never>

ProtectedreadPredicateContext

Returns ReadPredicateContext<C>

ref

Parameters

Returns Raw<any> | Ref<string, {}>

sameSource

Parameters

Returns boolean

where

Type Parameters

Parameters

Returns ReadPredicateBuilder< C, AppendOrigins<P, ParametersOf<G>, "root"> extends ParameterState ? ParameterState & AppendOrigins<P, ParametersOf<G>, "root"> : never,>

Type Parameters

`Readonly` `Internal`[PARAMETER_READER]

`Readonly` `Internal`[PARAMETER_STATE]

`Protected`addReadPredicate

Returns ReadPredicateBuilder<
C,
AppendOrigins<P, ParametersOf<G>, "root"> extends ParameterState
? ParameterState & AppendOrigins<P, ParametersOf<G>, "root">
: never,
>

Returns ReadPredicateBuilder<
C,
ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
: never,
>

Returns ReadPredicateBuilder<
C,
ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
: never,
>

Returns ReadPredicateBuilder<
C,
AppendOrigins<P, ParametersOf<G>, "root"> extends ParameterState
? ParameterState & AppendOrigins<P, ParametersOf<G>, "root">
: never,
>

Returns ReadPredicateBuilder<
C,
ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
: never,
>

Returns ReadPredicateBuilder<
C,
ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
: never,
>

Returns ReadPredicateBuilder<
C,
ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
: never,
>

Returns ReadPredicateBuilder<
C,
ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
: never,
>

`Protected`readPredicateContext

Returns ReadPredicateBuilder<
C,
AppendOrigins<P, ParametersOf<G>, "root"> extends ParameterState
? ParameterState & AppendOrigins<P, ParametersOf<G>, "root">
: never,
>

Returns ReadPredicateBuilder<
C,
ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
: never,
>

Returns ReadPredicateBuilder<
C,
ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
: never,
>

Returns ReadPredicateBuilder<
C,
ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
: never,
>

Returns ReadPredicateBuilder<
C,
ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
: never,
>

Returns ReadPredicateBuilder<
C,
ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
: never,
>

Returns ReadPredicateBuilder<
C,
ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
: never,
>

Returns ReadPredicateBuilder<
C,
ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
: never,
>

Returns ReadPredicateBuilder<
C,
ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
: never,
>

Returns ReadPredicateBuilder<
C,
ValueParameters<P, A, PredicateValue<C, S>> extends ParameterState
? ParameterState & ValueParameters<P, A, PredicateValue<C, S>>
: never,
>