feat: add useIdbMemoryStorage

Author: subframe7536

README.md

@@ -23,7 +23,7 @@ const { run, changes, lastInsertRowId, close } = await initSQLite(
 
 #### IndexedDB
 
-use IDBBatchAtomicVFS with `wa-sqlite-async.wasm`, larger than sync version, better compatibility
+use `IDBBatchAtomicVFS` with `wa-sqlite-async.wasm`, larger than sync version, better compatibility
 
 [minimal IndexedDB backend browser version](https://caniuse.com/mdn-api_lockmanager)
 
@@ -41,7 +41,7 @@ const { run, changes, lastInsertRowId, close } = await initSQLite(
 
 #### OPFS
 
-use OPFSCoopSyncVFS with `wa-sqlite.wasm`, smaller than async version
+use `OPFSCoopSyncVFS` with `wa-sqlite.wasm`, smaller than async version
 
 [minimal OPFS backend browser version](https://caniuse.com/mdn-api_filesystemsyncaccesshandle)
 

playground/src/index.ts

@@ -8,7 +8,7 @@ import {
  isOpfsSupported,
  useMemoryStorage,
 } from '../../src'
-import { useIdbStorage } from '../../src/vfs/idb'
+import { useIdbMemoryStorage, useIdbStorage } from '../../src/vfs/idb'
 import { runSQL } from './runSQL'
 import OpfsWorker from './worker?worker'
 

src/types/index.ts

@@ -29,36 +29,39 @@ export type Options = {
 
 export type SQLiteDB = {
  /**
- * file name (IDBBatchAtomicVFS) or directory path (AccessHandlePoolVFS)
+ * File name (`IDBBatchAtomicVFS`) or directory path (`OPFSCoopSyncVFS`)
  */
  path: string
  /**
- * db pointer
+ * DB pointer
  */
  db: number
  /**
- * sqlite apis
+ * SQLite apis
  */
  sqlite: SQLiteAPI
+ /**
+ * Wasm build module
+ */
  sqliteModule: any
  /**
- * sqlite vfs
+ * SQLite vfs
  */
  vfs: SQLiteVFS
  /**
- * close db
+ * Close db
  */
  close: () => Promise<void>
  /**
- * get db changes
+ * Get db changes
  */
  changes: () => number
  /**
- * get lastInsertRowId
+ * Get lastInsertRowId
  */
  lastInsertRowId: () => number
  /**
- * run sql and return result list
+ * Run sql and return result list
  * @param onData trigger onn stream has data received
  * @param sql raw sql with placeholder
  * @param parameters params that replace the placeholder
@@ -67,7 +70,7 @@ export type SQLiteDB = {
  */
  stream: (onData: (data: Record<string, SQLiteCompatibleType>) => void, sql: string, parameters?: SQLiteCompatibleType[]) => Promise<void>
  /**
- * run sql and return result list
+ * Run sql and return result list
  * @param sql raw sql with placeholder
  * @param parameters params that replace the placeholder
  * @example

src/types/wa-sqlite.d.ts

@@ -4,6 +4,12 @@ declare module 'wa-sqlite/src/examples/IDBBatchAtomicVFS.js' {
  }
 }
 
+declare module 'wa-sqlite/src/examples/IDBMirrorVFS.js' {
+ export class IDBMirrorVFS {
+ static create(name: string, module: any): Promise<SQLiteVFS>
+ }
+}
+
 declare module 'wa-sqlite/src/examples/OPFSCoopSyncVFS.js' {
  export class OPFSCoopSyncVFS {
  static create(name: string, module: any): Promise<SQLiteVFS>

src/vfs/idb.ts

@@ -1,19 +1,16 @@
 import type { BaseOptions, IDBBatchAtomicVFSOptions, Options } from '../types'
 import SQLiteAsyncESMFactory from 'wa-sqlite/dist/wa-sqlite-async.mjs'
 import { IDBBatchAtomicVFS } from 'wa-sqlite/src/examples/IDBBatchAtomicVFS.js'
+import { IDBMirrorVFS } from 'wa-sqlite/src/examples/IDBMirrorVFS.js'
 
 export { IDBBatchAtomicVFS } from 'wa-sqlite/src/examples/IDBBatchAtomicVFS.js'
+export { IDBMirrorVFS } from 'wa-sqlite/src/examples/IDBMirrorVFS.js'
 
-export type IDBVFSOptions = IDBBatchAtomicVFSOptions & {
- /**
- * @default 'idb-sqlite-vfs'
- */
- idbName?: string
-}
+export type IDBVFSOptions = IDBBatchAtomicVFSOptions
 
 /**
- * storage data in IndexedDB,
- * use IDBBatchAtomicVFS with `wa-sqlite-async.wasm` (larger than sync version), better compatibility
+ * Store data in IndexedDB,
+ * Use `IDBBatchAtomicVFS` with `wa-sqlite-async.wasm` (larger than sync version), better compatibility
  * @param fileName db file name
  * @param options options
  * @example
@@ -35,21 +32,59 @@ export async function useIdbStorage(
 ): Promise<Options> {
  const {
  url,
- idbName = 'idb-sqlite-vfs',
  lockPolicy = 'shared+hint',
  lockTimeout = Infinity,
  readonly,
  } = options
  const sqliteModule = await SQLiteAsyncESMFactory(
  url ? { locateFile: () => url } : undefined,
  )
+ const idbName = fileName.endsWith('.db') ? fileName : `${fileName}.db`
  const vfsOptions = { idbName, lockPolicy, lockTimeout }
  /// keep-sorted
+ return {
+ path: idbName,
+ readonly,
+ sqliteModule,
+ vfsFn: IDBMirrorVFS.create,
+ vfsOptions,
+ }
+}
+
+/**
+ * Store data in memory and sync to IndexedDB,
+ * Use `IDBMirrorVFS` with `wa-sqlite-async.wasm` (larger than sync version), better performance compare to `IDBBatchAtomicVFS`
+ * @param fileName db file name
+ * @param options options
+ * @example
+ * ```ts
+ * import { useIdbMemoryStorage } from '@subframe7536/sqlite-wasm/idb'
+ * import { getAsyncWasmURL, initSQLite } from '@subframe7536/sqlite-wasm'
+ *
+ * // const url = 'https://cdn.jsdelivr.net/gh/rhashimoto/wa-sqlite@v0.9.9/dist/wa-sqlite-async.wasm'
+ * const url = getAsyncWasmURL()
+ *
+ * const { run, changes, lastInsertRowId, close, sqlite, db } = await initSQLite(
+ * useIdbMemoryStorage('test', { url })
+ * )
+ * ```
+ */
+export async function useIdbMemoryStorage(
+ fileName: string,
+ options: BaseOptions = {},
+): Promise<Options> {
+ const {
+ url,
+ readonly,
+ } = options
+ const sqliteModule = await SQLiteAsyncESMFactory(
+ url ? { locateFile: () => url } : undefined,
+ )
+ /// keep-sorted
  return {
  path: fileName.endsWith('.db') ? fileName : `${fileName}.db`,
  readonly,
  sqliteModule,
  vfsFn: IDBBatchAtomicVFS.create,
- vfsOptions,
  }
 }