Skip to content

Latest commit

 

History

History
110 lines (81 loc) · 3.61 KB

README.md

File metadata and controls

110 lines (81 loc) · 3.61 KB
Raw

Deno SQLite Module

test status deno doc

This is an SQLite module for JavaScript and TypeScript. The wrapper is targeted at Deno 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. 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.

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. There is also a list of examples in the examples folder.

Example

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, 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:

deno bundle --import-map browser/import_map.json browser/mod.ts [output_bundle_path]

The modules documentation can be seen by running

deno doc browser/mod.ts

Databases created in the browser are persisted using indexedDB.

Users

(listed in alphabetical order, please submit a PR if you are using this library and are not included)