Skip to Content

Last Updated: 3/9/2026


kysely

  • DummyDriver

Class DummyDriver

A driver that does absolutely nothing.

You can use this to create Kysely instances solely for building queries

Examples

This example creates a Kysely instance for building postgres queries:

import { DummyDriver, Kysely, PostgresAdapter, PostgresIntrospector, PostgresQueryCompiler} from 'kysely' import type { Database } from 'type-editor' // imaginary module const db = new Kysely< Database>({ dialect: { createAdapter: () => new PostgresAdapter(), createDriver: () => new DummyDriver(), createIntrospector: (db: Kysely< any>) => new PostgresIntrospector(db), createQueryCompiler: () => new PostgresQueryCompiler(), },})

You can use it to build a query and compile it to SQL but trying to execute the query will throw an error.

const { sql } = db. selectFrom('person'). selectAll(). compile() console. log(sql) // select * from "person"

Implements

Index

Constructors

constructor

Methods

acquireConnection beginTransaction commitTransaction destroy init releaseConnection releaseSavepoint rollbackToSavepoint rollbackTransaction savepoint

Constructors

constructor

  • new DummyDriver(): DummyDriver

    Returns DummyDriver

Methods

acquireConnection

beginTransaction

  • beginTransaction(): Promise<void>

    Begins a transaction.

    Returns Promise<void>

commitTransaction

  • commitTransaction(): Promise<void>

    Commits a transaction.

    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(): Promise<void>

    Releases a connection back to the pool.

    Returns Promise<void>

releaseSavepoint

  • releaseSavepoint(): Promise<void>

    Releases a savepoint within a transaction.

    Returns Promise<void>

rollbackToSavepoint

  • rollbackToSavepoint(): Promise<void>

    Rolls back to a savepoint within a transaction.

    Returns Promise<void>

rollbackTransaction

  • rollbackTransaction(): Promise<void>

    Rolls back a transaction.

    Returns Promise<void>

savepoint

  • savepoint(): Promise<void>

    Establishses a new savepoint within a transaction.

    Returns Promise<void>

Settings

Member Visibility

On This Page

ExamplesConstructors

constructor

Methods

acquireConnectionbeginTransactioncommitTransactiondestroyinitreleaseConnectionreleaseSavepointrollbackToSavepointrollbackTransactionsavepoint