feat: fts5 support

Author: subframe7536

README.md

@@ -1,17 +1,17 @@
-## sqlite-wasm
+# sqlite-wasm
 
-typesafe [wa-sqlite](https://github.com/rhashimoto/wa-sqlite) wrapper, run in memory or persist data to IndexedDB or [OPFS](https://developer.mozilla.org/en-US/docs/Web/API/File_System_API/Origin_private_file_system)
+Typesafe [custom wa-sqlite](https://github.com/subframe7536/sqwab/releases/tag/v1729389754) wrapper, run in memory or persist data to IndexedDB or [OPFS](https://developer.mozilla.org/en-US/docs/Web/API/File_System_API/Origin_private_file_system), support FTS5 and update / delete limit
 
-low-level layer for [kysely-wasqlite-worker-dialect](https://github.com/subframe7536/kysely-sqlite-tools/tree/master/packages/dialect-wasqlite-worker)
+Low-level layer for [kysely-wasqlite-worker-dialect](https://github.com/subframe7536/kysely-sqlite-tools/tree/master/packages/dialect-wasqlite-worker)
 
-### Usage
+## Usage
 
-#### Memory
+### Memory
 
-use MemoryVFS with `wa-sqlite.wasm`, no data persistence
+Use `MemoryVFS` with `wa-sqlite.wasm`, no data persistence
 
 ```ts
-import { getSyncWasmURL, initSQLite, isOpfsSupported, useMemoryStorage } from '@subframe7536/sqlite-wasm'
+import { initSQLite, isOpfsSupported, useMemoryStorage } from '@subframe7536/sqlite-wasm'
 
 // optional url
 const url = 'https://cdn.jsdelivr.net/gh/rhashimoto/wa-sqlite@v0.9.9/dist/wa-sqlite.wasm'
@@ -21,14 +21,14 @@ const { run, changes, lastInsertRowId, close } = await initSQLite(
 )
 ```
 
-#### IndexedDB
+### IndexedDB
 
 use `IDBBatchAtomicVFS` with `wa-sqlite-async.wasm`, larger than sync version, better compatibility
 
 [minimal IndexedDB backend browser version](https://caniuse.com/mdn-api_lockmanager)
 
 ```ts
-import { getAsyncWasmURL, initSQLite } from '@subframe7536/sqlite-wasm'
+import { initSQLite } from '@subframe7536/sqlite-wasm'
 import { useIdbStorage } from '@subframe7536/sqlite-wasm/idb'
 
 // optional url
@@ -39,7 +39,23 @@ const { run, changes, lastInsertRowId, close } = await initSQLite(
 )
 ```
 
-#### OPFS
+#### IdbMemory
+
+Use `IDBMirrorVFS` with `wa-sqlite-async.wasm` (larger than sync version), better performance compare to `useIdbStorage`, store data in memory and sync to IndexedDB.
+
+```ts
+import { initSQLite } from '@subframe7536/sqlite-wasm'
+import { useIdbMemoryStorage } from '@subframe7536/sqlite-wasm/idb'
+
+// optional url
+const url = 'https://cdn.jsdelivr.net/gh/rhashimoto/wa-sqlite@v0.9.9/dist/wa-sqlite-async.wasm'
+
+const { run, changes, lastInsertRowId, close } = await initSQLite(
+ useIdbMemoryStorage('IndexedDB', { url })
+)
+```
+
+### OPFS
 
 use `OPFSCoopSyncVFS` with `wa-sqlite.wasm`, smaller than async version
 
@@ -48,7 +64,7 @@ use `OPFSCoopSyncVFS` with `wa-sqlite.wasm`, smaller than async version
 **MUST RUN IN WEB WORKER**
 
 ```ts
-import { getSyncWasmURL, initSQLite, isOpfsSupported } from '@subframe7536/sqlite-wasm'
+import { initSQLite, isOpfsSupported } from '@subframe7536/sqlite-wasm'
 import { useOpfsStorage } from '@subframe7536/sqlite-wasm/opfs'
 
 // optional url
@@ -63,3 +79,23 @@ onmessage = async () => {
  )
 }
 ```
+
+### Custom Function
+
+```ts
+import { def, initSQLite, useMemoryStorage } from '@subframe7536/sqlite-wasm'
+
+// optional url
+const url = 'https://cdn.jsdelivr.net/gh/rhashimoto/wa-sqlite@v0.9.9/dist/wa-sqlite.wasm'
+
+const { sqlite, db, run } = await initSQLite(useMemoryStorage({ url }))
+
+def(sqlite, db, 'testFn', (a: number, b: number) => a + b)
+
+await run('select testFn(1,2) as a')
+// [{ a: 3 }]
+```
+
+## License
+
+MIT

src/vfs/idb.ts

@@ -1,7 +1,7 @@
 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'
+import SQLiteAsyncESMFactory from '../../wa-sqlite-fts5/wa-sqlite-async.mjs'
 
 export { IDBBatchAtomicVFS } from 'wa-sqlite/src/examples/IDBBatchAtomicVFS.js'
 export { IDBMirrorVFS } from 'wa-sqlite/src/examples/IDBMirrorVFS.js'
@@ -16,10 +16,9 @@ export type IDBVFSOptions = IDBBatchAtomicVFSOptions
  * @example
  * ```ts
  * import { useIdbStorage } from '@subframe7536/sqlite-wasm/idb'
- * import { getAsyncWasmURL, initSQLite } from '@subframe7536/sqlite-wasm'
+ * import { 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 url = 'https://cdn.jsdelivr.net/gh/rhashimoto/wa-sqlite@v0.9.9/dist/wa-sqlite-async.wasm'
  *
  * const { run, changes, lastInsertRowId, close, sqlite, db } = await initSQLite(
  * useIdbStorage('test', { url })
@@ -59,10 +58,9 @@ export async function useIdbStorage(
  * @example
  * ```ts
  * import { useIdbMemoryStorage } from '@subframe7536/sqlite-wasm/idb'
- * import { getAsyncWasmURL, initSQLite } from '@subframe7536/sqlite-wasm'
+ * import { 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 url = 'https://cdn.jsdelivr.net/gh/rhashimoto/wa-sqlite@v0.9.9/dist/wa-sqlite-async.wasm'
  *
  * const { run, changes, lastInsertRowId, close, sqlite, db } = await initSQLite(
  * useIdbMemoryStorage('test', { url })

src/vfs/memory.ts

@@ -1,6 +1,6 @@
 import type { BaseOptions, Options } from '../types'
-import SQLiteESMFactory from 'wa-sqlite/dist/wa-sqlite.mjs'
 import { MemoryVFS } from 'wa-sqlite/src/examples/MemoryVFS.js'
+import SQLiteESMFactory from '../../wa-sqlite-fts5/wa-sqlite.mjs'
 
 export { MemoryVFS } from 'wa-sqlite/src/examples/MemoryVFS.js'
 

src/vfs/opfs.ts

@@ -1,6 +1,6 @@
 import type { BaseOptions, Options } from '../types'
-import SQLiteESMFactory from 'wa-sqlite/dist/wa-sqlite.mjs'
 import { OPFSCoopSyncVFS } from 'wa-sqlite/src/examples/OPFSCoopSyncVFS.js'
+import SQLiteESMFactory from '../../wa-sqlite-fts5/wa-sqlite.mjs'
 
 export { OPFSCoopSyncVFS } from 'wa-sqlite/src/examples/OPFSCoopSyncVFS.js'
 
@@ -13,11 +13,10 @@ export { OPFSCoopSyncVFS } from 'wa-sqlite/src/examples/OPFSCoopSyncVFS.js'
  * @param options wasm file url
  * @example
  * // only effect in worker
- * import { getSyncWasmURL, initSQLite, isOpfsSupported } from '@subframe7536/sqlite-wasm'
+ * import { initSQLite, isOpfsSupported } from '@subframe7536/sqlite-wasm'
  * import { useOpfsStorage } from '@subframe7536/sqlite-wasm/opfs'
  *
- * // const url = 'https://cdn.jsdelivr.net/gh/rhashimoto/wa-sqlite@v0.9.9/dist/wa-sqlite.wasm',
- * const url = getSyncWasmURL()
+ * const url = 'https://cdn.jsdelivr.net/gh/rhashimoto/wa-sqlite@v0.9.9/dist/wa-sqlite.wasm'
  *
  * onmessage = async () => {
  * if (!isOpfsSupported()) {

wa-sqlite-fts5/README.md

@@ -0,0 +1,5 @@
+# wa-sqlite fts5
+
+Download from https://github.com/subframe7536/sqwab/releases
+
+Tag: `v1729389754`