SQLite dialect that uses the better-sqlite3 library.

The constructor takes an instance of SqliteDialectConfig.

import Database from 'better-sqlite3'

new SqliteDialect({
database: new Database('db.sqlite')
})

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

import Database from 'better-sqlite3'

new SqliteDialect({
database: async () => new Database('db.sqlite')
})

Implements

Constructors

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