JSPM – sqlite@2.0.2

Package Exports

sqlite
sqlite/legacy

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (sqlite) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

SQLite Client for Node.js Apps

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

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 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');.

Migrations

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

`migrations/001-initial.sql`

-- Up
CREATE TABLE User (id INTEGER PRIMARY KEY, email TEXT);
INSERT INTO User (id, email) VALUES (1, 'user@example.com');

-- Down
DROP TABLE User;

`migrations/002-post.sql`

-- Up
CREATE TABLE Post (id INTEGER PRIMARY KEY, userId INTEGER, title TEXT, body TEXT);

-- Down
DROP TABLE Post;

`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 */);

(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.

React Starter Kit — Isomorphic web app boilerplate (Node.js/Express, React.js, GraphQL)
Babel Starter Kit — JavaScript library boilerplate (ES2015, Babel, Rollup)
Membership Database — SQL database boilerplate for web app users, roles and auth tokens

Support

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

License

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

sqlite