@dolthub/doltlite-wasm

DoltLite compiled to WebAssembly: a drop-in SQLite build with Dolt-style version control — dolt_commit, dolt_branch, dolt_merge, dolt_diff, and the rest — that runs in the browser and in any JS runtime.

This is the WebAssembly distribution. For a native Node/Bun addon, use @dolthub/doltlite instead.

Install

npm install @dolthub/doltlite-wasm

Browser (OPFS-backed, persistent)

OPFS persistence requires the page be served cross-origin isolated (the COOP/COEP headers below); without them you still get an in-memory database.

import { sqlite3InitModule } from '@dolthub/doltlite-wasm';

const sqlite3 = await sqlite3InitModule();

// OpfsDb exists only after the OPFS VFS installs. sqlite3.opfs is removed
// during init, so ('opfs' in sqlite3) stays false even when OPFS is ready.
const db = sqlite3.oo1.OpfsDb
  ? new sqlite3.oo1.OpfsDb('/app.db')
  : new sqlite3.oo1.DB(':memory:');

db.exec(`CREATE TABLE IF NOT EXISTS t(id INTEGER PRIMARY KEY, msg TEXT)`);
db.exec(`INSERT INTO t(msg) VALUES('hello')`);
db.exec(`SELECT dolt_commit('-A', '-m', 'first commit')`);

for (const row of db.selectObjects(`SELECT * FROM dolt_log`)) {
  console.log(row.commit_hash, row.message);
}

Required headers for OPFS (cross-origin isolation):

Cross-Origin-Opener-Policy: same-origin
Cross-Origin-Embedder-Policy: require-corp

Node / Bun

import { sqlite3InitModule } from '@dolthub/doltlite-wasm';

const sqlite3 = await sqlite3InitModule();
const db = new sqlite3.oo1.DB(':memory:');
db.exec(`CREATE TABLE t(x)`);
db.exec(`SELECT dolt_commit('-A', '-m', 'init')`);

That import loads the Node build under Node and the bundler build in a browser. Paths are process-local. For persistence, serialize or use native @dolthub/doltlite.

Entry points

The JavaScript API is the upstream SQLite WASM API — see the sqlite3-wasm docs. Everything there works; DoltLite adds the dolt_* version-control functions and virtual tables on top.

License

Apache-2.0. See LICENSE.md. SQLite itself is public domain.