Interface Driver

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

interface Driver {
    acquireConnection(): Promise<DatabaseConnection>;
    beginTransaction(connection, settings): Promise<void>;
    commitTransaction(connection): Promise<void>;
    destroy(): Promise<void>;
    init(): Promise<void>;
    releaseConnection(connection): Promise<void>;
    rollbackTransaction(connection): Promise<void>;
}

Implemented by

Methods

acquireConnection beginTransaction commitTransaction destroy init releaseConnection rollbackTransaction

Methods

acquireConnection

  • acquireConnection(): Promise<DatabaseConnection>

  • Acquires a new connection from the pool.

    Returns Promise<DatabaseConnection>

beginTransaction

  • beginTransaction(connection, settings): Promise<void>

  • Begins a transaction.

    Parameters

    Returns Promise<void>

commitTransaction

  • commitTransaction(connection): Promise<void>

  • Commits a transaction.

    Parameters

    Returns Promise<void>

destroy

  • destroy(): Promise<void>

  • Destroys the driver and releases all resources.

    Returns Promise<void>

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>

releaseConnection

  • releaseConnection(connection): Promise<void>

  • Releases a connection back to the pool.

    Parameters

    Returns Promise<void>

rollbackTransaction

  • rollbackTransaction(connection): Promise<void>

  • Rolls back a transaction.

    Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

acquireConnectionbeginTransactioncommitTransactiondestroyinitreleaseConnectionrollbackTransaction