Class SchemaQueryBuilder<TLocalSchema, TResult>

Type Parameters

TLocalSchema extends ObjectSchemaBuilder<any, any, any, any, any, any, any>
TResult

Constructors

constructor

new SchemaQueryBuilder<
    TLocalSchema extends
        ObjectSchemaBuilder<any, any, any, any, any, any, any>,
    TResult,
>(
    knex: Knex,
    localSchema: TLocalSchema,
    baseQuery?: QueryBuilder<any, any>,
): SchemaQueryBuilder<TLocalSchema, TResult>
Type Parameters
- TLocalSchema extends ObjectSchemaBuilder<any, any, any, any, any, any, any>
- TResult
Parameters
- knex: Knex
- localSchema: TLocalSchema
- OptionalbaseQuery: QueryBuilder<any, any>
Returns SchemaQueryBuilder<TLocalSchema, TResult>
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:18

Methods

andWhere

andWhere(column: ColumnRef<TLocalSchema>, operator: string, value: any): this
Parameters
- column: ColumnRef<TLocalSchema>
- operator: string
- value: any
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:38
andWhere(column: ColumnRef<TLocalSchema>, value: any): this
Parameters
- column: ColumnRef<TLocalSchema>
- value: any
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:39
andWhere(record: Record<string, any>): this
Parameters
- record: Record<string, any>
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:40
andWhere(callback: (builder: QueryBuilder) => void): this
Parameters
- callback: (builder: QueryBuilder) => void
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:41
andWhere(raw: Raw): this
Parameters
- raw: Raw
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:42

apply

apply(fn: (builder: QueryBuilder) => void): this
Parameters
- fn: (builder: QueryBuilder) => void
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:119

avg

avg(column: Raw<any> | ColumnRef<TLocalSchema>): this
Parameters
- column: Raw<any> | ColumnRef<TLocalSchema>
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:27

bulkInsert

bulkInsert(
    rows: InsertType<TLocalSchema>[],
    opts?: {
        chunkSize?: number;
        conflictColumns?: ColumnRef<TLocalSchema>[];
        onConflict?: "ignore" | "merge";
    },
): Promise<TResult[]>
Parameters
- rows: InsertType<TLocalSchema>[]
- Optionalopts: {
      chunkSize?: number;
      conflictColumns?: ColumnRef<TLocalSchema>[];
      onConflict?: "ignore" | "merge";
  }
Returns Promise<TResult[]>
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:94

bulkUpdate

bulkUpdate(
    updates: readonly {
        set: Partial<InferType<TLocalSchema>>;
        where: Partial<InferType<TLocalSchema>>;
    }[],
): Promise<number>
Parameters
- updates: readonly {
  set: Partial<InferType<TLocalSchema>>;
  where: Partial<InferType<TLocalSchema>>;
  }[]
Returns Promise<number>
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:104

bulkUpsert

bulkUpsert(
rows: InsertType<TLocalSchema>[],
opts: { chunkSize?: number; conflictColumns: ColumnRef<TLocalSchema>[] },
): Promise<TResult[]>
Parameters
- rows: InsertType<TLocalSchema>[]
- opts: { chunkSize?: number; conflictColumns: ColumnRef<TLocalSchema>[] }
Returns Promise<TResult[]>
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:99

count

count(column?: Raw<any> | ColumnRef<TLocalSchema>): this
Parameters
- Optionalcolumn: Raw<any> | ColumnRef<TLocalSchema>
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:22

countDistinct

countDistinct(column?: Raw<any> | ColumnRef<TLocalSchema>): this
Parameters
- Optionalcolumn: Raw<any> | ColumnRef<TLocalSchema>
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:23

delete

delete(): Promise<number>
Returns Promise<number>
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:108

distinct

distinct(...columns: (Raw<any> | ColumnRef<TLocalSchema>)[]): this
Parameters
- ...columns: (Raw<any> | ColumnRef<TLocalSchema>)[]
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:21

execute

execute(): Promise<TResult[]>
Returns Promise<TResult[]>
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:124

first

first(): Promise<TResult | undefined>
Returns Promise<TResult | undefined>
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:125

groupBy

groupBy(...columns: (Raw<any> | ColumnRef<TLocalSchema>)[]): this
Parameters
- ...columns: (Raw<any> | ColumnRef<TLocalSchema>)[]
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:71

groupByRaw

groupByRaw(sql: string, ...bindings: any[]): this
Parameters
- sql: string
- ...bindings: any[]
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:72

hardDelete

hardDelete(): Promise<number>
Returns Promise<number>
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:111

having

having(
    column: Raw<any> | ColumnRef<TLocalSchema>,
    operator: string,
    value: any,
): this
Parameters
- column: Raw<any> | ColumnRef<TLocalSchema>
- operator: string
- value: any
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:73

havingRaw

havingRaw(sql: string, ...bindings: any[]): this
Parameters
- sql: string
- ...bindings: any[]
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:74

include

include(
relationName: string,
customize?: (q: SchemaQueryBuilder<any, any>) => void,
): this
Parameters
- relationName: string
- Optionalcustomize: (q: SchemaQueryBuilder<any, any>) => void
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:115

includeVariant

includeVariant(
    variantKey: string,
    relationName: string,
    customize?: (q: SchemaQueryBuilder<any, any>) => void,
): this
Parameters
- variantKey: string
- relationName: string
- Optionalcustomize: (q: SchemaQueryBuilder<any, any>) => void
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:116

insert

insert(data: InsertType<TLocalSchema>): Promise<TResult>
Parameters
- data: InsertType<TLocalSchema>
Returns Promise<TResult>
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:87

insertMany

insertMany(data: InsertType<TLocalSchema>[]): Promise<TResult[]>
Parameters
- data: InsertType<TLocalSchema>[]
Returns Promise<TResult[]>
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:88

joinMany

joinMany<
    TForeignSchema extends
        ObjectSchemaBuilder<any, any, any, any, any, any, any>,
    TFieldName extends string,
>(
    spec: JoinManySpec<TLocalSchema, TForeignSchema, TFieldName>,
): SchemaQueryBuilder<
    TLocalSchema,
    WithJoinedMany<TResult, TFieldName, TForeignSchema>,
>
Type Parameters
- TForeignSchema extends ObjectSchemaBuilder<any, any, any, any, any, any, any>
- TFieldName extends string
Parameters
- spec: JoinManySpec<TLocalSchema, TForeignSchema, TFieldName>
Returns SchemaQueryBuilder<
TLocalSchema,
WithJoinedMany<TResult, TFieldName, TForeignSchema>,
>
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:114

joinOne

joinOne<
    TForeignSchema extends
        ObjectSchemaBuilder<any, any, any, any, any, any, any>,
    TFieldName extends string,
    TRequired extends boolean = true,
>(
    spec: JoinOneSpec<TLocalSchema, TForeignSchema, TFieldName, TRequired>,
): SchemaQueryBuilder<
    TLocalSchema,
    WithJoinedOne<TResult, TFieldName, TForeignSchema, TRequired>,
>
Type Parameters
- TForeignSchema extends ObjectSchemaBuilder<any, any, any, any, any, any, any>
- TFieldName extends string
- TRequired extends boolean = true
Parameters
- spec: JoinOneSpec<TLocalSchema, TForeignSchema, TFieldName, TRequired>
Returns SchemaQueryBuilder<
TLocalSchema,
WithJoinedOne<TResult, TFieldName, TForeignSchema, TRequired>,
>
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:113

limit

limit(n: number): this
Parameters
- n: number
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:75

max

max(column: Raw<any> | ColumnRef<TLocalSchema>): this
Parameters
- column: Raw<any> | ColumnRef<TLocalSchema>
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:25

min

min(column: Raw<any> | ColumnRef<TLocalSchema>): this
Parameters
- column: Raw<any> | ColumnRef<TLocalSchema>
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:24

offset

offset(n: number): this
Parameters
- n: number
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:76

onConflict

onConflict(
...conflictColumns: ColumnRef<TLocalSchema>[],
): OnConflictBuilder<TLocalSchema, TResult>
Parameters
- ...conflictColumns: ColumnRef<TLocalSchema>[]
Returns OnConflictBuilder<TLocalSchema, TResult>
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:89

onlyDeleted

onlyDeleted(): this
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:110

orderBy

orderBy(
column: Raw<any> | ColumnRef<TLocalSchema>,
direction?: "asc" | "desc",
): this
Parameters
- column: Raw<any> | ColumnRef<TLocalSchema>
- Optionaldirection: "asc" | "desc"
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:69

orderByRaw

orderByRaw(sql: string, ...bindings: any[]): this
Parameters
- sql: string
- ...bindings: any[]
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:70

orWhere

orWhere(column: ColumnRef<TLocalSchema>, operator: string, value: any): this
Parameters
- column: ColumnRef<TLocalSchema>
- operator: string
- value: any
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:43
orWhere(column: ColumnRef<TLocalSchema>, value: any): this
Parameters
- column: ColumnRef<TLocalSchema>
- value: any
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:44
orWhere(record: Record<string, any>): this
Parameters
- record: Record<string, any>
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:45
orWhere(callback: (builder: QueryBuilder) => void): this
Parameters
- callback: (builder: QueryBuilder) => void
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:46
orWhere(raw: Raw): this
Parameters
- raw: Raw
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:47

orWhereIn

orWhereIn(
column: ColumnRef<TLocalSchema>,
values: readonly any[] | QueryBuilder<any, any>,
): this
Parameters
- column: ColumnRef<TLocalSchema>
- values: readonly any[] | QueryBuilder<any, any>
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:55

orWhereNotIn

orWhereNotIn(
column: ColumnRef<TLocalSchema>,
values: readonly any[] | QueryBuilder<any, any>,
): this
Parameters
- column: ColumnRef<TLocalSchema>
- values: readonly any[] | QueryBuilder<any, any>
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:56

orWhereNotNull

orWhereNotNull(column: ColumnRef<TLocalSchema>): this
Parameters
- column: ColumnRef<TLocalSchema>
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:60

orWhereNull

orWhereNull(column: ColumnRef<TLocalSchema>): this
Parameters
- column: ColumnRef<TLocalSchema>
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:59

paginate

paginate(
opts: { page: number; pageSize: number },
): Promise<PaginationResult<TResult>>
Parameters
- opts: { page: number; pageSize: number }
Returns Promise<PaginationResult<TResult>>
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:77

paginateAfter

paginateAfter(
    opts: {
        column?: ColumnRef<TLocalSchema>;
        cursor?: any;
        direction?: "asc" | "desc";
        limit: number;
    },
): Promise<CursorPaginationResult<TResult>>
Parameters
- opts: {
      column?: ColumnRef<TLocalSchema>;
      cursor?: any;
      direction?: "asc" | "desc";
      limit: number;
  }
Returns Promise<CursorPaginationResult<TResult>>
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:81

pluck

pluck<K extends string>(column: ColumnRef<TLocalSchema>): Promise<TResult[K][]>
Type Parameters
- K extends string
Parameters
- column: ColumnRef<TLocalSchema>
Returns Promise<TResult[K][]>
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:126

projected

projected<K extends string>(
    name: K,
): SchemaQueryBuilder<
    TLocalSchema,
    Pick<TResult, ProjectionKeysOf<TLocalSchema, K> & keyof TResult>,
>
Type Parameters
- K extends string
Parameters
- name: K
Returns SchemaQueryBuilder<
TLocalSchema,
Pick<TResult, ProjectionKeysOf<TLocalSchema, K> & keyof TResult>,
>
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:29

restore

restore(): Promise<TResult[]>
Returns Promise<TResult[]>
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:112

scoped

scoped<K extends never>(name: K): this
Type Parameters
- K extends never
Parameters
- name: K
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:30

select

select(...columns: (Raw<any> | ColumnRef<TLocalSchema>)[]): this
Parameters
- ...columns: (Raw<any> | ColumnRef<TLocalSchema>)[]
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:19
select<TSel extends SelectSelector<TLocalSchema>>(
selector: TSel,
): SchemaQueryBuilder<TLocalSchema, SelectProjection<ReturnType<TSel>>>
Type Parameters
- TSel extends SelectSelector<TLocalSchema>
Parameters
- selector: TSel
Returns SchemaQueryBuilder<TLocalSchema, SelectProjection<ReturnType<TSel>>>
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:20

selectRaw

selectRaw(sql: string, bindings?: any[]): this
Parameters
- sql: string
- Optionalbindings: any[]
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:28

selectVariants

selectVariants(keys: string[]): this
Parameters
- keys: string[]
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:118

sum

sum(column: Raw<any> | ColumnRef<TLocalSchema>): this
Parameters
- column: Raw<any> | ColumnRef<TLocalSchema>
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:26

then

then<TReturn1 = TResult[], TReturn2 = never>(
    onfulfilled?:
        | ((value: TResult[]) => TReturn1 | PromiseLike<TReturn1>)
        | null,
    onrejected?: ((reason: any) => TReturn2 | PromiseLike<TReturn2>) | null,
): Promise<TReturn1 | TReturn2>
Type Parameters
- TReturn1 = TResult[]
- TReturn2 = never
Parameters
- Optionalonfulfilled: ((value: TResult[]) => TReturn1 | PromiseLike<TReturn1>) | null
- Optionalonrejected: ((reason: any) => TReturn2 | PromiseLike<TReturn2>) | null
Returns Promise<TReturn1 | TReturn2>
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:127

toKnexQuery

toKnexQuery(): QueryBuilder
Returns QueryBuilder
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:122

toQuery

toQuery(): string
Returns string
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:121

toString

toString(): string
Returns string
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:123

transacting

transacting(trx: Transaction): SchemaQueryBuilder<TLocalSchema, TResult>
Parameters
- trx: Transaction
Returns SchemaQueryBuilder<TLocalSchema, TResult>
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:120

unscoped

unscoped(): this
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:31

update

update(data: Partial<InferType<TLocalSchema>>): Promise<TResult[]>
Parameters
- data: Partial<InferType<TLocalSchema>>
Returns Promise<TResult[]>
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:103

upsert

upsert(
    data: InsertType<TLocalSchema>,
    opts: {
        conflictColumns: ColumnRef<TLocalSchema>[];
        updateColumns?: ColumnRef<TLocalSchema>[];
    },
): Promise<TResult>
Parameters
- data: InsertType<TLocalSchema>
- opts: {
  conflictColumns: ColumnRef<TLocalSchema>[];
  updateColumns?: ColumnRef<TLocalSchema>[];
  }
Returns Promise<TResult>
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:90

where

where(column: ColumnRef<TLocalSchema>, operator: string, value: any): this
Parameters
- column: ColumnRef<TLocalSchema>
- operator: string
- value: any
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:32
where(column: ColumnRef<TLocalSchema>, value: any): this
Parameters
- column: ColumnRef<TLocalSchema>
- value: any
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:33
where(raw: Raw, operator: string, value: any): this
Parameters
- raw: Raw
- operator: string
- value: any
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:34
where(callback: (builder: QueryBuilder) => void): this
Parameters
- callback: (builder: QueryBuilder) => void
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:35
where(record: Record<string, any>): this
Parameters
- record: Record<string, any>
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:36
where(raw: Raw): this
Parameters
- raw: Raw
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:37

whereBetween

whereBetween(column: ColumnRef<TLocalSchema>, range: readonly [any, any]): this
Parameters
- column: ColumnRef<TLocalSchema>
- range: readonly [any, any]
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:61

whereExists

whereExists(
callback: QueryBuilder<any, any> | QueryCallback<any, unknown[]>,
): this
Parameters
- callback: QueryBuilder<any, any> | QueryCallback<any, unknown[]>
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:66

whereILike

whereILike(column: ColumnRef<TLocalSchema>, value: string): this
Parameters
- column: ColumnRef<TLocalSchema>
- value: string
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:64

whereIn

whereIn(
column: ColumnRef<TLocalSchema>,
values: readonly any[] | QueryBuilder<any, any>,
): this
Parameters
- column: ColumnRef<TLocalSchema>
- values: readonly any[] | QueryBuilder<any, any>
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:53

whereJsonPath

whereJsonPath(
    column: ColumnRef<TLocalSchema>,
    path: string,
    operator?: string,
    value?: any,
): this
Parameters
- column: ColumnRef<TLocalSchema>
- path: string
- Optionaloperator: string
- Optionalvalue: any
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:68

whereLike

whereLike(column: ColumnRef<TLocalSchema>, value: string): this
Parameters
- column: ColumnRef<TLocalSchema>
- value: string
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:63

whereNot

whereNot(column: ColumnRef<TLocalSchema>, operator: string, value: any): this
Parameters
- column: ColumnRef<TLocalSchema>
- operator: string
- value: any
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:48
whereNot(column: ColumnRef<TLocalSchema>, value: any): this
Parameters
- column: ColumnRef<TLocalSchema>
- value: any
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:49
whereNot(record: Record<string, any>): this
Parameters
- record: Record<string, any>
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:50
whereNot(callback: (builder: QueryBuilder) => void): this
Parameters
- callback: (builder: QueryBuilder) => void
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:51
whereNot(raw: Raw): this
Parameters
- raw: Raw
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:52

whereNotBetween

whereNotBetween(
column: ColumnRef<TLocalSchema>,
range: readonly [any, any],
): this
Parameters
- column: ColumnRef<TLocalSchema>
- range: readonly [any, any]
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:62

whereNotExists

whereNotExists(
callback: QueryBuilder<any, any> | QueryCallback<any, unknown[]>,
): this
Parameters
- callback: QueryBuilder<any, any> | QueryCallback<any, unknown[]>
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:67

whereNotIn

whereNotIn(
column: ColumnRef<TLocalSchema>,
values: readonly any[] | QueryBuilder<any, any>,
): this
Parameters
- column: ColumnRef<TLocalSchema>
- values: readonly any[] | QueryBuilder<any, any>
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:54

whereNotNull

whereNotNull(column: ColumnRef<TLocalSchema>): this
Parameters
- column: ColumnRef<TLocalSchema>
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:58

whereNull

whereNull(column: ColumnRef<TLocalSchema>): this
Parameters
- column: ColumnRef<TLocalSchema>
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:57

whereRaw

whereRaw(sql: string, ...bindings: any[]): this
Parameters
- sql: string
- ...bindings: any[]
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:65

whereVariant

whereVariant(key: string, column: string, operator: string, value: any): this
Parameters
- key: string
- column: string
- operator: string
- value: any
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:117

withDeleted

withDeleted(): this
Returns this
- Defined in libs/knex-schema/dist/SchemaQueryBuilder.d.ts:109

Class SchemaQueryBuilder<TLocalSchema, TResult>

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns SchemaQueryBuilder<TLocalSchema, TResult>

Methods

andWhere

Parameters

Returns this

Parameters

Returns this

Parameters

Returns this

Parameters

Returns this

Parameters

Returns this

apply

Parameters

Returns this

avg

Parameters

Returns this

bulkInsert

Parameters

Returns Promise<TResult[]>

bulkUpdate

Parameters

Returns Promise<number>

bulkUpsert

Parameters

Returns Promise<TResult[]>

count

Parameters

Returns this

countDistinct

Parameters

Returns this

delete

Returns Promise<number>

distinct

Parameters

Returns this

execute

Returns Promise<TResult[]>

first

Returns Promise<TResult | undefined>

groupBy

Parameters

Returns this

groupByRaw

Parameters

Returns this

hardDelete

Returns Promise<number>

having

Parameters

Returns this

havingRaw

Parameters

Returns this

include

Parameters

Returns this

includeVariant

Parameters

Returns this

insert

Parameters

Returns Promise<TResult>

insertMany

Parameters

Returns Promise<TResult[]>

joinMany

Type Parameters

Returns SchemaQueryBuilder<
TLocalSchema,
WithJoinedMany<TResult, TFieldName, TForeignSchema>,
>

Returns SchemaQueryBuilder<
TLocalSchema,
WithJoinedOne<TResult, TFieldName, TForeignSchema, TRequired>,
>

Returns SchemaQueryBuilder<
TLocalSchema,
Pick<TResult, ProjectionKeysOf<TLocalSchema, K> & keyof TResult>,
>