Interface: BatchInsertBuilder<TRecord, TResult>#
Type parameters#
| Name | Type | Default |
|---|---|---|
TRecord | {} | any |
TResult | - | number[] |
Hierarchy#
Promise<ResolveResult<TResult>>
↳ BatchInsertBuilder
Properties#
[Symbol.toStringTag]#
• Readonly [Symbol.toStringTag]: string
Defined in: docs/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:174
Methods#
catch#
â–¸ catch<TResult>(onrejected?: null | (reason: any) => TResult | PromiseLike<TResult>): Promise<Resolve<TResult> | TResult>
Attaches a callback for only the rejection of the Promise.
Type parameters:#
| Name | Default |
|---|---|
TResult | never |
Parameters:#
| Name | Type | Description |
|---|---|---|
onrejected? | null | (reason: any) => TResult | PromiseLike<TResult> | The callback to execute when the Promise is rejected. |
Returns: Promise<Resolve<TResult> | TResult>
A Promise for the completion of the callback.
Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1448
finally#
â–¸ finally(onfinally?: null | () => void): Promise<Resolve<TResult>>
Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.
Parameters:#
| Name | Type | Description |
|---|---|---|
onfinally? | null | () => void | The callback to execute when the Promise is settled (fulfilled or rejected). |
Returns: Promise<Resolve<TResult>>
A Promise for the completion of the callback.
Defined in: docs/node_modules/typescript/lib/lib.es2018.promise.d.ts:31
returning#
â–¸ returning(column: **): [BatchInsertBuilder](/docs/api/interfaces/knex.knex.batchinsertbuilder)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never*>[]>
Parameters:#
| Name | Type |
|---|---|
column | *** |
Returns: BatchInsertBuilder<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never>[]>
Defined in: node_modules/knex/types/index.d.ts:1541
â–¸ returning<TKey, TResult2>(column: TKey): BatchInsertBuilder<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 |
Returns: BatchInsertBuilder<TRecord, TResult2>
Defined in: node_modules/knex/types/index.d.ts:1542
â–¸ returning<TKey, TResult2>(columns: readonly TKey[]): BatchInsertBuilder<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[] |
Returns: BatchInsertBuilder<TRecord, TResult2>
Defined in: node_modules/knex/types/index.d.ts:1552
â–¸ returning<TResult2>(column: unknown extends TRecord ? string | readonly string[] : never): BatchInsertBuilder<TRecord, TResult2>
Type parameters:#
| Name | Default |
|---|---|
TResult2 | Partial<AnyOrUnknownToOther<TRecord, {}\>\>[] |
Parameters:#
| Name | Type |
|---|---|
column | unknown extends TRecord ? string | readonly string[] : never |
Returns: BatchInsertBuilder<TRecord, TResult2>
Defined in: node_modules/knex/types/index.d.ts:1562
then#
â–¸ then<TResult1, TResult2>(onfulfilled?: null | (value: Resolve<TResult>) => TResult1 | PromiseLike<TResult1>, onrejected?: null | (reason: any) => TResult2 | PromiseLike<TResult2>): Promise<TResult1 | TResult2>
Attaches callbacks for the resolution and/or rejection of the Promise.
Type parameters:#
| Name | Default |
|---|---|
TResult1 | Resolve<TResult\> |
TResult2 | never |
Parameters:#
| Name | Type | Description |
|---|---|---|
onfulfilled? | null | (value: Resolve<TResult>) => TResult1 | PromiseLike<TResult1> | The callback to execute when the Promise is resolved. |
onrejected? | null | (reason: any) => TResult2 | PromiseLike<TResult2> | The callback to execute when the Promise is rejected. |
Returns: Promise<TResult1 | TResult2>
A Promise for the completion of which ever callback is executed.
Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1441
transacting#
â–¸ transacting(trx: Transaction<any, any>): BatchInsertBuilder<TRecord, TResult>
Parameters:#
| Name | Type |
|---|---|
trx | Transaction<any, any> |
Returns: BatchInsertBuilder<TRecord, TResult>
Defined in: node_modules/knex/types/index.d.ts:1539