Skip to content

Commit 0f5842b

Browse files
authored
Update README.md
1 parent d85f62b commit 0f5842b

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ sql.js is a light wrapper around SQLite compiled with EMScripten for use in the
66

77
This repo is a fork of and wrapper around sql.js to provide a read-only HTTP-Range-request based virtual file system for SQLite. It allows hosting an SQLite database on a static file hoster and querying that database from the browser without fully downloading it.
88

9-
The virtual file system is an emscripten filesystem with some "smart" logic to accelerate fetching with virtual read heads that speed up when sequential data is fetched. It could also be useful to other application, the code is in [lazyFile.ts](./src/lazyFile.ts).
9+
The virtual file system is an emscripten filesystem with some "smart" logic to accelerate fetching with virtual read heads that speed up when sequential data is fetched. It could also be useful to other applications, the code is in [lazyFile.ts](./src/lazyFile.ts). It might also be useful to implement this lazy fetching as an [SQLite VFS](https://www.sqlite.org/vfs.html) since then SQLite could be compiled with e.g. WASI SDK without relying on all the emscripten OS emulation.
1010

11-
Note that this only works well if your database and indices is structured well.
11+
Note that this whole thing only works well if your database and indexes are structured well.
1212

13-
It also provides a proof-of-concept level implementation of a DOM virtual table that allows interacting (read/write) with the browser DOM directly from within SQLite queries.
13+
sql.js-httpvfs also provides a proof-of-concept level implementation of a DOM virtual table that allows interacting (read/write) with the browser DOM directly from within SQLite queries.
1414

1515

1616
## Usage
@@ -70,6 +70,7 @@ const worker = await createDbWorker(
7070

7171
const result = await worker.db.exec(`select * from table where id = ?`, [123]);
7272

73+
7374
```
7475

7576
## Is this production ready?
@@ -84,4 +85,4 @@ This project is inspired by:
8485
* https://phiresky.github.io/tv-show-ratings/ a project of mine that fetches the backing data from a WebTorrent (and afterwards seeds it). Not SQLite though, just a torrent with a set of hashed file chunks containing protobufs.
8586
* https://phiresky.github.io/youtube-sponsorship-stats/?uploader=Adam+Ragusea what I originally built sql.js-httpvfs for
8687

87-
The original code of lazyFile is based on the emscripten createLazyFile function, though not much of that code is remaining.
88+
The original code of lazyFile is based on the emscripten createLazyFile function, though not much of that code is remaining.

0 commit comments

Comments
 (0)