A Dialect is the glue between Kysely and the underlying database engine.

See the built-in PostgresDialect as an example of a dialect. Users can implement their own dialects and use them by passing it in the KyselyConfig.dialect property.

interface Dialect {
    createAdapter(): DialectAdapter;
    createDriver(): Driver;
    createIntrospector(db): DatabaseIntrospector;
    createQueryCompiler(): QueryCompiler;
}

Implemented by

Methods

  • Creates an adapter for the dialect.

    Returns DialectAdapter

  • Creates a driver for the dialect.

    Returns Driver

  • Creates a database introspector that can be used to get database metadata such as the table names and column names of those tables.

    db never has any plugins installed. It's created using Kysely.withoutPlugins.

    Parameters

    Returns DatabaseIntrospector

  • Creates a query compiler for the dialect.

    Returns QueryCompiler