Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    sqlitepublic

    SQLite Client for Node.js Apps

    NPM version NPM downloads Build Status Dependency Status Online Chat

    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

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

    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.

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

    import express from 'express';
    import Promise from 'bluebird';
    import sqlite from 'sqlite';
     
    const app = express();
    const port = process.env.PORT || 3000;
    const dbPromise = sqlite.open('./database.sqlite', { Promise });
     
    app.get('/post/:id', async (req, res, next) => {
      try {
        const db = await dbPromise;
        const [post, categories] = await Promise.all([
          db.get('SELECT * FROM Post WHERE id = ?', req.params.id),
          db.all('SELECT * FROM Category')
        ]);
        res.render('post', { post, categories });
      } catch (err) {
        next(err);
      }
    });
     
    app.listen(port);

    Cached DB Driver

    If you want to enable the database object cache

    sqlite.open('./database.sqlite', { cached: true })

    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
    -- Up 
    CREATE 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');
     
    -- Down 
    DROP TABLE Category
    DROP TABLE Post;
    migrations/002-missing-index.sql
    -- Up 
    CREATE INDEX Post_ix_categoryId ON Post (categoryId);
     
    -- Down 
    DROP INDEX Post_ix_categoryId;
    app.js (Node.js/Express)
    import express from 'express';
    import Promise from 'bluebird';
    import sqlite from 'sqlite';
     
    const app = express();
    const port = process.env.PORT || 3000;
     
    const dbPromise = Promise.resolve()
      .then(() => sqlite.open('./database.sqlite', { Promise }))
      .then(db => db.migrate({ force: 'last' }));
     
    app.use(/* app routes */);
     
    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.

    Multiple Connections

    The open method resolves to the db instance which can be used in order to reference multiple open databases.

    ES6

    import sqlite from 'sqlite';
     
    Promise.all([
      sqlite.open('./main.sqlite', { Promise }),
      sqlite.open('./users.sqlite', { Promise })
    ]).then(function([mainDb, usersDb]){
      ...
    });

    ES7+ Async/Await

    import sqlite from 'sqlite';
     
    async function main() {
      const [mainDb, usersDb] = await Promise.all([
        sqlite.open('./main.sqlite', { Promise }),
        sqlite.open('./users.sqlite', { Promise })
      ]);
      ...
    }
    main();

    References

    Related Projects

    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

    The MIT License © 2015-present Kriasoft. All rights reserved.


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

    install

    npm i sqlite

    Downloadsweekly downloads

    4,437

    version

    2.9.2

    license

    MIT

    repository

    githubgithub

    last publish

    collaborators

    • avatar