wasm_browser

command
v0.23.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 19, 2026 License: AGPL-3.0 Imports: 10 Imported by: 0

README

tinySQL WASM Browser (wasm_browser)

Compiles tinySQL to WebAssembly and serves it with a modern browser UI. The entire SQL engine runs client-side — no server required after the initial file download.

Build

All-in-one script
cd cmd/wasm_browser

# Build only (produces web/tinySQL.wasm, optional .gz, and web/wasm_exec.js)
./build.sh --build-only

# Build and start a local HTTP server on port 8080
./build.sh --serve

# Serve existing assets without rebuilding
./build.sh --skip-build --serve

Then open http://localhost:8080 in your browser.

Manual build
cd cmd/wasm_browser
GOOS=js GOARCH=wasm go build -o web/tinySQL.wasm .
cp "$(go env GOROOT)/lib/wasm/wasm_exec.js" web/
cd web && python3 -m http.server 8080

UI features

  • SQL editor with multi-statement support
  • Result table with column headers
  • Schema inspector (list tables, show columns)
  • SQL editor state, selected demo query, and the database snapshot are restored from localStorage
  • Export results as CSV or JSON

JavaScript API

The WASM module exposes window.tinySQL functions callable from the browser console or your own JavaScript:

Function Description
tinySQL.open([dsn]) Open an in-memory database (mem://?tenant=name)
tinySQL.close() Close the current connection
tinySQL.exec(sql) Execute a SQL statement
tinySQL.query(sql) Execute a query and return rows
tinySQL.exportDB() Return a base64-encoded GOB snapshot
tinySQL.importDB(snapshot) Replace the current database from a snapshot
tinySQL.listTables() Return table metadata
tinySQL.describeTable(table) Return column definitions for a table

Notes

  • The SQL engine still runs in memory. The browser demo persists a compact database snapshot to localStorage after successful mutations and restores it on reload.
  • Clear the browser's site data for the demo origin to reset the persisted snapshot.
  • WASM files must be served over HTTP (not file://) due to browser security restrictions — use the built-in server or any static file host.
  • Modern browsers load the generated tinySQL.wasm.gz companion and stream it through DecompressionStream; older browsers and hosts that already apply compression fall back to tinySQL.wasm automatically.
  • The browser API executes directly against TinySQL's engine instead of through database/sql; this reduces bundle size and avoids connection-pool overhead.
  • Set window.tinySQLWasmDebug = true before loading the module to enable diagnostic console logs; normal query paths stay quiet.
  • For a Node.js variant see ../wasm_node/.

Documentation

Rendered for js/wasm
The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
referencegen
Package referencegen extracts the ordered example overview used by the browser-based function reference.
Package referencegen extracts the ordered example overview used by the browser-based function reference.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL