Version: 4.4

Interface: Knex<TRecord, TResult>#

Type parameters#

Name	Type	Default
`TRecord`	{}	any
`TResult`	-	unknown[]

Hierarchy#

QueryInterface<TRecord, TResult>
EventEmitter
↳ Knex

Callable#

▸ Knex<TTable>(tableName: TTable, options?: PgTableOptions): QueryBuilder<TableType<TTable>, DeferredKeySelection<ResolveTableType<TableType<TTable>, base>, never, false, {}, false, {}, never>[]>

Type parameters:#

Name	Type
`TTable`	never

Parameters:#

Name	Type
`tableName`	TTable
`options?`	PgTableOptions

Returns: QueryBuilder<TableType<TTable>, DeferredKeySelection<ResolveTableType<TableType<TTable>, base>, never, false, {}, false, {}, never>[]>

Defined in: node_modules/knex/types/index.d.ts:332

▸ Knex<TRecord2, TResult2>(tableName?: string | Raw<any> | QueryBuilder<any, any> | AliasDict, options?: PgTableOptions): QueryBuilder<TRecord2, TResult2>

Type parameters:#

Name	Default
`TRecord2`	TRecord
`TResult2`	DeferredKeySelection<TRecord2, never, false, {}, false, {}, never\>[]

Parameters:#

Name	Type
`tableName?`	string \| Raw<any> \| QueryBuilder<any, any> \| AliasDict
`options?`	PgTableOptions

Returns: QueryBuilder<TRecord2, TResult2>

Defined in: node_modules/knex/types/index.d.ts:336

Properties#

VERSION#

• VERSION: string

Defined in: node_modules/knex/types/index.d.ts:341

knex#

• __knex__: string

Defined in: node_modules/knex/types/index.d.ts:342

andHaving#

• andHaving: Having<TRecord, TResult>

Inherited from: QueryInterface.andHaving

Defined in: node_modules/knex/types/index.d.ts:543

andWhere#

• andWhere: Where<TRecord, TResult>

Inherited from: QueryInterface.andWhere

Defined in: node_modules/knex/types/index.d.ts:497

andWhereBetween#

• andWhereBetween: WhereBetween<TRecord, TResult>

Inherited from: QueryInterface.andWhereBetween

Defined in: node_modules/knex/types/index.d.ts:521

andWhereNot#

• andWhereNot: Where<TRecord, TResult>

Inherited from: QueryInterface.andWhereNot

Defined in: node_modules/knex/types/index.d.ts:500

andWhereNotBetween#

• andWhereNotBetween: WhereBetween<TRecord, TResult>

Inherited from: QueryInterface.andWhereNotBetween

Defined in: node_modules/knex/types/index.d.ts:524

andWhereRaw#

• andWhereRaw: WhereRaw<TRecord, TResult>

Inherited from: QueryInterface.andWhereRaw

Defined in: node_modules/knex/types/index.d.ts:504

as#

• as: As<TRecord, TResult>

Inherited from: QueryInterface.as

Defined in: node_modules/knex/types/index.d.ts:467

avg#

• avg: TypePreservingAggregation<TRecord, TResult, any>

Inherited from: QueryInterface.avg

Defined in: node_modules/knex/types/index.d.ts:586

avgDistinct#

• avgDistinct: TypePreservingAggregation<TRecord, TResult, any>

Inherited from: QueryInterface.avgDistinct

Defined in: node_modules/knex/types/index.d.ts:587

client#

• client: any

Defined in: node_modules/knex/types/index.d.ts:375

column#

• column: Select<TRecord, TResult>

Inherited from: QueryInterface.column

Defined in: node_modules/knex/types/index.d.ts:469

columns#

• columns: Select<TRecord, TResult>

Inherited from: QueryInterface.columns

Defined in: node_modules/knex/types/index.d.ts:468

count#

• count: AsymmetricAggregation<TRecord, TResult, string | number>

Inherited from: QueryInterface.count

Defined in: node_modules/knex/types/index.d.ts:580

countDistinct#

• countDistinct: AsymmetricAggregation<TRecord, TResult, string | number>

Inherited from: QueryInterface.countDistinct

Defined in: node_modules/knex/types/index.d.ts:581

crossJoin#

• crossJoin: Join<TRecord, TResult>

Inherited from: QueryInterface.crossJoin

Defined in: node_modules/knex/types/index.d.ts:486

distinct#

• distinct: Distinct<TRecord, TResult>

Inherited from: QueryInterface.distinct

Defined in: node_modules/knex/types/index.d.ts:473

distinctOn#

• distinctOn: DistinctOn<TRecord, TResult>

Inherited from: QueryInterface.distinctOn

Defined in: node_modules/knex/types/index.d.ts:474

first#

• first: Select<TRecord, AddUnionMember<UnwrapArrayMember<TResult>, undefined>>

Inherited from: QueryInterface.first

Defined in: node_modules/knex/types/index.d.ts:608

fn#

• fn: FunctionHelper

Defined in: node_modules/knex/types/index.d.ts:378

from#

• from: Table<TRecord, TResult>

Inherited from: QueryInterface.from

Defined in: node_modules/knex/types/index.d.ts:470

fullOuterJoin#

• fullOuterJoin: Join<TRecord, TResult>

Inherited from: QueryInterface.fullOuterJoin

Defined in: node_modules/knex/types/index.d.ts:485

groupBy#

• groupBy: GroupBy<TRecord, TResult>

Inherited from: QueryInterface.groupBy

Defined in: node_modules/knex/types/index.d.ts:527

groupByRaw#

• groupByRaw: RawQueryBuilder<TRecord, TResult>

Inherited from: QueryInterface.groupByRaw

Defined in: node_modules/knex/types/index.d.ts:528

having#

• having: Having<TRecord, TResult>

Inherited from: QueryInterface.having

Defined in: node_modules/knex/types/index.d.ts:542

havingBetween#

• havingBetween: HavingRange<TRecord, TResult>

Inherited from: QueryInterface.havingBetween

Defined in: node_modules/knex/types/index.d.ts:551

havingIn#

• havingIn: HavingRange<TRecord, TResult>

Inherited from: QueryInterface.havingIn

Defined in: node_modules/knex/types/index.d.ts:547

havingNotBetween#

• havingNotBetween: HavingRange<TRecord, TResult>

Inherited from: QueryInterface.havingNotBetween

Defined in: node_modules/knex/types/index.d.ts:549

havingRaw#

• havingRaw: RawQueryBuilder<TRecord, TResult>

Inherited from: QueryInterface.havingRaw

Defined in: node_modules/knex/types/index.d.ts:544

havingWrapped#

• havingWrapped: WhereWrapped<TRecord, TResult>

Inherited from: QueryInterface.havingWrapped

Defined in: node_modules/knex/types/index.d.ts:506

innerJoin#

• innerJoin: Join<TRecord, TResult>

Inherited from: QueryInterface.innerJoin

Defined in: node_modules/knex/types/index.d.ts:479

intersect#

• intersect: Intersect<TRecord, TResult>

Inherited from: QueryInterface.intersect

Defined in: node_modules/knex/types/index.d.ts:535

into#

• into: Table<TRecord, TResult>

Inherited from: QueryInterface.into

Defined in: node_modules/knex/types/index.d.ts:471

join#

• join: Join<TRecord, TResult>

Inherited from: QueryInterface.join

Defined in: node_modules/knex/types/index.d.ts:477

joinRaw#

• joinRaw: JoinRaw<TRecord, TResult>

Inherited from: QueryInterface.joinRaw

Defined in: node_modules/knex/types/index.d.ts:478

leftJoin#

• leftJoin: Join<TRecord, TResult>

Inherited from: QueryInterface.leftJoin

Defined in: node_modules/knex/types/index.d.ts:480

leftOuterJoin#

• leftOuterJoin: Join<TRecord, TResult>

Inherited from: QueryInterface.leftOuterJoin

Defined in: node_modules/knex/types/index.d.ts:481

max#

• max: TypePreservingAggregation<TRecord, TResult, any>

Inherited from: QueryInterface.max

Defined in: node_modules/knex/types/index.d.ts:583

migrate#

• migrate: Migrator

Defined in: node_modules/knex/types/index.d.ts:376

min#

• min: TypePreservingAggregation<TRecord, TResult, any>

Inherited from: QueryInterface.min

Defined in: node_modules/knex/types/index.d.ts:582

orHaving#

• orHaving: Having<TRecord, TResult>

Inherited from: QueryInterface.orHaving

Defined in: node_modules/knex/types/index.d.ts:545

orHavingBetween#

• orHavingBetween: HavingRange<TRecord, TResult>

Inherited from: QueryInterface.orHavingBetween

Defined in: node_modules/knex/types/index.d.ts:550

orHavingNotBetween#

• orHavingNotBetween: HavingRange<TRecord, TResult>

Inherited from: QueryInterface.orHavingNotBetween

Defined in: node_modules/knex/types/index.d.ts:548

orHavingRaw#

• orHavingRaw: RawQueryBuilder<TRecord, TResult>

Inherited from: QueryInterface.orHavingRaw

Defined in: node_modules/knex/types/index.d.ts:546

orWhere#

• orWhere: Where<TRecord, TResult>

Inherited from: QueryInterface.orWhere

Defined in: node_modules/knex/types/index.d.ts:498

orWhereBetween#

• orWhereBetween: WhereBetween<TRecord, TResult>

Inherited from: QueryInterface.orWhereBetween

Defined in: node_modules/knex/types/index.d.ts:520

orWhereExists#

• orWhereExists: WhereExists<TRecord, TResult>

Inherited from: QueryInterface.orWhereExists

Defined in: node_modules/knex/types/index.d.ts:508

orWhereIn#

• orWhereIn: WhereIn<TRecord, TResult>

Inherited from: QueryInterface.orWhereIn

Defined in: node_modules/knex/types/index.d.ts:512

orWhereNot#

• orWhereNot: Where<TRecord, TResult>

Inherited from: QueryInterface.orWhereNot

Defined in: node_modules/knex/types/index.d.ts:501

orWhereNotBetween#

• orWhereNotBetween: WhereBetween<TRecord, TResult>

Inherited from: QueryInterface.orWhereNotBetween

Defined in: node_modules/knex/types/index.d.ts:523

orWhereNotExists#

• orWhereNotExists: WhereExists<TRecord, TResult>

Inherited from: QueryInterface.orWhereNotExists

Defined in: node_modules/knex/types/index.d.ts:510

orWhereNotIn#

• orWhereNotIn: WhereIn<TRecord, TResult>

Inherited from: QueryInterface.orWhereNotIn

Defined in: node_modules/knex/types/index.d.ts:514

orWhereNotNull#

• orWhereNotNull: WhereNull<TRecord, TResult>

Inherited from: QueryInterface.orWhereNotNull

Defined in: node_modules/knex/types/index.d.ts:518

orWhereNull#

• orWhereNull: WhereNull<TRecord, TResult>

Inherited from: QueryInterface.orWhereNull

Defined in: node_modules/knex/types/index.d.ts:516

orWhereRaw#

• orWhereRaw: WhereRaw<TRecord, TResult>

Inherited from: QueryInterface.orWhereRaw

Defined in: node_modules/knex/types/index.d.ts:503

orderBy#

• orderBy: OrderBy<TRecord, TResult>

Inherited from: QueryInterface.orderBy

Defined in: node_modules/knex/types/index.d.ts:531

orderByRaw#

• orderByRaw: RawQueryBuilder<TRecord, TResult>

Inherited from: QueryInterface.orderByRaw

Defined in: node_modules/knex/types/index.d.ts:532

outerJoin#

• outerJoin: Join<TRecord, TResult>

Inherited from: QueryInterface.outerJoin

Defined in: node_modules/knex/types/index.d.ts:484

raw#

• raw: RawBuilder<TRecord, any>

Defined in: node_modules/knex/types/index.d.ts:344

ref#

• ref: RefBuilder

Defined in: node_modules/knex/types/index.d.ts:379

rightJoin#

• rightJoin: Join<TRecord, TResult>

Inherited from: QueryInterface.rightJoin

Defined in: node_modules/knex/types/index.d.ts:482

rightOuterJoin#

• rightOuterJoin: Join<TRecord, TResult>

Inherited from: QueryInterface.rightOuterJoin

Defined in: node_modules/knex/types/index.d.ts:483

schema#

• schema: SchemaBuilder

Defined in: node_modules/knex/types/index.d.ts:369

seed#

• seed: Seeder

Defined in: node_modules/knex/types/index.d.ts:377

select#

• select: Select<TRecord, TResult>

Inherited from: QueryInterface.select

Defined in: node_modules/knex/types/index.d.ts:466

sum#

• sum: TypePreservingAggregation<TRecord, TResult, any>

Inherited from: QueryInterface.sum

Defined in: node_modules/knex/types/index.d.ts:584

sumDistinct#

• sumDistinct: TypePreservingAggregation<TRecord, TResult, any>

Inherited from: QueryInterface.sumDistinct

Defined in: node_modules/knex/types/index.d.ts:585

table#

• table: Table<TRecord, TResult>

Inherited from: QueryInterface.table

Defined in: node_modules/knex/types/index.d.ts:472

union#

• union: Union<TRecord, TResult>

Inherited from: QueryInterface.union

Defined in: node_modules/knex/types/index.d.ts:538

unionAll#

• unionAll: Union<TRecord, TResult>

Inherited from: QueryInterface.unionAll

Defined in: node_modules/knex/types/index.d.ts:539

userParams#

• userParams: Record<string, any>

Defined in: node_modules/knex/types/index.d.ts:380

where#

• where: Where<TRecord, TResult>

Inherited from: QueryInterface.where

Defined in: node_modules/knex/types/index.d.ts:496

whereBetween#

• whereBetween: WhereBetween<TRecord, TResult>

Inherited from: QueryInterface.whereBetween

Defined in: node_modules/knex/types/index.d.ts:519

whereExists#

• whereExists: WhereExists<TRecord, TResult>

Inherited from: QueryInterface.whereExists

Defined in: node_modules/knex/types/index.d.ts:507

whereIn#

• whereIn: WhereIn<TRecord, TResult>

Inherited from: QueryInterface.whereIn

Defined in: node_modules/knex/types/index.d.ts:511

whereNot#

• whereNot: Where<TRecord, TResult>

Inherited from: QueryInterface.whereNot

Defined in: node_modules/knex/types/index.d.ts:499

whereNotBetween#

• whereNotBetween: WhereBetween<TRecord, TResult>

Inherited from: QueryInterface.whereNotBetween

Defined in: node_modules/knex/types/index.d.ts:522

whereNotExists#

• whereNotExists: WhereExists<TRecord, TResult>

Inherited from: QueryInterface.whereNotExists

Defined in: node_modules/knex/types/index.d.ts:509

whereNotIn#

• whereNotIn: WhereIn<TRecord, TResult>

Inherited from: QueryInterface.whereNotIn

Defined in: node_modules/knex/types/index.d.ts:513

whereNotNull#

• whereNotNull: WhereNull<TRecord, TResult>

Inherited from: QueryInterface.whereNotNull

Defined in: node_modules/knex/types/index.d.ts:517

whereNull#

• whereNull: WhereNull<TRecord, TResult>

Inherited from: QueryInterface.whereNull

Defined in: node_modules/knex/types/index.d.ts:515

whereRaw#

• whereRaw: WhereRaw<TRecord, TResult>

Inherited from: QueryInterface.whereRaw

Defined in: node_modules/knex/types/index.d.ts:502

whereWrapped#

• whereWrapped: WhereWrapped<TRecord, TResult>

Inherited from: QueryInterface.whereWrapped

Defined in: node_modules/knex/types/index.d.ts:505

with#

• with: With<TRecord, TResult>

Inherited from: QueryInterface.with

Defined in: node_modules/knex/types/index.d.ts:489

withRaw#

• withRaw: WithRaw<TRecord, TResult>

Inherited from: QueryInterface.withRaw

Defined in: node_modules/knex/types/index.d.ts:491

withRecursive#

• withRecursive: With<TRecord, TResult>

Inherited from: QueryInterface.withRecursive

Defined in: node_modules/knex/types/index.d.ts:490

withSchema#

• withSchema: WithSchema<TRecord, TResult>

Inherited from: QueryInterface.withSchema

Defined in: node_modules/knex/types/index.d.ts:492

withWrapped#

• withWrapped: WithWrapped<TRecord, TResult>

Inherited from: QueryInterface.withWrapped

Defined in: node_modules/knex/types/index.d.ts:493

Methods#

addListener#

▸ addListener(event: string | symbol, listener: (...args: any[]) => void): Knex<TRecord, TResult>

Parameters:#

Name	Type
`event`	string \| symbol
`listener`	(...`args`: any[]) => void

Returns: Knex<TRecord, TResult>

Defined in: node_modules/@types/node/events.d.ts:57

batchInsert#

▸ batchInsert<TRecord2, TResult2>(tableName: TableDescriptor, data: TRecord2 extends CompositeTableType<unknown, unknown, Partial<unknown>> ? readonly ResolveTableType<TRecord2, insert>[] : readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord2>, {}>>>> | readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord2>, {}>>>[])[], chunkSize?: number): BatchInsertBuilder<TRecord2, TResult2>

Type parameters:#

Name	Default
`TRecord2`	TRecord
`TResult2`	number[]

Parameters:#

Name	Type
`tableName`	TableDescriptor
`data`	TRecord2 extends CompositeTableType<unknown, unknown, Partial<unknown>> ? readonly ResolveTableType<TRecord2, insert>[] : readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord2>, {}>>>> \| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord2>, {}>>>[])[]
`chunkSize?`	number

Returns: BatchInsertBuilder<TRecord2, TResult2>

Defined in: node_modules/knex/types/index.d.ts:361

clear#

▸ clear(statement: ClearStatements): QueryBuilder<TRecord, TResult>

Parameters:#

Name	Type
`statement`	ClearStatements

Returns: QueryBuilder<TRecord, TResult>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:573

clearCounters#

▸ clearCounters(): QueryBuilder<TRecord, TResult>

Returns: QueryBuilder<TRecord, TResult>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:572

clearGroup#

▸ clearGroup(): QueryBuilder<TRecord, TResult>

Returns: QueryBuilder<TRecord, TResult>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:569

clearHaving#

▸ clearHaving(): QueryBuilder<TRecord, TResult>

Returns: QueryBuilder<TRecord, TResult>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:571

clearOrder#

▸ clearOrder(): QueryBuilder<TRecord, TResult>

Returns: QueryBuilder<TRecord, TResult>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:570

clearSelect#

▸ clearSelect(): QueryBuilder<TRecord, UnwrapArrayMember<TResult> extends DeferredKeySelection<TBase, TKeys, true, any, any, any, any> ? DeferredKeySelection<TBase, never, false, {}, false, {}, never>[] : TResult>

Returns: QueryBuilder<TRecord, UnwrapArrayMember<TResult> extends DeferredKeySelection<TBase, TKeys, true, any, any, any, any> ? DeferredKeySelection<TBase, never, false, {}, false, {}, never>[] : TResult>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:554

clearWhere#

▸ clearWhere(): QueryBuilder<TRecord, TResult>

Returns: QueryBuilder<TRecord, TResult>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:568

decrement#

▸ decrement(columnName: keyof TRecord, amount?: number): QueryBuilder<TRecord, number>

Parameters:#

Name	Type
`columnName`	keyof TRecord
`amount?`	number

Returns: QueryBuilder<TRecord, number>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:598

▸ decrement(columnName: string, amount?: number): QueryBuilder<TRecord, number>

Parameters:#

Name	Type
`columnName`	string
`amount?`	number

Returns: QueryBuilder<TRecord, number>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:602

del#

▸ del(returning: **, options?: DMLOptions): [QueryBuilder](/docs/api/classes/knex.knex.querybuilder)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never*>[]>

Parameters:#

Name	Type
`returning`	***
`options?`	DMLOptions

Returns: QueryBuilder<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never>[]>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:832

▸ del<TKey, TResult2>(returning: TKey, options?: DMLOptions): QueryBuilder<TRecord, TResult2>

Type parameters:#

Name	Type	Default
`TKey`	string	-
`TResult2`	-	SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\>, TRecord\>, TKey\>, true\>[]

Parameters:#

Name	Type
`returning`	TKey
`options?`	DMLOptions

Returns: QueryBuilder<TRecord, TResult2>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:836

▸ del<TKey, TResult2>(returning: readonly TKey[], options?: DMLOptions): QueryBuilder<TRecord, TResult2[]>

Type parameters:#

Name	Type	Default
`TKey`	string	-
`TResult2`	-	AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\>, TRecord\>, TKey\>, {}\>[]

Parameters:#

Name	Type
`returning`	readonly TKey[]
`options?`	DMLOptions

Returns: QueryBuilder<TRecord, TResult2[]>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:847

▸ del<TResult2>(returning: string | readonly string[], options?: DMLOptions): QueryBuilder<TRecord, TResult2>

Type parameters:#

Name	Default
`TResult2`	Partial<AnyOrUnknownToOther<TRecord, {}\>\>[]

Parameters:#

Name	Type
`returning`	string \| readonly string[]
`options?`	DMLOptions

Returns: QueryBuilder<TRecord, TResult2>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:858

▸ del<TResult2>(): QueryBuilder<TRecord, TResult2>

Type parameters:#

Name	Default
`TResult2`	number

Returns: QueryBuilder<TRecord, TResult2>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:862

delete#

▸ delete(returning: **, options?: DMLOptions): [QueryBuilder](/docs/api/classes/knex.knex.querybuilder)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never*>[]>

Parameters:#

Name	Type
`returning`	***
`options?`	DMLOptions

Returns: QueryBuilder<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never>[]>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:864

▸ delete<TKey, TResult2>(returning: TKey, options?: DMLOptions): QueryBuilder<TRecord, TResult2>

Type parameters:#

Name	Type	Default
`TKey`	string	-
`TResult2`	-	SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\>, ResolveTableType<TRecord, base\>\>, TKey\>, true\>[]

Parameters:#

Name	Type
`returning`	TKey
`options?`	DMLOptions

Returns: QueryBuilder<TRecord, TResult2>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:868

▸ delete<TKey, TResult2>(returning: readonly TKey[], options?: DMLOptions): QueryBuilder<TRecord, TResult2>

Type parameters:#

Name	Type	Default
`TKey`	string	-
`TResult2`	-	AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\>, TRecord\>, TKey\>, {}\>[]

Parameters:#

Name	Type
`returning`	readonly TKey[]
`options?`	DMLOptions

Returns: QueryBuilder<TRecord, TResult2>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:879

▸ delete<TResult2>(returning: string | readonly string[], options?: DMLOptions): QueryBuilder<TRecord, TResult2>

Type parameters:#

Name	Default
`TResult2`	any

Parameters:#

Name	Type
`returning`	string \| readonly string[]
`options?`	DMLOptions

Returns: QueryBuilder<TRecord, TResult2>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:890

▸ delete<TResult2>(): QueryBuilder<TRecord, TResult2>

Type parameters:#

Name	Default
`TResult2`	number

Returns: QueryBuilder<TRecord, TResult2>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:894

destroy#

▸ destroy(callback: Function): void

Parameters:#

Name	Type
`callback`	Function

Returns: void

Defined in: node_modules/knex/types/index.d.ts:358

▸ destroy(): Promise<void>

Returns: Promise<void>

Defined in: node_modules/knex/types/index.d.ts:359

emit#

▸ emit(event: string | symbol, ...args: any[]): boolean

Parameters:#

Name	Type
`event`	string \| symbol
`...args`	any[]

Returns: boolean

Defined in: node_modules/@types/node/events.d.ts:67

eventNames#

▸ eventNames(): (string | symbol)[]

Returns: (string | symbol)[]

Defined in: node_modules/@types/node/events.d.ts:72

getMaxListeners#

▸ getMaxListeners(): number

Returns: number

Defined in: node_modules/@types/node/events.d.ts:64

increment#

▸ increment(columnName: keyof TRecord, amount?: number): QueryBuilder<TRecord, number>

Parameters:#

Name	Type
`columnName`	keyof TRecord
`amount?`	number

Returns: QueryBuilder<TRecord, number>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:589

▸ increment(columnName: string, amount?: number): QueryBuilder<TRecord, number>

Parameters:#

Name	Type
`columnName`	string
`amount?`	number

Returns: QueryBuilder<TRecord, number>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:593

initialize#

▸ initialize(config?: Config<any>): void

Parameters:#

Name	Type
`config?`	Config<any>

Returns: void

Defined in: node_modules/knex/types/index.d.ts:357

insert#

▸ insert(data: TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, insert> | readonly ResolveTableType<TRecord, insert>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> | readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[] | readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> | readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[])[], returning: **, options?: DMLOptions): [QueryBuilder](/docs/api/classes/knex.knex.querybuilder)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never*>[]>

Parameters:#

Name	Type
`data`	TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, insert> \| readonly ResolveTableType<TRecord, insert>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> \| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[] \| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> \| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[])[]
`returning`	***
`options?`	DMLOptions

Returns: QueryBuilder<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never>[]>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:615

▸ insert<TKey, TResult2>(data: TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, insert> | readonly ResolveTableType<TRecord, insert>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> | readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[] | readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> | readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[])[], returning: TKey, options?: DMLOptions): QueryBuilder<TRecord, TResult2>

Type parameters:#

Name	Type	Default
`TKey`	string	-
`TResult2`	-	SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\>, ResolveTableType<TRecord, base\>\>, TKey\>, true\>[]

Parameters:#

Name	Type
`data`	TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, insert> \| readonly ResolveTableType<TRecord, insert>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> \| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[] \| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> \| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[])[]
`returning`	TKey
`options?`	DMLOptions

Returns: QueryBuilder<TRecord, TResult2>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:622

▸ insert<TKey, TResult2>(data: TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, insert> | readonly ResolveTableType<TRecord, insert>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> | readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[] | readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> | readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[])[], returning: readonly TKey[], options?: DMLOptions): QueryBuilder<TRecord, TResult2>

Type parameters:#

Name	Type	Default
`TKey`	string	-
`TResult2`	-	AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\>, ResolveTableType<TRecord, base\>\>, TKey\>, {}\>[]

Parameters:#

Name	Type
`data`	TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, insert> \| readonly ResolveTableType<TRecord, insert>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> \| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[] \| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> \| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[])[]
`returning`	readonly TKey[]
`options?`	DMLOptions

Returns: QueryBuilder<TRecord, TResult2>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:636

Type parameters:#

Name	Type	Default
`TKey`	string	-
`TResult2`	-	SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\>, TRecord\>, TKey\>, true\>[]

Parameters:#

Name	Type
`data`	TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, insert> \| readonly ResolveTableType<TRecord, insert>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> \| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[] \| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> \| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[])[]
`returning`	TKey
`options?`	DMLOptions

Returns: QueryBuilder<TRecord, TResult2>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:650

▸ insert<TKey, TResult2>(data: TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, insert> | readonly ResolveTableType<TRecord, insert>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> | readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[] | readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> | readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[])[], returning: readonly TKey[], options?: DMLOptions): QueryBuilder<TRecord, TResult2>

Type parameters:#

Name	Type	Default
`TKey`	string	-
`TResult2`	-	SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\>, TRecord\>, TKey\>, true\>[]

Parameters:#

Name	Type
`data`	TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, insert> \| readonly ResolveTableType<TRecord, insert>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> \| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[] \| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> \| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[])[]
`returning`	readonly TKey[]
`options?`	DMLOptions

Returns: QueryBuilder<TRecord, TResult2>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:664

▸ insert<TResult2>(data: TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, insert> | readonly ResolveTableType<TRecord, insert>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> | readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[] | readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> | readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[])[]): QueryBuilder<TRecord, TResult2>

Type parameters:#

Name	Default
`TResult2`	number[]

Parameters:#

Name Type

data TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, insert> | readonly ResolveTableType<TRecord, insert>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> | readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[] | readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> | readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[])[]

Returns: QueryBuilder<TRecord, TResult2>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:678

limit#

▸ limit(limit: number): QueryBuilder<TRecord, TResult>

Parameters:#

Name	Type
`limit`	number

Returns: QueryBuilder<TRecord, TResult>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:577

listenerCount#

▸ listenerCount(event: string | symbol): number

Parameters:#

Name	Type
`event`	string \| symbol

Returns: number

Defined in: node_modules/@types/node/events.d.ts:68

listeners#

▸ listeners(event: string | symbol): Function[]

Parameters:#

Name	Type
`event`	string \| symbol

Returns: Function[]

Defined in: node_modules/@types/node/events.d.ts:65

modify#

▸ modify<TRecord2, TResult2>(callback: QueryCallbackWithArgs<TRecord, any>, ...args: any[]): QueryBuilder<TRecord2, TResult2>

Type parameters:#

Name	Type	Default
`TRecord2`	{}	any
`TResult2`	{}	any

Parameters:#

Name	Type
`callback`	QueryCallbackWithArgs<TRecord, any>
`...args`	any[]

Returns: QueryBuilder<TRecord2, TResult2>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:684

off#

▸ off(event: string | symbol, listener: (...args: any[]) => void): Knex<TRecord, TResult>

Parameters:#

Name	Type
`event`	string \| symbol
`listener`	(...`args`: any[]) => void

Returns: Knex<TRecord, TResult>

Defined in: node_modules/@types/node/events.d.ts:61

offset#

▸ offset(offset: number): QueryBuilder<TRecord, TResult>

Parameters:#

Name	Type
`offset`	number

Returns: QueryBuilder<TRecord, TResult>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:576

on#

▸ on(event: string | symbol, listener: (...args: any[]) => void): Knex<TRecord, TResult>

Parameters:#

Name	Type
`event`	string \| symbol
`listener`	(...`args`: any[]) => void

Returns: Knex<TRecord, TResult>

Defined in: node_modules/@types/node/events.d.ts:58

onConflict#

▸ onConflict<TKey, TResult2>(column: TKey): OnConflictQueryBuilder<TRecord, TResult2>

Type parameters:#

Name	Type	Default
`TKey`	string	-
`TResult2`	-	SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\>, TRecord\>, TKey\>, true\>[]

Parameters:#

Name	Type
`column`	TKey

Returns: OnConflictQueryBuilder<TRecord, TResult2>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:812

▸ onConflict<TKey, TResult2>(columns: readonly TKey[]): OnConflictQueryBuilder<TRecord, TResult2>

Type parameters:#

Name	Type	Default
`TKey`	string	-
`TResult2`	-	SetSingle<AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\>, TRecord\>, TKey\>, {}\>, false\>[]

Parameters:#

Name	Type
`columns`	readonly TKey[]

Returns: OnConflictQueryBuilder<TRecord, TResult2>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:822

once#

▸ once(event: string | symbol, listener: (...args: any[]) => void): Knex<TRecord, TResult>

Parameters:#

Name	Type
`event`	string \| symbol
`listener`	(...`args`: any[]) => void

Returns: Knex<TRecord, TResult>

Defined in: node_modules/@types/node/events.d.ts:59

pluck#

▸ pluck<K>(column: K): QueryBuilder<TRecord, TRecord[K][]>

Type parameters:#

Name	Type
`K`	string \| number \| symbol

Parameters:#

Name	Type
`column`	K

Returns: QueryBuilder<TRecord, TRecord[K][]>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:610

▸ pluck<TResult2>(column: string): QueryBuilder<TRecord, TResult2>

Type parameters:#

Name	Type
`TResult2`	{}

Parameters:#

Name	Type
`column`	string

Returns: QueryBuilder<TRecord, TResult2>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:613

prependListener#

▸ prependListener(event: string | symbol, listener: (...args: any[]) => void): Knex<TRecord, TResult>

Parameters:#

Name	Type
`event`	string \| symbol
`listener`	(...`args`: any[]) => void

Returns: Knex<TRecord, TResult>

Defined in: node_modules/@types/node/events.d.ts:70

prependOnceListener#

▸ prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): Knex<TRecord, TResult>

Parameters:#

Name	Type
`event`	string \| symbol
`listener`	(...`args`: any[]) => void

Returns: Knex<TRecord, TResult>

Defined in: node_modules/@types/node/events.d.ts:71

queryBuilder#

▸ queryBuilder<TRecord2, TResult2>(): QueryBuilder<TRecord2, TResult2>

Type parameters:#

Name	Default
`TRecord2`	TRecord
`TResult2`	TResult

Returns: QueryBuilder<TRecord2, TResult2>

Defined in: node_modules/knex/types/index.d.ts:370

rawListeners#

▸ rawListeners(event: string | symbol): Function[]

Parameters:#

Name	Type
`event`	string \| symbol

Returns: Function[]

Defined in: node_modules/@types/node/events.d.ts:66

removeAllListeners#

▸ removeAllListeners(event?: string | symbol): Knex<TRecord, TResult>

Parameters:#

Name	Type
`event?`	string \| symbol

Returns: Knex<TRecord, TResult>

Defined in: node_modules/@types/node/events.d.ts:62

removeListener#

▸ removeListener(event: string | symbol, listener: (...args: any[]) => void): Knex<TRecord, TResult>

Parameters:#

Name	Type
`event`	string \| symbol
`listener`	(...`args`: any[]) => void

Returns: Knex<TRecord, TResult>

Defined in: node_modules/@types/node/events.d.ts:60

returning#

▸ returning(column: **, options?: DMLOptions): [QueryBuilder](/docs/api/classes/knex.knex.querybuilder)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never*>[]>

Parameters:#

Name	Type
`column`	***
`options?`	DMLOptions

Returns: QueryBuilder<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never>[]>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:785

▸ returning<TKey, TResult2>(column: TKey, options?: DMLOptions): QueryBuilder<TRecord, TResult2>

Type parameters:#

Name	Type	Default
`TKey`	string	-
`TResult2`	-	SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\>, ResolveTableType<TRecord, base\>\>, TKey\>, true\>[]

Parameters:#

Name	Type
`column`	TKey
`options?`	DMLOptions

Returns: QueryBuilder<TRecord, TResult2>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:786

▸ returning<TKey, TResult2>(columns: readonly TKey[], options?: DMLOptions): QueryBuilder<TRecord, TResult2>

Type parameters:#

Name	Type	Default
`TKey`	string	-
`TResult2`	-	SetSingle<AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\>, ResolveTableType<TRecord, base\>\>, TKey\>, {}\>, false\>[]

Parameters:#

Name	Type
`columns`	readonly TKey[]
`options?`	DMLOptions

Returns: QueryBuilder<TRecord, TResult2>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:797

▸ returning<TResult2>(column: string | readonly string[], options?: DMLOptions): QueryBuilder<TRecord, TResult2>

Type parameters:#

Name	Default
`TResult2`	Partial<AnyOrUnknownToOther<TRecord, {}\>\>[]

Parameters:#

Name	Type
`column`	string \| readonly string[]
`options?`	DMLOptions

Returns: QueryBuilder<TRecord, TResult2>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:807

setMaxListeners#

▸ setMaxListeners(n: number): Knex<TRecord, TResult>

Parameters:#

Name	Type
`n`	number

Returns: Knex<TRecord, TResult>

Defined in: node_modules/@types/node/events.d.ts:63

transaction#

▸ transaction(transactionScope?: null, config?: any): Promise<Transaction<any, any>>

Parameters:#

Name	Type
`transactionScope?`	null
`config?`	any

Returns: Promise<Transaction<any, any>>

Defined in: node_modules/knex/types/index.d.ts:349

▸ transaction<T>(transactionScope: (trx: Transaction<any, any>) => void | Promise<T>, config?: any): Promise<T>

Type parameters:#

Name
`T`

Parameters:#

Name	Type
`transactionScope`	(`trx`: Transaction<any, any>) => void \| Promise<T>
`config?`	any

Returns: Promise<T>

Defined in: node_modules/knex/types/index.d.ts:353

transactionProvider#

▸ transactionProvider(config?: any): function

Parameters:#

Name	Type
`config?`	any

Returns: function

Defined in: node_modules/knex/types/index.d.ts:346

truncate#

▸ truncate(): QueryBuilder<TRecord, void>

Returns: QueryBuilder<TRecord, void>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:896

update#

▸ update<K1, K2, TResult2>(columnName: K1, value: Readonly<ResolveTableType<TRecord, update>[K1]> | Readonly<Raw<ResolveTableType<TRecord, update>[K1]>>, returning: K2, options?: DMLOptions): QueryBuilder<TRecord, TResult2>

Type parameters:#

Name	Type	Default
`K1`	string	-
`K2`	string	-
`TResult2`	-	SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\>, ResolveTableType<TRecord, base\>\>, K2\>, true\>[]

Parameters:#

Name	Type
`columnName`	K1
`value`	Readonly<ResolveTableType<TRecord, update>[K1]> \| Readonly<Raw<ResolveTableType<TRecord, update>[K1]>>
`returning`	K2
`options?`	DMLOptions

Returns: QueryBuilder<TRecord, TResult2>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:688

▸ update<K1, K2, TResult2>(columnName: K1, value: Readonly<ResolveTableType<TRecord, update>[K1]> | Readonly<Raw<ResolveTableType<TRecord, update>[K1]>>, returning: readonly K2[], options?: DMLOptions): QueryBuilder<TRecord, TResult2>

Type parameters:#

Name	Type	Default
`K1`	string	-
`K2`	string	-
`TResult2`	-	AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\>, ResolveTableType<TRecord, base\>\>, K2\>, {}\>[]

Parameters:#

Name	Type
`columnName`	K1
`value`	Readonly<ResolveTableType<TRecord, update>[K1]> \| Readonly<Raw<ResolveTableType<TRecord, update>[K1]>>
`returning`	readonly K2[]
`options?`	DMLOptions

Returns: QueryBuilder<TRecord, TResult2>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:702

▸ update<K>(columnName: K, value: Readonly<TRecord[K]> | Readonly<Raw<TRecord[K]>>): QueryBuilder<TRecord, number>

Type parameters:#

Name	Type
`K`	string \| number \| symbol

Parameters:#

Name	Type
`columnName`	K
`value`	Readonly<TRecord[K]> \| Readonly<Raw<TRecord[K]>>

Returns: QueryBuilder<TRecord, number>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:716

▸ update<TResult2>(columnName: string, value: Value, returning: string | readonly string[], options?: DMLOptions): QueryBuilder<TRecord, TResult2>

Type parameters:#

Name	Default
`TResult2`	Partial<AnyOrUnknownToOther<TRecord, {}\>\>[]

Parameters:#

Name	Type
`columnName`	string
`value`	Value
`returning`	string \| readonly string[]
`options?`	DMLOptions

Returns: QueryBuilder<TRecord, TResult2>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:720

▸ update(data: Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> | readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[], returning: **, options?: DMLOptions): [QueryBuilder](/docs/api/classes/knex.knex.querybuilder)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never*>[]>

Parameters:#

Name	Type
`data`	Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> \| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[]
`returning`	***
`options?`	DMLOptions

Returns: QueryBuilder<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never>[]>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:726

▸ update<TKey, TResult2>(data: TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, update> : Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> | readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[], returning: TKey, options?: DMLOptions): QueryBuilder<TRecord, TResult2>

Type parameters:#

Name	Type	Default
`TKey`	string	-
`TResult2`	-	SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\>, ResolveTableType<TRecord, base\>\>, TKey\>, true\>[]

Parameters:#

Name	Type
`data`	TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, update> : Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> \| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[]
`returning`	TKey
`options?`	DMLOptions

Returns: QueryBuilder<TRecord, TResult2>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:731

▸ update<TKey, TResult2>(data: TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, update> : Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> | readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[], returning: readonly TKey[], options?: DMLOptions): QueryBuilder<TRecord, TResult2>

Type parameters:#

Name	Type	Default
`TKey`	string	-
`TResult2`	-	AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\>, ResolveTableType<TRecord, base\>\>, TKey\>, {}\>[]

Parameters:#

Name	Type
`data`	TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, update> : Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> \| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[]
`returning`	readonly TKey[]
`options?`	DMLOptions

Returns: QueryBuilder<TRecord, TResult2>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:743

▸ update<TKey, TResult2>(data: TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, update> : Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> | readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[], returning: TKey | readonly TKey[], options?: DMLOptions): QueryBuilder<TRecord, TResult2>

Type parameters:#

Name	Type	Default
`TKey`	string	string
`TResult2`	{}[]	AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\>, TRecord\>, TKey\>, {}\>[]

Parameters:#

Name	Type
`data`	TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, update> : Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> \| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[]
`returning`	TKey \| readonly TKey[]
`options?`	DMLOptions

Returns: QueryBuilder<TRecord, TResult2>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:755

▸ update<TKey, TResult2>(data: TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, update> : Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> | readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[], returning: readonly TKey[], options?: DMLOptions): QueryBuilder<TRecord, TResult2>

Type parameters:#

Name	Type	Default
`TKey`	string	-
`TResult2`	{}[]	AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\>, TRecord\>, TKey\>, {}\>[]

Parameters:#

Name	Type
`data`	TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, update> : Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> \| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[]
`returning`	readonly TKey[]
`options?`	DMLOptions

Returns: QueryBuilder<TRecord, TResult2>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:767

▸ update<TResult2>(data: TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, update> : Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> | readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[]): QueryBuilder<TRecord, TResult2>

Type parameters:#

Name	Default
`TResult2`	number

Parameters:#

Name	Type
`data`	TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, update> : Readonly<Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>> \| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord>, {}>>>[]

Returns: QueryBuilder<TRecord, TResult2>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:779

▸ update<TResult2>(columnName: string, value: Value): QueryBuilder<TRecord, TResult2>

Type parameters:#

Name	Default
`TResult2`	number

Parameters:#

Name	Type
`columnName`	string
`value`	Value

Returns: QueryBuilder<TRecord, TResult2>

Inherited from: QueryInterface

Defined in: node_modules/knex/types/index.d.ts:783

withUserParams#

▸ withUserParams(params: Record<string, any>): Knex<any, unknown[]>

Parameters:#

Name	Type
`params`	Record<string, any>

Returns: Knex<any, unknown[]>

Defined in: node_modules/knex/types/index.d.ts:381

Interface: Knex<TRecord, TResult>#

Type parameters#

Hierarchy#

Callable#

Type parameters:#

Parameters:#

Type parameters:#

Parameters:#

Properties#

VERSION#

__knex__#

andHaving#

andWhere#

andWhereBetween#

andWhereNot#

andWhereNotBetween#

andWhereRaw#

as#

avg#

avgDistinct#

client#

column#

columns#

count#

countDistinct#

crossJoin#

distinct#

distinctOn#

first#

fn#

from#

fullOuterJoin#

groupBy#

groupByRaw#

having#

havingBetween#

havingIn#

havingNotBetween#

havingRaw#

havingWrapped#

innerJoin#

intersect#

into#

join#

joinRaw#

leftJoin#

leftOuterJoin#

max#

migrate#

min#

orHaving#

orHavingBetween#

orHavingNotBetween#

orHavingRaw#

orWhere#

orWhereBetween#

orWhereExists#

orWhereIn#

orWhereNot#

orWhereNotBetween#

orWhereNotExists#

orWhereNotIn#

orWhereNotNull#

orWhereNull#

orWhereRaw#

orderBy#

orderByRaw#

outerJoin#

raw#

ref#

rightJoin#

rightOuterJoin#

schema#

seed#

select#

sum#

sumDistinct#

table#

union#

unionAll#

knex#