Class PostgresDriver

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

Hierarchy

PostgresDriver

Implements

Driver

Index

Constructors

Methods

acquireConnection beginTransaction commitTransaction destroy init releaseConnection rollbackTransaction

Constructors

constructor

new PostgresDriver(config): PostgresDriver
Parameters
- config: PostgresDialectConfig
Returns PostgresDriver
- Defined in kysely/src/dialect/postgres/postgres-driver.ts:23

Methods

acquireConnection

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

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

beginTransaction

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

commitTransaction

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

destroy

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

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

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/postgres/postgres-driver.ts:27

releaseConnection

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

rollbackTransaction

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

Generated using TypeDoc