Skip to content

Latest commit

 

History

History
142 lines (100 loc) · 3.65 KB

README.md

File metadata and controls

142 lines (100 loc) · 3.65 KB
Raw

SQLiteTable

SQLiteTable is a class that helps you deal with sqlite database. It's very simple and useful for small projects when you don't want any kind of ORM but also you don't wont to find yourself in writing simple queries over and over again.

SQLiteTable is written in TypeScript and it provides typings if you would like to use it with this language (which is recommended) hovewer you can use SQLiteTable with plain JavaScript also.

SQLiteTable is designed in OOP manner and it's best to inherit from it.

Installation

npm install sqlite-table

Example usage

var SQLiteTable = require('sqlite-table');
var sqlite3 = require('sqlite3');

// UserTable class:
var UserTable = function (db) {
  SQLiteTable.call(this, db);
  this.tableName = 'user';
};
UserTable.prototype = Object.create(SQLiteTable.prototype);

// example usage
var db = new sqlite3.Database(':memory:');
db.run('CREATE TABLE user(id INTEGER PRIMARY KEY, firstName TEXT, lastName TEXT)', function (err) {
  var userTable = new UserTable(db);
  var user = {firstName: 'Szymon',lastName: 'Wygnański'};
  user.insert(user, function (err) {
    if (err) {
      // do something with the error
    } else {
      console.log(user); // => {id: 1, firstName: 'Szymon',lastName: 'Wygnański'};
    }
  });
});

API

get many records

public all(next:(err:Error, result:any[])=>void):void;
public all(params?:any, next?:(err:Error, result:any[])=>void):void;

You can get many records using all method. If you will not specify param object then you will get all the records.

You can specify params object and set the search criteria. For example:

var db = new sqlite3.Database(':memory:');
var userTable = new UserTable(db);

userTable.all({firstName: 'Szymon'}, function (err, users) {
  /// users is an array of all the users with first name Szymon.
});

limited get many records

public allLimited(where?:any,
                  limit:{limit:number;offset:number} = {limit: 1000, offset: 0},
                  next:(err?:Error, result?:any[])=>void = ()=> {}):void;
var db = new sqlite3.Database(':memory:');
var userTable = new UserTable(db);

userTable.allLimited({firstName: 'Szymon'}, {limit: 3, offset: 2}, function (err, users) {
  /// users is an array of all the users with first name Szymon.
});

count

public count(where:any = {}, next:(err?:Error, count?:number)=>void = ()=>{}):void;

save

public save(data:any, next:(err?:Error, record?:any)=>void):void;

if data.id is set then update method is invoked, otherwise insert. next callback receive the saved record as a recult.

get one record

public find(params:string, next:(err:Error, result:any)=>void):void;
public find(params:any, next:(err:Error, result:any)=>void):void;

Works same as all method but returns only one record.

insert

public insert(data:any, next:(err?:Error, id?:string)=>void):void;

Insert data into database. Second param of the next callback function will be an id of the new record and data.id property will be set.

update

public update(data:any, next:(err?:Error)=>void):void;

Update record by data.id. The field: data.id must be set, otherwise an error is thrown.

remove

public remove(id:string, next:(err?:Error)=>void):void;

Removes record by id.

Joins

If you want to do something with the record before retrieving it by find or all methods then you can implement the joins(record:any, done:(err:Error, record?:any)=>void):void method.

LICENSE: ISC

ISC license is even simpler MIT like license. Check out the LICENSE file.