Last Updated: 3/10/2026

kysely

• Dialect

Interface Dialect

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: Kysely<any>): DatabaseIntrospector;
    createQueryCompiler(): QueryCompiler;
}

Implemented by

• MssqlDialect
• MysqlDialect
• PostgresDialect
• SqliteDialect

Index

Methods

createAdapter createDriver createIntrospector createQueryCompiler

Methods

createAdapter

• createAdapter(): DialectAdapter

  Creates an adapter for the dialect.

  Returns DialectAdapter

createDriver

• createDriver(): Driver

  Creates a driver for the dialect.

  Returns Driver

createIntrospector

• createIntrospector(db: Kysely<any>): DatabaseIntrospector

  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

  • db: Kysely<any>

  Returns DatabaseIntrospector

createQueryCompiler

• createQueryCompiler(): QueryCompiler

  Creates a query compiler for the dialect.

  Returns QueryCompiler

Settings

Member Visibility

On This Page

Methods

createAdaptercreateDrivercreateIntrospectorcreateQueryCompiler