@squill/sqlite3-browser

 

$3

At the moment, written with SQLite 3.31 in mind.

This is a SQLite 3.31 adapter for @squill/squill

Based on sql.js

-----

A Playground that executes raw SQL and TS code may be found at https://anyhowstep.github.io/tsql-sqlite3-browser/test-playground/public/

A Playground that executes raw SQL only may be found at https://anyhowstep.github.io/tsql-sqlite3-browser/test-browser/public/

-----

$3

+ Document browser usage instructions
+ You may see sample usage at test-browser/src/index.ts
+ Document native BigInt vs polyfilled BigInt support
+ Document detailed usage instructions

$3

``ts
//node.js usage instructions
import * as sql from "@squill/squill";
import * as sqlite3 from "@squill/sqlite3-browser";
import * as worker from "worker_threads";
import * as fs from "fs";

const myWorker = new worker.Worker(
${__dirname}/path/to/node_modules/@squill/sqlite3-browser/dist/worker/worker-node.js
);

const sqlite3Worker = new sqlite3.SqliteWorker({
postMessage : myWorker.postMessage.bind(myWorker),
setOnMessage : (onMessage) => {
myWorker.on("message", (data) => {
onMessage(data);
});
},
});

const pool = new sqlite3.Pool(sqlite3Worker);

//May open a sqlite3 file
await pool.acquire(
connection => connection.open(
fs.readFileSync(path/to/sqlite3/database/file)
)
);

//Raw queries may be used
await pool.acquire(async (connection) => {
await connection.rawQuery(CREATE TABLE T (x INT));
await connection.rawQuery(INSERT INTO T VALUES (1), (2), (3));
/*
{
"query": {
"sql": "SELECT SUM(x) FROM T"
},
"results": [
[
6n //A BigInt
]
],
"columns": [
"SUM(x)"
]
}
*/
await connection.rawQuery(SELECT SUM(x) FROM T);
});

const myTable = sql.table("myTable")
.addColumns({
myTableId : sql.dtBigIntSigned(),
description : sql.dtVarChar(1024),
})
.setAutoIncrement(columns => columns.myTableId);

await pool
.acquire(connection => myTable
.whereEqPrimaryKey({
myTableId : 1337n,
})
.fetchOne(connection)
)
.then(
(row) => {
console.log(row.myTableId);
console.log(row.description);
},
(err) => {
if (sql.isSqlError(err)) {
//Probably some error related to executing a SQL query
//Maybe a RowNotFoundError
} else {
//Probably some other error
}
}
);

/**
* Build a query that may be used later.
*/
const myQuery = sql.from(myTable)
.select(columns => [
columns.myTableId
sql.concat(
"Description: ",
columns.description
).as("labeledDescription"),
]);

await pool
.acquire(connection => myQuery
.whereEqPrimaryKey(
tables => tables.myTable,
{
myTableId : 1337n,
}
)
.fetchOne(connection)
)
.then(
(row) => {
console.log(row.myTableId);
console.log(row.labeledDescription);
},
(err) => {
if (sql.isSqlError(err)) {
//Probably some error related to executing a SQL query
//Maybe a RowNotFoundError
} else {
//Probably some other error
}
}
);

//Gets a Uint8Array which contains the entire database
await pool
.acquire(connection => connection.export());

//The pool cannot be used anymore after this
await pool.disconnect();
//Be sure to not leak workers!
await myWorker.terminate();

`

-----

$3

For development, you'll need to first set up https://github.com/AnyhowStep/tsql

1. Clone https://github.com/AnyhowStep/tsql
1. npm install
1. npm run rebuild

You may now set up this repo

1. Clone this repo
1. npm install
1. npm link ../path/to/tsql (We need this for unified tests which are not published on npm)
1. npm run sanity-check (builds and runs node tests)
1. npm run build-test-browser (builds test-browser; only run after sanity-check or build!)
1. npm run start-test-browser (Starts an express server at port 8000 for the Playground)
1. npm run` for more commands