@tsdrivers/mssql

Appearance

@tsdrivers/mssql / QueryStream

Class: QueryStream<T> ​

Defined in: projects/ts-mssql/core/stream.ts:22

An async iterable stream of rows from a query. Rows are fetched one at a time from the Rust cursor.

Example ​

ts
for await (const row of stream) {
  console.log(row.Name);
}

// Or collect
const all = await stream.toArray();

Type Parameters ​

T ​

T = Record<string, unknown>

Implements ​

  • AsyncIterable<T>
  • Disposable
  • AsyncDisposable

Methods ​

[asyncDispose]() ​

[asyncDispose](): Promise<void>

Defined in: projects/ts-mssql/core/stream.ts:141

Returns ​

Promise<void>

Implementation of ​

AsyncDisposable.[asyncDispose]

[asyncIterator]() ​

[asyncIterator](): AsyncIterableIterator<T>

Defined in: projects/ts-mssql/core/stream.ts:45

Returns ​

AsyncIterableIterator<T>

Implementation of ​

AsyncIterable.[asyncIterator]

[dispose]() ​

[dispose](): void

Defined in: projects/ts-mssql/core/stream.ts:137

Returns ​

void

Implementation of ​

Disposable.[dispose]

close() ​

close(): void

Defined in: projects/ts-mssql/core/stream.ts:123

Returns ​

void

filter() ​

filter(fn): Promise<T[]>

Defined in: projects/ts-mssql/core/stream.ts:75

Filter rows and collect.

Parameters ​

fn ​

(row) => boolean

Returns ​

Promise<T[]>

map() ​

map<U>(fn): Promise<U[]>

Defined in: projects/ts-mssql/core/stream.ts:68

Transform each row and collect.

Type Parameters ​

U ​

U

Parameters ​

fn ​

(row) => U

Returns ​

Promise<U[]>

pipeTo() ​

pipeTo(writable): Promise<void>

Defined in: projects/ts-mssql/core/stream.ts:91

Pipe to a WritableStream.

Parameters ​

writable ​

WritableStream<T>

Returns ​

Promise<void>

reduce() ​

reduce<U>(fn, initial): Promise<U>

Defined in: projects/ts-mssql/core/stream.ts:84

Reduce over rows without collecting all in memory.

Type Parameters ​

U ​

U

Parameters ​

fn ​

(acc, row) => U

initial ​

U

Returns ​

Promise<U>

toArray() ​

toArray(): Promise<T[]>

Defined in: projects/ts-mssql/core/stream.ts:61

Collect all remaining rows into an array.

Returns ​

Promise<T[]>

toReadableStream() ​

toReadableStream(): ReadableStream<T>

Defined in: projects/ts-mssql/core/stream.ts:103

Return a standard ReadableStream.

Returns ​

ReadableStream<T>