Interface Driver

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

Hierarchy

Driver

Implemented by

Index

Methods

acquireConnection beginTransaction commitTransaction destroy init releaseConnection rollbackTransaction

Methods

acquireConnection

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

Returns Promise<DatabaseConnection>
- Defined in kysely/src/driver/driver.ts:20

beginTransaction

beginTransaction(connection, settings): Promise<void>
Begins a transaction.
Parameters
- connection: DatabaseConnection
- settings: TransactionSettings
Returns Promise<void>
- Defined in kysely/src/driver/driver.ts:25

commitTransaction

commitTransaction(connection): Promise<void>
Commits a transaction.
Parameters
- connection: DatabaseConnection
Returns Promise<void>
- Defined in kysely/src/driver/driver.ts:33

destroy

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

Returns Promise<void>
- Defined in kysely/src/driver/driver.ts:48

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>
- Defined in kysely/src/driver/driver.ts:15

releaseConnection

releaseConnection(connection): Promise<void>
Releases a connection back to the pool.
Parameters
- connection: DatabaseConnection
Returns Promise<void>
- Defined in kysely/src/driver/driver.ts:43

rollbackTransaction

rollbackTransaction(connection): Promise<void>
Rolls back a transaction.
Parameters
- connection: DatabaseConnection
Returns Promise<void>
- Defined in kysely/src/driver/driver.ts:38

Generated using TypeDoc