mssql-ts-ffi

Appearance

mssql-ts-ffi / MssqlPool

Class: MssqlPool ​

Defined in: pool.ts:25

A connection pool for SQL Server. Acquire connections or use convenience methods that auto-acquire and release.

Example ​

ts
const pool = await mssql.createPool(connectionString);
const users = await pool.query<User>("SELECT * FROM Users");
await pool.close();

Implements ​

  • AsyncDisposable

Methods ​

[asyncDispose]() ​

[asyncDispose](): Promise<void>

Defined in: pool.ts:157

Returns ​

Promise<void>

Implementation of ​

AsyncDisposable.[asyncDispose]

bulk() ​

bulk(table): PoolBulkInsertBuilder

Defined in: pool.ts:144

Create a bulk insert builder. Connection is acquired on execute() and released automatically afterward.

Parameters ​

table ​

string

Returns ​

PoolBulkInsertBuilder

close() ​

close(): void

Defined in: pool.ts:150

Close the pool and all connections.

Returns ​

void

connect() ​

connect(): Promise<MssqlConnection>

Defined in: pool.ts:37

Acquire a connection from the pool.

Returns ​

Promise<MssqlConnection>

exec() ​

exec(sql, params?, opts?): Promise<ExecResult>

Defined in: pool.ts:104

Execute a stored procedure using an auto-acquired connection.

Parameters ​

sql ​

string

params? ​

Params

opts? ​

CommandOptions

Returns ​

Promise<ExecResult>

execute() ​

execute(sql, params?, opts?): Promise<number>

Defined in: pool.ts:94

Execute a non-query and return the number of rows affected.

Parameters ​

sql ​

string

params? ​

Params

opts? ​

CommandOptions

Returns ​

Promise<number>

query() ​

query<T>(sql, params?, opts?): Promise<T[]>

Defined in: pool.ts:50

Execute a query using an auto-acquired connection.

Type Parameters ​

T ​

T = Record<string, unknown>

Parameters ​

sql ​

string

params? ​

Params

opts? ​

CommandOptions

Returns ​

Promise<T[]>

queryFirst() ​

queryFirst<T>(sql, params?, opts?): Promise<T | undefined>

Defined in: pool.ts:64

Execute a query and return the first row, or undefined.

Type Parameters ​

T ​

T = Record<string, unknown>

Parameters ​

sql ​

string

params? ​

Params

opts? ​

CommandOptions

Returns ​

Promise<T | undefined>

querySingle() ​

querySingle<T>(sql, params?, opts?): Promise<T>

Defined in: pool.ts:74

Execute a query and return exactly one row.

Type Parameters ​

T ​

T = Record<string, unknown>

Parameters ​

sql ​

string

params? ​

Params

opts? ​

CommandOptions

Returns ​

Promise<T>

queryStream() ​

queryStream<T>(sql, params?, opts?): Promise<PooledQueryStream<T>>

Defined in: pool.ts:125

Open a streaming query. The connection is held until the stream closes.

Type Parameters ​

T ​

T = Record<string, unknown>

Parameters ​

sql ​

string

params? ​

Params

opts? ​

StreamOptions

Returns ​

Promise<PooledQueryStream<T>>

scalar() ​

scalar<T>(sql, params?, opts?): Promise<T | undefined>

Defined in: pool.ts:84

Execute a query and return the first column of the first row.

Type Parameters ​

T ​

T = unknown

Parameters ​

sql ​

string

params? ​

Params

opts? ​

CommandOptions

Returns ​

Promise<T | undefined>

sql() ​

sql<T>(strings, ...values): Promise<T[]>

Defined in: pool.ts:114

Tagged template for parameterized queries.

Type Parameters ​

T ​

T = Record<string, unknown>

Parameters ​

strings ​

TemplateStringsArray

values ​

...ParamValue[]

Returns ​

Promise<T[]>