@sqlbro/client v0.0.5

Sqlbro client

A tiny wrapper around sql.js-httpvfs to query read only public Sqlite databases from the browser:

import { initDb, query } from "@sqlbro/client";

await initDb("mydb.sqlite");
const data: Array<Record<string, any>> = await query(
  "SELECT * FROM mytable"
)

Install

npm install @sqlbro/client
# or
yarn add @sqlbro/client

Initialize the database

import { initDb } from "@sqlbro/client";

initDb()

Params and types:

function initDb(baseUrl?: string, dbName?: string): Promise<void>

Default values for the initDb params:

baseUrl = window.document.baseURI + "assets/"
dbName = "db.sqlite",

Example of initialization with different params:

import { initDb } from "@sqlbro/client";

initDb(
  window.document.baseURI + '/static',
  "db/mydb.sqlite", // the db is in /static/db/mydb.sqlite
)

Wait for the database initialization

Explicitly wait for the db to finish it's initialization:

import { isDbReady } from "@sqlbro/client";

await isDbReady;
console.log("The db is ready")

Note: the query function below will automatically wait for the db initialization to complete before running a query. So it is safe the run a query right after initDb not having to explicitly wait for the db ready state

Configure

:warning: These files have to be available from an url:

• sqlite.worker.js
• sql-wasm.wasm

Either copy them manualy from node_modules/sql.js-httpvfs/dist/ to a static url location or use a bundler:

Webpack

An example for Webpack 5 is available in the sql.js-httpvfs repository

Vitejs

Example to bundle the required files with Vitejs:

npm install --save-dev vite-plugin-static-copy
# or
yarn add -D vite-plugin-static-copy

Then in the vite.config.ts file:

import { defineConfig } from 'vite'
import { viteStaticCopy } from 'vite-plugin-static-copy'

export default defineConfig({
  assetsInclude: ['**/*.sqlite'],
  plugins: [
    // ...
    viteStaticCopy({
      targets: [
        {
          src: 'node_modules/sql.js-httpvfs/dist/sqlite.worker.js',
          dest: 'assets'
        },
        {
          src: 'node_modules/sql.js-httpvfs/dist/sql-wasm.wasm',
          dest: 'assets'
        },
        {
          src: 'src/assets/db.sqlite',
          dest: 'assets'
        }
      ]
    })
  ],
})

This will handle the files in dev mode and for the build

Query

Query the database from the browser:

import { query } from "@sqlbro/client"

const data: Array<Record<string, any>> = await query(
  "SELECT * FROM mytable"
)

Typing:

function query<T = Array<Record<string, any>>>(q: string): Promise<T>

Example of a query the would return typed data:

interface Product {
  id: number;
  name: string;
  description: string;
}

const data: Array<Product> = await query(
  "SELECT id,name,description FROM products"
)

Example

An example is available with a basic query and a json query