MySQL dialect that uses the mysql2 library.

The constructor takes an instance of MysqlDialectConfig.

import { createPool } from 'mysql2'

new MysqlDialect({
pool: createPool({
database: 'some_db',
host: 'localhost',
})
})

If you want the pool to only be created once it's first used, pool can be a function:

import { createPool } from 'mysql2'

new MysqlDialect({
pool: async () => createPool({
database: 'some_db',
host: 'localhost',
})
})

Implements

Constructors

  • Parameters

    Returns MysqlDialect

Properties

#private: any

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