Interface: Knex<TRecord, TResult>#
knex.Knex
Type parameters#
| Name | Type | Default |
|---|---|---|
TRecord | object | 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?: TableDescriptor | AliasDict, options?: PgTableOptions): QueryBuilder<TRecord2, TResult2>
Type parameters:#
| Name | Default |
|---|---|
TRecord2 | TRecord |
TResult2 | DeferredKeySelection<TRecord2, never, false, {}, false, {}, never>[] |
Parameters:#
| Name | Type |
|---|---|
tableName? | TableDescriptor | AliasDict |
options? | PgTableOptions |
Returns: QueryBuilder<TRecord2, TResult2>
Defined in: node_modules/knex/types/index.d.ts:336
Constructors#
constructor#
• constructor: object
Inherited from: void
Properties#
RefMemberTag#
• RefMemberTag: typeof RefMemberTag
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:544
andWhere#
• andWhere: Where<TRecord, TResult>
Inherited from: QueryInterface.andWhere
Defined in: node_modules/knex/types/index.d.ts:498
andWhereBetween#
• andWhereBetween: WhereBetween<TRecord, TResult>
Inherited from: QueryInterface.andWhereBetween
Defined in: node_modules/knex/types/index.d.ts:522
andWhereNot#
• andWhereNot: Where<TRecord, TResult>
Inherited from: QueryInterface.andWhereNot
Defined in: node_modules/knex/types/index.d.ts:501
andWhereNotBetween#
• andWhereNotBetween: WhereBetween<TRecord, TResult>
Inherited from: QueryInterface.andWhereNotBetween
Defined in: node_modules/knex/types/index.d.ts:525
andWhereRaw#
• andWhereRaw: WhereRaw<TRecord, TResult>
Inherited from: QueryInterface.andWhereRaw
Defined in: node_modules/knex/types/index.d.ts:505
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:587
avgDistinct#
• avgDistinct: TypePreservingAggregation<TRecord, TResult, any>
Inherited from: QueryInterface.avgDistinct
Defined in: node_modules/knex/types/index.d.ts:588
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:581
countDistinct#
• countDistinct: AsymmetricAggregation<TRecord, TResult, string | number>
Inherited from: QueryInterface.countDistinct
Defined in: node_modules/knex/types/index.d.ts:582
crossJoin#
• crossJoin: Join<TRecord, TResult>
Inherited from: QueryInterface.crossJoin
Defined in: node_modules/knex/types/index.d.ts:487
distinct#
• distinct: Distinct<TRecord, TResult>
Inherited from: QueryInterface.distinct
Defined in: node_modules/knex/types/index.d.ts:474
distinctOn#
• distinctOn: DistinctOn<TRecord, TResult>
Inherited from: QueryInterface.distinctOn
Defined in: node_modules/knex/types/index.d.ts:475
first#
• first: Select<TRecord, AddUnionMember<UnwrapArrayMember<TResult>, undefined>>
Inherited from: QueryInterface.first
Defined in: node_modules/knex/types/index.d.ts:609
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:471
fullOuterJoin#
• fullOuterJoin: Join<TRecord, TResult>
Inherited from: QueryInterface.fullOuterJoin
Defined in: node_modules/knex/types/index.d.ts:486
groupBy#
• groupBy: GroupBy<TRecord, TResult>
Inherited from: QueryInterface.groupBy
Defined in: node_modules/knex/types/index.d.ts:528
groupByRaw#
• groupByRaw: RawQueryBuilder<TRecord, TResult>
Inherited from: QueryInterface.groupByRaw
Defined in: node_modules/knex/types/index.d.ts:529
having#
• having: Having<TRecord, TResult>
Inherited from: QueryInterface.having
Defined in: node_modules/knex/types/index.d.ts:543
havingBetween#
• havingBetween: HavingRange<TRecord, TResult>
Inherited from: QueryInterface.havingBetween
Defined in: node_modules/knex/types/index.d.ts:552
havingIn#
• havingIn: HavingRange<TRecord, TResult>
Inherited from: QueryInterface.havingIn
Defined in: node_modules/knex/types/index.d.ts:548
havingNotBetween#
• havingNotBetween: HavingRange<TRecord, TResult>
Inherited from: QueryInterface.havingNotBetween
Defined in: node_modules/knex/types/index.d.ts:550
havingRaw#
• havingRaw: RawQueryBuilder<TRecord, TResult>
Inherited from: QueryInterface.havingRaw
Defined in: node_modules/knex/types/index.d.ts:545
havingWrapped#
• havingWrapped: WhereWrapped<TRecord, TResult>
Inherited from: QueryInterface.havingWrapped
Defined in: node_modules/knex/types/index.d.ts:507
hintComment#
• hintComment: HintComment<TRecord, TResult>
Inherited from: QueryInterface.hintComment
Defined in: node_modules/knex/types/index.d.ts:470
innerJoin#
• innerJoin: Join<TRecord, TResult>
Inherited from: QueryInterface.innerJoin
Defined in: node_modules/knex/types/index.d.ts:480
intersect#
• intersect: Intersect<TRecord, TResult>
Inherited from: QueryInterface.intersect
Defined in: node_modules/knex/types/index.d.ts:536
into#
• into: Table<TRecord, TResult>
Inherited from: QueryInterface.into
Defined in: node_modules/knex/types/index.d.ts:472
join#
• join: Join<TRecord, TResult>
Inherited from: QueryInterface.join
Defined in: node_modules/knex/types/index.d.ts:478
joinRaw#
• joinRaw: JoinRaw<TRecord, TResult>
Inherited from: QueryInterface.joinRaw
Defined in: node_modules/knex/types/index.d.ts:479
leftJoin#
• leftJoin: Join<TRecord, TResult>
Inherited from: QueryInterface.leftJoin
Defined in: node_modules/knex/types/index.d.ts:481
leftOuterJoin#
• leftOuterJoin: Join<TRecord, TResult>
Inherited from: QueryInterface.leftOuterJoin
Defined in: node_modules/knex/types/index.d.ts:482
max#
• max: TypePreservingAggregation<TRecord, TResult, any>
Inherited from: QueryInterface.max
Defined in: node_modules/knex/types/index.d.ts:584
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:583
orHaving#
• orHaving: Having<TRecord, TResult>
Inherited from: QueryInterface.orHaving
Defined in: node_modules/knex/types/index.d.ts:546
orHavingBetween#
• orHavingBetween: HavingRange<TRecord, TResult>
Inherited from: QueryInterface.orHavingBetween
Defined in: node_modules/knex/types/index.d.ts:551
orHavingNotBetween#
• orHavingNotBetween: HavingRange<TRecord, TResult>
Inherited from: QueryInterface.orHavingNotBetween
Defined in: node_modules/knex/types/index.d.ts:549
orHavingRaw#
• orHavingRaw: RawQueryBuilder<TRecord, TResult>
Inherited from: QueryInterface.orHavingRaw
Defined in: node_modules/knex/types/index.d.ts:547
orWhere#
• orWhere: Where<TRecord, TResult>
Inherited from: QueryInterface.orWhere
Defined in: node_modules/knex/types/index.d.ts:499
orWhereBetween#
• orWhereBetween: WhereBetween<TRecord, TResult>
Inherited from: QueryInterface.orWhereBetween
Defined in: node_modules/knex/types/index.d.ts:521
orWhereExists#
• orWhereExists: WhereExists<TRecord, TResult>
Inherited from: QueryInterface.orWhereExists
Defined in: node_modules/knex/types/index.d.ts:509
orWhereIn#
• orWhereIn: WhereIn<TRecord, TResult>
Inherited from: QueryInterface.orWhereIn
Defined in: node_modules/knex/types/index.d.ts:513
orWhereNot#
• orWhereNot: Where<TRecord, TResult>
Inherited from: QueryInterface.orWhereNot
Defined in: node_modules/knex/types/index.d.ts:502
orWhereNotBetween#
• orWhereNotBetween: WhereBetween<TRecord, TResult>
Inherited from: QueryInterface.orWhereNotBetween
Defined in: node_modules/knex/types/index.d.ts:524
orWhereNotExists#
• orWhereNotExists: WhereExists<TRecord, TResult>
Inherited from: QueryInterface.orWhereNotExists
Defined in: node_modules/knex/types/index.d.ts:511
orWhereNotIn#
• orWhereNotIn: WhereIn<TRecord, TResult>
Inherited from: QueryInterface.orWhereNotIn
Defined in: node_modules/knex/types/index.d.ts:515
orWhereNotNull#
• orWhereNotNull: WhereNull<TRecord, TResult>
Inherited from: QueryInterface.orWhereNotNull
Defined in: node_modules/knex/types/index.d.ts:519
orWhereNull#
• orWhereNull: WhereNull<TRecord, TResult>
Inherited from: QueryInterface.orWhereNull
Defined in: node_modules/knex/types/index.d.ts:517
orWhereRaw#
• orWhereRaw: WhereRaw<TRecord, TResult>
Inherited from: QueryInterface.orWhereRaw
Defined in: node_modules/knex/types/index.d.ts:504
orderBy#
• orderBy: OrderBy<TRecord, TResult>
Inherited from: QueryInterface.orderBy
Defined in: node_modules/knex/types/index.d.ts:532
orderByRaw#
• orderByRaw: RawQueryBuilder<TRecord, TResult>
Inherited from: QueryInterface.orderByRaw
Defined in: node_modules/knex/types/index.d.ts:533
outerJoin#
• outerJoin: Join<TRecord, TResult>
Inherited from: QueryInterface.outerJoin
Defined in: node_modules/knex/types/index.d.ts:485
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:483
rightOuterJoin#
• rightOuterJoin: Join<TRecord, TResult>
Inherited from: QueryInterface.rightOuterJoin
Defined in: node_modules/knex/types/index.d.ts:484
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:585
sumDistinct#
• sumDistinct: TypePreservingAggregation<TRecord, TResult, any>
Inherited from: QueryInterface.sumDistinct
Defined in: node_modules/knex/types/index.d.ts:586
table#
• table: Table<TRecord, TResult>
Inherited from: QueryInterface.table
Defined in: node_modules/knex/types/index.d.ts:473
union#
• union: Union<TRecord, TResult>
Inherited from: QueryInterface.union
Defined in: node_modules/knex/types/index.d.ts:539
unionAll#
• unionAll: Union<TRecord, TResult>
Inherited from: QueryInterface.unionAll
Defined in: node_modules/knex/types/index.d.ts:540
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:497
whereBetween#
• whereBetween: WhereBetween<TRecord, TResult>
Inherited from: QueryInterface.whereBetween
Defined in: node_modules/knex/types/index.d.ts:520
whereExists#
• whereExists: WhereExists<TRecord, TResult>
Inherited from: QueryInterface.whereExists
Defined in: node_modules/knex/types/index.d.ts:508
whereIn#
• whereIn: WhereIn<TRecord, TResult>
Inherited from: QueryInterface.whereIn
Defined in: node_modules/knex/types/index.d.ts:512
whereNot#
• whereNot: Where<TRecord, TResult>
Inherited from: QueryInterface.whereNot
Defined in: node_modules/knex/types/index.d.ts:500
whereNotBetween#
• whereNotBetween: WhereBetween<TRecord, TResult>
Inherited from: QueryInterface.whereNotBetween
Defined in: node_modules/knex/types/index.d.ts:523
whereNotExists#
• whereNotExists: WhereExists<TRecord, TResult>
Inherited from: QueryInterface.whereNotExists
Defined in: node_modules/knex/types/index.d.ts:510
whereNotIn#
• whereNotIn: WhereIn<TRecord, TResult>
Inherited from: QueryInterface.whereNotIn
Defined in: node_modules/knex/types/index.d.ts:514
whereNotNull#
• whereNotNull: WhereNull<TRecord, TResult>
Inherited from: QueryInterface.whereNotNull
Defined in: node_modules/knex/types/index.d.ts:518
whereNull#
• whereNull: WhereNull<TRecord, TResult>
Inherited from: QueryInterface.whereNull
Defined in: node_modules/knex/types/index.d.ts:516
whereRaw#
• whereRaw: WhereRaw<TRecord, TResult>
Inherited from: QueryInterface.whereRaw
Defined in: node_modules/knex/types/index.d.ts:503
whereWrapped#
• whereWrapped: WhereWrapped<TRecord, TResult>
Inherited from: QueryInterface.whereWrapped
Defined in: node_modules/knex/types/index.d.ts:506
with#
• with: With<TRecord, TResult>
Inherited from: QueryInterface.with
Defined in: node_modules/knex/types/index.d.ts:490
withRaw#
• withRaw: WithRaw<TRecord, TResult>
Inherited from: QueryInterface.withRaw
Defined in: node_modules/knex/types/index.d.ts:492
withRecursive#
• withRecursive: With<TRecord, TResult>
Inherited from: QueryInterface.withRecursive
Defined in: node_modules/knex/types/index.d.ts:491
withSchema#
• withSchema: WithSchema<TRecord, TResult>
Inherited from: QueryInterface.withSchema
Defined in: node_modules/knex/types/index.d.ts:493
withWrapped#
• withWrapped: WithWrapped<TRecord, TResult>
Inherited from: QueryInterface.withWrapped
Defined in: node_modules/knex/types/index.d.ts:494
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>
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:62
batchInsert#
â–¸ batchInsert<TRecord2, TResult2>(tableName: TableDescriptor, data: TRecord2 extends CompositeTableType<unknown, unknown, Partial<unknown>> ? readonly ResolveTableType<TRecord2, insert>[] : readonly DbRecordArr<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 DbRecordArr<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:574
clearCounters#
â–¸ clearCounters(): QueryBuilder<TRecord, TResult>
Returns: QueryBuilder<TRecord, TResult>
Inherited from: QueryInterface
Defined in: node_modules/knex/types/index.d.ts:573
clearGroup#
â–¸ clearGroup(): QueryBuilder<TRecord, TResult>
Returns: QueryBuilder<TRecord, TResult>
Inherited from: QueryInterface
Defined in: node_modules/knex/types/index.d.ts:570
clearHaving#
â–¸ clearHaving(): QueryBuilder<TRecord, TResult>
Returns: QueryBuilder<TRecord, TResult>
Inherited from: QueryInterface
Defined in: node_modules/knex/types/index.d.ts:572
clearOrder#
â–¸ clearOrder(): QueryBuilder<TRecord, TResult>
Returns: QueryBuilder<TRecord, TResult>
Inherited from: QueryInterface
Defined in: node_modules/knex/types/index.d.ts:571
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:555
clearWhere#
â–¸ clearWhere(): QueryBuilder<TRecord, TResult>
Returns: QueryBuilder<TRecord, TResult>
Inherited from: QueryInterface
Defined in: node_modules/knex/types/index.d.ts:569
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:599
â–¸ 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:603
del#
â–¸ del(returning: **, options?: DMLOptions): [QueryBuilder](/docs/api/classes/knex.knex-1.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:833
â–¸ 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:837
â–¸ 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:848
â–¸ 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:859
â–¸ 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:863
delete#
â–¸ delete(returning: **, options?: DMLOptions): [QueryBuilder](/docs/api/classes/knex.knex-1.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:865
â–¸ 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:869
â–¸ 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:880
â–¸ 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:891
â–¸ 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:895
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
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:72
eventNames#
â–¸ eventNames(): (string | symbol)[]
Returns: (string | symbol)[]
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:77
getMaxListeners#
â–¸ getMaxListeners(): number
Returns: number
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:69
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:590
â–¸ 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:594
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>[] : DbRecordArr<TRecord> | readonly DbRecordArr<TRecord>[], returning: **, options?: DMLOptions): [QueryBuilder](/docs/api/classes/knex.knex-1.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>[] : DbRecordArr<TRecord> | readonly DbRecordArr<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:616
â–¸ insert<TKey, TResult2>(data: TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, insert> | readonly ResolveTableType<TRecord, insert>[] : DbRecordArr<TRecord> | readonly DbRecordArr<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>[] : DbRecordArr<TRecord> | readonly DbRecordArr<TRecord>[] |
returning | TKey |
options? | DMLOptions |
Returns: QueryBuilder<TRecord, TResult2>
Inherited from: QueryInterface
Defined in: node_modules/knex/types/index.d.ts:623
â–¸ insert<TKey, TResult2>(data: TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, insert> | readonly ResolveTableType<TRecord, insert>[] : DbRecordArr<TRecord> | readonly DbRecordArr<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>[] : DbRecordArr<TRecord> | readonly DbRecordArr<TRecord>[] |
returning | readonly TKey[] |
options? | DMLOptions |
Returns: QueryBuilder<TRecord, TResult2>
Inherited from: QueryInterface
Defined in: node_modules/knex/types/index.d.ts:637
â–¸ insert<TKey, TResult2>(data: TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, insert> | readonly ResolveTableType<TRecord, insert>[] : DbRecordArr<TRecord> | readonly DbRecordArr<TRecord>[], 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 |
|---|---|
data | TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, insert> | readonly ResolveTableType<TRecord, insert>[] : DbRecordArr<TRecord> | readonly DbRecordArr<TRecord>[] |
returning | TKey |
options? | DMLOptions |
Returns: QueryBuilder<TRecord, TResult2>
Inherited from: QueryInterface
Defined in: node_modules/knex/types/index.d.ts:651
â–¸ insert<TKey, TResult2>(data: TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, insert> | readonly ResolveTableType<TRecord, insert>[] : DbRecordArr<TRecord> | readonly DbRecordArr<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>[] : DbRecordArr<TRecord> | readonly DbRecordArr<TRecord>[] |
returning | readonly TKey[] |
options? | DMLOptions |
Returns: QueryBuilder<TRecord, TResult2>
Inherited from: QueryInterface
Defined in: node_modules/knex/types/index.d.ts:665
â–¸ insert<TResult2>(data: TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, insert> | readonly ResolveTableType<TRecord, insert>[] : DbRecordArr<TRecord> | readonly DbRecordArr<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>[] : DbRecordArr<TRecord> | readonly DbRecordArr<TRecord>[] |
Returns: QueryBuilder<TRecord, TResult2>
Inherited from: QueryInterface
Defined in: node_modules/knex/types/index.d.ts:679
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:578
listenerCount#
â–¸ listenerCount(event: string | symbol): number
Parameters:#
| Name | Type |
|---|---|
event | string | symbol |
Returns: number
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:73
listeners#
â–¸ listeners(event: string | symbol): Function[]
Parameters:#
| Name | Type |
|---|---|
event | string | symbol |
Returns: Function[]
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:70
modify#
â–¸ modify<TRecord2, TResult2>(callback: QueryCallbackWithArgs<TRecord, any>, ...args: any[]): QueryBuilder<TRecord2, TResult2>
Type parameters:#
| Name | Type | Default |
|---|---|---|
TRecord2 | object | any |
TResult2 | object | 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:685
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>
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:66
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:577
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>
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:63
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:813
â–¸ 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:823
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>
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:64
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:611
â–¸ pluck<TResult2>(column: string): QueryBuilder<TRecord, TResult2>
Type parameters:#
| Name | Type |
|---|---|
TResult2 | object |
Parameters:#
| Name | Type |
|---|---|
column | string |
Returns: QueryBuilder<TRecord, TResult2>
Inherited from: QueryInterface
Defined in: node_modules/knex/types/index.d.ts:614
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>
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:75
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>
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:76
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[]
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:71
removeAllListeners#
â–¸ removeAllListeners(event?: string | symbol): Knex<TRecord, TResult>
Parameters:#
| Name | Type |
|---|---|
event? | string | symbol |
Returns: Knex<TRecord, TResult>
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:67
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>
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:65
returning#
â–¸ returning(column: **, options?: DMLOptions): [QueryBuilder](/docs/api/classes/knex.knex-1.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:786
â–¸ 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:787
â–¸ 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:798
â–¸ 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:808
setMaxListeners#
â–¸ setMaxListeners(n: number): Knex<TRecord, TResult>
Parameters:#
| Name | Type |
|---|---|
n | number |
Returns: Knex<TRecord, TResult>
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:68
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: () => Promise<Transaction<any, any>>
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:897
update#
â–¸ update<K1, K2, TResult2>(columnName: K1, value: DbColumn<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 | DbColumn<ResolveTableType<TRecord, update>[K1]> |
returning | K2 |
options? | DMLOptions |
Returns: QueryBuilder<TRecord, TResult2>
Inherited from: QueryInterface
Defined in: node_modules/knex/types/index.d.ts:689
â–¸ update<K1, K2, TResult2>(columnName: K1, value: DbColumn<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 | DbColumn<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:703
â–¸ update<K>(columnName: K, value: DbColumn<TRecord[K]>): QueryBuilder<TRecord, number>
Type parameters:#
| Name | Type |
|---|---|
K | string | number | symbol |
Parameters:#
| Name | Type |
|---|---|
columnName | K |
value | DbColumn<TRecord[K]> |
Returns: QueryBuilder<TRecord, number>
Inherited from: QueryInterface
Defined in: node_modules/knex/types/index.d.ts:717
â–¸ 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:721
â–¸ update(data: DbRecordArr<TRecord>, returning: **, options?: DMLOptions): [QueryBuilder](/docs/api/classes/knex.knex-1.querybuilder)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false*, {}, never>[]>
Parameters:#
| Name | Type |
|---|---|
data | DbRecordArr<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:727
â–¸ update<TKey, TResult2>(data: TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, update> : DbRecordArr<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> : DbRecordArr<TRecord> |
returning | TKey |
options? | DMLOptions |
Returns: QueryBuilder<TRecord, TResult2>
Inherited from: QueryInterface
Defined in: node_modules/knex/types/index.d.ts:732
â–¸ update<TKey, TResult2>(data: TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, update> : DbRecordArr<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> : DbRecordArr<TRecord> |
returning | readonly TKey[] |
options? | DMLOptions |
Returns: QueryBuilder<TRecord, TResult2>
Inherited from: QueryInterface
Defined in: node_modules/knex/types/index.d.ts:744
â–¸ update<TKey, TResult2>(data: TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, update> : DbRecordArr<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> : DbRecordArr<TRecord> |
returning | TKey | readonly TKey[] |
options? | DMLOptions |
Returns: QueryBuilder<TRecord, TResult2>
Inherited from: QueryInterface
Defined in: node_modules/knex/types/index.d.ts:756
â–¸ update<TKey, TResult2>(data: TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, update> : DbRecordArr<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> : DbRecordArr<TRecord> |
returning | readonly TKey[] |
options? | DMLOptions |
Returns: QueryBuilder<TRecord, TResult2>
Inherited from: QueryInterface
Defined in: node_modules/knex/types/index.d.ts:768
â–¸ update<TResult2>(data: TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, update> : DbRecordArr<TRecord>): QueryBuilder<TRecord, TResult2>
Type parameters:#
| Name | Default |
|---|---|
TResult2 | number |
Parameters:#
| Name | Type |
|---|---|
data | TRecord extends CompositeTableType<unknown, unknown, Partial<unknown>> ? ResolveTableType<TRecord, update> : DbRecordArr<TRecord> |
Returns: QueryBuilder<TRecord, TResult2>
Inherited from: QueryInterface
Defined in: node_modules/knex/types/index.d.ts:780
â–¸ 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:784
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