Heaven.js for SQLite is a JavaScript library for Node.js that gives you a CRUD API for your SQLite database by implementing a Data Mapper or Table Data Gateway object. It's built on Heaven.js and comes with adapters for Mapbox's SQLite3, Joshua Wise's Better SQLite3 and Node v22.5's experimental SQLite module. It'll also work with other SQLite libraries that have compatible APIs. Along with Sqlate.js's tagged template strings, this permits convenient SQL queries that get parsed to your models and equally easy creation and updating.
Installing
npm install heaven-sqlite
Heaven.js for SQLite follows semantic versioning, so feel free to depend on its major version with something like >= 2 < 3 (a.k.a ^2).
Using with Mapbox's SQLite3
Instantiate SqliteHeaven by passing it the constructor for your model, an SQLite connection and a table name:
var SqliteHeaven = require("heaven-sqlite/mapbox")var Sqlite3 = require("sqlite3")var sqlite = new Sqlite3.Database(":memory:")sqlite.serialize()function Model(attrs) { Object.assign(this, attrs) }var modelsDb = new SqliteHeaven(Model, sqlite, "models")
Suppose the "models" table looks like this:
CREATE TABLE "models" ( "id" INTEGER PRIMARY KEY NOT NULL, "name" TEXT DEFAULT '', "age" INTEGER DEFAULT 0)
var sql = require("sqlate")var john = await modelsDb.create({name: "John", age: 13})var mike = await modelsDb.create({name: "Mike", age: 42})modelsDb.search(sql`SELECT * FROM models WHERE age < 15`)modelsDb.read(john.id)modelsDb.update(model, {age: 42})modelsDb.delete(model)
Using with Joshua Wise's Better SQLite3
Instantiate SqliteHeaven by passing it the constructor for your model, an SQLite connection and a table name:
var SqliteHeaven = require("heaven-sqlite/better")var Sqlite3 = require("better-sqlite3")var sqlite = new Sqlite3.Database(":memory:")function Model(attrs) { Object.assign(this, attrs) }var modelsDb = new SqliteHeaven(Model, sqlite, "models")
Suppose the "models" table looks like this:
CREATE TABLE "models" ( "id" INTEGER PRIMARY KEY NOT NULL, "name" TEXT DEFAULT '', "age" INTEGER DEFAULT 0)
You can then call the five CRUD methods like described in Heaven.js's README, but compared to Mapbox's SQLite3, synchronously:
var sql = require("sqlate")var john = modelsDb.create({name: "John", age: 13})var mike = modelsDb.create({name: "Mike", age: 42})modelsDb.search(sql`SELECT * FROM models WHERE age < 15`)modelsDb.read(john.id)modelsDb.update(model, {age: 42})modelsDb.delete(model)
Using with Node v22's experimental SQLite
Instantiate SqliteHeaven by passing it the constructor for your model, an SQLite connection and a table name:
var SqliteHeaven = require("heaven-sqlite")var Sqlite = require("node:sqlite").DatabaseSyncvar sqlite = new Sqlite(":memory:")function Model(attrs) { Object.assign(this, attrs) }var modelsDb = new SqliteHeaven(Model, sqlite, "models")
Suppose the "models" table looks like this:
CREATE TABLE "models" ( "id" INTEGER PRIMARY KEY NOT NULL, "name" TEXT DEFAULT '', "age" INTEGER DEFAULT 0)
You can then call the five CRUD methods like described in Heaven.js's README synchronously:
var sql = require("sqlate")var john = modelsDb.create({name: "John", age: 13})var mike = modelsDb.create({name: "Mike", age: 42})modelsDb.search(sql`SELECT * FROM models WHERE age < 15`)modelsDb.read(john.id)modelsDb.update(model, {age: 42})modelsDb.delete(model)
License
Heaven.js for SQLite is released under a Lesser GNU Affero General Public License, which in summary means:
You can use this program for no cost.
You can use this program for both personal and commercial reasons.
You do not have to share your own program's code which uses this program.
You have to share modifications (e.g. bug-fixes) you've made to this program.
For more convoluted language, see the LICENSE file.