kysely-bun-worker

kysely dialect for bun:sqlite, run sql in worker

From v0.7.0, this dialect requires Bun@^1.1.14

Install

1bun install kysely kysely-bun-worker

Usage

1import { BunWorkerDialect } from 'kysely-bun-worker'
2
3const dialect = new BunWorkerDialect({
4  // default
5  url: ':memory:',
6})

Custom Worker

in worker.ts

1import { createOnMessageCallback, defaultCreateDatabaseFn } from 'kysely-bun-worker'
2
3createOnMessageCallback(
4  async (...args) => {
5    const db = defaultCreateDatabaseFn(...args)
6    db.loadExtension(/* ... */)
7    return db
8  }
9)

Normal Dialect

In v1.1.0, you can use BunSqliteDialect to run SQLs in main thread

1import { BunSqliteDialect } from 'kysely-bun-worker/normal'
2
3const dialect = new BunSqliteDialect({
4  // default
5  url: ':memory:',
6})

Config

1export type BunWorkerDialectConfig = {
2  /**
3   * db file path
4   *
5   * @default ':memory:'
6   */
7  url?: string
8  onCreateConnection?: (connection: DatabaseConnection) => Promisable<void>
9  /**
10   * use bun:sqlite's built-in statment cache
11   * @see https://bun.sh/docs/api/sqlite#query
12   */
13  cacheStatment?: boolean
14  /**
15   * custom worker, default is a worker that use bun:sqlite
16   */
17  worker?: Worker
18  /**
19   * DB constructor options
20   * @default { create: true }
21   */
22  dbOptions?: ConstructorParameters<typeof Database>[1]
23}