Typesafe custom wa-sqlite wrapper, run in memory or persist data to IndexedDB or OPFS, support FTS5 and update / delete limit
Low-level layer for kysely-wasqlite-worker-dialect
Use MemoryVFS with wa-sqlite.wasm, no data persistence
import { initSQLite, isOpfsSupported, useMemoryStorage } from '@subframe7536/sqlite-wasm' // optional url const url = 'https://cdn.jsdelivr.net/npm/@subframe7536/sqlite-wasm@0.5.0/wa-sqlite.wasm' const url1 = 'https://cdn.jsdelivr.net/gh/subframe7536/sqlite-wasm@main/wa-sqlite-fts5/wa-sqlite.wasm' const { run, changes, lastInsertRowId, close } = await initSQLite( useMemoryStorage({ url }) )use IDBBatchAtomicVFS with wa-sqlite-async.wasm, larger than sync version, better compatibility
minimal IndexedDB backend browser version
import { initSQLite } from '@subframe7536/sqlite-wasm' import { useIdbStorage } from '@subframe7536/sqlite-wasm/idb' // optional url const url = 'https://cdn.jsdelivr.net/npm/@subframe7536/sqlite-wasm@0.5.0/wa-sqlite-async.wasm' const url1 = 'https://cdn.jsdelivr.net/gh/subframe7536/sqlite-wasm@main/wa-sqlite-fts5/wa-sqlite-async.wasm' const { run, changes, lastInsertRowId, close } = await initSQLite( useIdbStorage('test.db', { url }) )Use IDBMirrorVFS with wa-sqlite-async.wasm (larger than sync version), better performance compare to useIdbStorage, store data in memory and sync to IndexedDB.
import { initSQLite } from '@subframe7536/sqlite-wasm' import { useIdbMemoryStorage } from '@subframe7536/sqlite-wasm/idb-memory' // before 0.5.0 // import { useIdbMemoryStorage } from '@subframe7536/sqlite-wasm/idb' // optional url const url = 'https://cdn.jsdelivr.net/npm/@subframe7536/sqlite-wasm@0.5.0/dist/wa-sqlite-async.wasm' const { run, changes, lastInsertRowId, close } = await initSQLite( useIdbMemoryStorage('test.db', { url }) )use OPFSCoopSyncVFS with wa-sqlite.wasm, smaller than async version
minimal OPFS backend browser version
MUST RUN IN WEB WORKER
import { initSQLite, isOpfsSupported } from '@subframe7536/sqlite-wasm' import { useOpfsStorage } from '@subframe7536/sqlite-wasm/opfs' // optional url const url = 'https://cdn.jsdelivr.net/npm/@subframe7536/sqlite-wasm@0.5.0/dist/wa-sqlite.wasm' onmessage = async () => { if (!await isOpfsSupported()) { // this can be called in main thread return } const { run, changes, lastInsertRowId, close } = await initSQLite( useOpfsStorage('test.db', url) ) }From v0.5.0
Existing database can be File or ReadableStream
async function selectFile(): Promise<File> { return await new Promise((resolve, reject) => { const input = document.createElement('input') input.type = 'file' input.onchange = () => { const file = input.files?.[0] if (file) { resolve(file) } else { reject(new Error('No file selected')) } input.remove() } input.oncancel = () => { reject(new Error('File selection cancelled')) input.remove() } input.click() }) } const FileOrReadableStream = remote ? (await fetch(remoteSqliteURL)).body! : await selectFile()Import while initiaizing
import { initSQLite, withExistDB } from '@subframe7536/sqlite-wasm' import { useIdbStorage } from '@subframe7536/sqlite-wasm/idb' const db = initSQLite( useIdbStorage('test.db', withExistDB(FileOrReadableStream, { url })) )or load it later
import { importDatabase } from '@subframe7536/sqlite-wasm' import { useIdbStorage } from '@subframe7536/sqlite-wasm/idb' const db = initSQLite('test.db', { url }) await db.sync(FileOrReadableStream) // or use independent function await importDatabase(db.vfs, db.path, FileOrReadableStream)Currently only useIdbStorage is tested, useIdbMemoryStorage will emit error (upstream)
From v0.5.0
If you are using useOpfsStorage, you can directly download it from OPFS, since its db file has same structure as native filesystem.
Example for useIdbStorage
import { exportDatabase } from '@subframe7536/sqlite-wasm' import { useIdbStorage } from '@subframe7536/sqlite-wasm/idb' const db = initSQLite('test.db', { url }) const buffer = await db.dump() // or use independent function const buffer1 = exportDatabase(db.vfs, db.path)Currently only useIdbStorage is tested
import { customFunction, initSQLite, isOpfsSupported } from '@subframe7536/sqlite-wasm' import { useOpfsStorage } from '@subframe7536/sqlite-wasm/opfs' import { uuidv7 } from 'uuidv7' const { run, sqlite, db } = await initSQLite( useOpfsStorage('test') ) customFunction(sqlite, db, 'uuidv7', () => uuidv7()) console.log(await run('select uuidv7() as a')) // [{ "a": "01932f1b-b663-7714-af4d-17a3d9efc7b3" }]import { close, customFunctionCore, initSQLiteCore, run } from '@subframe7536/sqlite-wasm' const core = initSQLiteCore(/* options */) customFunctionCore(core, 'test', num => num) run(core, 'select test(?)', [1]) close(core)MIT