node package manager

sqlite

SQLite client for Node.js applications

A wrapper library that adds ES6 promises and SQL-based migrations API to sqlite3 (docs).

$ npm install sqlite --save

This module has the same API as the original sqlite3 library (docs) except that all its API methods return promises and do not accept callback arguments.

Below is an example of how to use it with Node.js/Express and Babel:

import express from 'express';
import Promise from 'bluebird';
import db from 'sqlite';
 
const app = express();
const port = process.env.PORT || 3000;
 
app.get('/', async (req, res, next) => {
  try {
    const row = await db.get(`SELECT * FROM tableName WHERE id = ?`, 123);
    res.send(`Hello, ${row.columnName}!`);
  } catch (err) {
    next(err);
  }
});
 
// Connect to the database before launching Node.js app 
(async () => {
  try {
    await db.open('./database.sqlite', { Promise });
  } finally {
    app.listen(port);
  }
})();

NOTE: For Node.js v5 and below use var db = require('sqlite/legacy');.

This module comes with a lightweight migrations API that works with SQL-based migration files as the following example demonstrates:

-- Up 
CREATE TABLE User (id INTEGER PRIMARY KEY, email TEXT);
INSERT INTO User (id, email) VALUES (1'user@example.com');
 
-- Down 
DROP TABLE User;
-- Up 
CREATE TABLE Post (id INTEGER PRIMARY KEY, userId INTEGER, title TEXT, body TEXT);
 
-- Down 
DROP TABLE Post;
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 */);
 
(async () => {
  try {
    // Try connect to the database and update its schema to the latest version 
    await db.open('./db.sqlite', { Promise });
    await db.migrate();
  } finally {
    // Launch Node.js/Express app 
    app.listen(port);
  }
})();

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.

  • Join #node-sqlite chat room on Gitter to stay up to date regarding the project
  • Join #sqlite IRC chat room on Freenode about general discussion about SQLite

The MIT License © 2015-2016 Kriasoft, LLC. All rights reserved.


Made with ♥ by Konstantin Tarkus (@koistya) and contributors