mssql-ts-ffi / MssqlConnection
Class: MssqlConnection
Defined in: connection.ts:35
A single connection to SQL Server.
Use await using for automatic cleanup:
await using cn = await mssql.connect(connectionString);
const rows = await cn.query<User>("SELECT * FROM Users");Implements
AsyncDisposable
Methods
[asyncDispose]()
[asyncDispose]():
Promise<void>
Defined in: connection.ts:245
Returns
Promise<void>
Implementation of
AsyncDisposable.[asyncDispose]
beginTransaction()
beginTransaction(
isolation?):Promise<Transaction>
Defined in: connection.ts:197
Begin a transaction with the given isolation level.
Parameters
isolation?
IsolationLevel = "READ_COMMITTED"
Returns
Promise<Transaction>
bulk()
bulk(
table):BulkInsertBuilder
Defined in: connection.ts:191
Create a bulk insert builder for the given table.
Parameters
table
string
Returns
disconnect()
disconnect():
Promise<void>
Defined in: connection.ts:237
Disconnect this connection permanently. For pooled connections, the connection is destroyed (NOT returned to pool). Cascades: disposes transactions, closes streams, then disconnects.
Returns
Promise<void>
exec()
exec(
sql,params?,opts?):Promise<ExecResult>
Defined in: connection.ts:123
Execute a stored procedure and return a rich result with OUTPUT parameters and multiple result sets.
Parameters
sql
string
params?
opts?
Returns
Promise<ExecResult>
execute()
execute(
sql,params?,opts?):Promise<number>
Defined in: connection.ts:105
Execute a non-query and return the number of rows affected.
Parameters
sql
string
params?
opts?
Returns
Promise<number>
openFilestream()
openFilestream(
path,txContext,mode):FilestreamHandle
Defined in: connection.ts:224
Open a FILESTREAM handle (Windows only).
Parameters
path
string
txContext
string | Uint8Array<ArrayBufferLike>
mode
Returns
query()
query<
T>(sql,params?,opts?):Promise<T[]>
Defined in: connection.ts:51
Execute a query and return all rows.
Type Parameters
T
T = Record<string, unknown>
Parameters
sql
string
params?
opts?
Returns
Promise<T[]>
queryFirst()
queryFirst<
T>(sql,params?,opts?):Promise<T|undefined>
Defined in: connection.ts:66
Execute a query and return the first row, or undefined.
Type Parameters
T
T = Record<string, unknown>
Parameters
sql
string
params?
opts?
Returns
Promise<T | undefined>
querySingle()
querySingle<
T>(sql,params?,opts?):Promise<T>
Defined in: connection.ts:76
Execute a query and return exactly one row. Throws if not exactly 1.
Type Parameters
T
T = Record<string, unknown>
Parameters
sql
string
params?
opts?
Returns
Promise<T>
queryStream()
queryStream<
T>(sql,params?,opts?):Promise<QueryStream<T>>
Defined in: connection.ts:161
Open a streaming query for large result sets.
Type Parameters
T
T = Record<string, unknown>
Parameters
sql
string
params?
opts?
StreamOptions
Returns
Promise<QueryStream<T>>
scalar()
scalar<
T>(sql,params?,opts?):Promise<T|undefined>
Defined in: connection.ts:89
Execute a query and return the first column of the first row.
Type Parameters
T
T = unknown
Parameters
sql
string
params?
opts?
Returns
Promise<T | undefined>
sql()
sql<
T>(strings, ...values):Promise<T[]>
Defined in: connection.ts:138
Tagged template for parameterized queries.
Type Parameters
T
T = Record<string, unknown>
Parameters
strings
TemplateStringsArray
values
...ParamValue[]
Returns
Promise<T[]>
sqlWith()
sqlWith(
opts): <T>(strings, ...values) =>Promise<T[]>
Defined in: connection.ts:147
Tagged template with options.
Parameters
opts
Returns
<
T>(strings, ...values):Promise<T[]>
Type Parameters
T
T = Record<string, unknown>
Parameters
strings
TemplateStringsArray
values
...ParamValue[]
Returns
Promise<T[]>