Type Definitions
MSConnectionOptions
MSSQL specific extension of the SQLERConnectionOptions from the sqler module.
Properties:
| Name | Type | Description | |||||
|---|---|---|---|---|---|---|---|
driverOptions |
Object
|
The |
|||||
| Name | Type | Attributes | Description |
|---|---|---|---|
connection |
Object
|
<optional> |
An object that will contain properties/values that will be used to construct the MSSQL connections
(e.g. |
Type:
-
SQLERConnectionOptions
MSExecOptions
MSSQL specific extension of the SQLERExecOptions from the sqler module. When a property of binds
contains an object it will be interpolated for property values on the mssql module.
For example, binds.name = '${SOME_MSSQL_CONSTANT}' will be interpolated as binds.name = mssql.SOME_MSSQL_CONSTANT.
Properties:
| Name | Type | Attributes | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
driverOptions |
Object
|
<optional> |
The |
||||||||
| Name | Type | Attributes | Description |
|---|---|---|---|
inputBindTypes |
Object
|
<optional> |
An object that contains properties that match the bind parameter names. Each property should contain a value
that corresponds to a |
outputBindTypes |
Object
|
<optional> |
An object that contains properties that match the bind parameter names. Each property should contain a value
that corresponds to a |
Type:
-
SQLERExecOptions
MSPlan
Transactions are wrapped in a parent transaction object so private properties can be added
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
txo |
MSTransactionObject
|
<optional> |
The transaction object |
stmt |
MSPreparedStatement
|
<optional> |
The prepared statement object (undefined when none) |
req |
Object
|
<optional> |
The MSSQL request (undefined when using only prepared statement(s)) |
run |
MSPlanRunner
|
<optional> |
The SQL executor for the plan |
Type:
-
Object
(async) MSPlanRunner(sql)
Will either prepare/execute the passed SQL or query the passed SQL
Parameters:
| Name | Type | Description |
|---|---|---|
sql |
String
|
The SQL statement that contains the bind parameters |
MSPreparedStatement
Prepared statements are wrapped in a parent prepared statement object so private properties can be added
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
ps |
Object
|
The MSSQL prepared statement |
|
txId |
String
|
<optional> |
The transaction that the prepared statement is participating in (if any) |
Type:
-
Object
MSTransactionObject
Transactions are wrapped in a parent transaction object so private properties can be added
Properties:
| Name | Type | Description |
|---|---|---|
tx |
SQLERTransaction
|
The transaction |
msTx |
Obejct
|
The MSSQL transaction |
Type:
-
Object
MSTransactionOptions
Properties:
| Name | Type | Attributes | Description | ||||
|---|---|---|---|---|---|---|---|
driverOptions |
Object
|
<optional> |
The |
||||
| Name | Type | Attributes | Description |
|---|---|---|---|
isolationLevel |
String
|
<optional> |
Controls the locking and row versioning behavior of MSSQL statements issued by a connection.
When a property value is a string surrounded by |
Type:
-
SQLERTransactionOptions