SQLite Wasm

Installation

npm install @sqlite.org/sqlite-wasm

Bug reports

Warning

This project wraps the code of SQLite Wasm with no changes, apart from added TypeScript types. Please do not file issues or feature requests regarding the underlying SQLite Wasm code here. Instead, please follow the SQLite 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 without persistence.

Usage

In a worker (with OPFS):

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.ts`.
const worker = new Worker(new URL('./worker.ts', import.meta.url), { type: 'module' });

// In `worker.ts`.
import sqlite3InitModule from '@sqlite.org/sqlite-wasm';

const sqlite3 = await sqlite3InitModule();

console.log('Running SQLite3 version', sqlite3.version.libVersion);

const db = new sqlite3.oo1.OpfsDb('/mydb.sqlite3');

try {
  // Your SQLite code here.
} finally {
  db.close();
}

In the main thread (without OPFS):

import sqlite3InitModule from '@sqlite.org/sqlite-wasm';

const sqlite3 = await sqlite3InitModule();

console.log('Running SQLite3 version', sqlite3.version.libVersion);

const db = new sqlite3.oo1.DB('/mydb.sqlite3', 'ct');

try {
  // Your SQLite code here.
} finally {
  db.close();
}

Usage with Vite

import { defineConfig } from 'vite';

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

Examples

Projects using this package

Contributing

Deprecations

Acknowledgements