Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dyedgreen/deno-sqlite
Deno SQLite module
https://github.com/dyedgreen/deno-sqlite
browser database deno deno-sqlite docs-deno javascript sqlite3 typescript wasm webassembly
Last synced: about 12 hours ago
JSON representation
Deno SQLite module
- Host: GitHub
- URL: https://github.com/dyedgreen/deno-sqlite
- Owner: dyedgreen
- License: mit
- Created: 2019-12-09T22:41:56.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-05T14:48:49.000Z (2 months ago)
- Last Synced: 2024-12-06T17:04:34.736Z (8 days ago)
- Topics: browser, database, deno, deno-sqlite, docs-deno, javascript, sqlite3, typescript, wasm, webassembly
- Language: TypeScript
- Homepage: https://deno.land/x/sqlite
- Size: 28.6 MB
- Stars: 413
- Watchers: 8
- Forks: 38
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - deno-sqlite
README
# Deno SQLite Module
[](https://github.com/dyedgreen/deno-sqlite/actions)
[](https://deno.land/x/sqlite/mod.ts)
This is an SQLite module for JavaScript and TypeScript. The wrapper is targeted
at [Deno](https://deno.land) and uses a version of SQLite3 compiled to
WebAssembly (WASM). This module focuses on correctness, ease of use and
performance.
This module guarantees API compatibility according to
[semantic versioning](https://semver.org). Please report any issues you
encounter. Note that the `master` branch might contain new or breaking features.
The versioning guarantee applies only to
[tagged releases](https://github.com/dyedgreen/deno-sqlite/releases).
This module relies on filesystem APIs stabilized in Deno v1.44. To use it with
earlier Deno versions, you must pass the `--unstable-fs` flag when running your
application.
## Documentation
Documentation is available [Deno Docs](https://deno.land/x/sqlite). There is
also a list of examples in the [`examples`](./examples) folder.
## Example
```javascript
import { DB } from "https://deno.land/x/sqlite/mod.ts";
// Open a database
const db = new DB("test.db");
db.execute(`
CREATE TABLE IF NOT EXISTS people (
id INTEGER PRIMARY KEY AUTOINCREMENT,
name TEXT
)
`);
// Run a simple query
for (const name of ["Peter Parker", "Clark Kent", "Bruce Wayne"]) {
db.query("INSERT INTO people (name) VALUES (?)", [name]);
}
// Print out data in table
for (const [name] of db.query("SELECT name FROM people")) {
console.log(name);
}
// Close connection
db.close();
```
## Comparison to Plugin based Modules
### TL;DR
If you want something that just works (and is fast), use this library.
Depending on your specific needs, there is also
[sqlite3](https://github.com/denodrivers/sqlite3), however using that module
requires the `--allow-ffi` and `--unstable` flags, which means the database
connection may bypass e.g. file access permissions.
### Advantages
- Security: benefit from Denos security settings, without the need to trust a
third party
- Portability: runs everywhere Deno runs and can even run in the browser
- Ease of Use: takes full advantage of Denos module cache and does not require
any network access after initial download
- Speed: thanks to WASM, the database performance is comparable to native
bindings in most situations and the API is carefully designed to provide
optimal performance
### Disadvantages
- Weaker Persistence Guarantees: due to limitations in Denos file system APIs,
SQLite can't acquire file locks or memory map files (e.g. this module does not
support WAL mode)
## Browser Version (Experimental)
There is **experimental** support for using `deno-sqlite` in the browser. You
can generate a browser compatible module by running:
```bash
deno bundle --import-map browser/import_map.json browser/mod.ts [output_bundle_path]
```
The modules documentation can be seen by running
```bash
deno doc browser/mod.ts
```
Databases created in the browser are persisted using
[indexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API).
## Users
- [cotton](https://github.com/rahmanfadhil/cotton)
- [deno-nessie](https://github.com/halvardssm/deno-nessie)
- [denodb](https://github.com/eveningkid/denodb)
- [denolib/typeorm](https://github.com/denolib/typeorm)
- [kysely-deno-sqlite](https://gitlab.com/soapbox-pub/kysely-deno-sqlite)
- [small-orm-sqlite](https://github.com/enimatek-nl/small-orm-sqlite)
_(listed in alphabetical order, please submit a PR if you are using this library
and are not included)_