feat(dialect-bun-worker): add db options

Author: subframe7536

packages/dialect-bun-worker/README.md

@@ -16,6 +16,7 @@ bun install kysely kysely-bun-worker
 import { BunWorkerDialect } from 'kysely-bun-worker'
 
 const dialect = new BunWorkerDialect({
+  // default
   url: ':memory:',
 })
 ```
@@ -36,6 +37,19 @@ createOnMessageCallback(
 )
 ```
 
+### Normal Dialect
+
+In v1.1.0, you can use `BunSqliteDialect` to run SQLs in main thread
+
+```ts
+import { BunSqliteDialect } from 'kysely-bun-worker'
+
+const dialect = new BunSqliteDialect({
+  // default
+  url: ':memory:',
+})
+```
+
 ## Config
 
 ```ts
@@ -56,5 +70,10 @@ export type BunWorkerDialectConfig = {
    * custom worker, default is a worker that use bun:sqlite
    */
   worker?: Worker
+  /**
+   * DB constructor options
+   * @default { create: true }
+   */
+  dbOptions?: ConstructorParameters<typeof Database>[1]
 }
 ```

packages/dialect-bun-worker/src/index.ts

@@ -19,10 +19,11 @@ export class BunWorkerDialect extends GenericSqliteWorkerDialect<globalThis.Work
         new URL('./worker', import.meta.url),
         { type: 'module' },
       ),
+      dbOptions: opt = { create: true },
     } = config || {}
     super(
       () => ({
-        data: { cache, fileName },
+        data: { cache, fileName, opt },
         mitt: createNodeMitt(),
         handle: handleWebWorker,
         worker,

packages/dialect-bun-worker/src/normal.ts

@@ -11,9 +11,10 @@ export class BunSqliteDialect extends GenericSqliteDialect {
       url = ':memory:',
       cacheStatment = false,
       onCreateConnection,
+      dbOptions = { create: true },
     } = config || {}
     super(
-      () => createSqliteExecutor(new Database(url), cacheStatment),
+      () => createSqliteExecutor(new Database(url, dbOptions), cacheStatment),
       onCreateConnection,
     )
   }

packages/dialect-bun-worker/src/type.ts

@@ -1,16 +1,20 @@
+import type Database from 'bun:sqlite'
 import type { IBaseSqliteDialectConfig } from 'kysely-generic-sqlite'
 
+export type DBOptions = Exclude<ConstructorParameters<typeof Database>[1], undefined>
+
 export interface BunWorkerDialectConfig extends IBaseSqliteDialectConfig {
   /**
-   * db file path
+   * DB file path
    *
    * @default ':memory:'
    */
   url?: string
   /**
-   * use `bun:sqlite` built-in statment cache
-   * @see https://bun.sh/docs/api/sqlite#query
+   * DB constructor options
+   * @default { create: true }
    */
+  dbOptions?: DBOptions
   cacheStatment?: boolean
   /**
    * custom worker, default is a worker that use bun:sqlite
@@ -21,6 +25,7 @@ export interface BunWorkerDialectConfig extends IBaseSqliteDialectConfig {
 export type InitData = {
   fileName: string
   cache: boolean
+  opt: DBOptions
 }
 
 export interface BunSqliteDialectConfig extends IBaseSqliteDialectConfig {
@@ -35,4 +40,9 @@ export interface BunSqliteDialectConfig extends IBaseSqliteDialectConfig {
    * @see https://bun.sh/docs/api/sqlite#query
    */
   cacheStatment?: boolean
+  /**
+   * DB constructor options
+   * @default { create: true }
+   */
+  dbOptions?: DBOptions
 }

packages/dialect-bun-worker/src/worker/utils.ts

@@ -1,6 +1,6 @@
 import type { Statement } from 'bun:sqlite'
 import type { MessageHandleFn } from 'kysely-generic-sqlite/worker'
-import type { InitData } from '../type'
+import type { DBOptions, InitData } from '../type'
 import Database from 'bun:sqlite'
 import { type IGenericSqlite, parseBigInt, type Promisable } from 'kysely-generic-sqlite'
 import { createWebOnMessageCallback } from 'kysely-generic-sqlite/worker-helper-web'
@@ -17,10 +17,13 @@ async function* iterateData(
   }
 }
 
-export type CreateDatabaseFn = (fileName: string) => Promisable<Database>
+export type CreateDatabaseFn = (
+  fileName: string,
+  opt: DBOptions
+) => Promisable<Database>
 
 export const defaultCreateDatabaseFn: CreateDatabaseFn
-  = fileName => new Database(fileName, { create: true })
+  = (fileName, opt) => new Database(fileName, opt)
 
 /**
  * Handle worker message, support custom callback on initialization.
@@ -40,8 +43,8 @@ export function createOnMessageCallback(
   message?: MessageHandleFn<Database>,
 ): void {
   createWebOnMessageCallback<InitData, Database>(
-    async ({ cache, fileName }) => {
-      const db = await create(fileName)
+    async ({ cache, fileName, opt }) => {
+      const db = await create(fileName, opt)
       return createSqliteExecutor(db, cache)
     },
     message,