kysely
    Preparing search index...

    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: DatabaseConnection,
            settings: TransactionSettings,
        ): Promise<void>;
        commitTransaction(connection: DatabaseConnection): Promise<void>;
        destroy(): Promise<void>;
        init(): Promise<void>;
        releaseConnection(connection: DatabaseConnection): Promise<void>;
        releaseSavepoint?(
            connection: DatabaseConnection,
            savepointName: string,
            compileQuery: (node: RootOperationNode, queryId: QueryId) => CompiledQuery,
        ): Promise<void>;
        rollbackToSavepoint?(
            connection: DatabaseConnection,
            savepointName: string,
            compileQuery: (node: RootOperationNode, queryId: QueryId) => CompiledQuery,
        ): Promise<void>;
        rollbackTransaction(connection: DatabaseConnection): Promise<void>;
        savepoint?(
            connection: DatabaseConnection,
            savepointName: string,
            compileQuery: (node: RootOperationNode, queryId: QueryId) => CompiledQuery,
        ): Promise<void>;
    }

    Implemented by

    Index

    Methods

    acquireConnection beginTransaction commitTransaction destroy init releaseConnection releaseSavepoint? rollbackToSavepoint? rollbackTransaction savepoint?

    Methods

    • Initializes the driver.

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

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Methods