Bug reports

Warning

This project wraps the code ofSQLite Wasm withno changes,apart from added TypeScript types. Please donot file issues or featurerequests regarding the underlying SQLite Wasm code here. Instead, pleasefollow theSQLite bug filing instructions.Filing TypeScript type related issues and feature requests is fine.

Node.js support

Warning

Node.js is currently only supported for in-memory databases withoutpersistence.

Installation

npm install @sqlite.org/sqlite-wasm

Usage

In a wrapped worker (with OPFS if available):

Warning

For this to work, you need to set the following headers on your server:

Cross-Origin-Opener-Policy: same-origin

Cross-Origin-Embedder-Policy: require-corp

import{sqlite3Worker1Promiser}from'@sqlite.org/sqlite-wasm';constlog=console.log;consterror=console.error;constinitializeSQLite=async()=>{try{log('Loading and initializing SQLite3 module...');constpromiser=awaitnewPromise((resolve)=>{const_promiser=sqlite3Worker1Promiser({onready:()=>resolve(_promiser),});});log('Done initializing. Running demo...');constconfigResponse=awaitpromiser('config-get',{});log('Running SQLite3 version',configResponse.result.version.libVersion);constopenResponse=awaitpromiser('open',{filename:'file:mydb.sqlite3?vfs=opfs',});const{ dbId}=openResponse;log('OPFS is available, created persisted database at',openResponse.result.filename.replace(/^file:(.*?)\?vfs=opfs$/,'$1'),);// Your SQLite code here.}catch(err){if(!(errinstanceofError)){err=newError(err.result.message);}error(err.name,err.message);}};initializeSQLite();

In a worker (with OPFS if available):

Warning

For this to work, you need to set the following headers on your server:

Cross-Origin-Opener-Policy: same-origin

Cross-Origin-Embedder-Policy: require-corp

// In `main.js`.constworker=newWorker('worker.js',{type:'module'});

// In `worker.js`.importsqlite3InitModulefrom'@sqlite.org/sqlite-wasm';constlog=console.log;consterror=console.error;conststart=(sqlite3)=>{log('Running SQLite3 version',sqlite3.version.libVersion);constdb='opfs'insqlite3      ?newsqlite3.oo1.OpfsDb('/mydb.sqlite3')      :newsqlite3.oo1.DB('/mydb.sqlite3','ct');log('opfs'insqlite3      ?`OPFS is available, created persisted database at${db.filename}`      :`OPFS is not available, created transient database${db.filename}`,);// Your SQLite code here.};constinitializeSQLite=async()=>{try{log('Loading and initializing SQLite3 module...');constsqlite3=awaitsqlite3InitModule({print:log,printErr:error});log('Done initializing. Running demo...');start(sqlite3);}catch(err){error('Initialization error:',err.name,err.message);}};initializeSQLite();

In the main thread (without OPFS):

importsqlite3InitModulefrom'@sqlite.org/sqlite-wasm';constlog=console.log;consterror=console.error;conststart=(sqlite3)=>{log('Running SQLite3 version',sqlite3.version.libVersion);constdb=newsqlite3.oo1.DB('/mydb.sqlite3','ct');// Your SQLite code here.};constinitializeSQLite=async()=>{try{log('Loading and initializing SQLite3 module...');constsqlite3=awaitsqlite3InitModule({print:log,printErr:error,});log('Done initializing. Running demo...');start(sqlite3);}catch(err){error('Initialization error:',err.name,err.message);}};initializeSQLite();

Usage with vite

import{defineConfig}from'vite';exportdefaultdefineConfig({server:{headers:{'Cross-Origin-Opener-Policy':'same-origin','Cross-Origin-Embedder-Policy':'require-corp',},},optimizeDeps:{exclude:['@sqlite.org/sqlite-wasm'],},});

Demo

Projects using this package

Deploying a new version

License

Acknowledgements