MysqlDialect

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',
  })
})

class MysqlDialect implements Dialect {

constructor(config: MysqlDialectConfig);

createAdapter(): DialectAdapter;

createDriver(): Driver;

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

createQueryCompiler(): QueryCompiler;

}

§Implements

new MysqlDialect(config: MysqlDialectConfig)

createAdapter(): DialectAdapter

Creates an adapter for the dialect.

createDriver(): Driver

Creates a driver for the dialect.

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.

createQueryCompiler(): QueryCompiler

Creates a query compiler for the dialect.