Skip to content
Heaven.js's Table Data Gateway for SQLite. CRUD API that parses and serializes your models.
JavaScript Makefile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
test
.editorconfig
.gitignore
.npmignore
CHANGELOG.md
LICENSE
Makefile
README.md
index.js
package.json

README.md

Heaven.js for SQLite

NPM version

Heaven.js for SQLite is a JavaScript library for Node.js that gives you a CRUD API for your SQLite database by implementing a Table Data Gateway. It's built on Heaven.js for Mapbox's SQLite3, but will work with other compatible SQLite libraries. 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.

Until Heaven.js for SQLite reaches v1, its documentation is likely to be lacking. Sorry for that! It is, however, already used in production.

Installing

npm install heaven-sqlite

Heaven.js for SQLite follows semantic versioning, so feel free to depend on its major version with something like >= 1.0.0 < 2 (a.k.a ^1.0.0).

Using

Instantiate SqliteHeaven by passing it the constructor for your model, an SQLite connection and a table name:

var SqliteHeaven = require("heaven-sqlite")
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
)

You can then call the five CRUD methods like described in Heaven.js's README:

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)

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.

About

Andri Möll typed this and the code.
Monday Calendar supported the engineering work.

If you find Heaven.js for SQLite needs improving, please don't hesitate to type to me now at andri@dot.ee or create an issue online.

You can’t perform that action at this time.