@tsdrivers/mssql

Appearance

@tsdrivers/mssql / BulkInsertBuilder

Class: BulkInsertBuilder ​

Defined in: projects/ts-mssql/core/bulk.ts:26

Builder for bulk insert operations.

Example ​

ts
await cn.bulk("Users")
  .columns([
    { name: "Id", type: "uniqueidentifier" },
    { name: "Name", type: "nvarchar" },
  ])
  .rows([
    [mssql.newCOMB(), "Alice"],
    [mssql.newCOMB(), "Bob"],
  ])
  .execute();

Methods ​

batchSize() ​

batchSize(size): this

Defined in: projects/ts-mssql/core/bulk.ts:77

Set batch size — rows are sent in chunks of this size.

Parameters ​

size ​

number

Returns ​

this

columns() ​

columns(cols): this

Defined in: projects/ts-mssql/core/bulk.ts:42

Define the columns for the bulk insert.

Parameters ​

cols ​

BulkColumn[]

Returns ​

this

execute() ​

execute(): Promise<number>

Defined in: projects/ts-mssql/core/bulk.ts:83

Execute the bulk insert. Returns total rows affected.

Returns ​

Promise<number>

fromAsyncIterable() ​

fromAsyncIterable<T>(source, transform): Promise<BulkInsertBuilder>

Defined in: projects/ts-mssql/core/bulk.ts:66

Add rows from an async iterable with a transform function.

Type Parameters ​

T ​

T

Parameters ​

source ​

AsyncIterable<T>

transform ​

(item) => ParamValue[]

Returns ​

Promise<BulkInsertBuilder>

fromObjects() ​

fromObjects(objects): this

Defined in: projects/ts-mssql/core/bulk.ts:54

Add rows from an array of objects (keys matching column names).

Parameters ​

objects ​

Record<string, ParamValue>[]

Returns ​

this

rows() ​

rows(rows): this

Defined in: projects/ts-mssql/core/bulk.ts:48

Add rows as positional arrays (matching column order).

Parameters ​

rows ​

ParamValue[][]

Returns ​

this