A wrapper library that adds ES6 promises and SQL-based migrations API to
sqlite3 (docs).
🔥 Want to strengthen your core JavaScript skills and master ES6? I would personally recommend this awesome ES6 course by Wes Bos.
How to Install
$ npm install sqlite --save
How to Use
This module has the same API as the original sqlite3 library (docs),
except that all its API methods return ES6 Promises and do not accept callback arguments.
import express from 'express';import Promise from 'bluebird';import db from 'sqlite';const app = express();const port = process.env.PORT || 3000;app.get('/post/:id', async (req, res, next) => { try { const [post, categories] = await Promise.all([ db.get('SELECT * FROM Post WHERE id = ?', req.params.id), db.all('SELECT * FROM Category'); ]);
NOTE: For Node.js v5 and below use var db = require('sqlite/legacy');.
Migrations
This module comes with a lightweight migrations API that works with SQL-based migration files
as the following example demonstrates:
migrations/001-initial-schema.sql
-- UpCREATE TABLE Category (id INTEGER PRIMARY KEY, name TEXT);CREATE TABLE Post (id INTEGER PRIMARY KEY, categoryId INTEGER, title TEXT, CONSTRAINT Post_fk_categoryId FOREIGN KEY (categoryId) REFERENCES Category (id) ON UPDATE CASCADE ON DELETE CASCADE);INSERT INTO Category (id, name) VALUES (1, 'Business');INSERT INTO Category (id, name) VALUES (2, 'Technology');-- DownDROP TABLE CategoryDROP TABLE Post;
migrations/002-missing-index.sql
-- UpCREATE INDEX Post_ix_categoryId ON Post (categoryId);-- DownDROP INDEX Post_ix_categoryId;
app.js (Node.js/Express)
import express from 'express';import Promise from 'bluebird';import db from 'sqlite';const app = express();const port = process.env.PORT || 3000;app.use(/* app routes */);Promise.resolve() // First, try connect to the database and update its schema to the latest version .then(() => db.open('./database.sqlite', { Promise })) .then(() => db.migrate({ force: 'last' })) .
NOTE: For the development environment, while working on the database schema, you may want to set
force: 'last' (default false) that will force the migration API to rollback and re-apply the
latest migration over again each time when Node.js app launches.
Multiple Connections
The open method resolves to the db instance which can be used in order to reference multiple open databases.