Class MssqlDriver

A Driver creates and releases database connections and is also responsible for connection pooling (if the dialect supports pooling).

Implements

Driver

Index

Constructors

Methods

acquireConnection beginTransaction commitTransaction destroy init releaseConnection rollbackToSavepoint rollbackTransaction savepoint

Constructors

constructor

new MssqlDriver(config: MssqlDialectConfig): MssqlDriver
Parameters
- config: MssqlDialectConfig
Returns MssqlDriver
- Defined in kysely/src/dialect/mssql/mssql-driver.ts:41

Methods

acquireConnection

acquireConnection(): Promise<DatabaseConnection>
Acquires a new connection from the pool.

Returns Promise<DatabaseConnection>
Implementation of Driver.acquireConnection
- Defined in kysely/src/dialect/mssql/mssql-driver.ts:74

beginTransaction

beginTransaction(
connection: MssqlConnection,
settings: TransactionSettings,
): Promise<void>
Begins a transaction.
Parameters
- connection: MssqlConnection
- settings: TransactionSettings
Returns Promise<void>
Implementation of Driver.beginTransaction
- Defined in kysely/src/dialect/mssql/mssql-driver.ts:78

commitTransaction

commitTransaction(connection: MssqlConnection): Promise<void>
Commits a transaction.
Parameters
- connection: MssqlConnection
Returns Promise<void>
Implementation of Driver.commitTransaction
- Defined in kysely/src/dialect/mssql/mssql-driver.ts:85

destroy

destroy(): Promise<void>
Destroys the driver and releases all resources.

Returns Promise<void>
Implementation of Driver.destroy
- Defined in kysely/src/dialect/mssql/mssql-driver.ts:118

init

init(): Promise<void>
Initializes the driver.

After calling this method the driver should be usable and acquireConnection etc. methods should be callable.

Returns Promise<void>
Implementation of Driver.init
- Defined in kysely/src/dialect/mssql/mssql-driver.ts:70

releaseConnection

releaseConnection(connection: MssqlConnection): Promise<void>
Releases a connection back to the pool.
Parameters
- connection: MssqlConnection
Returns Promise<void>
Implementation of Driver.releaseConnection
- Defined in kysely/src/dialect/mssql/mssql-driver.ts:107

rollbackToSavepoint

rollbackToSavepoint(
connection: MssqlConnection,
savepointName: string,
): Promise<void>
Rolls back to a savepoint within a transaction.
Parameters
- connection: MssqlConnection
- savepointName: string
Returns Promise<void>
Implementation of Driver.rollbackToSavepoint
- Defined in kysely/src/dialect/mssql/mssql-driver.ts:100

rollbackTransaction

rollbackTransaction(connection: MssqlConnection): Promise<void>
Rolls back a transaction.
Parameters
- connection: MssqlConnection
Returns Promise<void>
Implementation of Driver.rollbackTransaction
- Defined in kysely/src/dialect/mssql/mssql-driver.ts:89

savepoint

savepoint(connection: MssqlConnection, savepointName: string): Promise<void>
Establishses a new savepoint within a transaction.
Parameters
- connection: MssqlConnection
- savepointName: string
Returns Promise<void>
Implementation of Driver.savepoint
- Defined in kysely/src/dialect/mssql/mssql-driver.ts:93