Class MysqlDriver

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

Implements

Driver

Index

Constructors

constructor

Methods

acquireConnection beginTransaction commitTransaction destroy init releaseConnection releaseSavepoint rollbackToSavepoint rollbackTransaction savepoint

Constructors

constructor

new MysqlDriver(configOrPool: MysqlDialectConfig): MysqlDriver
Parameters
- configOrPool: MysqlDialectConfig
Returns MysqlDriver
- Defined in kysely/src/dialect/mysql/mysql-driver.ts:27

Methods

acquireConnection

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

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

beginTransaction

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

commitTransaction

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

destroy

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

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

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/mysql/mysql-driver.ts:31

releaseConnection

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

releaseSavepoint

releaseSavepoint(
    connection: DatabaseConnection,
    savepointName: string,
    compileQuery: (node: RootOperationNode, queryId: QueryId) => CompiledQuery,
): Promise<void>
Releases a savepoint within a transaction.
Parameters
- connection: DatabaseConnection
- savepointName: string
- compileQuery: (node: RootOperationNode, queryId: QueryId) => CompiledQuery
Returns Promise<void>
Implementation of Driver.releaseSavepoint
- Defined in kysely/src/dialect/mysql/mysql-driver.ts:130

rollbackToSavepoint

rollbackToSavepoint(
    connection: DatabaseConnection,
    savepointName: string,
    compileQuery: (node: RootOperationNode, queryId: QueryId) => CompiledQuery,
): Promise<void>
Rolls back to a savepoint within a transaction.
Parameters
- connection: DatabaseConnection
- savepointName: string
- compileQuery: (node: RootOperationNode, queryId: QueryId) => CompiledQuery
Returns Promise<void>
Implementation of Driver.rollbackToSavepoint
- Defined in kysely/src/dialect/mysql/mysql-driver.ts:117

rollbackTransaction

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

savepoint

savepoint(
    connection: DatabaseConnection,
    savepointName: string,
    compileQuery: (node: RootOperationNode, queryId: QueryId) => CompiledQuery,
): Promise<void>
Establishses a new savepoint within a transaction.
Parameters
- connection: DatabaseConnection
- savepointName: string
- compileQuery: (node: RootOperationNode, queryId: QueryId) => CompiledQuery
Returns Promise<void>
Implementation of Driver.savepoint
- Defined in kysely/src/dialect/mysql/mysql-driver.ts:104

Class MysqlDriver

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MysqlDriver

Methods

acquireConnection

Returns Promise<DatabaseConnection>

beginTransaction

Parameters

Returns Promise<void>

commitTransaction

Parameters

Returns Promise<void>

destroy

Returns Promise<void>

init

Returns Promise<void>

releaseConnection

Parameters

Returns Promise<void>

releaseSavepoint

Parameters

Returns Promise<void>

rollbackToSavepoint

Parameters

Returns Promise<void>

rollbackTransaction

Parameters

Returns Promise<void>

savepoint

Parameters

Returns Promise<void>

Settings

On This Page